Class: VoucherifySdk::LoyaltiesTiersGetResponseBody

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

Overview

Response body schema for GET ‘/loyalties/campaignId/tiers/loyaltyTierId`.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LoyaltiesTiersGetResponseBody

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/VoucherifySdk/models/loyalties_tiers_get_response_body.rb', line 132

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

  if attributes.key?(:'earning_rules')
    if (value = attributes[:'earning_rules']).is_a?(Hash)
      self.earning_rules = value
    end
  end

  if attributes.key?(:'rewards')
    if (value = attributes[:'rewards']).is_a?(Hash)
      self.rewards = value
    end
  end

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#campaign_id ⇒ Object

Unique parent campaign ID.



34
35
36
 
# File 'lib/VoucherifySdk/models/loyalties_tiers_get_response_body.rb', line 34

def campaign_id
  @campaign_id
end

#config ⇒ Object

Returns the value of attribute config.



45
46
47
 
# File 'lib/VoucherifySdk/models/loyalties_tiers_get_response_body.rb', line 45

def config
  @config
end

#created_at ⇒ Object

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



40
41
42
 
# File 'lib/VoucherifySdk/models/loyalties_tiers_get_response_body.rb', line 40

def created_at
  @created_at
end

#earning_rules ⇒ Object

Contains a list of earning rule IDs and their points mapping for the given earning rule.



23
24
25
 
# File 'lib/VoucherifySdk/models/loyalties_tiers_get_response_body.rb', line 23

def earning_rules
  @earning_rules
end

#expiration ⇒ Object

Returns the value of attribute expiration.



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

def expiration
  @expiration
end

#id ⇒ Object

Unique loyalty tier ID.



31
32
33
 
# File 'lib/VoucherifySdk/models/loyalties_tiers_get_response_body.rb', line 31

def id
  @id
end

#metadata ⇒ Object

The metadata object stores all custom attributes assigned to the loyalty tier. A set of key/value pairs that you can attach to a loyalty tier object. It can be useful for storing additional information about the loyalty tier in a structured format.



37
38
39
 
# File 'lib/VoucherifySdk/models/loyalties_tiers_get_response_body.rb', line 37

def metadata
  @metadata
end

#name ⇒ Object

Loyalty Tier name.



20
21
22
 
# File 'lib/VoucherifySdk/models/loyalties_tiers_get_response_body.rb', line 20

def name
  @name
end

#object ⇒ Object

The type of object represented by JSON. This object stores information about the loyalty.



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

def object
  @object
end

#points ⇒ Object

Returns the value of attribute points.



28
29
30
 
# File 'lib/VoucherifySdk/models/loyalties_tiers_get_response_body.rb', line 28

def points
  @points
end

#rewards ⇒ Object

Contains a list of reward IDs and their points mapping for the given reward.



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

def rewards
  @rewards
end

#updated_at ⇒ Object

Timestamp representing the date and time when the loyalty tier was updated in ISO 8601 format.



43
44
45
 
# File 'lib/VoucherifySdk/models/loyalties_tiers_get_response_body.rb', line 43

def updated_at
  @updated_at
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



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/VoucherifySdk/models/loyalties_tiers_get_response_body.rb', line 334

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



93
94
95
 
# File 'lib/VoucherifySdk/models/loyalties_tiers_get_response_body.rb', line 93

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/VoucherifySdk/models/loyalties_tiers_get_response_body.rb', line 75

def self.attribute_map
  {
    :'name' => :'name',
    :'earning_rules' => :'earning_rules',
    :'rewards' => :'rewards',
    :'points' => :'points',
    :'id' => :'id',
    :'campaign_id' => :'campaign_id',
    :'metadata' => :'metadata',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at',
    :'config' => :'config',
    :'expiration' => :'expiration',
    :'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



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/VoucherifySdk/models/loyalties_tiers_get_response_body.rb', line 310

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

List of class defined in allOf (OpenAPI v3)



124
125
126
127
128
 
# File 'lib/VoucherifySdk/models/loyalties_tiers_get_response_body.rb', line 124

def self.openapi_all_of
  [
  :'LoyaltyTier'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



116
117
118
119
120
121
 
# File 'lib/VoucherifySdk/models/loyalties_tiers_get_response_body.rb', line 116

def self.openapi_nullable
  Set.new([
    :'metadata',
    :'updated_at',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/VoucherifySdk/models/loyalties_tiers_get_response_body.rb', line 98

def self.openapi_types
  {
    :'name' => :'String',
    :'earning_rules' => :'Hash<String, MappingPoints>',
    :'rewards' => :'Hash<String, MappingPoints>',
    :'points' => :'LoyaltyTierBasePoints',
    :'id' => :'String',
    :'campaign_id' => :'String',
    :'metadata' => :'Object',
    :'created_at' => :'Time',
    :'updated_at' => :'Time',
    :'config' => :'LoyaltyTierAllOfConfig',
    :'expiration' => :'LoyaltyTierExpiration',
    :'object' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/VoucherifySdk/models/loyalties_tiers_get_response_body.rb', line 278

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      earning_rules == o.earning_rules &&
      rewards == o.rewards &&
      points == o.points &&
      id == o.id &&
      campaign_id == o.campaign_id &&
      metadata == o.metadata &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      config == o.config &&
      expiration == o.expiration &&
      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



405
406
407
408
409
410
411
412
413
414
415
416
417
 
# File 'lib/VoucherifySdk/models/loyalties_tiers_get_response_body.rb', line 405

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


297
298
299
 
# File 'lib/VoucherifySdk/models/loyalties_tiers_get_response_body.rb', line 297

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



303
304
305
 
# File 'lib/VoucherifySdk/models/loyalties_tiers_get_response_body.rb', line 303

def hash
  [name, earning_rules, rewards, points, id, campaign_id, metadata, created_at, updated_at, config, expiration, 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



216
217
218
219
220
221
222
223
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
 
# File 'lib/VoucherifySdk/models/loyalties_tiers_get_response_body.rb', line 216

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @points.nil?
    invalid_properties.push('invalid value for "points", points cannot be nil.')
  end

  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

  if @campaign_id.nil?
    invalid_properties.push('invalid value for "campaign_id", campaign_id cannot be nil.')
  end

  if @created_at.nil?
    invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
  end

  if @config.nil?
    invalid_properties.push('invalid value for "config", config cannot be nil.')
  end

  if @object.nil?
    invalid_properties.push('invalid value for "object", object 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



381
382
383
 
# File 'lib/VoucherifySdk/models/loyalties_tiers_get_response_body.rb', line 381

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



387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/VoucherifySdk/models/loyalties_tiers_get_response_body.rb', line 387

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



375
376
377
 
# File 'lib/VoucherifySdk/models/loyalties_tiers_get_response_body.rb', line 375

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



252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/VoucherifySdk/models/loyalties_tiers_get_response_body.rb', line 252

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @name.nil?
  return false if @points.nil?
  return false if @id.nil?
  return false if @campaign_id.nil?
  return false if @created_at.nil?
  return false if @config.nil?
  return false if @object.nil?
  object_validator = EnumAttributeValidator.new('String', ["loyalty_tier"])
  return false unless object_validator.valid?(@object)
  true
end