ultracart_api 4.1.102 → 4.1.103

data/lib/ultracart_api/models/affiliate_query.rb

@@ -0,0 +1,489 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+The version of the OpenAPI document: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.0.1-SNAPSHOT
+
+=end
+
+require 'date'
+require 'time'
+
+module UltracartClient
+  class AffiliateQuery
+    # Affiliate OID
+    attr_accessor :affiliate_oid
+
+    # City
+    attr_accessor :city
+
+    # Company name
+    attr_accessor :company_name
+
+    # ISO-3166 two letter country code
+    attr_accessor :country_code
+
+    # Email
+    attr_accessor :email
+
+    # First name
+    attr_accessor :first_name
+
+    # Last name
+    attr_accessor :last_name
+
+    # Postal code
+    attr_accessor :postal_code
+
+    # StoreFront short code
+    attr_accessor :short_code
+
+    # State for United States otherwise region or province for other countries
+    attr_accessor :state
+
+    # Status
+    attr_accessor :status
+
+    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
+      {
+        :'affiliate_oid' => :'affiliate_oid',
+        :'city' => :'city',
+        :'company_name' => :'company_name',
+        :'country_code' => :'country_code',
+        :'email' => :'email',
+        :'first_name' => :'first_name',
+        :'last_name' => :'last_name',
+        :'postal_code' => :'postal_code',
+        :'short_code' => :'short_code',
+        :'state' => :'state',
+        :'status' => :'status'
+      }
+    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
+      {
+        :'affiliate_oid' => :'Integer',
+        :'city' => :'String',
+        :'company_name' => :'String',
+        :'country_code' => :'String',
+        :'email' => :'String',
+        :'first_name' => :'String',
+        :'last_name' => :'String',
+        :'postal_code' => :'String',
+        :'short_code' => :'String',
+        :'state' => :'String',
+        :'status' => :'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 `UltracartClient::AffiliateQuery` 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 `UltracartClient::AffiliateQuery`. 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?(:'affiliate_oid')
+        self.affiliate_oid = attributes[:'affiliate_oid']
+      end
+
+      if attributes.key?(:'city')
+        self.city = attributes[:'city']
+      end
+
+      if attributes.key?(:'company_name')
+        self.company_name = attributes[:'company_name']
+      end
+
+      if attributes.key?(:'country_code')
+        self.country_code = attributes[:'country_code']
+      end
+
+      if attributes.key?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.key?(:'first_name')
+        self.first_name = attributes[:'first_name']
+      end
+
+      if attributes.key?(:'last_name')
+        self.last_name = attributes[:'last_name']
+      end
+
+      if attributes.key?(:'postal_code')
+        self.postal_code = attributes[:'postal_code']
+      end
+
+      if attributes.key?(:'short_code')
+        self.short_code = attributes[:'short_code']
+      end
+
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      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
+      invalid_properties = Array.new
+      if !@city.nil? && @city.to_s.length > 50
+        invalid_properties.push('invalid value for "city", the character length must be smaller than or equal to 50.')
+      end
+
+      if !@company_name.nil? && @company_name.to_s.length > 100
+        invalid_properties.push('invalid value for "company_name", the character length must be smaller than or equal to 100.')
+      end
+
+      if !@country_code.nil? && @country_code.to_s.length > 2
+        invalid_properties.push('invalid value for "country_code", the character length must be smaller than or equal to 2.')
+      end
+
+      if !@email.nil? && @email.to_s.length > 150
+        invalid_properties.push('invalid value for "email", the character length must be smaller than or equal to 150.')
+      end
+
+      if !@first_name.nil? && @first_name.to_s.length > 50
+        invalid_properties.push('invalid value for "first_name", the character length must be smaller than or equal to 50.')
+      end
+
+      if !@last_name.nil? && @last_name.to_s.length > 50
+        invalid_properties.push('invalid value for "last_name", the character length must be smaller than or equal to 50.')
+      end
+
+      if !@postal_code.nil? && @postal_code.to_s.length > 15
+        invalid_properties.push('invalid value for "postal_code", the character length must be smaller than or equal to 15.')
+      end
+
+      if !@short_code.nil? && @short_code.to_s.length > 30
+        invalid_properties.push('invalid value for "short_code", the character length must be smaller than or equal to 30.')
+      end
+
+      if !@state.nil? && @state.to_s.length > 30
+        invalid_properties.push('invalid value for "state", the character length must be smaller than or equal to 30.')
+      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?
+      return false if !@city.nil? && @city.to_s.length > 50
+      return false if !@company_name.nil? && @company_name.to_s.length > 100
+      return false if !@country_code.nil? && @country_code.to_s.length > 2
+      return false if !@email.nil? && @email.to_s.length > 150
+      return false if !@first_name.nil? && @first_name.to_s.length > 50
+      return false if !@last_name.nil? && @last_name.to_s.length > 50
+      return false if !@postal_code.nil? && @postal_code.to_s.length > 15
+      return false if !@short_code.nil? && @short_code.to_s.length > 30
+      return false if !@state.nil? && @state.to_s.length > 30
+      status_validator = EnumAttributeValidator.new('String', ["Active", "Inactive"])
+      return false unless status_validator.valid?(@status)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] city Value to be assigned
+    def city=(city)
+      if !city.nil? && city.to_s.length > 50
+        fail ArgumentError, 'invalid value for "city", the character length must be smaller than or equal to 50.'
+      end
+
+      @city = city
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] company_name Value to be assigned
+    def company_name=(company_name)
+      if !company_name.nil? && company_name.to_s.length > 100
+        fail ArgumentError, 'invalid value for "company_name", the character length must be smaller than or equal to 100.'
+      end
+
+      @company_name = company_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] country_code Value to be assigned
+    def country_code=(country_code)
+      if !country_code.nil? && country_code.to_s.length > 2
+        fail ArgumentError, 'invalid value for "country_code", the character length must be smaller than or equal to 2.'
+      end
+
+      @country_code = country_code
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] email Value to be assigned
+    def email=(email)
+      if !email.nil? && email.to_s.length > 150
+        fail ArgumentError, 'invalid value for "email", the character length must be smaller than or equal to 150.'
+      end
+
+      @email = email
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] first_name Value to be assigned
+    def first_name=(first_name)
+      if !first_name.nil? && first_name.to_s.length > 50
+        fail ArgumentError, 'invalid value for "first_name", the character length must be smaller than or equal to 50.'
+      end
+
+      @first_name = first_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] last_name Value to be assigned
+    def last_name=(last_name)
+      if !last_name.nil? && last_name.to_s.length > 50
+        fail ArgumentError, 'invalid value for "last_name", the character length must be smaller than or equal to 50.'
+      end
+
+      @last_name = last_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] postal_code Value to be assigned
+    def postal_code=(postal_code)
+      if !postal_code.nil? && postal_code.to_s.length > 15
+        fail ArgumentError, 'invalid value for "postal_code", the character length must be smaller than or equal to 15.'
+      end
+
+      @postal_code = postal_code
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] short_code Value to be assigned
+    def short_code=(short_code)
+      if !short_code.nil? && short_code.to_s.length > 30
+        fail ArgumentError, 'invalid value for "short_code", the character length must be smaller than or equal to 30.'
+      end
+
+      @short_code = short_code
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] state Value to be assigned
+    def state=(state)
+      if !state.nil? && state.to_s.length > 30
+        fail ArgumentError, 'invalid value for "state", the character length must be smaller than or equal to 30.'
+      end
+
+      @state = state
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["Active", "Inactive"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+      end
+      @status = status
+    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 &&
+          affiliate_oid == o.affiliate_oid &&
+          city == o.city &&
+          company_name == o.company_name &&
+          country_code == o.country_code &&
+          email == o.email &&
+          first_name == o.first_name &&
+          last_name == o.last_name &&
+          postal_code == o.postal_code &&
+          short_code == o.short_code &&
+          state == o.state &&
+          status == o.status
+    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
+      [affiliate_oid, city, company_name, country_code, email, first_name, last_name, postal_code, short_code, state, status].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)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{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[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _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 = UltracartClient.const_get(type)
+        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