digital_femsa 1.0.0 → 1.1.0

data/lib/digital_femsa/api/webhooks_api.rb

@@ -21,7 +21,7 @@ module DigitalFemsa
     end
     # Create Webhook
     # What we do at Femsa translates into events. For example, an event of interest to us occurs at the time a payment is successfully processed. At that moment we will be interested in doing several things: Send an email to the buyer, generate an invoice, start the process of shipping the product, etc.
-    # @param webhook_request [WebhookRequest] requested field for webhook
+    # @param webhook_request [WebhookRequest] Webhook creation/update request payload.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
     # @return [WebhookResponse]
@@ -32,7 +32,7 @@ module DigitalFemsa
 
     # Create Webhook
     # What we do at Femsa translates into events. For example, an event of interest to us occurs at the time a payment is successfully processed. At that moment we will be interested in doing several things: Send an email to the buyer, generate an invoice, start the process of shipping the product, etc.
-    # @param webhook_request [WebhookRequest] requested field for webhook
+    # @param webhook_request [WebhookRequest] Webhook creation/update request payload.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
     # @return [Array<(WebhookResponse, Integer, Hash)>] WebhookResponse data, response status code and response headers
@@ -94,7 +94,8 @@ module DigitalFemsa
       return data, status_code, headers
     end
 
-    # Delete Webhook
+    # Delete webhook
+    # Deletes a webhook.
     # @param id [String] Identifier of the resource
     # @param [Hash] opts the optional parameters
     # @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
@@ -104,7 +105,8 @@ module DigitalFemsa
       data
     end
 
-    # Delete Webhook
+    # Delete webhook
+    # Deletes a webhook.
     # @param id [String] Identifier of the resource
     # @param [Hash] opts the optional parameters
     # @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
@@ -162,7 +164,8 @@ module DigitalFemsa
       return data, status_code, headers
     end
 
-    # Get Webhook
+    # Get webhook
+    # Retrieves the details of a webhook by its ID.
     # @param id [String] Identifier of the resource
     # @param [Hash] opts the optional parameters
     # @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
@@ -173,7 +176,8 @@ module DigitalFemsa
       data
     end
 
-    # Get Webhook
+    # Get webhook
+    # Retrieves the details of a webhook by its ID.
     # @param id [String] Identifier of the resource
     # @param [Hash] opts the optional parameters
     # @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
@@ -240,6 +244,7 @@ module DigitalFemsa
     # @option opts [String] :x_child_company_id In the case of a holding company, the company id of the child company to which will process the request.
     # @option opts [Integer] :limit The numbers of items to return, the maximum value is 250 (default to 20)
     # @option opts [String] :search General order search, e.g. by mail, reference etc.
+    # @option opts [String] :url url for webhook filter
     # @option opts [String] :_next next page
     # @option opts [String] :previous previous page
     # @return [GetWebhooksResponse]
@@ -255,6 +260,7 @@ module DigitalFemsa
     # @option opts [String] :x_child_company_id In the case of a holding company, the company id of the child company to which will process the request.
     # @option opts [Integer] :limit The numbers of items to return, the maximum value is 250 (default to 20)
     # @option opts [String] :search General order search, e.g. by mail, reference etc.
+    # @option opts [String] :url url for webhook filter
     # @option opts [String] :_next next page
     # @option opts [String] :previous previous page
     # @return [Array<(GetWebhooksResponse, Integer, Hash)>] GetWebhooksResponse data, response status code and response headers
@@ -281,6 +287,7 @@ module DigitalFemsa
       query_params = opts[:query_params] || {}
       query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
       query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
+      query_params[:'url'] = opts[:'url'] if !opts[:'url'].nil?
       query_params[:'next'] = opts[:'_next'] if !opts[:'_next'].nil?
       query_params[:'previous'] = opts[:'previous'] if !opts[:'previous'].nil?
 
@@ -320,8 +327,8 @@ module DigitalFemsa
       return data, status_code, headers
     end
 
