Class: TalonOne::AccountAnalytics

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AccountAnalytics

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/talon_one/models/account_analytics.rb', line 137

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#active_campaigns ⇒ Object

Total number of active campaigns in the account.



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

def active_campaigns
  @active_campaigns
end

#active_coupons ⇒ Object

Total number of active coupons in the account.



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

def active_coupons
  @active_coupons
end

#active_referral_codes ⇒ Object

Total number of active referral codes in the account.



48
49
50
 
# File 'lib/talon_one/models/account_analytics.rb', line 48

def active_referral_codes
  @active_referral_codes
end

#active_rules ⇒ Object

Total number of active rules in the account.



54
55
56
 
# File 'lib/talon_one/models/account_analytics.rb', line 54

def active_rules
  @active_rules
end

#applications ⇒ Object

Total number of applications in the account.



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

def applications
  @applications
end

#campaigns ⇒ Object

Total number of campaigns in the account.



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

def campaigns
  @campaigns
end

#coupons ⇒ Object

Total number of coupons in the account.



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

def coupons
  @coupons
end

#custom_attributes ⇒ Object

Total number of custom attributes in the account.



63
64
65
 
# File 'lib/talon_one/models/account_analytics.rb', line 63

def custom_attributes
  @custom_attributes
end

#expired_coupons ⇒ Object

Total number of expired coupons in the account.



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

def expired_coupons
  @expired_coupons
end

#expired_referral_codes ⇒ Object

Total number of expired referral codes in the account.



51
52
53
 
# File 'lib/talon_one/models/account_analytics.rb', line 51

def expired_referral_codes
  @expired_referral_codes
end

#last_updated_at ⇒ Object

The point in time when the analytics numbers were updated last.



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

def last_updated_at
  @last_updated_at
end

#live_active_campaigns ⇒ Object

Total number of active campaigns in live applications in the account.



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

def live_active_campaigns
  @live_active_campaigns
end

#live_applications ⇒ Object

Total number of live applications in the account.



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

def live_applications
  @live_applications
end

#live_loyalty_programs ⇒ Object

Total number of live loyalty programs in the account.



72
73
74
 
# File 'lib/talon_one/models/account_analytics.rb', line 72

def live_loyalty_programs
  @live_loyalty_programs
end

#loyalty_programs ⇒ Object

Total number of all loyalty programs in the account.



69
70
71
 
# File 'lib/talon_one/models/account_analytics.rb', line 69

def loyalty_programs
  @loyalty_programs
end

#referral_codes ⇒ Object

Total number of referral codes in the account.



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

def referral_codes
  @referral_codes
end

#roles ⇒ Object

Total number of roles in the account.



60
61
62
 
# File 'lib/talon_one/models/account_analytics.rb', line 60

def roles
  @roles
end

#sandbox_applications ⇒ Object

Total number of sandbox applications in the account.



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

def sandbox_applications
  @sandbox_applications
end

#users ⇒ Object

Total number of users in the account.



57
58
59
 
# File 'lib/talon_one/models/account_analytics.rb', line 57

def users
  @users
end

#webhooks ⇒ Object

Total number of webhooks in the account.



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

def webhooks
  @webhooks
end

Class Method Details

.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
95
96
97
98
99
100
101
 
# File 'lib/talon_one/models/account_analytics.rb', line 78

def self.attribute_map
  {
    :'applications' => :'applications',
    :'live_applications' => :'liveApplications',
    :'sandbox_applications' => :'sandboxApplications',
    :'campaigns' => :'campaigns',
    :'active_campaigns' => :'activeCampaigns',
    :'live_active_campaigns' => :'liveActiveCampaigns',
    :'coupons' => :'coupons',
    :'active_coupons' => :'activeCoupons',
    :'expired_coupons' => :'expiredCoupons',
    :'referral_codes' => :'referralCodes',
    :'active_referral_codes' => :'activeReferralCodes',
    :'expired_referral_codes' => :'expiredReferralCodes',
    :'active_rules' => :'activeRules',
    :'users' => :'users',
    :'roles' => :'roles',
    :'custom_attributes' => :'customAttributes',
    :'webhooks' => :'webhooks',
    :'loyalty_programs' => :'loyaltyPrograms',
    :'live_loyalty_programs' => :'liveLoyaltyPrograms',
    :'last_updated_at' => :'lastUpdatedAt'
  }
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



