digital_femsa 1.0.0 → 1.1.0

data/lib/digital_femsa/models/order_update_request.rb

@@ -14,52 +14,62 @@ require 'date'
 require 'time'
 
 module DigitalFemsa
-  # a order
+  # Order update payload. Only supported fields can be modified.
   class OrderUpdateRequest
-    attr_accessor :charges
-
-    attr_accessor :checkout
-
-    # Currency with which the payment will be made. It uses the 3-letter code of the [International Standard ISO 4217.](https://es.wikipedia.org/wiki/ISO_4217)
+    # Currency code in ISO 4217 (3-letter uppercase).
     attr_accessor :currency
 
     attr_accessor :customer_info
 
-    # List of [discounts](https://developers.femsa.com/v2.1.0/reference/orderscreatediscountline) that are applied to the order. You must have at least one discount.
-    attr_accessor :discount_lines
-
-    attr_accessor :fiscal_entity
-
     # List of [products](https://developers.femsa.com/v2.1.0/reference/orderscreateproduct) that are sold in the order. You must have at least one product.
     attr_accessor :line_items
 
-    attr_accessor :metadata
+    attr_accessor :charges
+
+    # List of [discounts](https://developers.femsa.com/v2.1.0/reference/orderscreatediscountline) that are applied to the order. You must have at least one discount.
+    attr_accessor :discount_lines
 
-    # Indicates whether the order charges must be preauthorized
-    attr_accessor :pre_authorize
+    attr_accessor :tax_lines
+
+    # Existing shipping contact id from the customer to link to this order.
+    attr_accessor :shipping_contact_id
 
     attr_accessor :shipping_contact
 
     # List of [shipping costs](https://developers.femsa.com/v2.1.0/reference/orderscreateshipping). If the online store offers digital products.
     attr_accessor :shipping_lines
 
-    attr_accessor :tax_lines
+    # Existing fiscal entity id from the customer to link to this order.
+    attr_accessor :fiscal_entity_id
+
+    attr_accessor :fiscal_entity
+
+    # URL where the customer should be redirected after completing a payment flow (if applicable).
+    attr_accessor :return_url
+
+    # Arbitrary key-value data that you can attach to the order for your internal use. It is not used for payment processing. Keys should be strings; values can be any JSON value. 
+    attr_accessor :metadata
+
+    # Order status update (only allowed transitions will be accepted).
+    attr_accessor :status
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'charges' => :'charges',
-        :'checkout' => :'checkout',
         :'currency' => :'currency',
         :'customer_info' => :'customer_info',
-        :'discount_lines' => :'discount_lines',
-        :'fiscal_entity' => :'fiscal_entity',
         :'line_items' => :'line_items',
-        :'metadata' => :'metadata',
-        :'pre_authorize' => :'pre_authorize',
+        :'charges' => :'charges',
+        :'discount_lines' => :'discount_lines',
+        :'tax_lines' => :'tax_lines',
+        :'shipping_contact_id' => :'shipping_contact_id',
         :'shipping_contact' => :'shipping_contact',
         :'shipping_lines' => :'shipping_lines',
-        :'tax_lines' => :'tax_lines'
+        :'fiscal_entity_id' => :'fiscal_entity_id',
+        :'fiscal_entity' => :'fiscal_entity',
+        :'return_url' => :'return_url',
+        :'metadata' => :'metadata',
+        :'status' => :'status'
       }
     end
 
@@ -71,24 +81,28 @@ module DigitalFemsa
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'charges' => :'Array<ChargeRequest>',
-        :'checkout' => :'CheckoutRequest',
         :'currency' => :'String',
         :'customer_info' => :'OrderUpdateRequestCustomerInfo',
-        :'discount_lines' => :'Array<OrderDiscountLinesRequest>',
-        :'fiscal_entity' => :'OrderUpdateFiscalEntityRequest',
         :'line_items' => :'Array<Product>',
