digital_femsa 1.0.0

data/lib/digital_femsa/models/customer.rb

@@ -0,0 +1,374 @@
+=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
+  # a customer
+  class Customer
+    attr_accessor :antifraud_info
+
+    # It is a value that allows identifying if the email is corporate or not.
+    attr_accessor :corporate
+
+    # It is an undefined value.
+    attr_accessor :custom_reference
+
+    # 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).
+    attr_accessor :email
+
+    # 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
+
+    # 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
+
+    attr_accessor :fiscal_entities
+
+    attr_accessor :metadata
+
+    # Client's name
+    attr_accessor :name
+
+    # Contains details of the payment methods that the customer has active or has used in Femsa
+    attr_accessor :payment_sources
+
+    # Is the customer's phone number
+    attr_accessor :phone
+
+    # Contains the detail of the shipping addresses that the client has active or has used in Femsa
+    attr_accessor :shipping_contacts
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'antifraud_info' => :'antifraud_info',
+        :'corporate' => :'corporate',
+        :'custom_reference' => :'custom_reference',
+        :'email' => :'email',
+        :'default_payment_source_id' => :'default_payment_source_id',
+        :'default_shipping_contact_id' => :'default_shipping_contact_id',
+        :'fiscal_entities' => :'fiscal_entities',
+        :'metadata' => :'metadata',
+        :'name' => :'name',
+        :'payment_sources' => :'payment_sources',
+        :'phone' => :'phone',
+        :'shipping_contacts' => :'shipping_contacts'
+      }
+    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
+      {
+        :'antifraud_info' => :'CustomerAntifraudInfo',
+        :'corporate' => :'Boolean',
+        :'custom_reference' => :'String',
+        :'email' => :'String',
+        :'default_payment_source_id' => :'String',
+        :'default_shipping_contact_id' => :'String',
+        :'fiscal_entities' => :'Array<CustomerFiscalEntitiesRequest>',
+        :'metadata' => :'Hash<String, Object>',
+        :'name' => :'String',
+        :'payment_sources' => :'Array<CustomerPaymentMethodsRequest>',
+        :'phone' => :'String',
+        :'shipping_contacts' => :'Array<CustomerShippingContacts>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'antifraud_info',
+      ])
+    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::Customer` 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::Customer`. 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?(:'antifraud_info')
+        self.antifraud_info = attributes[:'antifraud_info']
+      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?(:'email')
+        self.email = attributes[:'email']
+      else
+        self.email = nil
+      end
+
+      if attributes.key?(:'default_payment_source_id')
+        self.default_payment_source_id = attributes[:'default_payment_source_id']
+      end
+
+      if attributes.key?(:'default_shipping_contact_id')
+        self.default_shipping_contact_id = attributes[:'default_shipping_contact_id']
+      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
+        end
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'payment_sources')
+        if (value = attributes[:'payment_sources']).is_a?(Array)
+          self.payment_sources = value
+        end
+      end
+
+      if attributes.key?(:'phone')
+        self.phone = attributes[:'phone']
+      else
+        self.phone = nil
+      end
+
+      if attributes.key?(:'shipping_contacts')
+        if (value = attributes[:'shipping_contacts']).is_a?(Array)
+          self.shipping_contacts = value
+        end
+      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 @email.nil?
+        invalid_properties.push('invalid value for "email", email 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 @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @phone.nil?
+        invalid_properties.push('invalid value for "phone", phone 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 @email.nil?
+      return false if !@metadata.nil? && @metadata.length > 100
+      return false if @name.nil?
+      return false if @phone.nil?
+      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 &&
+          corporate == o.corporate &&
+          custom_reference == o.custom_reference &&
+          email == o.email &&
+          default_payment_source_id == o.default_payment_source_id &&
+          default_shipping_contact_id == o.default_shipping_contact_id &&
+          fiscal_entities == o.fiscal_entities &&
+          metadata == o.metadata &&
+          name == o.name &&
+          payment_sources == o.payment_sources &&
+          phone == o.phone &&
+          shipping_contacts == o.shipping_contacts
+    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
+      [antifraud_info, corporate, custom_reference, email, default_payment_source_id, default_shipping_contact_id, fiscal_entities, metadata, name, payment_sources, phone, shipping_contacts].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/customer_address.rb

@@ -0,0 +1,301 @@
+=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
+  class CustomerAddress
+    attr_accessor :street1
+
+    attr_accessor :street2
+
+    attr_accessor :postal_code
+
+    attr_accessor :city
+
+    attr_accessor :state
+
+    # this field follows the [ISO 3166-1 alpha-2 standard](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
+    attr_accessor :country
+
+    attr_accessor :residential
+
+    attr_accessor :external_number
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'street1' => :'street1',
+        :'street2' => :'street2',
+        :'postal_code' => :'postal_code',
+        :'city' => :'city',
+        :'state' => :'state',
+        :'country' => :'country',
+        :'residential' => :'residential',
+        :'external_number' => :'external_number'
+      }
+    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
+      {
+        :'street1' => :'String',
+        :'street2' => :'String',
+        :'postal_code' => :'String',
+        :'city' => :'String',
+        :'state' => :'String',
+        :'country' => :'String',
+        :'residential' => :'Boolean',
+        :'external_number' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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::CustomerAddress` 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::CustomerAddress`. 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?(:'street1')
+        self.street1 = attributes[:'street1']
+      else
+        self.street1 = nil
+      end
+
+      if attributes.key?(:'street2')
+        self.street2 = attributes[:'street2']
+      end
+
+      if attributes.key?(:'postal_code')
+        self.postal_code = attributes[:'postal_code']
+      else
+        self.postal_code = nil
+      end
+
+      if attributes.key?(:'city')
+        self.city = attributes[:'city']
+      else
+        self.city = nil
+      end
+
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      end
+
+      if attributes.key?(:'country')
+        self.country = attributes[:'country']
+      end
+
+      if attributes.key?(:'residential')
+        self.residential = attributes[:'residential']
+      else
+        self.residential = false
+      end
+
+      if attributes.key?(:'external_number')
+        self.external_number = attributes[:'external_number']
+      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 @street1.nil?
+        invalid_properties.push('invalid value for "street1", street1 cannot be nil.')
+      end
+
+      if @postal_code.nil?
+        invalid_properties.push('invalid value for "postal_code", postal_code cannot be nil.')
+      end
+
+      if @city.nil?
+        invalid_properties.push('invalid value for "city", city 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 @street1.nil?
+      return false if @postal_code.nil?
+      return false if @city.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 &&
+          street1 == o.street1 &&
+          street2 == o.street2 &&
+          postal_code == o.postal_code &&
+          city == o.city &&
+          state == o.state &&
+          country == o.country &&
+          residential == o.residential &&
+          external_number == o.external_number
+    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
+      [street1, street2, postal_code, city, state, country, residential, external_number].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