digital_femsa 1.0.0 → 1.1.0

data/lib/digital_femsa/models/order_response.rb

@@ -14,84 +14,105 @@ require 'date'
 require 'time'
 
 module DigitalFemsa
-  # order response
+  # Order model. Some nested resources are returned as list previews (for example: `charges`, `line_items`), and may be `null` depending on the request/context. The `checkout` field is only present when the order is linked to a checkout (`channel.checkout_request_id`). 
   class OrderResponse
-    # The total amount to be collected in cents
+    attr_accessor :id
+
+    attr_accessor :object
+
+    attr_accessor :livemode
+
     attr_accessor :amount
 
-    # The total amount refunded in cents
+    attr_accessor :currency
+
+    # Current payment status of the order. It can be `null` for orders without payment information yet.
+    attr_accessor :payment_status
+
     attr_accessor :amount_refunded
 
-    attr_accessor :channel
+    # Indicates whether the order uses split payments (when available/configured).
+    attr_accessor :split_payment
 
-    attr_accessor :charges
+    # Metadata attached to the order.
+    attr_accessor :metadata
 
-    attr_accessor :checkout
+    # Indicates whether the order is currently refundable.
+    attr_accessor :is_refundable
 
-    # The time at which the object was created in seconds since the Unix epoch
     attr_accessor :created_at
 
-    # The three-letter ISO 4217 currency code. The currency of the order.
-    attr_accessor :currency
+    attr_accessor :updated_at
 
     attr_accessor :customer_info
 
-    attr_accessor :discount_lines
+    attr_accessor :shipping_contact
 
-    attr_accessor :fiscal_entity
+    attr_accessor :channel
 
-    attr_accessor :id
+    attr_accessor :fiscal_entity
 
-    attr_accessor :is_refundable
+    attr_accessor :checkout
 
     attr_accessor :line_items
 
-    # Whether the object exists in live mode or test mode
-    attr_accessor :livemode
-
-    # Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
-    attr_accessor :metadata
-
-    attr_accessor :next_action
-
-    # String representing the object’s type. Objects of the same type share the same value.
-    attr_accessor :object
-
-    # The payment status of the order.
-    attr_accessor :payment_status
+    attr_accessor :discount_lines
 
-    # Indicates the processing mode for the order, either ecommerce, recurrent or validation.
-    attr_accessor :processing_mode
+    attr_accessor :charges
 
-    attr_accessor :shipping_contact
+    # Partial reference information (when applicable). Structure may vary depending on the payment flow.
+    attr_accessor :partial_reference
+
+    # Additional payment information (when available). Structure may vary.
+    attr_accessor :payments_info
+
+    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
 
-    # The time at which the object was last updated in seconds since the Unix epoch
-    attr_accessor :updated_at
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'id' => :'id',
+        :'object' => :'object',
+        :'livemode' => :'livemode',
         :'amount' => :'amount',
+        :'currency' => :'currency',
+        :'payment_status' => :'payment_status',
         :'amount_refunded' => :'amount_refunded',
-        :'channel' => :'channel',
-        :'charges' => :'charges',
-        :'checkout' => :'checkout',
+        :'split_payment' => :'split_payment',
+        :'metadata' => :'metadata',
+        :'is_refundable' => :'is_refundable',
         :'created_at' => :'created_at',
-        :'currency' => :'currency',
+        :'updated_at' => :'updated_at',
         :'customer_info' => :'customer_info',
-        :'discount_lines' => :'discount_lines',
+        :'shipping_contact' => :'shipping_contact',
+        :'channel' => :'channel',
         :'fiscal_entity' => :'fiscal_entity',
-        :'id' => :'id',
-        :'is_refundable' => :'is_refundable',
+        :'checkout' => :'checkout',
         :'line_items' => :'line_items',
-        :'livemode' => :'livemode',
-        :'metadata' => :'metadata',
-        :'next_action' => :'next_action',
-        :'object' => :'object',
-        :'payment_status' => :'payment_status',
-        :'processing_mode' => :'processing_mode',
-        :'shipping_contact' => :'shipping_contact',
-        :'updated_at' => :'updated_at'
+        :'discount_lines' => :'discount_lines',
+        :'charges' => :'charges',
+        :'partial_reference' => :'partial_reference',
+        :'payments_info' => :'payments_info'
       }
     end
 
@@ -103,34 +124,41 @@ module DigitalFemsa
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'id' => :'String',
+        :'object' => :'String',
+        :'livemode' => :'Boolean',
         :'amount' => :'Integer',