-    # Test Webhook
-    # Send a webhook.ping event
+    # Test webhook
+    # Sends a test event to the specified webhook to verify it can receive events.
     # @param id [String] Identifier of the resource
     # @param [Hash] opts the optional parameters
     # @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
@@ -331,8 +338,8 @@ module DigitalFemsa
       data
     end
 
-    # Test Webhook
-    # Send a webhook.ping event
+    # Test webhook
+    # Sends a test event to the specified webhook to verify it can receive events.
     # @param id [String] Identifier of the resource
     # @param [Hash] opts the optional parameters
     # @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
@@ -390,10 +397,10 @@ module DigitalFemsa
       return data, status_code, headers
     end
 
-    # Update Webhook
-    # updates an existing webhook
+    # Update webhook
+    # Updates an existing webhook.
     # @param id [String] Identifier of the resource
-    # @param webhook_update_request [WebhookUpdateRequest] requested fields in order to update a webhook
+    # @param webhook_update_request [WebhookUpdateRequest] Webhook update request payload.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
     # @option opts [String] :x_child_company_id In the case of a holding company, the company id of the child company to which will process the request.
@@ -403,10 +410,10 @@ module DigitalFemsa
       data
     end
 
-    # Update Webhook
-    # updates an existing webhook
+    # Update webhook
+    # Updates an existing webhook.
     # @param id [String] Identifier of the resource
-    # @param webhook_update_request [WebhookUpdateRequest] requested fields in order to update a webhook
+    # @param webhook_update_request [WebhookUpdateRequest] Webhook update request payload.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
     # @option opts [String] :x_child_company_id In the case of a holding company, the company id of the child company to which will process the request.

data/lib/digital_femsa/api_client.rb

@@ -34,11 +34,11 @@ module DigitalFemsa
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "DigitalFemsa/v2 RubyBindings/#{DigitalFemsa::VERSION}"
+      @user_agent = "App/v2 RubyBindings/#{DigitalFemsa::VERSION}"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent,
-        'X-DigitalFemsa-Client-User-Agent' => digitalfemsa_headers.to_json
+        'Spin-Client-User-Agent' => digitalfemsa_headers_to_string
       }
     end
 
@@ -430,13 +430,17 @@ module DigitalFemsa
     end
     def digitalfemsa_headers
       params = {
-        bindings_version: DigitalFemsa::VERSION,
+        sdk_version: DigitalFemsa::VERSION,
         lang: 'ruby',
-        lang_version: RUBY_VERSION,
-        publisher: 'digitalfemsa'
+        lang_version: RUBY_VERSION
       }
 
       @digitalfemsa_headers ||= params
     end
+    
+    def digitalfemsa_headers_to_string
+      headers = digitalfemsa_headers
+      headers.map { |k, v| "#{k}=#{v}" }.join(';')
+    end
   end
 end

data/lib/digital_femsa/models/api_key_create_response.rb

@@ -48,7 +48,7 @@ module DigitalFemsa
     # Indicates if the api key is private or public
     attr_accessor :role
 
-    # It is occupied as a user when authenticated with basic authentication, with a blank password. This value will only appear once, in the request to create a new key. Copy and save it in a safe place.
+    # Used as the username for Basic Authentication, with a blank password. This value is shown only once (when the key is created). Copy and store it securely. 
     attr_accessor :authentication_token
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/digital_femsa/models/api_key_request.rb

@@ -15,11 +15,34 @@ require 'time'
 
 module DigitalFemsa
   class ApiKeyRequest
-    # A name or brief explanation of what this api key is used for
+    # A name or brief explanation of what this API key is used for.
     attr_accessor :description
 