-        :'metadata' => :'Hash<String, String>',
-        :'pre_authorize' => :'Boolean',
+        :'charges' => :'Array<ChargeRequest>',
+        :'discount_lines' => :'Array<OrderDiscountLinesRequest>',
+        :'tax_lines' => :'Array<OrderTaxRequest>',
+        :'shipping_contact_id' => :'String',
         :'shipping_contact' => :'CustomerShippingContacts',
         :'shipping_lines' => :'Array<ShippingRequest>',
-        :'tax_lines' => :'Array<OrderTaxRequest>'
+        :'fiscal_entity_id' => :'String',
+        :'fiscal_entity' => :'OrderUpdateFiscalEntityRequest',
+        :'return_url' => :'String',
+        :'metadata' => :'Hash<String, Object>',
+        :'status' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'shipping_contact_id',
+        :'fiscal_entity_id',
       ])
     end
 
@@ -107,16 +121,6 @@ module DigitalFemsa
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'charges')
-        if (value = attributes[:'charges']).is_a?(Array)
-          self.charges = value
-        end
-      end
-
-      if attributes.key?(:'checkout')
-        self.checkout = attributes[:'checkout']
-      end
-
       if attributes.key?(:'currency')
         self.currency = attributes[:'currency']
       end
@@ -125,32 +129,32 @@ module DigitalFemsa
         self.customer_info = attributes[:'customer_info']
       end
 
-      if attributes.key?(:'discount_lines')
-        if (value = attributes[:'discount_lines']).is_a?(Array)
-          self.discount_lines = value
+      if attributes.key?(:'line_items')
+        if (value = attributes[:'line_items']).is_a?(Array)
+          self.line_items = value
         end
       end
 
-      if attributes.key?(:'fiscal_entity')
-        self.fiscal_entity = attributes[:'fiscal_entity']
+      if attributes.key?(:'charges')
+        if (value = attributes[:'charges']).is_a?(Array)
+          self.charges = value
+        end
       end
 
-      if attributes.key?(:'line_items')
-        if (value = attributes[:'line_items']).is_a?(Array)
-          self.line_items = value
+      if attributes.key?(:'discount_lines')
+        if (value = attributes[:'discount_lines']).is_a?(Array)
+          self.discount_lines = value
         end
       end
 
-      if attributes.key?(:'metadata')
-        if (value = attributes[:'metadata']).is_a?(Hash)
-          self.metadata = value
+      if attributes.key?(:'tax_lines')
+        if (value = attributes[:'tax_lines']).is_a?(Array)
+          self.tax_lines = value
         end
       end
 
-      if attributes.key?(:'pre_authorize')
-        self.pre_authorize = attributes[:'pre_authorize']
-      else
-        self.pre_authorize = false
+      if attributes.key?(:'shipping_contact_id')
+        self.shipping_contact_id = attributes[:'shipping_contact_id']
       end
 
       if attributes.key?(:'shipping_contact')
@@ -163,11 +167,27 @@ module DigitalFemsa
         end
       end
 
-      if attributes.key?(:'tax_lines')
-        if (value = attributes[:'tax_lines']).is_a?(Array)
-          self.tax_lines = value
+      if attributes.key?(:'fiscal_entity_id')
+        self.fiscal_entity_id = attributes[:'fiscal_entity_id']
+      end
+
+      if attributes.key?(:'fiscal_entity')
+        self.fiscal_entity = attributes[:'fiscal_entity']
+      end
+
+      if attributes.key?(:'return_url')
+        self.return_url = attributes[:'return_url']
+      end
+
+      if attributes.key?(:'metadata')
+        if (value = attributes[:'metadata']).is_a?(Hash)
+          self.metadata = value
         end
       end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -179,6 +199,10 @@ module DigitalFemsa
         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
+
       invalid_properties
     end
 
