Class: TalonOne::TierUpgradeData

Inherits:
Object
  • Object
show all
Defined in:
lib/talon_one/models/tier_upgrade_data.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TierUpgradeData

Initializes the object

Parameters:

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

    Model attributes in the form of hash



87
88
89
90
91
92
93
94
95
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
 
# File 'lib/talon_one/models/tier_upgrade_data.rb', line 87

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#current_points ⇒ Object

The number of points the customer had at the time of tier upgrade.



30
31
32
 
# File 'lib/talon_one/models/tier_upgrade_data.rb', line 30

def current_points
  @current_points
end

#current_tier ⇒ Object

The name of the customer’s current tier.



27
28
29
 
# File 'lib/talon_one/models/tier_upgrade_data.rb', line 27

def current_tier
  @current_tier
end

#customer_profile_id ⇒ Object

The integration ID of the customer profile whose tier was upgraded.



18
19
20
 
# File 'lib/talon_one/models/tier_upgrade_data.rb', line 18

def customer_profile_id
  @customer_profile_id
end

#loyalty_program_id ⇒ Object

The ID of the loyalty program.



21
22
23
 
# File 'lib/talon_one/models/tier_upgrade_data.rb', line 21

def loyalty_program_id
  @loyalty_program_id
end

#next_tier ⇒ Object

The name of the customer’s next tier.



39
40
41
 
# File 'lib/talon_one/models/tier_upgrade_data.rb', line 39

def next_tier
  @next_tier
end

#old_tier ⇒ Object

The name of the customer’s previous tier.



33
34
35
 
# File 'lib/talon_one/models/tier_upgrade_data.rb', line 33

def old_tier
  @old_tier
end

#points_required_to_the_next_tier ⇒ Object

The number of points needed for a customer to reach the next tier.



36
37
38
 
# File 'lib/talon_one/models/tier_upgrade_data.rb', line 36

def points_required_to_the_next_tier
  @points_required_to_the_next_tier
end

#subledger_id ⇒ Object

The ID of the subledger, when applicable. If this field is empty, the main ledger is used.



24
25
26
 
# File 'lib/talon_one/models/tier_upgrade_data.rb', line 24

def subledger_id
  @subledger_id
end

#tier_expiration_date ⇒ Object

The exact date and time the tier expires.



42
43
44
 
# File 'lib/talon_one/models/tier_upgrade_data.rb', line 42

def tier_expiration_date
  @tier_expiration_date
end

#timestamp_of_tier_change ⇒ Object

The exact date and time the tier was changed.



45
46
47
 
# File 'lib/talon_one/models/tier_upgrade_data.rb', line 45

def timestamp_of_tier_change
  @timestamp_of_tier_change
end

Class Method Details

.attribute_map ⇒ Object

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



48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/talon_one/models/tier_upgrade_data.rb', line 48

def self.attribute_map
  {
    :'customer_profile_id' => :'CustomerProfileID',
    :'loyalty_program_id' => :'LoyaltyProgramID',
    :'subledger_id' => :'SubledgerID',
    :'current_tier' => :'CurrentTier',
    :'current_points' => :'CurrentPoints',
    :'old_tier' => :'OldTier',
    :'points_required_to_the_next_tier' => :'PointsRequiredToTheNextTier',
    :'next_tier' => :'NextTier',
    :'tier_expiration_date' => :'TierExpirationDate',
    :'timestamp_of_tier_change' => :'TimestampOfTierChange'
  }
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



242
243
244
 
# File 'lib/talon_one/models/tier_upgrade_data.rb', line 242

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



80
81
82
83
 
# File 'lib/talon_one/models/tier_upgrade_data.rb', line 80

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

.openapi_types ⇒ Object

Attribute type mapping.



64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/talon_one/models/tier_upgrade_data.rb', line 64

def self.openapi_types
  {
    :'customer_profile_id' => :'String',
    :'loyalty_program_id' => :'Integer',
    :'subledger_id' => :'String',
    :'current_tier' => :'String',
    :'current_points' => :'Float',
    :'old_tier' => :'String',
    :'points_required_to_the_next_tier' => :'Float',
    :'next_tier' => :'String',
    :'tier_expiration_date' => :'DateTime',
    :'timestamp_of_tier_change' => :'DateTime'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/talon_one/models/tier_upgrade_data.rb', line 212

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      customer_profile_id == o.customer_profile_id &&
      loyalty_program_id == o.loyalty_program_id &&
      subledger_id == o.subledger_id &&
      current_tier == o.current_tier &&
      current_points == o.current_points &&
      old_tier == o.old_tier &&
      points_required_to_the_next_tier == o.points_required_to_the_next_tier &&
      next_tier == o.next_tier &&
      tier_expiration_date == o.tier_expiration_date &&
      timestamp_of_tier_change == o.timestamp_of_tier_change
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



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/talon_one/models/tier_upgrade_data.rb', line 270

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
    TalonOne.const_get(type).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



339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/talon_one/models/tier_upgrade_data.rb', line 339

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



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/talon_one/models/tier_upgrade_data.rb', line 249

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_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


229
230
231
 
# File 'lib/talon_one/models/tier_upgrade_data.rb', line 229

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



235
236
237
 
# File 'lib/talon_one/models/tier_upgrade_data.rb', line 235

def hash
  [customer_profile_id, loyalty_program_id, subledger_id, current_tier, current_points, old_tier, points_required_to_the_next_tier, next_tier, tier_expiration_date, timestamp_of_tier_change].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



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
 
# File 'lib/talon_one/models/tier_upgrade_data.rb', line 145

def list_invalid_properties
  invalid_properties = Array.new
  if @customer_profile_id.nil?
    invalid_properties.push('invalid value for "customer_profile_id", customer_profile_id cannot be nil.')
  end

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

  if @loyalty_program_id < 1
    invalid_properties.push('invalid value for "loyalty_program_id", must be greater than or equal to 1.')
  end

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

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

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

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

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



315
316
317
 
# File 'lib/talon_one/models/tier_upgrade_data.rb', line 315

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



321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/talon_one/models/tier_upgrade_data.rb', line 321

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



309
310
311
 
# File 'lib/talon_one/models/tier_upgrade_data.rb', line 309

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



184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/talon_one/models/tier_upgrade_data.rb', line 184

def valid?
  return false if @customer_profile_id.nil?
  return false if @loyalty_program_id.nil?
  return false if @loyalty_program_id < 1
  return false if @subledger_id.nil?
  return false if @current_tier.nil?
  return false if @current_points.nil?
  return false if @tier_expiration_date.nil?
  return false if @timestamp_of_tier_change.nil?
  true
end