class UltracartClient::CouponQuery

Attributes

affiliate_oid[RW]

Affiliate oid

coupon_type[RW]

The type of coupon.

description[RW]

Description of this coupon

exclude_expired[RW]

Exclude expired coupons if true

expiration_dts_begin[RW]

Expiration date begin

expiration_dts_end[RW]

Expiration date begin

merchant_code[RW]

Merchant code is a unique character string for this coupon.

merchant_code_or_description[RW]

Merchant code description used for searching

start_dts_begin[RW]

Start date begin

start_dts_end[RW]

Start date end

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/ultracart_api/models/coupon_query.rb, line 48
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
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/ultracart_api/models/coupon_query.rb, line 81
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
swagger_types() click to toggle source

Attribute type mapping.

# File lib/ultracart_api/models/coupon_query.rb, line 64
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

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/ultracart_api/models/coupon_query.rb, line 143
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
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/ultracart_api/models/coupon_query.rb, line 194
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
_to_hash(value) click to toggle source

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

# File lib/ultracart_api/models/coupon_query.rb, line 260
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
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/ultracart_api/models/coupon_query.rb, line 173
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
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/ultracart_api/models/coupon_query.rb, line 160
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/ultracart_api/models/coupon_query.rb, line 166
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
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/ultracart_api/models/coupon_query.rb, line 130
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/ultracart_api/models/coupon_query.rb, line 240
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/ultracart_api/models/coupon_query.rb, line 246
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
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/ultracart_api/models/coupon_query.rb, line 234
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/ultracart_api/models/coupon_query.rb, line 137
def valid?
  true
end