+    # Defines the type of API key to create. Only \"private\" is supported for creation. A \"public\" API key already exists by default per company/environment. 
     attr_accessor :role
 
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -90,9 +113,21 @@ module DigitalFemsa
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @role.nil?
+      role_validator = EnumAttributeValidator.new('String', ["private"])
+      return false unless role_validator.valid?(@role)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] role Object to be assigned
+    def role=(role)
+      validator = EnumAttributeValidator.new('String', ["private"])
+      unless validator.valid?(role)
+        fail ArgumentError, "invalid value for \"role\", must be one of #{validator.allowable_values}."
+      end
+      @role = role
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/lib/digital_femsa/models/balance_response.rb

@@ -14,9 +14,9 @@ require 'date'
 require 'time'
 
 module DigitalFemsa
-  # balance model
+  # Company balance summary.  Monetary fields are returned as arrays of amounts grouped by currency (see `balance_common_field` items). 
   class BalanceResponse
-    # The balance's available
+    # Amounts currently available, grouped by currency.
     attr_accessor :available
 
     # The balance's cashout retention amount
@@ -25,25 +25,25 @@ module DigitalFemsa
     # The balance's Femsa retention
     attr_accessor :conekta_retention
 
-    # The balance's gateway
+    # Gateway balance amounts, grouped by currency.
     attr_accessor :gateway
 
-    # The balance's pending
+    # Amounts pending settlement, grouped by currency.
     attr_accessor :pending
 
-    # The balance's retained
+    # Amounts currently retained, grouped by currency.
     attr_accessor :retained
 
-    # The balance's retention amount
+    # Retention amount applied, grouped by currency.
     attr_accessor :retention_amount
 
-    # The balance's target collateral amount
+    # Target collateral amount, grouped by currency.
     attr_accessor :target_collateral_amount
 
-    # The balance's target retention amount
+    # Target retention amount, grouped by currency.
     attr_accessor :target_retention_amount
 
-    # The balance's temporarily retained
+    # Amounts temporarily retained
     attr_accessor :temporarily_retained
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/digital_femsa/models/charge_order_response.rb

@@ -85,7 +85,7 @@ module DigitalFemsa
     def self.openapi_types
       {
         :'amount' => :'Integer',
-        :'channel' => :'ChargeResponseChannel',
+        :'channel' => :'ChargeOrderResponseChannel',
         :'created_at' => :'Integer',
         :'currency' => :'String',
         :'customer_id' => :'String',

data/lib/digital_femsa/models/{order_next_action_response.rb → charge_order_response_channel.rb}

@@ -14,18 +14,22 @@ require 'date'
 require 'time'
 
 module DigitalFemsa
-  # contains the following attributes that will guide to continue the flow
-  class OrderNextActionResponse
-    attr_accessor :redirect_to_url
+  class ChargeOrderResponseChannel
+    attr_accessor :segment
 
-    # Indicates the type of action to be taken
-    attr_accessor :type
+    attr_accessor :checkout_request_id
+
+    attr_accessor :checkout_request_type
+
+    attr_accessor :id
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'redirect_to_url' => :'redirect_to_url',
-        :'type' => :'type'
+        :'segment' => :'segment',
+        :'checkout_request_id' => :'checkout_request_id',
+        :'checkout_request_type' => :'checkout_request_type',
+        :'id' => :'id'
       }
     end
 
@@ -37,8 +41,10 @@ module DigitalFemsa
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'redirect_to_url' => :'OrderNextActionResponseRedirectToUrl',
-        :'type' => :'String'
+        :'segment' => :'String',
+        :'checkout_request_id' => :'String',
+        :'checkout_request_type' => :'String',
+        :'id' => :'String'
       }
     end
 
@@ -52,23 +58,31 @@ module DigitalFemsa
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `DigitalFemsa::OrderNextActionResponse` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DigitalFemsa::ChargeOrderResponseChannel` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h|
         if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `DigitalFemsa::OrderNextActionResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `DigitalFemsa::ChargeOrderResponseChannel`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'redirect_to_url')