@@ -187,6 +211,7 @@ module DigitalFemsa
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if !@currency.nil? && @currency.to_s.length > 3
+      return false if !@metadata.nil? && @metadata.length > 100
       true
     end
 
@@ -204,23 +229,39 @@ module DigitalFemsa
       @currency = currency
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] metadata Value to be assigned
+    def metadata=(metadata)
+      if metadata.nil?
+        fail ArgumentError, 'metadata cannot be nil'
+      end
+
+      if metadata.length > 100
+        fail ArgumentError, 'invalid value for "metadata", number of items must be less than or equal to 100.'
+      end
+
+      @metadata = metadata
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          charges == o.charges &&
-          checkout == o.checkout &&
           currency == o.currency &&
           customer_info == o.customer_info &&
-          discount_lines == o.discount_lines &&
-          fiscal_entity == o.fiscal_entity &&
           line_items == o.line_items &&
-          metadata == o.metadata &&
-          pre_authorize == o.pre_authorize &&
+          charges == o.charges &&
+          discount_lines == o.discount_lines &&
+          tax_lines == o.tax_lines &&
+          shipping_contact_id == o.shipping_contact_id &&
           shipping_contact == o.shipping_contact &&
           shipping_lines == o.shipping_lines &&
-          tax_lines == o.tax_lines
+          fiscal_entity_id == o.fiscal_entity_id &&
+          fiscal_entity == o.fiscal_entity &&
+          return_url == o.return_url &&
+          metadata == o.metadata &&
+          status == o.status
     end
 
     # @see the `==` method
@@ -232,7 +273,7 @@ module DigitalFemsa
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [charges, checkout, currency, customer_info, discount_lines, fiscal_entity, line_items, metadata, pre_authorize, shipping_contact, shipping_lines, tax_lines].hash
+      [currency, customer_info, line_items, charges, discount_lines, tax_lines, shipping_contact_id, shipping_contact, shipping_lines, fiscal_entity_id, fiscal_entity, return_url, metadata, status].hash
     end
 
     # Builds the object from hash

data/lib/digital_femsa/models/payment_method_cash.rb

@@ -61,7 +61,7 @@ module DigitalFemsa
       {
         :'type' => :'String',
         :'object' => :'String',
-        :'auth_code' => :'Integer',
+        :'auth_code' => :'String',
         :'cashier_id' => :'String',
         :'reference' => :'String',
         :'barcode_url' => :'String',

data/lib/digital_femsa/models/payment_method_cash_request.rb

@@ -15,9 +15,10 @@ require 'time'
 
 module DigitalFemsa
   class PaymentMethodCashRequest
-    # Type of payment method
+    # Type of payment method.
     attr_accessor :type
 
+    # Expiration date as unix timestamp (seconds).
     attr_accessor :expires_at
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/digital_femsa/models/product.rb

@@ -15,44 +15,41 @@ require 'time'
 
 module DigitalFemsa
   class Product
-    attr_accessor :antifraud_info
-
-    # The brand of the item.
-    attr_accessor :brand
-
-    # Short description of the item
-    attr_accessor :description
-
-    # It is a key/value hash that can hold custom fields. Maximum 100 elements and allows special characters.
-    attr_accessor :metadata
-
     # The name of the item. It will be displayed in the order.
     attr_accessor :name
 
+    # The price of the item in cents.
+    attr_accessor :unit_price
+
     # The quantity of the item in the order.
     attr_accessor :quantity
 
     # The stock keeping unit for the item. It is used to identify the item in the order.
     attr_accessor :sku
 
+    # The brand of the item.
+    attr_accessor :brand
+
+    # Short description of the item
+    attr_accessor :description
+
     # List of tags for the item. It is used to identify the item in the order.
     attr_accessor :tags
 
-    # The price of the item in cents.
-    attr_accessor :unit_price
+    # Arbitrary key-value data for your internal use. Keys should be strings; values can be any JSON value. 
+    attr_accessor :metadata
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'antifraud_info' => :'antifraud_info',
-        :'brand' => :'brand',
-        :'description' => :'description',
-        :'metadata' => :'metadata',
         :'name' => :'name',
+        :'unit_price' => :'unit_price',
         :'quantity' => :'quantity',
         :'sku' => :'sku',
+        :'brand' => :'brand',
+        :'description' => :'description',
         :'tags' => :'tags',
-        :'unit_price' => :'unit_price'
+        :'metadata' => :'metadata'
       }
     end
 
