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



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

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?(:'active_campaigns')
    self.active_campaigns = attributes[:'active_campaigns']
  end

  if attributes.key?(:'campaigns')
    self.campaigns = attributes[:'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?(:'custom_attributes')
    self.custom_attributes = attributes[:'custom_attributes']
  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?(:'users')
    self.users = attributes[:'users']
  end

  if attributes.key?(:'roles')
    self.roles = attributes[:'roles']
  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?(:'active_rules')
    self.active_rules = attributes[:'active_rules']
  end
end

Instance Attribute Details

#active_campaigns ⇒ Object

Total Number of Active Applications inside the account



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

def active_campaigns
  @active_campaigns
end

#active_coupons ⇒ Object

Total Number of active coupons inside the account



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

def active_coupons
  @active_coupons
end

#active_referral_codes ⇒ Object

Total Number of active referral codes inside the account



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

def active_referral_codes
  @active_referral_codes
end

#active_rules ⇒ Object

Total Number of active rules in the account



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

def active_rules
  @active_rules
end

#applications ⇒ Object

Total Number of Applications inside 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 inside the account



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

def campaigns
  @campaigns
end

#coupons ⇒ Object

Total Number of coupons inside the account



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

def coupons
  @coupons
end

#custom_attributes ⇒ Object

Total Number of custom attributes inside the account



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

def custom_attributes
  @custom_attributes
end

#expired_coupons ⇒ Object

Total Number of expired coupons inside the account



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

def expired_coupons
  @expired_coupons
end

#expired_referral_codes ⇒ Object

Total Number of expired referral codes inside the account



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

def expired_referral_codes
  @expired_referral_codes
end

#loyalty_programs ⇒ Object

Total Number of loyalty programs inside the account



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

def loyalty_programs
  @loyalty_programs
end

#referral_codes ⇒ Object

Total Number of referral codes inside the account



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

def referral_codes
  @referral_codes
end

#roles ⇒ Object

Total Number of roles inside the account



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

def roles
  @roles
end

#users ⇒ Object

Total Number of users inside the account



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

def users
  @users
end

#webhooks ⇒ Object

Total Number of webhooks inside the account



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

def webhooks
  @webhooks
end

Class Method Details

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/talon_one/models/account_analytics.rb', line 63

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



311
312
313
 
# File 'lib/talon_one/models/account_analytics.rb', line 311

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



105
106
107
108
 
# File 'lib/talon_one/models/account_analytics.rb', line 105

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

.openapi_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/talon_one/models/account_analytics.rb', line 84

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/talon_one/models/account_analytics.rb', line 276

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



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
372
373
374
 
# File 'lib/talon_one/models/account_analytics.rb', line 339

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



408
409
410
411
412
413
414
415
416
417
418
419
420
 
# File 'lib/talon_one/models/account_analytics.rb', line 408

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



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

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


298
299
300
 
# File 'lib/talon_one/models/account_analytics.rb', line 298

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



304
305
306
 
# File 'lib/talon_one/models/account_analytics.rb', line 304

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



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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/talon_one/models/account_analytics.rb', line 188

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

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

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



384
385
386
 
# File 'lib/talon_one/models/account_analytics.rb', line 384

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



390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/talon_one/models/account_analytics.rb', line 390

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



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

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



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/talon_one/models/account_analytics.rb', line 255

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