Class: UltracartClient::CustomerLoyaltyRedemption

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CustomerLoyaltyRedemption

Initializes the object

Parameters:

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

    Model attributes in the form of hash



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/ultracart_api/models/customer_loyalty_redemption.rb', line 96

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#coupon_code ⇒ Object

Coupon code



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

def coupon_code
  @coupon_code
end

#coupon_code_oid ⇒ Object

Coupon code OID



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

def coupon_code_oid
  @coupon_code_oid
end

#coupon_used ⇒ Object

Coupon used



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

def coupon_used
  @coupon_used
end

#description_for_customer ⇒ Object

Description for customer



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

def description_for_customer
  @description_for_customer
end

#expiration_dts ⇒ Object

Expiration date



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

def expiration_dts
  @expiration_dts
end

#gift_certificate_code ⇒ Object

Gift certificate code



33
34
35
 
# File 'lib/ultracart_api/models/customer_loyalty_redemption.rb', line 33

def gift_certificate_code
  @gift_certificate_code
end

#gift_certificate_oid ⇒ Object

Gift certificate oid



36
37
38
 
# File 'lib/ultracart_api/models/customer_loyalty_redemption.rb', line 36

def gift_certificate_oid
  @gift_certificate_oid
end

#loyalty_ledger_oid ⇒ Object

Loyalty ledger OID



39
40
41
 
# File 'lib/ultracart_api/models/customer_loyalty_redemption.rb', line 39

def loyalty_ledger_oid
  @loyalty_ledger_oid
end

#loyalty_points ⇒ Object

Loyalty points



42
43
44
 
# File 'lib/ultracart_api/models/customer_loyalty_redemption.rb', line 42

def loyalty_points
  @loyalty_points
end

#loyalty_redemption_oid ⇒ Object

Loyalty redemption OID



45
46
47
 
# File 'lib/ultracart_api/models/customer_loyalty_redemption.rb', line 45

def loyalty_redemption_oid
  @loyalty_redemption_oid
end

#order_id ⇒ Object

Order id



48
49
50
 
# File 'lib/ultracart_api/models/customer_loyalty_redemption.rb', line 48

def order_id
  @order_id
end

#redemption_dts ⇒ Object

Redemption date



51
52
53
 
# File 'lib/ultracart_api/models/customer_loyalty_redemption.rb', line 51

def redemption_dts
  @redemption_dts
end

#remaining_balance ⇒ Object

Remaining balance



54
55
56
 
# File 'lib/ultracart_api/models/customer_loyalty_redemption.rb', line 54

def remaining_balance
  @remaining_balance
end

Class Method Details

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/ultracart_api/models/customer_loyalty_redemption.rb', line 57

def self.attribute_map
  {
    :'coupon_code' => :'coupon_code',
    :'coupon_code_oid' => :'coupon_code_oid',
    :'coupon_used' => :'coupon_used',
    :'description_for_customer' => :'description_for_customer',
    :'expiration_dts' => :'expiration_dts',
    :'gift_certificate_code' => :'gift_certificate_code',
    :'gift_certificate_oid' => :'gift_certificate_oid',
    :'loyalty_ledger_oid' => :'loyalty_ledger_oid',
    :'loyalty_points' => :'loyalty_points',
    :'loyalty_redemption_oid' => :'loyalty_redemption_oid',
    :'order_id' => :'order_id',
    :'redemption_dts' => :'redemption_dts',
    :'remaining_balance' => :'remaining_balance'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/ultracart_api/models/customer_loyalty_redemption.rb', line 76

def self.swagger_types
  {
    :'coupon_code' => :'String',
    :'coupon_code_oid' => :'Integer',
    :'coupon_used' => :'BOOLEAN',
    :'description_for_customer' => :'String',
    :'expiration_dts' => :'String',
    :'gift_certificate_code' => :'String',
    :'gift_certificate_oid' => :'Integer',
    :'loyalty_ledger_oid' => :'Integer',
    :'loyalty_points' => :'Integer',
    :'loyalty_redemption_oid' => :'Integer',
    :'order_id' => :'String',
    :'redemption_dts' => :'String',
    :'remaining_balance' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/ultracart_api/models/customer_loyalty_redemption.rb', line 170

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      coupon_code == o.coupon_code &&
      coupon_code_oid == o.coupon_code_oid &&
      coupon_used == o.coupon_used &&
      description_for_customer == o.description_for_customer &&
      expiration_dts == o.expiration_dts &&
      gift_certificate_code == o.gift_certificate_code &&
      gift_certificate_oid == o.gift_certificate_oid &&
      loyalty_ledger_oid == o.loyalty_ledger_oid &&
      loyalty_points == o.loyalty_points &&
      loyalty_redemption_oid == o.loyalty_redemption_oid &&
      order_id == o.order_id &&
      redemption_dts == o.redemption_dts &&
      remaining_balance == o.remaining_balance
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



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/ultracart_api/models/customer_loyalty_redemption.rb', line 224

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



290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/ultracart_api/models/customer_loyalty_redemption.rb', line 290

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



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/ultracart_api/models/customer_loyalty_redemption.rb', line 203

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


190
191
192
 
# File 'lib/ultracart_api/models/customer_loyalty_redemption.rb', line 190

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



196
197
198
 
# File 'lib/ultracart_api/models/customer_loyalty_redemption.rb', line 196

def hash
  [coupon_code, coupon_code_oid, coupon_used, description_for_customer, expiration_dts, gift_certificate_code, gift_certificate_oid, loyalty_ledger_oid, loyalty_points, loyalty_redemption_oid, order_id, redemption_dts, remaining_balance].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



157
158
159
160
 
# File 'lib/ultracart_api/models/customer_loyalty_redemption.rb', line 157

def list_invalid_properties
  invalid_properties = Array.new
  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



270
271
272
 
# File 'lib/ultracart_api/models/customer_loyalty_redemption.rb', line 270

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



276
277
278
279
280
281
282
283
284
 
# File 'lib/ultracart_api/models/customer_loyalty_redemption.rb', line 276

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



264
265
266
 
# File 'lib/ultracart_api/models/customer_loyalty_redemption.rb', line 264

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



164
165
166
 
# File 'lib/ultracart_api/models/customer_loyalty_redemption.rb', line 164

def valid?
  true
end