@@ -64,15 +61,14 @@ module DigitalFemsa
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'antifraud_info' => :'Hash<String, Object>',
-        :'brand' => :'String',
-        :'description' => :'String',
-        :'metadata' => :'Hash<String, String>',
         :'name' => :'String',
+        :'unit_price' => :'Integer',
         :'quantity' => :'Integer',
         :'sku' => :'String',
+        :'brand' => :'String',
+        :'description' => :'String',
         :'tags' => :'Array<String>',
-        :'unit_price' => :'Integer'
+        :'metadata' => :'Hash<String, Object>'
       }
     end
 
@@ -97,32 +93,18 @@ module DigitalFemsa
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'antifraud_info')
-        if (value = attributes[:'antifraud_info']).is_a?(Hash)
-          self.antifraud_info = value
-        end
-      end
-
-      if attributes.key?(:'brand')
-        self.brand = attributes[:'brand']
-      end
-
-      if attributes.key?(:'description')
-        self.description = attributes[:'description']
-      end
-
-      if attributes.key?(:'metadata')
-        if (value = attributes[:'metadata']).is_a?(Hash)
-          self.metadata = value
-        end
-      end
-
       if attributes.key?(:'name')
         self.name = attributes[:'name']
       else
         self.name = nil
       end
 
+      if attributes.key?(:'unit_price')
+        self.unit_price = attributes[:'unit_price']
+      else
+        self.unit_price = nil
+      end
+
       if attributes.key?(:'quantity')
         self.quantity = attributes[:'quantity']
       else
@@ -133,16 +115,24 @@ module DigitalFemsa
         self.sku = attributes[:'sku']
       end
 
+      if attributes.key?(:'brand')
+        self.brand = attributes[:'brand']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
       if attributes.key?(:'tags')
         if (value = attributes[:'tags']).is_a?(Array)
           self.tags = value
         end
       end
 
-      if attributes.key?(:'unit_price')
-        self.unit_price = attributes[:'unit_price']
-      else
-        self.unit_price = nil
+      if attributes.key?(:'metadata')
+        if (value = attributes[:'metadata']).is_a?(Hash)
+          self.metadata = value
+        end
       end
     end
 
@@ -151,16 +141,16 @@ module DigitalFemsa
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if !@description.nil? && @description.to_s.length > 250
-        invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 250.')
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
       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.')
+      if @unit_price.nil?
+        invalid_properties.push('invalid value for "unit_price", unit_price cannot be nil.')
       end
 
-      if @name.nil?
-        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      if @unit_price < 0
+        invalid_properties.push('invalid value for "unit_price", must be greater than or equal to 0.')
       end
 
       if @quantity.nil?
@@ -171,12 +161,16 @@ module DigitalFemsa
         invalid_properties.push('invalid value for "quantity", must be greater than or equal to 1.')
       end
 
-      if @unit_price.nil?
-        invalid_properties.push('invalid value for "unit_price", unit_price cannot be nil.')
+      if !@description.nil? && @description.to_s.length > 250
+        invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 250.')
       end
 
-      if @unit_price < 0
-        invalid_properties.push('invalid value for "unit_price", must be greater than or equal to 0.')
+      if !@tags.nil? && @tags.length < 1
+        invalid_properties.push('invalid value for "tags", number of items must be greater than or equal to 1.')
+      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
 
       invalid_properties
