digital_femsa 1.0.0 → 1.1.0

data/lib/digital_femsa/models/customer_payment_sources_inner.rb

@@ -0,0 +1,104 @@
+=begin
+#Femsa API
+
+#Femsa sdk
+
+The version of the OpenAPI document: 2.1.0
+Contact: engineering@femsa.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.5.0
+
+=end
+
+require 'date'
+require 'time'
+
+module DigitalFemsa
+  module CustomerPaymentSourcesInner
+    class << self
+      # List of class defined in oneOf (OpenAPI v3)
+      def openapi_one_of
+        [
+          :'PaymentMethodCashRequest'
+        ]
+      end
+
+      # Builds the object
+      # @param [Mixed] Data to be matched against the list of oneOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+        # Go through the list of oneOf items and attempt to identify the appropriate one.
+        # Note:
+        # - We do not attempt to check whether exactly one item matches.
+        # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
+        #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
+        # - TODO: scalar values are de facto behaving as if they were nullable.
+        # - TODO: logging when debugging is set.
+        openapi_one_of.each do |klass|
+          begin
+            next if klass == :AnyType # "nullable: true"
+            typed_data = find_and_cast_into_type(klass, data)
+            return typed_data if typed_data
+          rescue # rescue all errors so we keep iterating even if the current item lookup raises
+          end
+        end
+
+        openapi_one_of.include?(:AnyType) ? data : nil
+      end
+
+      private
+
+      SchemaMismatchError = Class.new(StandardError)
+
+      # Note: 'File' is missing here because in the regular case we get the data _after_ a call to JSON.parse.
+      def find_and_cast_into_type(klass, data)
+        return if data.nil?
+
+        case klass.to_s
+        when 'Boolean'
+          return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass)
+        when 'Float'
+          return data if data.instance_of?(Float)
+        when 'Integer'
+          return data if data.instance_of?(Integer)
+        when 'Time'
+          return Time.parse(data)
+        when 'Date'
+          return Date.parse(data)
+        when 'String'
+          return data if data.instance_of?(String)
+        when 'Object' # "type: object"
+          return data if data.instance_of?(Hash)
+        when /\AArray<(?<sub_type>.+)>\z/ # "type: array"
+          if data.instance_of?(Array)
+            sub_type = Regexp.last_match[:sub_type]
+            return data.map { |item| find_and_cast_into_type(sub_type, item) }
+          end
+        when /\AHash<String, (?<sub_type>.+)>\z/ # "type: object" with "additionalProperties: { ... }"
+          if data.instance_of?(Hash) && data.keys.all? { |k| k.instance_of?(Symbol) || k.instance_of?(String) }
+            sub_type = Regexp.last_match[:sub_type]
+            return data.each_with_object({}) { |(k, v), hsh| hsh[k] = find_and_cast_into_type(sub_type, v) }
+          end
+        else # model
+          const = DigitalFemsa.const_get(klass)
+          if const
+            if const.respond_to?(:openapi_one_of) # nested oneOf model
+              model = const.build(data)
+              return model if model
+            else
+              # raise if data contains keys that are not known to the model
+              raise if const.respond_to?(:acceptable_attributes) && !(data.keys - const.acceptable_attributes).empty?
+              model = const.build_from_hash(data)
+              return model if model
+            end
+          end
+        end
+
+        raise # if no match by now, raise
+      rescue
+        raise SchemaMismatchError, "#{data} doesn't match the #{klass} type"
+      end
+    end
+  end
+
+end

data/lib/digital_femsa/models/customer_response.rb

@@ -16,66 +16,83 @@ require 'time'
 module DigitalFemsa
   # customer response
   class CustomerResponse
-    attr_accessor :antifraud_info
+    # Customer's ID
+    attr_accessor :id
 
-    # true if the customer is a company
-    attr_accessor :corporate
+    attr_accessor :object
 
-    # Creation date of the object
+    # Creation date of the object (Unix timestamp)
     attr_accessor :created_at
 
-    # Custom reference
-    attr_accessor :custom_reference
-
-    attr_accessor :default_fiscal_entity_id
-
-    attr_accessor :default_shipping_contact_id
+    # true if the object exists in live mode or false if the object exists in test mode
+    attr_accessor :livemode
 
-    attr_accessor :default_payment_source_id
+    # Customer's name
+    attr_accessor :name
 
     attr_accessor :email
 
-    attr_accessor :fiscal_entities
+    # Customer's phone number
+    attr_accessor :phone
 
-    # Customer's ID
-    attr_accessor :id
+    # true if the customer is a company
+    attr_accessor :corporate
 
