Class: TalonOne::CustomerActivityReport

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

Overview

A summary report of customer activity for a given time range.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CustomerActivityReport

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#accrued_discounts ⇒ Object

Number of accrued discounts in all customer campaigns.



43
44
45
 
# File 'lib/talon_one/models/customer_activity_report.rb', line 43

def accrued_discounts
  @accrued_discounts
end

#accrued_revenue ⇒ Object

Amount of accrued revenue in all customer campaigns.



46
47
48
 
# File 'lib/talon_one/models/customer_activity_report.rb', line 46

def accrued_revenue
  @accrued_revenue
end

#campaign_name ⇒ Object

The name of the campaign this customer belongs to.



55
56
57
 
# File 'lib/talon_one/models/customer_activity_report.rb', line 55

def campaign_name
  @campaign_name
end

#coupon_failed_attempts ⇒ Object

Number of failed coupon use attempts in all customer campaigns.



40
41
42
 
# File 'lib/talon_one/models/customer_activity_report.rb', line 40

def coupon_failed_attempts
  @coupon_failed_attempts
end

#coupon_redemptions ⇒ Object

Number of coupon redemptions in all customer campaigns.



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

def coupon_redemptions
  @coupon_redemptions
end

#coupon_use_attempts ⇒ Object

Number of coupon use attempts in all customer campaigns.



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

def coupon_use_attempts
  @coupon_use_attempts
end

#created ⇒ Object

The time this entity was created.



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

def created
  @created
end

#customer_id ⇒ Object

The internal Talon.One ID of the customer.



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

def customer_id
  @customer_id
end

#integration_id ⇒ Object

The integration ID set by your integration layer.



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

def integration_id
  @integration_id
end

#last_activity ⇒ Object

The last activity of the customer.



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

def last_activity
  @last_activity
end

#name ⇒ Object

The name for this customer profile.



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

def name
  @name
end

#total_orders ⇒ Object

Number of orders in all customer campaigns.



49
50
51
 
# File 'lib/talon_one/models/customer_activity_report.rb', line 49

def total_orders
  @total_orders
end

#total_orders_no_coupon ⇒ Object

Number of orders without coupon used in all customer campaigns.



52
53
54
 
# File 'lib/talon_one/models/customer_activity_report.rb', line 52

def total_orders_no_coupon
  @total_orders_no_coupon
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'integration_id' => :'integrationId',
    :'created' => :'created',
    :'name' => :'name',
    :'customer_id' => :'customerId',
    :'last_activity' => :'lastActivity',
    :'coupon_redemptions' => :'couponRedemptions',
    :'coupon_use_attempts' => :'couponUseAttempts',
    :'coupon_failed_attempts' => :'couponFailedAttempts',
    :'accrued_discounts' => :'accruedDiscounts',
    :'accrued_revenue' => :'accruedRevenue',
    :'total_orders' => :'totalOrders',
    :'total_orders_no_coupon' => :'totalOrdersNoCoupon',
    :'campaign_name' => :'campaignName'
  }
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



296
297
298
 
# File 'lib/talon_one/models/customer_activity_report.rb', line 296

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



96
97
98
99
 
# File 'lib/talon_one/models/customer_activity_report.rb', line 96

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

.openapi_types ⇒ Object

Attribute type mapping.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/talon_one/models/customer_activity_report.rb', line 77

def self.openapi_types
  {
    :'integration_id' => :'String',
    :'created' => :'DateTime',
    :'name' => :'String',
    :'customer_id' => :'Integer',
    :'last_activity' => :'DateTime',
    :'coupon_redemptions' => :'Integer',
    :'coupon_use_attempts' => :'Integer',
    :'coupon_failed_attempts' => :'Integer',
    :'accrued_discounts' => :'Float',
    :'accrued_revenue' => :'Float',
    :'total_orders' => :'Integer',
    :'total_orders_no_coupon' => :'Integer',
    :'campaign_name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/talon_one/models/customer_activity_report.rb', line 263

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      integration_id == o.integration_id &&
      created == o.created &&
      name == o.name &&
      customer_id == o.customer_id &&
      last_activity == o.last_activity &&
      coupon_redemptions == o.coupon_redemptions &&
      coupon_use_attempts == o.coupon_use_attempts &&
      coupon_failed_attempts == o.coupon_failed_attempts &&
      accrued_discounts == o.accrued_discounts &&
      accrued_revenue == o.accrued_revenue &&
      total_orders == o.total_orders &&
      total_orders_no_coupon == o.total_orders_no_coupon &&
      campaign_name == o.campaign_name
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



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/talon_one/models/customer_activity_report.rb', line 324

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



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

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



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/talon_one/models/customer_activity_report.rb', line 303

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


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



289
290
291
 
# File 'lib/talon_one/models/customer_activity_report.rb', line 289

def hash
  [integration_id, created, name, customer_id, last_activity, coupon_redemptions, coupon_use_attempts, coupon_failed_attempts, accrued_discounts, accrued_revenue, total_orders, total_orders_no_coupon, campaign_name].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



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

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

  if @integration_id.to_s.length > 1000
    invalid_properties.push('invalid value for "integration_id", the character length must be smaller than or equal to 1000.')
  end

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

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

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

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

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

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

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

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

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

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

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



369
370
371
 
# File 'lib/talon_one/models/customer_activity_report.rb', line 369

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



375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/talon_one/models/customer_activity_report.rb', line 375

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



363
364
365
 
# File 'lib/talon_one/models/customer_activity_report.rb', line 363

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



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/talon_one/models/customer_activity_report.rb', line 230

def valid?
  return false if @integration_id.nil?
  return false if @integration_id.to_s.length > 1000
  return false if @created.nil?
  return false if @name.nil?
  return false if @customer_id.nil?
  return false if @coupon_redemptions.nil?
  return false if @coupon_use_attempts.nil?
  return false if @coupon_failed_attempts.nil?
  return false if @accrued_discounts.nil?
  return false if @accrued_revenue.nil?
  return false if @total_orders.nil?
  return false if @total_orders_no_coupon.nil?
  return false if @campaign_name.nil?
  true
end