digital_femsa 1.0.0 → 1.1.0

data/lib/digital_femsa/models/transfers_response_destination.rb

@@ -0,0 +1,312 @@
+=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
+  # Destination payout method used to make the transfer.
+  class TransfersResponseDestination
+    # Unique identifier of the payee.
+    attr_accessor :payee_id
+
+    # Unique identifier of the payout method.
+    attr_accessor :id
+
+    # Date and time of creation of the payout method in Unix format.
+    attr_accessor :created_at
+
+    # Object name, present for bank transfer destination.
+    attr_accessor :object
+
+    # Destination type.
+    attr_accessor :type
+
+    # Last 4 digits of the destination account number.
+    attr_accessor :last4
+
+    # Name of the account holder.
+    attr_accessor :account_holder_name
+
+    # Name of the bank.
+    attr_accessor :bank
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'payee_id' => :'payee_id',
+        :'id' => :'id',
+        :'created_at' => :'created_at',
+        :'object' => :'object',
+        :'type' => :'type',
+        :'last4' => :'last4',
+        :'account_holder_name' => :'account_holder_name',
+        :'bank' => :'bank'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'payee_id' => :'String',
+        :'id' => :'String',
+        :'created_at' => :'Integer',
+        :'object' => :'String',
+        :'type' => :'String',
+        :'last4' => :'String',
+        :'account_holder_name' => :'String',
+        :'bank' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'object',
+        :'type',
+        :'last4',
+        :'account_holder_name',
+        :'bank'
+      ])
+    end
+
+    # Initializes the object
+    # @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::TransfersResponseDestination` 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::TransfersResponseDestination`. 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?(:'payee_id')
+        self.payee_id = attributes[:'payee_id']
+      else
+        self.payee_id = nil
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      else
+        self.created_at = nil
+      end
+
+      if attributes.key?(:'object')
+        self.object = attributes[:'object']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'last4')
+        self.last4 = attributes[:'last4']
+      end
+
+      if attributes.key?(:'account_holder_name')
+        self.account_holder_name = attributes[:'account_holder_name']
+      end
+
+      if attributes.key?(:'bank')
+        self.bank = attributes[:'bank']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @payee_id.nil?
+        invalid_properties.push('invalid value for "payee_id", payee_id cannot be nil.')
+      end
+
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @payee_id.nil?
+      return false if @id.nil?
+      return false if @created_at.nil?
+      true
+    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 &&
+          payee_id == o.payee_id &&
+          id == o.id &&
+          created_at == o.created_at &&
+          object == o.object &&
+          type == o.type &&
+          last4 == o.last4 &&
+          account_holder_name == o.account_holder_name &&
+          bank == o.bank
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [payee_id, id, created_at, object, type, last4, account_holder_name, bank].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = DigitalFemsa.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/digital_femsa/models/update_customer.rb

@@ -14,56 +14,51 @@ require 'date'
 require 'time'
 
 module DigitalFemsa
-  # update customer
+  # Request body to update a customer.
   class UpdateCustomer
-    attr_accessor :antifraud_info
-
-    # It is a parameter that allows to identify in the response, the Femsa ID of a payment method (payment_id)
-    attr_accessor :default_payment_source_id
+    # Customer's name.
+    attr_accessor :name
 
-    # An email address is a series of customizable characters followed by a universal Internet symbol, the at symbol (@), the name of a host server, and a web domain ending (.mx, .com, .org, . net, etc).
+    # Customer email address.
     attr_accessor :email
 
-    # Client's name
-    attr_accessor :name
-
-    # Is the customer's phone number
+    # Customer phone number.
     attr_accessor :phone
 
-    # It is a parameter that allows to identify in the response, the Femsa ID of the shipping address (shipping_contact)
-    attr_accessor :default_shipping_contact_id
-
-    # It is a value that allows identifying if the email is corporate or not.
+    # True if the customer represents a company.
     attr_accessor :corporate
 
-    # It is an undefined value.
+    # Merchant-defined reference used to identify the customer in your system.
     attr_accessor :custom_reference
 
-    attr_accessor :fiscal_entities
-
+    # Arbitrary metadata associated with the customer.
     attr_accessor :metadata
 
-    # Contains details of the payment methods that the customer has active or has used in Femsa
+    # Customer payment sources to create/attach (offline recurrent references).
     attr_accessor :payment_sources
 
-    # Contains the detail of the shipping addresses that the client has active or has used in Femsa
-    attr_accessor :shipping_contacts
+    # Sets the default payment source for the customer (must be an existing payment source on the customer).
+    attr_accessor :default_payment_source_id
+
+    # Sets the default fiscal entity for the customer (must be an existing fiscal entity on the customer).
+    attr_accessor :default_fiscal_entity_id
+
+    # Sets the default shipping contact for the customer (must be an existing shipping contact on the customer).
+    attr_accessor :default_shipping_contact_id
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'antifraud_info' => :'antifraud_info',
-        :'default_payment_source_id' => :'default_payment_source_id',
-        :'email' => :'email',
         :'name' => :'name',
+        :'email' => :'email',
         :'phone' => :'phone',