-    # true if the object exists in live mode or the value false if the object exists in test mode
-    attr_accessor :livemode
+    # Custom reference
+    attr_accessor :custom_reference
 
-    # Customer's name
-    attr_accessor :name
+    attr_accessor :default_fiscal_entity_id
 
-    attr_accessor :metadata
+    attr_accessor :default_shipping_contact_id
 
-    attr_accessor :object
+    # Customer metadata (maps to contextual_data in backend)
+    attr_accessor :metadata
 
     attr_accessor :payment_sources
 
-    # Customer's phone number
-    attr_accessor :phone
+    attr_accessor :fiscal_entities
 
     attr_accessor :shipping_contacts
 
+    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
       {
-        :'antifraud_info' => :'antifraud_info',
-        :'corporate' => :'corporate',
+        :'id' => :'id',
+        :'object' => :'object',
         :'created_at' => :'created_at',
+        :'livemode' => :'livemode',
+        :'name' => :'name',
+        :'email' => :'email',
+        :'phone' => :'phone',
+        :'corporate' => :'corporate',
         :'custom_reference' => :'custom_reference',
         :'default_fiscal_entity_id' => :'default_fiscal_entity_id',
         :'default_shipping_contact_id' => :'default_shipping_contact_id',
-        :'default_payment_source_id' => :'default_payment_source_id',
-        :'email' => :'email',
-        :'fiscal_entities' => :'fiscal_entities',
-        :'id' => :'id',
-        :'livemode' => :'livemode',
-        :'name' => :'name',
         :'metadata' => :'metadata',
-        :'object' => :'object',
         :'payment_sources' => :'payment_sources',
-        :'phone' => :'phone',
+        :'fiscal_entities' => :'fiscal_entities',
         :'shipping_contacts' => :'shipping_contacts'
       }
     end
@@ -88,22 +105,20 @@ module DigitalFemsa
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'antifraud_info' => :'CustomerAntifraudInfoResponse',
-        :'corporate' => :'Boolean',
+        :'id' => :'String',
+        :'object' => :'String',
         :'created_at' => :'Integer',
+        :'livemode' => :'Boolean',
+        :'name' => :'String',
+        :'email' => :'String',
+        :'phone' => :'String',
+        :'corporate' => :'Boolean',
         :'custom_reference' => :'String',
         :'default_fiscal_entity_id' => :'String',
         :'default_shipping_contact_id' => :'String',
-        :'default_payment_source_id' => :'String',
-        :'email' => :'String',
-        :'fiscal_entities' => :'CustomerFiscalEntitiesResponse',
-        :'id' => :'String',
-        :'livemode' => :'Boolean',
-        :'name' => :'String',
         :'metadata' => :'Hash<String, Object>',
-        :'object' => :'String',
         :'payment_sources' => :'CustomerPaymentMethodsResponse',
-        :'phone' => :'String',
+        :'fiscal_entities' => :'CustomerFiscalEntitiesResponse',
         :'shipping_contacts' => :'CustomerResponseShippingContacts'
       }
     end
@@ -111,9 +126,12 @@ module DigitalFemsa
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'antifraud_info',
+        :'name',
+        :'email',
+        :'phone',
         :'default_fiscal_entity_id',
-        :'default_payment_source_id',
+        :'default_shipping_contact_id',
+        :'metadata',
       ])
     end
 
@@ -132,12 +150,16 @@ module DigitalFemsa
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'antifraud_info')
-        self.antifraud_info = attributes[:'antifraud_info']
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
       end
 
-      if attributes.key?(:'corporate')
-        self.corporate = attributes[:'corporate']
+      if attributes.key?(:'object')
+        self.object = attributes[:'object']
+      else
+        self.object = nil
       end
 
       if attributes.key?(:'created_at')
@@ -146,46 +168,38 @@ module DigitalFemsa
         self.created_at = nil
       end
 
-      if attributes.key?(:'custom_reference')
-        self.custom_reference = attributes[:'custom_reference']
-      end
-
-      if attributes.key?(:'default_fiscal_entity_id')
-        self.default_fiscal_entity_id = attributes[:'default_fiscal_entity_id']
-      end
-
-      if attributes.key?(:'default_shipping_contact_id')
-        self.default_shipping_contact_id = attributes[:'default_shipping_contact_id']
+      if attributes.key?(:'livemode')
+        self.livemode = attributes[:'livemode']
+      else
+        self.livemode = nil
       end
 
-      if attributes.key?(:'default_payment_source_id')
-        self.default_payment_source_id = attributes[:'default_payment_source_id']
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
       end
 
       if attributes.key?(:'email')
         self.email = attributes[:'email']
       end
 