-        self.redirect_to_url = attributes[:'redirect_to_url']
+      if attributes.key?(:'segment')
+        self.segment = attributes[:'segment']
+      end
+
+      if attributes.key?(:'checkout_request_id')
+        self.checkout_request_id = attributes[:'checkout_request_id']
+      end
+
+      if attributes.key?(:'checkout_request_type')
+        self.checkout_request_type = attributes[:'checkout_request_type']
       end
 
-      if attributes.key?(:'type')
-        self.type = attributes[:'type']
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
       end
     end
 
@@ -92,8 +106,10 @@ module DigitalFemsa
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          redirect_to_url == o.redirect_to_url &&
-          type == o.type
+          segment == o.segment &&
+          checkout_request_id == o.checkout_request_id &&
+          checkout_request_type == o.checkout_request_type &&
+          id == o.id
     end
 
     # @see the `==` method
@@ -105,7 +121,7 @@ module DigitalFemsa
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [redirect_to_url, type].hash
+      [segment, checkout_request_id, checkout_request_type, id].hash
     end
 
     # Builds the object from hash

data/lib/digital_femsa/models/charge_request_payment_method.rb

@@ -14,13 +14,14 @@ require 'date'
 require 'time'
 
 module DigitalFemsa
-  # Payment method used in the charge. Go to the [payment methods](https://developers.femsa.com/reference/m%C3%A9todos-de-pago) section for more details 
+  # Payment method used in the charge. 
   class ChargeRequestPaymentMethod
-    # Method expiration date as unix timestamp
+    # Method expiration date as unix timestamp (applies to some payment methods, e.g. cash).
     attr_accessor :expires_at
 
     attr_accessor :type
 
+    # Identifier of a saved payment source to be used for this charge (if applicable).
     attr_accessor :payment_source_id
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/digital_femsa/models/charge_response.rb

@@ -52,6 +52,8 @@ module DigitalFemsa
 
     attr_accessor :status
 
+    attr_accessor :is_refundable
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -72,7 +74,8 @@ module DigitalFemsa
         :'payment_method' => :'payment_method',
         :'reference_id' => :'reference_id',
         :'refunds' => :'refunds',
-        :'status' => :'status'
+        :'status' => :'status',
+        :'is_refundable' => :'is_refundable'
       }
     end
 
@@ -101,13 +104,16 @@ module DigitalFemsa
         :'payment_method' => :'ChargeResponsePaymentMethod',
         :'reference_id' => :'String',
         :'refunds' => :'ChargeResponseRefunds',
-        :'status' => :'String'
+        :'status' => :'String',
+        :'is_refundable' => :'Boolean'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'failure_code',
+        :'failure_message',
         :'paid_at',
         :'reference_id',
         :'refunds',
@@ -200,6 +206,10 @@ module DigitalFemsa
       if attributes.key?(:'status')
         self.status = attributes[:'status']
       end
+
+      if attributes.key?(:'is_refundable')
+        self.is_refundable = attributes[:'is_refundable']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -239,7 +249,8 @@ module DigitalFemsa
           payment_method == o.payment_method &&
           reference_id == o.reference_id &&
           refunds == o.refunds &&
-          status == o.status
+          status == o.status &&
+          is_refundable == o.is_refundable
     end
 
     # @see the `==` method
@@ -251,7 +262,7 @@ module DigitalFemsa
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [amount, channel, created_at, currency, customer_id, description, device_fingerprint, failure_code, failure_message, id, livemode, object, order_id, paid_at, payment_method, reference_id, refunds, status].hash
+      [amount, channel, created_at, currency, customer_id, description, device_fingerprint, failure_code, failure_message, id, livemode, object, order_id, paid_at, payment_method, reference_id, refunds, status, is_refundable].hash
     end
 
     # Builds the object from hash

data/lib/digital_femsa/models/charge_response_refunds_data.rb

@@ -31,6 +31,11 @@ module DigitalFemsa
     # refund status
     attr_accessor :status
 
