Class: UltracartClient::GiftCertificate

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GiftCertificate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/ultracart_api/models/gift_certificate.rb', line 101

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'ledger_entries')
    if (value = attributes[:'ledger_entries']).is_a?(Array)
      self.ledger_entries = value
    end
  end

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

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

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

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

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

Instance Attribute Details

#activated ⇒ Object

True if this gift certificate is activated and ready to apply to purchases.



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

def activated
  @activated
end

#code ⇒ Object

The code used by the customer to purchase against this gift certificate.



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

def code
  @code
end

#customer_profile_oid ⇒ Object

This is the customer profile oid associated with this internally managed gift certificate.



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

def customer_profile_oid
  @customer_profile_oid
end

#deleted ⇒ Object

True if this gift certificate was deleted.



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

def deleted
  @deleted
end

#email ⇒ Object

Email of the customer associated with this gift certificate.



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

def email
  @email
end

#expiration_dts ⇒ Object

Expiration date time.



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

def expiration_dts
  @expiration_dts
end

#gift_certificate_oid ⇒ Object

Gift certificate oid.



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

def gift_certificate_oid
  @gift_certificate_oid
end

#internal ⇒ Object

This is an internally managed gift certificate associated with the loyalty cash rewards program.



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

def internal
  @internal
end

#ledger_entries ⇒ Object

A list of all ledger activity for this gift certificate.



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

def ledger_entries
  @ledger_entries
end

#merchant_id ⇒ Object

Merchant Id



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

def merchant_id
  @merchant_id
end

#merchant_note ⇒ Object

A list of all ledger activity for this gift certificate.



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

def merchant_note
  @merchant_note
end

#original_balance ⇒ Object

Original balance of the gift certificate.



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

def original_balance
  @original_balance
end

#reference_order_id ⇒ Object

The order used to purchase this gift certificate. This value is ONLY set during checkout when a certificate is purchased, not when it is used. Any usage is recorded in the ledger



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

def reference_order_id
  @reference_order_id
end

#remaining_balance ⇒ Object

The remaining balance on the gift certificate. This is never set directly, but calculated from the ledger. To change the remaining balance, add a ledger entry.



57
58
59
 
# File 'lib/ultracart_api/models/gift_certificate.rb', line 57

def remaining_balance
  @remaining_balance
end

Class Method Details

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/ultracart_api/models/gift_certificate.rb', line 60

def self.attribute_map
  {
    :'activated' => :'activated',
    :'code' => :'code',
    :'customer_profile_oid' => :'customer_profile_oid',
    :'deleted' => :'deleted',
    :'email' => :'email',
    :'expiration_dts' => :'expiration_dts',
    :'gift_certificate_oid' => :'gift_certificate_oid',
    :'internal' => :'internal',
    :'ledger_entries' => :'ledger_entries',
    :'merchant_id' => :'merchant_id',
    :'merchant_note' => :'merchant_note',
    :'original_balance' => :'original_balance',
    :'reference_order_id' => :'reference_order_id',
    :'remaining_balance' => :'remaining_balance'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/ultracart_api/models/gift_certificate.rb', line 80

def self.swagger_types
  {
    :'activated' => :'BOOLEAN',
    :'code' => :'String',
    :'customer_profile_oid' => :'Integer',
    :'deleted' => :'BOOLEAN',
    :'email' => :'String',
    :'expiration_dts' => :'String',
    :'gift_certificate_oid' => :'Integer',
    :'internal' => :'BOOLEAN',
    :'ledger_entries' => :'Array<GiftCertificateLedgerEntry>',
    :'merchant_id' => :'String',
    :'merchant_note' => :'String',
    :'original_balance' => :'Float',
    :'reference_order_id' => :'String',
    :'remaining_balance' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/ultracart_api/models/gift_certificate.rb', line 196

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      activated == o.activated &&
      code == o.code &&
      customer_profile_oid == o.customer_profile_oid &&
      deleted == o.deleted &&
      email == o.email &&
      expiration_dts == o.expiration_dts &&
      gift_certificate_oid == o.gift_certificate_oid &&
      internal == o.internal &&
      ledger_entries == o.ledger_entries &&
      merchant_id == o.merchant_id &&
      merchant_note == o.merchant_note &&
      original_balance == o.original_balance &&
      reference_order_id == o.reference_order_id &&
      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



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/ultracart_api/models/gift_certificate.rb', line 251

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



317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/ultracart_api/models/gift_certificate.rb', line 317

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



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/ultracart_api/models/gift_certificate.rb', line 230

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


217
218
219
 
# File 'lib/ultracart_api/models/gift_certificate.rb', line 217

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



223
224
225
 
# File 'lib/ultracart_api/models/gift_certificate.rb', line 223

def hash
  [activated, code, customer_profile_oid, deleted, email, expiration_dts, gift_certificate_oid, internal, ledger_entries, merchant_id, merchant_note, original_balance, reference_order_id, 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



168
169
170
171
172
173
174
175
 
# File 'lib/ultracart_api/models/gift_certificate.rb', line 168

def list_invalid_properties
  invalid_properties = Array.new
  if !@email.nil? && @email.to_s.length > 100
    invalid_properties.push('invalid value for "email", the character length must be smaller than or equal to 100.')
  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



297
298
299
 
# File 'lib/ultracart_api/models/gift_certificate.rb', line 297

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



303
304
305
306
307
308
309
310
311
 
# File 'lib/ultracart_api/models/gift_certificate.rb', line 303

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



291
292
293
 
# File 'lib/ultracart_api/models/gift_certificate.rb', line 291

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



179
180
181
182
 
# File 'lib/ultracart_api/models/gift_certificate.rb', line 179

def valid?
  return false if !@email.nil? && @email.to_s.length > 100
  true
end