@@ -186,42 +180,29 @@ module DigitalFemsa
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if !@description.nil? && @description.to_s.length > 250
-      return false if !@metadata.nil? && @metadata.length > 100
       return false if @name.nil?
-      return false if @quantity.nil?
-      return false if @quantity < 1
       return false if @unit_price.nil?
       return false if @unit_price < 0
+      return false if @quantity.nil?
+      return false if @quantity < 1
+      return false if !@description.nil? && @description.to_s.length > 250
+      return false if !@tags.nil? && @tags.length < 1
+      return false if !@metadata.nil? && @metadata.length > 100
       true
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] description Value to be assigned
-    def description=(description)
-      if description.nil?
-        fail ArgumentError, 'description cannot be nil'
-      end
-
-      if description.to_s.length > 250
-        fail ArgumentError, 'invalid value for "description", the character length must be smaller than or equal to 250.'
-      end
-
-      @description = description
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] metadata Value to be assigned
-    def metadata=(metadata)
-      if metadata.nil?
-        fail ArgumentError, 'metadata cannot be nil'
+    # @param [Object] unit_price Value to be assigned
+    def unit_price=(unit_price)
+      if unit_price.nil?
+        fail ArgumentError, 'unit_price cannot be nil'
       end
 
-      if metadata.length > 100
-        fail ArgumentError, 'invalid value for "metadata", number of items must be less than or equal to 100.'
+      if unit_price < 0
+        fail ArgumentError, 'invalid value for "unit_price", must be greater than or equal to 0.'
       end
 
-      @metadata = metadata
+      @unit_price = unit_price
     end
 
     # Custom attribute writer method with validation
@@ -239,17 +220,45 @@ module DigitalFemsa
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] unit_price Value to be assigned
-    def unit_price=(unit_price)
-      if unit_price.nil?
-        fail ArgumentError, 'unit_price cannot be nil'
+    # @param [Object] description Value to be assigned
+    def description=(description)
+      if description.nil?
+        fail ArgumentError, 'description cannot be nil'
       end
 
-      if unit_price < 0
-        fail ArgumentError, 'invalid value for "unit_price", must be greater than or equal to 0.'
+      if description.to_s.length > 250
+        fail ArgumentError, 'invalid value for "description", the character length must be smaller than or equal to 250.'
       end
 
-      @unit_price = unit_price
+      @description = description
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] tags Value to be assigned
+    def tags=(tags)
+      if tags.nil?
+        fail ArgumentError, 'tags cannot be nil'
+      end
+
+      if tags.length < 1
+        fail ArgumentError, 'invalid value for "tags", number of items must be greater than or equal to 1.'
+      end
+
+      @tags = tags
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] metadata Value to be assigned
+    def metadata=(metadata)
+      if metadata.nil?
+        fail ArgumentError, 'metadata cannot be nil'
+      end
+
+      if metadata.length > 100
+        fail ArgumentError, 'invalid value for "metadata", number of items must be less than or equal to 100.'
+      end
+
+      @metadata = metadata
     end
 
     # Checks equality by comparing each attribute.
@@ -257,15 +266,14 @@ module DigitalFemsa
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          antifraud_info == o.antifraud_info &&
-          brand == o.brand &&
-          description == o.description &&
-          metadata == o.metadata &&
           name == o.name &&
+          unit_price == o.unit_price &&
           quantity == o.quantity &&
           sku == o.sku &&
+          brand == o.brand &&
+          description == o.description &&
           tags == o.tags &&
-          unit_price == o.unit_price
+          metadata == o.metadata
     end
 
     # @see the `==` method
@@ -277,7 +285,7 @@ module DigitalFemsa
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [antifraud_info, brand, description, metadata, name, quantity, sku, tags, unit_price].hash
+      [name, unit_price, quantity, sku, brand, description, tags, metadata].hash
     end
 
     # Builds the object from hash