digital_femsa 1.0.0 → 1.1.0

data/lib/digital_femsa/models/checkout.rb

@@ -14,46 +14,50 @@ require 'date'
 require 'time'
 
 module DigitalFemsa
-  # It is a sub-resource of the Order model that can be stipulated in order to configure its corresponding checkout
+  # Creates a Payment Link. This is a sub-resource related to an Order template: each time a customer pays using the link, the API will create an Order using `order_template`. 
   class Checkout
-    # Those are the payment methods that will be available for the link
-    attr_accessor :allowed_payment_methods
+    # Payment link name.
+    attr_accessor :name
 
-    # It is the time when the link will expire. It is expressed in seconds since the Unix epoch. The valid range is from 2 to 365 days (the valid range will be taken from the next day of the creation date at 00:01 hrs) 
-    attr_accessor :expires_at
+    # Checkout type.
+    attr_accessor :type
 
-    # Reason for charge
-    attr_accessor :name
+    # false: single use. true: multiple payments
+    attr_accessor :recurrent
+
+    # Required when `recurrent` is true. Maximum number of payments allowed through the link.
+    attr_accessor :payments_limit_count
+
+    # Payment methods available in the payment link.
+    attr_accessor :allowed_payment_methods
 
     # This flag allows you to fill in the shipping information at checkout.
     attr_accessor :needs_shipping_contact
 
-    # This flag allows you to specify if the link will be on demand.
-    attr_accessor :on_demand_enabled
-
-    attr_accessor :order_template
+    # Start time for the link. Unix timestamp in seconds.
+    attr_accessor :starts_at
 
-    # It is the number of payments that can be made through the link.
-    attr_accessor :payments_limit_count
+    # Expiration time for the link (Unix timestamp in seconds). Valid range is between 2 and 365 days (calculated from the next day of creation at 00:01). 
+    attr_accessor :expires_at
 
-    # false: single use. true: multiple payments
-    attr_accessor :recurrent
+    # If true, the link does not expire.
+    attr_accessor :can_not_expire
 
-    # It is the type of link that will be created. It must be a valid type.
-    attr_accessor :type
+    attr_accessor :order_template
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'allowed_payment_methods' => :'allowed_payment_methods',
-        :'expires_at' => :'expires_at',
         :'name' => :'name',
-        :'needs_shipping_contact' => :'needs_shipping_contact',
-        :'on_demand_enabled' => :'on_demand_enabled',
-        :'order_template' => :'order_template',
-        :'payments_limit_count' => :'payments_limit_count',
+        :'type' => :'type',
         :'recurrent' => :'recurrent',
-        :'type' => :'type'
+        :'payments_limit_count' => :'payments_limit_count',
+        :'allowed_payment_methods' => :'allowed_payment_methods',
+        :'needs_shipping_contact' => :'needs_shipping_contact',
+        :'starts_at' => :'starts_at',
+        :'expires_at' => :'expires_at',
+        :'can_not_expire' => :'can_not_expire',
+        :'order_template' => :'order_template'
       }
     end
 
@@ -65,22 +69,22 @@ module DigitalFemsa
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'allowed_payment_methods' => :'Array<String>',
-        :'expires_at' => :'Integer',
         :'name' => :'String',
-        :'needs_shipping_contact' => :'Boolean',
-        :'on_demand_enabled' => :'Boolean',
-        :'order_template' => :'CheckoutOrderTemplate',
-        :'payments_limit_count' => :'Integer',
+        :'type' => :'String',
         :'recurrent' => :'Boolean',
-        :'type' => :'String'
+        :'payments_limit_count' => :'Integer',
+        :'allowed_payment_methods' => :'Array<String>',
+        :'needs_shipping_contact' => :'Boolean',
+        :'starts_at' => :'Integer',
+        :'expires_at' => :'Integer',
+        :'can_not_expire' => :'Boolean',
+        :'order_template' => :'CheckoutOrderTemplate'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'on_demand_enabled',
       ])
     end
 
@@ -99,54 +103,60 @@ module DigitalFemsa
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'allowed_payment_methods')
-        if (value = attributes[:'allowed_payment_methods']).is_a?(Array)
-          self.allowed_payment_methods = value
-        end
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
       else
-        self.allowed_payment_methods = nil
+        self.name = nil
       end
 
-      if attributes.key?(:'expires_at')
-        self.expires_at = attributes[:'expires_at']
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
       else
-        self.expires_at = nil
+        self.type = nil
       end
 
-      if attributes.key?(:'name')
-        self.name = attributes[:'name']
+      if attributes.key?(:'recurrent')
+        self.recurrent = attributes[:'recurrent']
       else
-        self.name = nil
+        self.recurrent = nil
       end
 