+        :'currency' => :'String',
+        :'payment_status' => :'String',
         :'amount_refunded' => :'Integer',
-        :'channel' => :'ChargeResponseChannel',
-        :'charges' => :'OrderResponseCharges',
-        :'checkout' => :'OrderResponseCheckout',
+        :'split_payment' => :'Boolean',
+        :'metadata' => :'Hash<String, Object>',
+        :'is_refundable' => :'Boolean',
         :'created_at' => :'Integer',
-        :'currency' => :'String',
+        :'updated_at' => :'Integer',
         :'customer_info' => :'OrderResponseCustomerInfo',
-        :'discount_lines' => :'OrderResponseDiscountLines',
+        :'shipping_contact' => :'OrderResponseShippingContact',
+        :'channel' => :'OrderResponseChannel',
         :'fiscal_entity' => :'OrderFiscalEntityResponse',
-        :'id' => :'String',
-        :'is_refundable' => :'Boolean',
+        :'checkout' => :'OrderResponseCheckout',
         :'line_items' => :'OrderResponseProducts',
-        :'livemode' => :'Boolean',
-        :'metadata' => :'Hash<String, Object>',
-        :'next_action' => :'OrderNextActionResponse',
-        :'object' => :'String',
-        :'payment_status' => :'String',
-        :'processing_mode' => :'String',
-        :'shipping_contact' => :'OrderResponseShippingContact',
-        :'updated_at' => :'Integer'
+        :'discount_lines' => :'OrderResponseDiscountLines',
+        :'charges' => :'OrderResponseCharges',
+        :'partial_reference' => :'Hash<String, Object>',
+        :'payments_info' => :'Hash<String, Object>'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'payment_status',
+        :'split_payment',
+        :'shipping_contact',
+        :'channel',
         :'fiscal_entity',
+        :'partial_reference',
+        :'payments_info'
       ])
     end
 
@@ -149,90 +177,98 @@ module DigitalFemsa
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'object')
+        self.object = attributes[:'object']
+      end
+
+      if attributes.key?(:'livemode')
+        self.livemode = attributes[:'livemode']
+      end
+
       if attributes.key?(:'amount')
         self.amount = attributes[:'amount']
       end
 
+      if attributes.key?(:'currency')
+        self.currency = attributes[:'currency']
+      end
+
+      if attributes.key?(:'payment_status')
+        self.payment_status = attributes[:'payment_status']
+      end
+
       if attributes.key?(:'amount_refunded')
         self.amount_refunded = attributes[:'amount_refunded']
       end
 
-      if attributes.key?(:'channel')
-        self.channel = attributes[:'channel']
+      if attributes.key?(:'split_payment')
+        self.split_payment = attributes[:'split_payment']
       end
 
-      if attributes.key?(:'charges')
-        self.charges = attributes[:'charges']
+      if attributes.key?(:'metadata')
+        if (value = attributes[:'metadata']).is_a?(Hash)
+          self.metadata = value
+        end
       end
 
-      if attributes.key?(:'checkout')
-        self.checkout = attributes[:'checkout']
+      if attributes.key?(:'is_refundable')
+        self.is_refundable = attributes[:'is_refundable']
       end
 
       if attributes.key?(:'created_at')
         self.created_at = attributes[:'created_at']
       end
 
-      if attributes.key?(:'currency')
-        self.currency = attributes[:'currency']
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
       end
 
       if attributes.key?(:'customer_info')
         self.customer_info = attributes[:'customer_info']
       end
 
-      if attributes.key?(:'discount_lines')
-        self.discount_lines = attributes[:'discount_lines']
+      if attributes.key?(:'shipping_contact')
+        self.shipping_contact = attributes[:'shipping_contact']
       end
 
-      if attributes.key?(:'fiscal_entity')
-        self.fiscal_entity = attributes[:'fiscal_entity']
+      if attributes.key?(:'channel')
+        self.channel = attributes[:'channel']
       end
 
-      if attributes.key?(:'id')
-        self.id = attributes[:'id']
+      if attributes.key?(:'fiscal_entity')
+        self.fiscal_entity = attributes[:'fiscal_entity']
       end
 
-      if attributes.key?(:'is_refundable')
-        self.is_refundable = attributes[:'is_refundable']
+      if attributes.key?(:'checkout')
+        self.checkout = attributes[:'checkout']
       end
 
       if attributes.key?(:'line_items')
         self.line_items = attributes[:'line_items']
       end
 