-      if attributes.key?(:'fiscal_entities')
-        self.fiscal_entities = attributes[:'fiscal_entities']
+      if attributes.key?(:'phone')
+        self.phone = attributes[:'phone']
       end
 
-      if attributes.key?(:'id')
-        self.id = attributes[:'id']
-      else
-        self.id = nil
+      if attributes.key?(:'corporate')
+        self.corporate = attributes[:'corporate']
       end
 
-      if attributes.key?(:'livemode')
-        self.livemode = attributes[:'livemode']
-      else
-        self.livemode = nil
+      if attributes.key?(:'custom_reference')
+        self.custom_reference = attributes[:'custom_reference']
       end
 
-      if attributes.key?(:'name')
-        self.name = attributes[:'name']
-      else
-        self.name = nil
+      if attributes.key?(:'default_fiscal_entity_id')
+        self.default_fiscal_entity_id = attributes[:'default_fiscal_entity_id']
+      end
+
+      if attributes.key?(:'default_shipping_contact_id')
+        self.default_shipping_contact_id = attributes[:'default_shipping_contact_id']
       end
 
       if attributes.key?(:'metadata')
@@ -194,18 +208,12 @@ module DigitalFemsa
         end
       end
 
-      if attributes.key?(:'object')
-        self.object = attributes[:'object']
-      else
-        self.object = nil
-      end
-
       if attributes.key?(:'payment_sources')
         self.payment_sources = attributes[:'payment_sources']
       end
 
-      if attributes.key?(:'phone')
-        self.phone = attributes[:'phone']
+      if attributes.key?(:'fiscal_entities')
+        self.fiscal_entities = attributes[:'fiscal_entities']
       end
 
       if attributes.key?(:'shipping_contacts')
@@ -218,30 +226,26 @@ module DigitalFemsa
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @created_at.nil?
-        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
-      end
-
       if @id.nil?
         invalid_properties.push('invalid value for "id", id cannot be nil.')
       end
 
-      if @livemode.nil?
-        invalid_properties.push('invalid value for "livemode", livemode cannot be nil.')
+      if @object.nil?
+        invalid_properties.push('invalid value for "object", object cannot be nil.')
+      end
+
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
       end
 
-      if @name.nil?
-        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      if @livemode.nil?
+        invalid_properties.push('invalid value for "livemode", livemode 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.')
       end
 
-      if @object.nil?
-        invalid_properties.push('invalid value for "object", object cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -249,23 +253,30 @@ module DigitalFemsa
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @created_at.nil?
       return false if @id.nil?
+      return false if @object.nil?
+      object_validator = EnumAttributeValidator.new('String', ["customer"])
+      return false unless object_validator.valid?(@object)
+      return false if @created_at.nil?
       return false if @livemode.nil?
-      return false if @name.nil?
       return false if !@metadata.nil? && @metadata.length > 100
-      return false if @object.nil?
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] object Object to be assigned
+    def object=(object)
+      validator = EnumAttributeValidator.new('String', ["customer"])
+      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] metadata Value to be assigned
     def metadata=(metadata)
-      if metadata.nil?
-        fail ArgumentError, 'metadata cannot be nil'
-      end
-
-      if metadata.length > 100
+      if !metadata.nil? && metadata.length > 100
         fail ArgumentError, 'invalid value for "metadata", number of items must be less than or equal to 100.'
       end
 
@@ -277,22 +288,20 @@ module DigitalFemsa
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          antifraud_info == o.antifraud_info &&
-          corporate == o.corporate &&
+          id == o.id &&
+          object == o.object &&
           created_at == o.created_at &&
+          livemode == o.livemode &&
+          name == o.name &&
+          email == o.email &&
+          phone == o.phone &&
+          corporate == o.corporate &&
           custom_reference == o.custom_reference &&
           default_fiscal_entity_id == o.default_fiscal_entity_id &&
           default_shipping_contact_id == o.default_shipping_contact_id &&
-          default_payment_source_id == o.default_payment_source_id &&
-          email == o.email &&
-          fiscal_entities == o.fiscal_entities &&
-          id == o.id &&
-          livemode == o.livemode &&
-          name == o.name &&
           metadata == o.metadata &&
-          object == o.object &&
           payment_sources == o.payment_sources &&
-          phone == o.phone &&
+          fiscal_entities == o.fiscal_entities &&
           shipping_contacts == o.shipping_contacts
     end
 
@@ -305,7 +314,7 @@ module DigitalFemsa
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [antifraud_info, corporate, created_at, custom_reference, default_fiscal_entity_id, default_shipping_contact_id, default_payment_source_id, email, fiscal_entities, id, livemode, name, metadata, object, payment_sources, phone, shipping_contacts].hash
+      [id, object, created_at, livemode, name, email, phone, corporate, custom_reference, default_fiscal_entity_id, default_shipping_contact_id, metadata, payment_sources, fiscal_entities, shipping_contacts].hash
     end
 
     # Builds the object from hash

