ultracart_api 3.10.221 → 4.0.32.rc

data/lib/ultracart_api/models/coupon_query.rb

@@ -1,275 +1,310 @@
-=begin
-#UltraCart Rest API V2
-
-#UltraCart REST API Version 2
-
-OpenAPI spec version: 2.0.0
-Contact: support@ultracart.com
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.15-SNAPSHOT
-
-=end
-
-require 'date'
-
-module UltracartClient
-  class CouponQuery
-    # Affiliate oid
-    attr_accessor :affiliate_oid
-
-    # The type of coupon.
-    attr_accessor :coupon_type
-
-    # Description of this coupon
-    attr_accessor :description
-
-    # Exclude expired coupons if true
-    attr_accessor :exclude_expired
-
-    # Expiration date begin
-    attr_accessor :expiration_dts_begin
-
-    # Expiration date begin
-    attr_accessor :expiration_dts_end
-
-    # Merchant code is a unique character string for this coupon.
-    attr_accessor :merchant_code
-
-    # Merchant code description used for searching
-    attr_accessor :merchant_code_or_description
-
-    # Start date begin
-    attr_accessor :start_dts_begin
-
-    # Start date end
-    attr_accessor :start_dts_end
-
-    # Attribute mapping from ruby-style variable name to JSON key.
-    def self.attribute_map
-      {
-        :'affiliate_oid' => :'affiliate_oid',
-        :'coupon_type' => :'coupon_type',
-        :'description' => :'description',
-        :'exclude_expired' => :'exclude_expired',
-        :'expiration_dts_begin' => :'expiration_dts_begin',
-        :'expiration_dts_end' => :'expiration_dts_end',
-        :'merchant_code' => :'merchant_code',
-        :'merchant_code_or_description' => :'merchant_code_or_description',
-        :'start_dts_begin' => :'start_dts_begin',
-        :'start_dts_end' => :'start_dts_end'
-      }
-    end
-
-    # Attribute type mapping.
-    def self.swagger_types
-      {
-        :'affiliate_oid' => :'Integer',
-        :'coupon_type' => :'String',
-        :'description' => :'String',
-        :'exclude_expired' => :'BOOLEAN',
-        :'expiration_dts_begin' => :'String',
-        :'expiration_dts_end' => :'String',
-        :'merchant_code' => :'String',
-        :'merchant_code_or_description' => :'String',
-        :'start_dts_begin' => :'String',
-        :'start_dts_end' => :'String'
-      }
-    end
-
-    # Initializes the object
-    # @param [Hash] attributes Model attributes in the form of hash
-    def initialize(attributes = {})
-      return unless attributes.is_a?(Hash)
-
-      # convert string to symbol for hash key
-      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
-
-      if attributes.has_key?(:'affiliate_oid')
-        self.affiliate_oid = attributes[:'affiliate_oid']
-      end
-
-      if attributes.has_key?(:'coupon_type')
-        self.coupon_type = attributes[:'coupon_type']
-      end
-
-      if attributes.has_key?(:'description')
-        self.description = attributes[:'description']
-      end
-
-      if attributes.has_key?(:'exclude_expired')
-        self.exclude_expired = attributes[:'exclude_expired']
-      end
-
-      if attributes.has_key?(:'expiration_dts_begin')
-        self.expiration_dts_begin = attributes[:'expiration_dts_begin']
-      end
-
-      if attributes.has_key?(:'expiration_dts_end')
-        self.expiration_dts_end = attributes[:'expiration_dts_end']
-      end
-
-      if attributes.has_key?(:'merchant_code')
-        self.merchant_code = attributes[:'merchant_code']
-      end
-
-      if attributes.has_key?(:'merchant_code_or_description')
-        self.merchant_code_or_description = attributes[:'merchant_code_or_description']
-      end
-
-      if attributes.has_key?(:'start_dts_begin')
-        self.start_dts_begin = attributes[:'start_dts_begin']
-      end
-
-      if attributes.has_key?(:'start_dts_end')
-        self.start_dts_end = attributes[:'start_dts_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
-      invalid_properties = Array.new
-      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?
-      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 &&
-          affiliate_oid == o.affiliate_oid &&
-          coupon_type == o.coupon_type &&
-          description == o.description &&
-          exclude_expired == o.exclude_expired &&
-          expiration_dts_begin == o.expiration_dts_begin &&
-          expiration_dts_end == o.expiration_dts_end &&
-          merchant_code == o.merchant_code &&
-          merchant_code_or_description == o.merchant_code_or_description &&
-          start_dts_begin == o.start_dts_begin &&
-          start_dts_end == o.start_dts_end
-    end
-
-    # @see the `==` method
-    # @param [Object] Object to be compared
-    def eql?(o)
-      self == o
-    end
-
-    # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
-    def hash
-      [affiliate_oid, coupon_type, description, exclude_expired, expiration_dts_begin, expiration_dts_end, merchant_code, merchant_code_or_description, start_dts_begin, start_dts_end].hash
-    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)
-      self.class.swagger_types.each_pair do |key, type|
-        if 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 # or else data not found in attributes(hash), not an issue as the data can be optional
-      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 :DateTime
-        DateTime.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
-        temp_model = UltracartClient.const_get(type).new
-        temp_model.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)
-        next if value.nil?
-        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
+=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 CouponQuery
+    # Affiliate oid
+    attr_accessor :affiliate_oid
+
+    # The type of coupon.
+    attr_accessor :coupon_type
+
+    # Description of this coupon
+    attr_accessor :description
+
+    # Exclude expired coupons if true
+    attr_accessor :exclude_expired
+
+    # Expiration date begin
+    attr_accessor :expiration_dts_begin
+
+    # Expiration date begin
+    attr_accessor :expiration_dts_end
+
+    # Merchant code is a unique character string for this coupon.
+    attr_accessor :merchant_code
+
+    # Merchant code description used for searching
+    attr_accessor :merchant_code_or_description
+
+    # Start date begin
+    attr_accessor :start_dts_begin
+
+    # Start date end
+    attr_accessor :start_dts_end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'affiliate_oid' => :'affiliate_oid',
+        :'coupon_type' => :'coupon_type',
+        :'description' => :'description',
+        :'exclude_expired' => :'exclude_expired',
+        :'expiration_dts_begin' => :'expiration_dts_begin',
+        :'expiration_dts_end' => :'expiration_dts_end',
+        :'merchant_code' => :'merchant_code',
+        :'merchant_code_or_description' => :'merchant_code_or_description',
+        :'start_dts_begin' => :'start_dts_begin',
+        :'start_dts_end' => :'start_dts_end'
+      }
+    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',
+        :'coupon_type' => :'String',
+        :'description' => :'String',
+        :'exclude_expired' => :'Boolean',
+        :'expiration_dts_begin' => :'String',
+        :'expiration_dts_end' => :'String',
+        :'merchant_code' => :'String',
+        :'merchant_code_or_description' => :'String',
+        :'start_dts_begin' => :'String',
+        :'start_dts_end' => :'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::CouponQuery` 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::CouponQuery`. 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?(:'coupon_type')
+        self.coupon_type = attributes[:'coupon_type']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'exclude_expired')
+        self.exclude_expired = attributes[:'exclude_expired']
+      end
+
+      if attributes.key?(:'expiration_dts_begin')
+        self.expiration_dts_begin = attributes[:'expiration_dts_begin']
+      end
+
+      if attributes.key?(:'expiration_dts_end')
+        self.expiration_dts_end = attributes[:'expiration_dts_end']
+      end
+
+      if attributes.key?(:'merchant_code')
+        self.merchant_code = attributes[:'merchant_code']
+      end
+
+      if attributes.key?(:'merchant_code_or_description')
+        self.merchant_code_or_description = attributes[:'merchant_code_or_description']
+      end
+
+      if attributes.key?(:'start_dts_begin')
+        self.start_dts_begin = attributes[:'start_dts_begin']
+      end
+
+      if attributes.key?(:'start_dts_end')
+        self.start_dts_end = attributes[:'start_dts_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
+      invalid_properties = Array.new
+      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?
+      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 &&
+          affiliate_oid == o.affiliate_oid &&
+          coupon_type == o.coupon_type &&
+          description == o.description &&
+          exclude_expired == o.exclude_expired &&
+          expiration_dts_begin == o.expiration_dts_begin &&
+          expiration_dts_end == o.expiration_dts_end &&
+          merchant_code == o.merchant_code &&
+          merchant_code_or_description == o.merchant_code_or_description &&
+          start_dts_begin == o.start_dts_begin &&
+          start_dts_end == o.start_dts_end
+    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, coupon_type, description, exclude_expired, expiration_dts_begin, expiration_dts_end, merchant_code, merchant_code_or_description, start_dts_begin, start_dts_end].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