-        :'default_shipping_contact_id' => :'default_shipping_contact_id',
         :'corporate' => :'corporate',
         :'custom_reference' => :'custom_reference',
-        :'fiscal_entities' => :'fiscal_entities',
         :'metadata' => :'metadata',
         :'payment_sources' => :'payment_sources',
-        :'shipping_contacts' => :'shipping_contacts'
+        :'default_payment_source_id' => :'default_payment_source_id',
+        :'default_fiscal_entity_id' => :'default_fiscal_entity_id',
+        :'default_shipping_contact_id' => :'default_shipping_contact_id'
       }
     end
 
@@ -75,25 +70,22 @@ module DigitalFemsa
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'antifraud_info' => :'UpdateCustomerAntifraudInfo',
-        :'default_payment_source_id' => :'String',
-        :'email' => :'String',
         :'name' => :'String',
+        :'email' => :'String',
         :'phone' => :'String',
-        :'default_shipping_contact_id' => :'String',
         :'corporate' => :'Boolean',
         :'custom_reference' => :'String',
-        :'fiscal_entities' => :'Array<CustomerFiscalEntitiesRequest>',
         :'metadata' => :'Hash<String, Object>',
         :'payment_sources' => :'Array<CustomerPaymentMethodsRequest>',
-        :'shipping_contacts' => :'Array<CustomerShippingContacts>'
+        :'default_payment_source_id' => :'String',
+        :'default_fiscal_entity_id' => :'String',
+        :'default_shipping_contact_id' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'antifraud_info',
       ])
     end
 
@@ -112,46 +104,26 @@ module DigitalFemsa
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'antifraud_info')
-        self.antifraud_info = attributes[:'antifraud_info']
-      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?(:'name')
-        self.name = attributes[:'name']
-      end
-
       if attributes.key?(:'phone')
         self.phone = attributes[:'phone']
       end
 
-      if attributes.key?(:'default_shipping_contact_id')
-        self.default_shipping_contact_id = attributes[:'default_shipping_contact_id']
-      end
-
       if attributes.key?(:'corporate')
         self.corporate = attributes[:'corporate']
-      else
-        self.corporate = false
       end
 
       if attributes.key?(:'custom_reference')
         self.custom_reference = attributes[:'custom_reference']
       end
 
-      if attributes.key?(:'fiscal_entities')
-        if (value = attributes[:'fiscal_entities']).is_a?(Array)
-          self.fiscal_entities = value
-        end
-      end
-
       if attributes.key?(:'metadata')
         if (value = attributes[:'metadata']).is_a?(Hash)
           self.metadata = value
@@ -164,10 +136,16 @@ module DigitalFemsa
         end
       end
 
-      if attributes.key?(:'shipping_contacts')
-        if (value = attributes[:'shipping_contacts']).is_a?(Array)
-          self.shipping_contacts = value
-        end
+      if attributes.key?(:'default_payment_source_id')
+        self.default_payment_source_id = attributes[:'default_payment_source_id']
+      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']
       end
     end
 
@@ -176,10 +154,6 @@ module DigitalFemsa
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      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,41 +161,24 @@ module DigitalFemsa
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if !@metadata.nil? && @metadata.length > 100
       true
     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 &&
-          antifraud_info == o.antifraud_info &&
-          default_payment_source_id == o.default_payment_source_id &&
-          email == o.email &&
           name == o.name &&
+          email == o.email &&
           phone == o.phone &&
-          default_shipping_contact_id == o.default_shipping_contact_id &&
           corporate == o.corporate &&
           custom_reference == o.custom_reference &&
-          fiscal_entities == o.fiscal_entities &&
           metadata == o.metadata &&
           payment_sources == o.payment_sources &&
-          shipping_contacts == o.shipping_contacts
+          default_payment_source_id == o.default_payment_source_id &&
+          default_fiscal_entity_id == o.default_fiscal_entity_id &&
+          default_shipping_contact_id == o.default_shipping_contact_id
     end
 
     # @see the `==` method
@@ -233,7 +190,7 @@ module DigitalFemsa
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [antifraud_info, default_payment_source_id, email, name, phone, default_shipping_contact_id, corporate, custom_reference, fiscal_entities, metadata, payment_sources, shipping_contacts].hash
+      [name, email, phone, corporate, custom_reference, metadata, payment_sources, default_payment_source_id, default_fiscal_entity_id, default_shipping_contact_id].hash
     end
 
     # Builds the object from hash

data/lib/digital_femsa/models/update_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

data/lib/digital_femsa/models/update_order_discount_lines_request.rb

@@ -23,6 +23,28 @@ module DigitalFemsa
 
     attr_accessor :type
 
+    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
       {
@@ -97,6 +119,8 @@ module DigitalFemsa
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if !@amount.nil? && @amount < 0
+      type_validator = EnumAttributeValidator.new('String', ["loyalty", "campaign", "coupon", "sign"])
+      return false unless type_validator.valid?(@type)
       true
     end
 
@@ -114,6 +138,16 @@ module DigitalFemsa
       @amount = amount
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ["loyalty", "campaign", "coupon", "sign"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+      end
+      @type = type
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)