-      if attributes.key?(:'livemode')
-        self.livemode = attributes[:'livemode']
-      end
-
-      if attributes.key?(:'metadata')
-        if (value = attributes[:'metadata']).is_a?(Hash)
-          self.metadata = value
-        end
-      end
-
-      if attributes.key?(:'next_action')
-        self.next_action = attributes[:'next_action']
-      end
-
-      if attributes.key?(:'object')
-        self.object = attributes[:'object']
-      end
-
-      if attributes.key?(:'payment_status')
-        self.payment_status = attributes[:'payment_status']
+      if attributes.key?(:'discount_lines')
+        self.discount_lines = attributes[:'discount_lines']
       end
 
-      if attributes.key?(:'processing_mode')
-        self.processing_mode = attributes[:'processing_mode']
+      if attributes.key?(:'charges')
+        self.charges = attributes[:'charges']
       end
 
-      if attributes.key?(:'shipping_contact')
-        self.shipping_contact = attributes[:'shipping_contact']
+      if attributes.key?(:'partial_reference')
+        if (value = attributes[:'partial_reference']).is_a?(Hash)
+          self.partial_reference = value
+        end
       end
 
-      if attributes.key?(:'updated_at')
-        self.updated_at = attributes[:'updated_at']
+      if attributes.key?(:'payments_info')
+        if (value = attributes[:'payments_info']).is_a?(Hash)
+          self.payments_info = value
+        end
       end
     end
 
@@ -241,6 +277,10 @@ module DigitalFemsa
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
+      if !@currency.nil? && @currency.to_s.length > 3
+        invalid_properties.push('invalid value for "currency", the character length must be smaller than or equal to 3.')
+      end
+
       if !@metadata.nil? && @metadata.length > 100
         invalid_properties.push('invalid value for "metadata", number of items must be less than or equal to 100.')
       end
@@ -252,10 +292,37 @@ module DigitalFemsa
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
+      object_validator = EnumAttributeValidator.new('String', ["order"])
+      return false unless object_validator.valid?(@object)
+      return false if !@currency.nil? && @currency.to_s.length > 3
       return false if !@metadata.nil? && @metadata.length > 100
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] object Object to be assigned
+    def object=(object)
+      validator = EnumAttributeValidator.new('String', ["order"])
+      unless validator.valid?(object)
+        fail ArgumentError, "invalid value for \"object\", must be one of #{validator.allowable_values}."
+      end
+      @object = object
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] currency Value to be assigned
+    def currency=(currency)
+      if currency.nil?
+        fail ArgumentError, 'currency cannot be nil'
+      end
+
+      if currency.to_s.length > 3
+        fail ArgumentError, 'invalid value for "currency", the character length must be smaller than or equal to 3.'
+      end
+
+      @currency = currency
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] metadata Value to be assigned
     def metadata=(metadata)
@@ -275,27 +342,28 @@ module DigitalFemsa
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          id == o.id &&
+          object == o.object &&
+          livemode == o.livemode &&
           amount == o.amount &&
+          currency == o.currency &&
+          payment_status == o.payment_status &&
           amount_refunded == o.amount_refunded &&
-          channel == o.channel &&
-          charges == o.charges &&
-          checkout == o.checkout &&
+          split_payment == o.split_payment &&
+          metadata == o.metadata &&
+          is_refundable == o.is_refundable &&
           created_at == o.created_at &&
-          currency == o.currency &&
+          updated_at == o.updated_at &&
           customer_info == o.customer_info &&
-          discount_lines == o.discount_lines &&
+          shipping_contact == o.shipping_contact &&
+          channel == o.channel &&
           fiscal_entity == o.fiscal_entity &&
-          id == o.id &&
-          is_refundable == o.is_refundable &&
+          checkout == o.checkout &&
           line_items == o.line_items &&
-          livemode == o.livemode &&
-          metadata == o.metadata &&
-          next_action == o.next_action &&
-          object == o.object &&
-          payment_status == o.payment_status &&
-          processing_mode == o.processing_mode &&
-          shipping_contact == o.shipping_contact &&
-          updated_at == o.updated_at
+          discount_lines == o.discount_lines &&
+          charges == o.charges &&
+          partial_reference == o.partial_reference &&
+          payments_info == o.payments_info
     end
 
     # @see the `==` method