+    attr_accessor :payout_id
+
+    # payout reference for oxxo stores
+    attr_accessor :reference
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -40,7 +45,9 @@ module DigitalFemsa
         :'expires_at' => :'expires_at',
         :'id' => :'id',
         :'object' => :'object',
-        :'status' => :'status'
+        :'status' => :'status',
+        :'payout_id' => :'payout_id',
+        :'reference' => :'reference'
       }
     end
 
@@ -58,7 +65,9 @@ module DigitalFemsa
         :'expires_at' => :'Integer',
         :'id' => :'String',
         :'object' => :'String',
-        :'status' => :'String'
+        :'status' => :'String',
+        :'payout_id' => :'String',
+        :'reference' => :'String'
       }
     end
 
@@ -118,6 +127,14 @@ module DigitalFemsa
       if attributes.key?(:'status')
         self.status = attributes[:'status']
       end
+
+      if attributes.key?(:'payout_id')
+        self.payout_id = attributes[:'payout_id']
+      end
+
+      if attributes.key?(:'reference')
+        self.reference = attributes[:'reference']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -166,7 +183,9 @@ module DigitalFemsa
           expires_at == o.expires_at &&
           id == o.id &&
           object == o.object &&
-          status == o.status
+          status == o.status &&
+          payout_id == o.payout_id &&
+          reference == o.reference
     end
 
     # @see the `==` method
@@ -178,7 +197,7 @@ module DigitalFemsa
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [amount, auth_code, created_at, expires_at, id, object, status].hash
+      [amount, auth_code, created_at, expires_at, id, object, status, payout_id, reference].hash
     end
 
     # Builds the object from hash

data/lib/digital_femsa/models/charge_update_request.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module DigitalFemsa
-  # requested field for update a charge
+  # Request body to update a charge. Only `reference_id` can be updated.
   class ChargeUpdateRequest
     # custom reference id
     attr_accessor :reference_id

data/lib/digital_femsa/models/charges_data_response.rb

@@ -52,6 +52,8 @@ module DigitalFemsa
 
     attr_accessor :status
 
+    attr_accessor :is_refundable
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -72,7 +74,8 @@ module DigitalFemsa
         :'payment_method' => :'payment_method',
         :'reference_id' => :'reference_id',
         :'refunds' => :'refunds',
-        :'status' => :'status'
+        :'status' => :'status',
+        :'is_refundable' => :'is_refundable'
       }
     end
 
@@ -101,13 +104,16 @@ module DigitalFemsa
         :'payment_method' => :'ChargeResponsePaymentMethod',
         :'reference_id' => :'String',
         :'refunds' => :'ChargeResponseRefunds',
-        :'status' => :'String'
+        :'status' => :'String',
+        :'is_refundable' => :'Boolean'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'failure_code',
+        :'failure_message',
         :'paid_at',
         :'reference_id',
         :'refunds',
@@ -207,6 +213,10 @@ module DigitalFemsa
       if attributes.key?(:'status')
         self.status = attributes[:'status']
       end
+
+      if attributes.key?(:'is_refundable')
+        self.is_refundable = attributes[:'is_refundable']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -246,7 +256,8 @@ module DigitalFemsa
           payment_method == o.payment_method &&
           reference_id == o.reference_id &&
           refunds == o.refunds &&
-          status == o.status
+          status == o.status &&
+          is_refundable == o.is_refundable
     end
 
     # @see the `==` method
@@ -258,7 +269,7 @@ module DigitalFemsa
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [amount, channel, created_at, currency, customer_id, description, device_fingerprint, failure_code, failure_message, id, livemode, object, order_id, paid_at, payment_method, reference_id, refunds, status].hash
+      [amount, channel, created_at, currency, customer_id, description, device_fingerprint, failure_code, failure_message, id, livemode, object, order_id, paid_at, payment_method, reference_id, refunds, status, is_refundable].hash
     end
 
     # Builds the object from hash