data/lib/digital_femsa/models/customer_shipping_contacts_response.rb

@@ -24,6 +24,7 @@ module DigitalFemsa
 
     attr_accessor :address
 
+    # Customer ID that owns this shipping contact.
     attr_accessor :parent_id
 
     attr_accessor :default
@@ -37,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/customers_response.rb

@@ -27,6 +27,7 @@ module DigitalFemsa
     # Url of the previous page.
     attr_accessor :previous_page_url
 
+    # Customers
     attr_accessor :data
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/digital_femsa/models/events_resend_response.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module DigitalFemsa
-  # event model
+  # Webhook log model returned after resending an event webhook delivery.
   class EventsResendResponse
     attr_accessor :failed_attempts
 

data/lib/digital_femsa/models/get_charges_response.rb

@@ -15,27 +15,27 @@ require 'time'
 
 module DigitalFemsa
   class GetChargesResponse
-    # Indicates if there are more pages to be requested
-    attr_accessor :has_more
-
-    # Object type, in this case is list
-    attr_accessor :object
-
     # URL of the next page.
     attr_accessor :next_page_url
 
     # Url of the previous page.
     attr_accessor :previous_page_url
 
+    # Indicates if there are more pages to be requested
+    attr_accessor :has_more
+
+    # Object type, in this case is list
+    attr_accessor :object
+
     attr_accessor :data
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'has_more' => :'has_more',
-        :'object' => :'object',
         :'next_page_url' => :'next_page_url',
         :'previous_page_url' => :'previous_page_url',
+        :'has_more' => :'has_more',
+        :'object' => :'object',
         :'data' => :'data'
       }
     end
@@ -48,10 +48,10 @@ module DigitalFemsa
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'has_more' => :'Boolean',
-        :'object' => :'String',
         :'next_page_url' => :'String',
         :'previous_page_url' => :'String',
+        :'has_more' => :'Boolean',
+        :'object' => :'String',
         :'data' => :'Array<ChargeResponse>'
       }
     end
@@ -87,6 +87,14 @@ module DigitalFemsa
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'next_page_url')
+        self.next_page_url = attributes[:'next_page_url']
+      end
+
+      if attributes.key?(:'previous_page_url')
+        self.previous_page_url = attributes[:'previous_page_url']
+      end
+
       if attributes.key?(:'has_more')
         self.has_more = attributes[:'has_more']
       else
@@ -99,14 +107,6 @@ module DigitalFemsa
         self.object = nil
       end
 
-      if attributes.key?(:'next_page_url')
-        self.next_page_url = attributes[:'next_page_url']
-      end
-
-      if attributes.key?(:'previous_page_url')
-        self.previous_page_url = attributes[:'previous_page_url']
-      end
-
       if attributes.key?(:'data')
         if (value = attributes[:'data']).is_a?(Array)
           self.data = value
@@ -144,10 +144,10 @@ module DigitalFemsa
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          has_more == o.has_more &&
-          object == o.object &&
           next_page_url == o.next_page_url &&
           previous_page_url == o.previous_page_url &&
+          has_more == o.has_more &&
+          object == o.object &&
           data == o.data
     end
 
@@ -160,7 +160,7 @@ module DigitalFemsa
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [has_more, object, next_page_url, previous_page_url, data].hash
+      [next_page_url, previous_page_url, has_more, object, data].hash
     end
 
     # Builds the object from hash

data/lib/digital_femsa/models/get_transactions_response.rb

@@ -27,7 +27,7 @@ module DigitalFemsa
     # Url of the previous page.
     attr_accessor :previous_page_url
 
-    # Transactions
+    # Transactions (ledger movements)
     attr_accessor :data
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/digital_femsa/models/log_response.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module DigitalFemsa
-  # log model
+  # Log model representing a recorded request/response cycle for troubleshooting and auditing.
   class LogResponse
     attr_accessor :created_at
 

data/lib/digital_femsa/models/logs_response.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module DigitalFemsa
-  # logs model
+  # Log model representing a recorded request/response cycle for troubleshooting and auditing.
   class LogsResponse
     # True, if there are more pages.
     attr_accessor :has_more

data/lib/digital_femsa/models/order_fiscal_entity_response.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module DigitalFemsa
-  # Fiscal entity of the order, Currently it is a purely informative field
+  # Fiscal entity information associated with the order. This field can be `null`.
   class OrderFiscalEntityResponse
     attr_accessor :address