Class: VoucherifySdk::SimpleVoucher

Inherits:
Object
  • Object
show all
Defined in:
lib/VoucherifySdk/models/simple_voucher.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SimpleVoucher

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
165
166
167
168
169
170
171
172
173
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
 
# File 'lib/VoucherifySdk/models/simple_voucher.rb', line 128

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `VoucherifySdk::SimpleVoucher` 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 `VoucherifySdk::SimpleVoucher`. 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?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.key?(:'code')
    self.code = attributes[:'code']
  else
    self.code = nil
  end

  if attributes.key?(:'gift')
    self.gift = attributes[:'gift']
  end

  if attributes.key?(:'discount')
    self.discount = attributes[:'discount']
  end

  if attributes.key?(:'loyalty_card')
    self.loyalty_card = attributes[:'loyalty_card']
  end

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  else
    self.type = 'voucher'
  end

  if attributes.key?(:'campaign')
    self.campaign = attributes[:'campaign']
  end

  if attributes.key?(:'campaign_id')
    self.campaign_id = attributes[:'campaign_id']
  end

  if attributes.key?(:'is_referral_code')
    self.is_referral_code = attributes[:'is_referral_code']
  end

  if attributes.key?(:'holder_id')
    self.holder_id = attributes[:'holder_id']
  end

  if attributes.key?(:'referrer_id')
    self.referrer_id = attributes[:'referrer_id']
  end

  if attributes.key?(:'created_at')
    self.created_at = attributes[:'created_at']
  end

  if attributes.key?(:'object')
    self.object = attributes[:'object']
  else
    self.object = 'voucher'
  end
end

Instance Attribute Details

#campaign ⇒ Object

Campaign object



35
36
37
 
# File 'lib/VoucherifySdk/models/simple_voucher.rb', line 35

def campaign
  @campaign
end

#campaign_id ⇒ Object

Campaign unique ID.



38
39
40
 
# File 'lib/VoucherifySdk/models/simple_voucher.rb', line 38

def campaign_id
  @campaign_id
end

#code ⇒ Object

Voucher code.



22
23
24
 
# File 'lib/VoucherifySdk/models/simple_voucher.rb', line 22

def code
  @code
end

#created_at ⇒ Object

Timestamp representing the date and time when the order was created in ISO 8601 format.



50
51
52
 
# File 'lib/VoucherifySdk/models/simple_voucher.rb', line 50

def created_at
  @created_at
end

#discount ⇒ Object

Returns the value of attribute discount.



26
27
28
 
# File 'lib/VoucherifySdk/models/simple_voucher.rb', line 26

def discount
  @discount
end

#gift ⇒ Object

Returns the value of attribute gift.



24
25
26
 
# File 'lib/VoucherifySdk/models/simple_voucher.rb', line 24

def gift
  @gift
end

#holder_id ⇒ Object

Unique customer ID of campaign owner.



44
45
46
 
# File 'lib/VoucherifySdk/models/simple_voucher.rb', line 44

def holder_id
  @holder_id
end

#id ⇒ Object

A unique identifier that represents the voucher assigned by Voucherify.



19
20
21
 
# File 'lib/VoucherifySdk/models/simple_voucher.rb', line 19

def id
  @id
end

#is_referral_code ⇒ Object

Flag indicating whether this voucher is a referral code; ‘true` for campaign type `REFERRAL_PROGRAM`.



41
42
43
 
# File 'lib/VoucherifySdk/models/simple_voucher.rb', line 41

def is_referral_code
  @is_referral_code
end

#loyalty_card ⇒ Object

Defines the loyalty card details.



29
30
31
 
# File 'lib/VoucherifySdk/models/simple_voucher.rb', line 29

def loyalty_card
  @loyalty_card
end

#object ⇒ Object

The type of object represented by JSON.



53
54
55
 
# File 'lib/VoucherifySdk/models/simple_voucher.rb', line 53

def object
  @object
end

#referrer_id ⇒ Object

Unique referrer ID.



47
48
49
 
# File 'lib/VoucherifySdk/models/simple_voucher.rb', line 47

def referrer_id
  @referrer_id
end

#type ⇒ Object

Type of the object.



32
33
34
 
# File 'lib/VoucherifySdk/models/simple_voucher.rb', line 32

def type
  @type
end

Class Method Details

._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



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/VoucherifySdk/models/simple_voucher.rb', line 303

def self._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 = VoucherifySdk.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



97
98
99
 
# File 'lib/VoucherifySdk/models/simple_voucher.rb', line 97

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/VoucherifySdk/models/simple_voucher.rb', line 78

def self.attribute_map
  {
    :'id' => :'id',
    :'code' => :'code',
    :'gift' => :'gift',
    :'discount' => :'discount',
    :'loyalty_card' => :'loyalty_card',
    :'type' => :'type',
    :'campaign' => :'campaign',
    :'campaign_id' => :'campaign_id',
    :'is_referral_code' => :'is_referral_code',
    :'holder_id' => :'holder_id',
    :'referrer_id' => :'referrer_id',
    :'created_at' => :'created_at',
    :'object' => :'object'
  }
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



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/VoucherifySdk/models/simple_voucher.rb', line 279

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



121
122
123
124
 
# File 'lib/VoucherifySdk/models/simple_voucher.rb', line 121

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/VoucherifySdk/models/simple_voucher.rb', line 102

def self.openapi_types
  {
    :'id' => :'String',
    :'code' => :'String',
    :'gift' => :'Gift',
    :'discount' => :'Discount',
    :'loyalty_card' => :'Object',
    :'type' => :'String',
    :'campaign' => :'Object',
    :'campaign_id' => :'String',
    :'is_referral_code' => :'Boolean',
    :'holder_id' => :'String',
    :'referrer_id' => :'String',
    :'created_at' => :'Time',
    :'object' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/VoucherifySdk/models/simple_voucher.rb', line 246

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      code == o.code &&
      gift == o.gift &&
      discount == o.discount &&
      loyalty_card == o.loyalty_card &&
      type == o.type &&
      campaign == o.campaign &&
      campaign_id == o.campaign_id &&
      is_referral_code == o.is_referral_code &&
      holder_id == o.holder_id &&
      referrer_id == o.referrer_id &&
      created_at == o.created_at &&
      object == o.object
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



374
375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/VoucherifySdk/models/simple_voucher.rb', line 374

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


266
267
268
 
# File 'lib/VoucherifySdk/models/simple_voucher.rb', line 266

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



272
273
274
 
# File 'lib/VoucherifySdk/models/simple_voucher.rb', line 272

def hash
  [id, code, gift, discount, loyalty_card, type, campaign, campaign_id, is_referral_code, holder_id, referrer_id, created_at, object].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



202
203
204
205
206
207
208
209
210
 
# File 'lib/VoucherifySdk/models/simple_voucher.rb', line 202

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @code.nil?
    invalid_properties.push('invalid value for "code", code cannot be nil.')
  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



350
351
352
 
# File 'lib/VoucherifySdk/models/simple_voucher.rb', line 350

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



356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/VoucherifySdk/models/simple_voucher.rb', line 356

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



344
345
346
 
# File 'lib/VoucherifySdk/models/simple_voucher.rb', line 344

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



214
215
216
217
218
219
220
221
222
 
# File 'lib/VoucherifySdk/models/simple_voucher.rb', line 214

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @code.nil?
  type_validator = EnumAttributeValidator.new('String', ["voucher"])
  return false unless type_validator.valid?(@type)
  object_validator = EnumAttributeValidator.new('String', ["voucher"])
  return false unless object_validator.valid?(@object)
  true
end