386
387
388
 
# File 'lib/talon_one/models/account_analytics.rb', line 386

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



130
131
132
133
 
# File 'lib/talon_one/models/account_analytics.rb', line 130

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

.openapi_types ⇒ Object

Attribute type mapping.



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/talon_one/models/account_analytics.rb', line 104

def self.openapi_types
  {
    :'applications' => :'Integer',
    :'live_applications' => :'Integer',
    :'sandbox_applications' => :'Integer',
    :'campaigns' => :'Integer',
    :'active_campaigns' => :'Integer',
    :'live_active_campaigns' => :'Integer',
    :'coupons' => :'Integer',
    :'active_coupons' => :'Integer',
    :'expired_coupons' => :'Integer',
    :'referral_codes' => :'Integer',
    :'active_referral_codes' => :'Integer',
    :'expired_referral_codes' => :'Integer',
    :'active_rules' => :'Integer',
    :'users' => :'Integer',
    :'roles' => :'Integer',
    :'custom_attributes' => :'Integer',
    :'webhooks' => :'Integer',
    :'loyalty_programs' => :'Integer',
    :'live_loyalty_programs' => :'Integer',
    :'last_updated_at' => :'DateTime'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/talon_one/models/account_analytics.rb', line 346

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      applications == o.applications &&
      live_applications == o.live_applications &&
      sandbox_applications == o.sandbox_applications &&
      campaigns == o.campaigns &&
      active_campaigns == o.active_campaigns &&
      live_active_campaigns == o.live_active_campaigns &&
      coupons == o.coupons &&
      active_coupons == o.active_coupons &&
      expired_coupons == o.expired_coupons &&
      referral_codes == o.referral_codes &&
      active_referral_codes == o.active_referral_codes &&
      expired_referral_codes == o.expired_referral_codes &&
      active_rules == o.active_rules &&
      users == o.users &&
      roles == o.roles &&
      custom_attributes == o.custom_attributes &&
      webhooks == o.webhooks &&
      loyalty_programs == o.loyalty_programs &&
      live_loyalty_programs == o.live_loyalty_programs &&
      last_updated_at == o.last_updated_at
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



414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/talon_one/models/account_analytics.rb', line 414

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



483
484
485
486
487
488
489
490
491
492
493
494
495
 
# File 'lib/talon_one/models/account_analytics.rb', line 483

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



393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/talon_one/models/account_analytics.rb', line 393

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


373
374
375
 
# File 'lib/talon_one/models/account_analytics.rb', line 373

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



379
380
381
 
# File 'lib/talon_one/models/account_analytics.rb', line 379

def hash
  [applications, live_applications, sandbox_applications, campaigns, active_campaigns, live_active_campaigns, coupons, active_coupons, expired_coupons, referral_codes, active_referral_codes, expired_referral_codes, active_rules, users, roles, custom_attributes, webhooks, loyalty_programs, live_loyalty_programs, last_updated_at].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



233
234
235
236
237
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
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
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/talon_one/models/account_analytics.rb', line 233

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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



459
460
461
 
# File 'lib/talon_one/models/account_analytics.rb', line 459

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



465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File 'lib/talon_one/models/account_analytics.rb', line 465

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



453
454
455
 
# File 'lib/talon_one/models/account_analytics.rb', line 453

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



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/talon_one/models/account_analytics.rb', line 320

def valid?
  return false if @applications.nil?
  return false if @live_applications.nil?
  return false if @sandbox_applications.nil?
  return false if @campaigns.nil?
  return false if @active_campaigns.nil?
  return false if @live_active_campaigns.nil?
  return false if @coupons.nil?
  return false if @active_coupons.nil?
  return false if @expired_coupons.nil?
  return false if @referral_codes.nil?
  return false if @active_referral_codes.nil?
  return false if @expired_referral_codes.nil?
  return false if @active_rules.nil?
  return false if @users.nil?
  return false if @roles.nil?
  return false if @custom_attributes.nil?
  return false if @webhooks.nil?
  return false if @loyalty_programs.nil?
  return false if @live_loyalty_programs.nil?
  return false if @last_updated_at.nil?
  true
end