Class: TalonOne::LoyaltyDashboardData

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

Overview

Datapoint for the graphs and cards on a loyalty program dashboard.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LoyaltyDashboardData

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/talon_one/models/loyalty_dashboard_data.rb', line 81

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#date ⇒ Object

Date at which data point was collected.



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

def date
  @date
end

#earned_points ⇒ Object

Returns the value of attribute earned_points.



41
42
43
 
# File 'lib/talon_one/models/loyalty_dashboard_data.rb', line 41

def earned_points
  @earned_points
end

#new_members ⇒ Object

Number of members who joined on this day.



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

def new_members
  @new_members
end

#spent_points ⇒ Object

Returns the value of attribute spent_points.



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

def spent_points
  @spent_points
end

#total_active_points ⇒ Object

Total of active points for this loyalty program.



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

def total_active_points
  @total_active_points
end

#total_expired_points ⇒ Object

Total of expired points for this loyalty program.



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

def total_expired_points
  @total_expired_points
end

#total_members ⇒ Object

Number of loyalty program members.



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

def total_members
  @total_members
end

#total_pending_points ⇒ Object

Total of pending points for this loyalty program.



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

def total_pending_points
  @total_pending_points
end

#total_spent_points ⇒ Object

Total of spent points for this loyalty program.



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

def total_spent_points
  @total_spent_points
end

Class Method Details

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/talon_one/models/loyalty_dashboard_data.rb', line 44

def self.attribute_map
  {
    :'date' => :'date',
    :'total_active_points' => :'totalActivePoints',
    :'total_pending_points' => :'totalPendingPoints',
    :'total_spent_points' => :'totalSpentPoints',
    :'total_expired_points' => :'totalExpiredPoints',
    :'total_members' => :'totalMembers',
    :'new_members' => :'newMembers',
    :'spent_points' => :'spentPoints',
    :'earned_points' => :'earnedPoints'
  }
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



220
221
222
 
# File 'lib/talon_one/models/loyalty_dashboard_data.rb', line 220

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



74
75
76
77
 
# File 'lib/talon_one/models/loyalty_dashboard_data.rb', line 74

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

.openapi_types ⇒ Object

Attribute type mapping.



59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/talon_one/models/loyalty_dashboard_data.rb', line 59

def self.openapi_types
  {
    :'date' => :'DateTime',
    :'total_active_points' => :'Float',
    :'total_pending_points' => :'Float',
    :'total_spent_points' => :'Float',
    :'total_expired_points' => :'Float',
    :'total_members' => :'Float',
    :'new_members' => :'Float',
    :'spent_points' => :'LoyaltyDashboardPointsBreakdown',
    :'earned_points' => :'LoyaltyDashboardPointsBreakdown'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/talon_one/models/loyalty_dashboard_data.rb', line 191

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      date == o.date &&
      total_active_points == o.total_active_points &&
      total_pending_points == o.total_pending_points &&
      total_spent_points == o.total_spent_points &&
      total_expired_points == o.total_expired_points &&
      total_members == o.total_members &&
      new_members == o.new_members &&
      spent_points == o.spent_points &&
      earned_points == o.earned_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



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
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/talon_one/models/loyalty_dashboard_data.rb', line 248

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



317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/talon_one/models/loyalty_dashboard_data.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



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/talon_one/models/loyalty_dashboard_data.rb', line 227

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


207
208
209
 
# File 'lib/talon_one/models/loyalty_dashboard_data.rb', line 207

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



213
214
215
 
# File 'lib/talon_one/models/loyalty_dashboard_data.rb', line 213

def hash
  [date, total_active_points, total_pending_points, total_spent_points, total_expired_points, total_members, new_members, spent_points, earned_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



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

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

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

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

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

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

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

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

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

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



293
294
295
 
# File 'lib/talon_one/models/loyalty_dashboard_data.rb', line 293

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



299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/talon_one/models/loyalty_dashboard_data.rb', line 299

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



287
288
289
 
# File 'lib/talon_one/models/loyalty_dashboard_data.rb', line 287

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



176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/talon_one/models/loyalty_dashboard_data.rb', line 176

def valid?
  return false if @date.nil?
  return false if @total_active_points.nil?
  return false if @total_pending_points.nil?
  return false if @total_spent_points.nil?
  return false if @total_expired_points.nil?
  return false if @total_members.nil?
  return false if @new_members.nil?
  return false if @spent_points.nil?
  return false if @earned_points.nil?
  true
end