@@ -307,7 +375,7 @@ module DigitalFemsa
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [amount, amount_refunded, channel, charges, checkout, created_at, currency, customer_info, discount_lines, fiscal_entity, id, is_refundable, line_items, livemode, metadata, next_action, object, payment_status, processing_mode, shipping_contact, updated_at].hash
+      [id, object, livemode, amount, currency, payment_status, amount_refunded, split_payment, metadata, is_refundable, created_at, updated_at, customer_info, shipping_contact, channel, fiscal_entity, checkout, line_items, discount_lines, charges, partial_reference, payments_info].hash
     end
 
     # Builds the object from hash

data/lib/digital_femsa/models/{order_next_action_response_redirect_to_url.rb → order_response_channel.rb}

@@ -14,19 +14,23 @@ require 'date'
 require 'time'
 
 module DigitalFemsa
-  # contains the following attributes that will guide to continue the flow
-  class OrderNextActionResponseRedirectToUrl
-    # pay.femsa.com/{id} Indicates the url of the Femsa component to authenticate the flow through 3DS2.
-    attr_accessor :url
+  # Channel information for the order (for example Checkout-related metadata). It may be `null`.
+  class OrderResponseChannel
+    attr_accessor :segment
 
-    # Indicates the url to which the 3DS2 flow returns at the end, when the integration is redirected.
-    attr_accessor :return_url
+    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
       {
-        :'url' => :'url',
-        :'return_url' => :'return_url'
+        :'segment' => :'segment',
+        :'checkout_request_id' => :'checkout_request_id',
+        :'checkout_request_type' => :'checkout_request_type',
+        :'id' => :'id'
       }
     end
 
@@ -38,8 +42,10 @@ module DigitalFemsa
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'url' => :'String',
-        :'return_url' => :'String'
+        :'segment' => :'String',
+        :'checkout_request_id' => :'String',
+        :'checkout_request_type' => :'String',
+        :'id' => :'String'
       }
     end
 
@@ -53,23 +59,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::OrderNextActionResponseRedirectToUrl` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DigitalFemsa::OrderResponseChannel` 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::OrderNextActionResponseRedirectToUrl`. 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::OrderResponseChannel`. 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?(:'url')
-        self.url = attributes[:'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?(:'return_url')
-        self.return_url = attributes[:'return_url']
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
       end
     end
 
@@ -93,8 +107,10 @@ module DigitalFemsa
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          url == o.url &&
-          return_url == o.return_url
+          segment == o.segment &&
+          checkout_request_id == o.checkout_request_id &&
+          checkout_request_type == o.checkout_request_type &&
+          id == o.id
     end
 
     # @see the `==` method
@@ -106,7 +122,7 @@ module DigitalFemsa
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [url, return_url].hash
+      [segment, checkout_request_id, checkout_request_type, id].hash
     end
 
     # Builds the object from hash

data/lib/digital_femsa/models/order_response_charges.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module DigitalFemsa
-  # The charges associated with the order
+  # List preview of charges created for the order. Charges are only created when included in the request or created later through payment flows. This field can be `null` depending on the response context. 
   class OrderResponseCharges
     # Indicates if there are more pages to be requested
     attr_accessor :has_more

data/lib/digital_femsa/models/order_response_checkout.rb

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module DigitalFemsa
+  # Checkout resource linked to the order. Present only when the order is linked to a checkout (`channel.checkout_request_id`).
   class OrderResponseCheckout
     attr_accessor :allowed_payment_methods
 

data/lib/digital_femsa/models/order_response_customer_info.rb

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module DigitalFemsa
+  # Customer information associated with the order.
   class OrderResponseCustomerInfo
     # Custom reference
     attr_accessor :customer_custom_reference

data/lib/digital_femsa/models/order_response_shipping_contact.rb

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module DigitalFemsa
+  # Shipping contact associated with the order. It may be `null` when not provided/required.
   class OrderResponseShippingContact
     attr_accessor :phone
 
@@ -23,6 +24,7 @@ module DigitalFemsa
 
     attr_accessor :address
 
+    # Customer ID that owns this shipping contact.
     attr_accessor :parent_id
 
     attr_accessor :default
@@ -36,6 +38,7 @@ module DigitalFemsa
 
     attr_accessor :object
 
+    # Present only when the shipping contact was deleted.
     attr_accessor :deleted
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/digital_femsa/models/order_update_fiscal_entity_request.rb

@@ -24,7 +24,7 @@ module DigitalFemsa
     # Name of the fiscal entity
     attr_accessor :name
 
-    # Metadata associated with the fiscal entity
+    # Arbitrary key-value data associated with the fiscal entity for your internal use. Keys should be strings; values can be any JSON value. 
     attr_accessor :metadata
 
     # Phone of the fiscal entity