-      if attributes.key?(:'needs_shipping_contact')
-        self.needs_shipping_contact = attributes[:'needs_shipping_contact']
+      if attributes.key?(:'payments_limit_count')
+        self.payments_limit_count = attributes[:'payments_limit_count']
       end
 
-      if attributes.key?(:'on_demand_enabled')
-        self.on_demand_enabled = attributes[:'on_demand_enabled']
+      if attributes.key?(:'allowed_payment_methods')
+        if (value = attributes[:'allowed_payment_methods']).is_a?(Array)
+          self.allowed_payment_methods = value
+        end
+      else
+        self.allowed_payment_methods = nil
       end
 
-      if attributes.key?(:'order_template')
-        self.order_template = attributes[:'order_template']
+      if attributes.key?(:'needs_shipping_contact')
+        self.needs_shipping_contact = attributes[:'needs_shipping_contact']
       else
-        self.order_template = nil
+        self.needs_shipping_contact = nil
       end
 
-      if attributes.key?(:'payments_limit_count')
-        self.payments_limit_count = attributes[:'payments_limit_count']
+      if attributes.key?(:'starts_at')
+        self.starts_at = attributes[:'starts_at']
       end
 
-      if attributes.key?(:'recurrent')
-        self.recurrent = attributes[:'recurrent']
+      if attributes.key?(:'expires_at')
+        self.expires_at = attributes[:'expires_at']
       else
-        self.recurrent = nil
+        self.expires_at = nil
       end
 
-      if attributes.key?(:'type')
-        self.type = attributes[:'type']
+      if attributes.key?(:'can_not_expire')
+        self.can_not_expire = attributes[:'can_not_expire']
+      end
+
+      if attributes.key?(:'order_template')
+        self.order_template = attributes[:'order_template']
       else
-        self.type = nil
+        self.order_template = nil
       end
     end
 
@@ -155,28 +165,32 @@ module DigitalFemsa
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @allowed_payment_methods.nil?
-        invalid_properties.push('invalid value for "allowed_payment_methods", allowed_payment_methods cannot be nil.')
-      end
-
-      if @expires_at.nil?
-        invalid_properties.push('invalid value for "expires_at", expires_at cannot be nil.')
-      end
-
       if @name.nil?
         invalid_properties.push('invalid value for "name", name cannot be nil.')
       end
 
-      if @order_template.nil?
-        invalid_properties.push('invalid value for "order_template", order_template cannot be nil.')
+      if @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
       end
 
       if @recurrent.nil?
         invalid_properties.push('invalid value for "recurrent", recurrent cannot be nil.')
       end
 
-      if @type.nil?
-        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      if @allowed_payment_methods.nil?
+        invalid_properties.push('invalid value for "allowed_payment_methods", allowed_payment_methods cannot be nil.')
+      end
+
+      if @needs_shipping_contact.nil?
+        invalid_properties.push('invalid value for "needs_shipping_contact", needs_shipping_contact cannot be nil.')
+      end
+
+      if @expires_at.nil?
+        invalid_properties.push('invalid value for "expires_at", expires_at cannot be nil.')
+      end
+
+      if @order_template.nil?
+        invalid_properties.push('invalid value for "order_template", order_template cannot be nil.')
       end
 
       invalid_properties
@@ -186,12 +200,13 @@ module DigitalFemsa
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @name.nil?
+      return false if @type.nil?
+      return false if @recurrent.nil?
       return false if @allowed_payment_methods.nil?
+      return false if @needs_shipping_contact.nil?
       return false if @expires_at.nil?
-      return false if @name.nil?
       return false if @order_template.nil?
-      return false if @recurrent.nil?
-      return false if @type.nil?
       true
     end
 
@@ -200,15 +215,16 @@ module DigitalFemsa
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          allowed_payment_methods == o.allowed_payment_methods &&
-          expires_at == o.expires_at &&
           name == o.name &&
-          needs_shipping_contact == o.needs_shipping_contact &&
-          on_demand_enabled == o.on_demand_enabled &&
-          order_template == o.order_template &&
-          payments_limit_count == o.payments_limit_count &&
+          type == o.type &&
           recurrent == o.recurrent &&
-          type == o.type
+          payments_limit_count == o.payments_limit_count &&
+          allowed_payment_methods == o.allowed_payment_methods &&
+          needs_shipping_contact == o.needs_shipping_contact &&
+          starts_at == o.starts_at &&
+          expires_at == o.expires_at &&
+          can_not_expire == o.can_not_expire &&
+          order_template == o.order_template
     end
 
     # @see the `==` method
