Class: UltracartClient::OrderCoupon

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/models/order_coupon.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrderCoupon

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/ultracart_api/models/order_coupon.rb', line 56

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?(:'accounting_code')
    self.accounting_code = attributes[:'accounting_code']
  end

  if attributes.has_key?(:'automatically_applied')
    self.automatically_applied = attributes[:'automatically_applied']
  end

  if attributes.has_key?(:'base_coupon_code')
    self.base_coupon_code = attributes[:'base_coupon_code']
  end

  if attributes.has_key?(:'coupon_code')
    self.coupon_code = attributes[:'coupon_code']
  end

  if attributes.has_key?(:'hdie_from_customer')
    self.hdie_from_customer = attributes[:'hdie_from_customer']
  end
end

Instance Attribute Details

#accounting_code ⇒ Object

QuickBooks accounting code for this coupon



18
19
20
 
# File 'lib/ultracart_api/models/order_coupon.rb', line 18

def accounting_code
  @accounting_code
end

#automatically_applied ⇒ Object

Whether or not the coupon was automatically applied to the order



21
22
23
 
# File 'lib/ultracart_api/models/order_coupon.rb', line 21

def automatically_applied
  @automatically_applied
end

#base_coupon_code ⇒ Object

Coupon code configured by the merchant. Will differ if the customer used a one time coupon code generated off this base coupon



24
25
26
 
# File 'lib/ultracart_api/models/order_coupon.rb', line 24

def base_coupon_code
  @base_coupon_code
end

#coupon_code ⇒ Object

Coupon code entered by the customer



27
28
29
 
# File 'lib/ultracart_api/models/order_coupon.rb', line 27

def coupon_code
  @coupon_code
end

#hdie_from_customer ⇒ Object

True if this coupon is hidde from the customer



30
31
32
 
# File 'lib/ultracart_api/models/order_coupon.rb', line 30

def hdie_from_customer
  @hdie_from_customer
end

Class Method Details

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
40
41
 
# File 'lib/ultracart_api/models/order_coupon.rb', line 33

def self.attribute_map
  {
    :'accounting_code' => :'accounting_code',
    :'automatically_applied' => :'automatically_applied',
    :'base_coupon_code' => :'base_coupon_code',
    :'coupon_code' => :'coupon_code',
    :'hdie_from_customer' => :'hdie_from_customer'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



44
45
46
47
48
49
50
51
52
 
# File 'lib/ultracart_api/models/order_coupon.rb', line 44

def self.swagger_types
  {
    :'accounting_code' => :'String',
    :'automatically_applied' => :'BOOLEAN',
    :'base_coupon_code' => :'String',
    :'coupon_code' => :'String',
    :'hdie_from_customer' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



128
129
130
131
132
133
134
135
136
 
# File 'lib/ultracart_api/models/order_coupon.rb', line 128

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      accounting_code == o.accounting_code &&
      automatically_applied == o.automatically_applied &&
      base_coupon_code == o.base_coupon_code &&
      coupon_code == o.coupon_code &&
      hdie_from_customer == o.hdie_from_customer
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/ultracart_api/models/order_coupon.rb', line 174

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) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/ultracart_api/models/order_coupon.rb', line 240

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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/ultracart_api/models/order_coupon.rb', line 153

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) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


140
141
142
 
# File 'lib/ultracart_api/models/order_coupon.rb', line 140

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



146
147
148
 
# File 'lib/ultracart_api/models/order_coupon.rb', line 146

def hash
  [accounting_code, automatically_applied, base_coupon_code, coupon_code, hdie_from_customer].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/ultracart_api/models/order_coupon.rb', line 85

def list_invalid_properties
  invalid_properties = Array.new
  if !@base_coupon_code.nil? && @base_coupon_code.to_s.length > 20
    invalid_properties.push('invalid value for "base_coupon_code", the character length must be smaller than or equal to 20.')
  end

  if !@coupon_code.nil? && @coupon_code.to_s.length > 20
    invalid_properties.push('invalid value for "coupon_code", the character length must be smaller than or equal to 20.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



220
221
222
 
# File 'lib/ultracart_api/models/order_coupon.rb', line 220

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



226
227
228
229
230
231
232
233
234
 
# File 'lib/ultracart_api/models/order_coupon.rb', line 226

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



214
215
216
 
# File 'lib/ultracart_api/models/order_coupon.rb', line 214

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



100
101
102
103
104
 
# File 'lib/ultracart_api/models/order_coupon.rb', line 100

def valid?
  return false if !@base_coupon_code.nil? && @base_coupon_code.to_s.length > 20
  return false if !@coupon_code.nil? && @coupon_code.to_s.length > 20
  true
end