Class: TalonOne::LoyaltyTier

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

Overview

A tier in a loyalty program.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LoyaltyTier

Initializes the object

Parameters:

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

    Model attributes in the form of hash



73
74
75
76
77
78
79
80
81
82
83
84
85
86
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
 
# File 'lib/talon_one/models/loyalty_tier.rb', line 73

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

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

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

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

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

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

Instance Attribute Details

#created ⇒ Object

The time this entity was created.



22
23
24
 
# File 'lib/talon_one/models/loyalty_tier.rb', line 22

def created
  @created
end

#id ⇒ Object

The internal ID of this entity.



19
20
21
 
# File 'lib/talon_one/models/loyalty_tier.rb', line 19

def id
  @id
end

#min_points ⇒ Object

The minimum amount of points required to enter the tier.



37
38
39
 
# File 'lib/talon_one/models/loyalty_tier.rb', line 37

def min_points
  @min_points
end

#name ⇒ Object

The name of the tier.



34
35
36
 
# File 'lib/talon_one/models/loyalty_tier.rb', line 34

def name
  @name
end

#program_id ⇒ Object

The ID of the loyalty program that owns this entity.



25
26
27
 
# File 'lib/talon_one/models/loyalty_tier.rb', line 25

def program_id
  @program_id
end

#program_name ⇒ Object

The integration name of the loyalty program that owns this entity.



28
29
30
 
# File 'lib/talon_one/models/loyalty_tier.rb', line 28

def program_name
  @program_name
end

#program_title ⇒ Object

The Campaign Manager-displayed name of the loyalty program that owns this entity.



31
32
33
 
# File 'lib/talon_one/models/loyalty_tier.rb', line 31

def program_title
  @program_title
end

Class Method Details

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/talon_one/models/loyalty_tier.rb', line 40

def self.attribute_map
  {
    :'id' => :'id',
    :'created' => :'created',
    :'program_id' => :'programID',
    :'program_name' => :'programName',
    :'program_title' => :'programTitle',
    :'name' => :'name',
    :'min_points' => :'minPoints'
  }
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



210
211
212
 
# File 'lib/talon_one/models/loyalty_tier.rb', line 210

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



66
67
68
69
 
# File 'lib/talon_one/models/loyalty_tier.rb', line 66

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

.openapi_types ⇒ Object

Attribute type mapping.



53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/talon_one/models/loyalty_tier.rb', line 53

def self.openapi_types
  {
    :'id' => :'Integer',
    :'created' => :'DateTime',
    :'program_id' => :'Integer',
    :'program_name' => :'String',
    :'program_title' => :'String',
    :'name' => :'String',
    :'min_points' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      created == o.created &&
      program_id == o.program_id &&
      program_name == o.program_name &&
      program_title == o.program_title &&
      name == o.name &&
      min_points == o.min_points
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



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/talon_one/models/loyalty_tier.rb', line 238

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



307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/talon_one/models/loyalty_tier.rb', line 307

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



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/talon_one/models/loyalty_tier.rb', line 217

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


197
198
199
 
# File 'lib/talon_one/models/loyalty_tier.rb', line 197

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



203
204
205
 
# File 'lib/talon_one/models/loyalty_tier.rb', line 203

def hash
  [id, created, program_id, program_name, program_title, name, min_points].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



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

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

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

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

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

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

  if @min_points > 999999999999.99
    invalid_properties.push('invalid value for "min_points", must be smaller than or equal to 999999999999.99.')
  end

  if @min_points < 0
    invalid_properties.push('invalid value for "min_points", must be greater than or equal to 0.')
  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



283
284
285
 
# File 'lib/talon_one/models/loyalty_tier.rb', line 283

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



289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/talon_one/models/loyalty_tier.rb', line 289

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



277
278
279
 
# File 'lib/talon_one/models/loyalty_tier.rb', line 277

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



152
153
154
155
156
157
158
159
160
161
 
# File 'lib/talon_one/models/loyalty_tier.rb', line 152

def valid?
  return false if @id.nil?
  return false if @created.nil?
  return false if @program_id.nil?
  return false if @name.nil?
  return false if @min_points.nil?
  return false if @min_points > 999999999999.99
  return false if @min_points < 0
  true
end