@@ -220,7 +236,7 @@ module DigitalFemsa
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [allowed_payment_methods, expires_at, name, needs_shipping_contact, on_demand_enabled, order_template, payments_limit_count, recurrent, type].hash
+      [name, type, recurrent, payments_limit_count, allowed_payment_methods, needs_shipping_contact, starts_at, expires_at, can_not_expire, order_template].hash
     end
 
     # Builds the object from hash

data/lib/digital_femsa/models/checkout_order_template.rb

@@ -14,17 +14,17 @@ require 'date'
 require 'time'
 
 module DigitalFemsa
-  # It maintains the attributes with which the order will be created when receiving a new payment.
+  # Attributes used to create the order when a new payment is received.
   class CheckoutOrderTemplate
-    # It is the currency in which the order will be created. It must be a valid ISO 4217 currency code.
+    # ISO 4217 currency code for the order.
     attr_accessor :currency
 
     attr_accessor :customer_info
 
-    # They are the products to buy. Each contains the \"unit price\" and \"quantity\" parameters that are used to calculate the total amount of the order.
+    # Products to buy. Each contains unit price and quantity used to calculate the order total.
     attr_accessor :line_items
 
-    # It is a set of key-value pairs that you can attach to the order. It can be used to store additional information about the order in a structured format.
+    # Arbitrary key-value data attached to the order for internal use.
     attr_accessor :metadata
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/digital_femsa/models/checkout_order_template_customer_info.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module DigitalFemsa
-  # It is the information of the customer who will be created when receiving a new payment.
+  # Customer information used when creating the order.
   module CheckoutOrderTemplateCustomerInfo
     class << self
       # List of class defined in oneOf (OpenAPI v3)

data/lib/digital_femsa/models/checkout_request.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module DigitalFemsa
-  # [Checkout](https://developers.femsa.com/v2.1.0/reference/payment-link) details 
+  # [Checkout](https://developers.digitalfemsa.io/docs/checkout-redireccionado) details 
   class CheckoutRequest
     # Are the payment methods available for this link
     attr_accessor :allowed_payment_methods

data/lib/digital_femsa/models/checkout_response.rb

@@ -32,7 +32,7 @@ module DigitalFemsa
 
     attr_accessor :metadata
 
-    # Reason for charge
+    # Payment link name
     attr_accessor :name
 
     attr_accessor :needs_shipping_contact

data/lib/digital_femsa/models/create_customer_fiscal_entities_response.rb

@@ -19,14 +19,14 @@ module DigitalFemsa
 
     attr_accessor :tax_id
 
+    attr_accessor :name
+
     attr_accessor :email
 
     attr_accessor :phone
 
     attr_accessor :metadata
 
-    attr_accessor :company_name
-
     attr_accessor :id
 
     attr_accessor :object
@@ -42,10 +42,10 @@ module DigitalFemsa
       {
         :'address' => :'address',
         :'tax_id' => :'tax_id',
+        :'name' => :'name',
         :'email' => :'email',
         :'phone' => :'phone',
         :'metadata' => :'metadata',
-        :'company_name' => :'company_name',
         :'id' => :'id',
         :'object' => :'object',
         :'created_at' => :'created_at',
@@ -64,10 +64,10 @@ module DigitalFemsa
       {
         :'address' => :'CustomerAddress',
         :'tax_id' => :'String',
+        :'name' => :'String',
         :'email' => :'String',
         :'phone' => :'String',
         :'metadata' => :'Hash<String, Object>',
-        :'company_name' => :'String',
         :'id' => :'String',
         :'object' => :'String',
         :'created_at' => :'Integer',
@@ -114,6 +114,10 @@ module DigitalFemsa
         self.tax_id = attributes[:'tax_id']
       end
 
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
       if attributes.key?(:'email')
         self.email = attributes[:'email']
       end
@@ -128,10 +132,6 @@ module DigitalFemsa
         end
       end
 
-      if attributes.key?(:'company_name')
-        self.company_name = attributes[:'company_name']
-      end
-
       if attributes.key?(:'id')
         self.id = attributes[:'id']
       else
@@ -201,10 +201,10 @@ module DigitalFemsa
       self.class == o.class &&
           address == o.address &&
           tax_id == o.tax_id &&
+          name == o.name &&
           email == o.email &&
           phone == o.phone &&
           metadata == o.metadata &&
-          company_name == o.company_name &&
           id == o.id &&
           object == o.object &&
           created_at == o.created_at &&
@@ -221,7 +221,7 @@ module DigitalFemsa
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [address, tax_id, email, phone, metadata, company_name, id, object, created_at, parent_id, default].hash
+      [address, tax_id, name, email, phone, metadata, id, object, created_at, parent_id, default].hash
     end
 
     # Builds the object from hash