Class: TalonOne::CustomerAnalytics

Inherits:
Object
  • Object
show all
Defined in:
lib/talon_one/models/customer_analytics.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 = {}) ⇒ CustomerAnalytics

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/customer_analytics.rb', line 73

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

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

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

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

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

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

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

Instance Attribute Details

#accepted_coupons ⇒ Object

Total accepted coupons for this customer.



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

def accepted_coupons
  @accepted_coupons
end

#created_coupons ⇒ Object

Total created coupons for this customer.



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

def created_coupons
  @created_coupons
end

#free_items ⇒ Object

Total free items given to this customer.



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

def free_items
  @free_items
end

#total_discounted_orders ⇒ Object

Total orders made by this customer that had a discount.



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

def total_discounted_orders
  @total_discounted_orders
end

#total_discounts ⇒ Object

The sum of discounts that were given across all closed sessions.



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

def total_discounts
  @total_discounts
end

#total_orders ⇒ Object

Total orders made by this customer.



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

def total_orders
  @total_orders
end

#total_revenue ⇒ Object

Total Revenue across all closed sessions.



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

def total_revenue
  @total_revenue
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/customer_analytics.rb', line 40

def self.attribute_map
  {
    :'accepted_coupons' => :'acceptedCoupons',
    :'created_coupons' => :'createdCoupons',
    :'free_items' => :'freeItems',
    :'total_orders' => :'totalOrders',
    :'total_discounted_orders' => :'totalDiscountedOrders',
    :'total_revenue' => :'totalRevenue',
    :'total_discounts' => :'totalDiscounts'
  }
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



192
193
194
 
# File 'lib/talon_one/models/customer_analytics.rb', line 192

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/customer_analytics.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/customer_analytics.rb', line 53

def self.openapi_types
  {
    :'accepted_coupons' => :'Integer',
    :'created_coupons' => :'Integer',
    :'free_items' => :'Integer',
    :'total_orders' => :'Integer',
    :'total_discounted_orders' => :'Integer',
    :'total_revenue' => :'Float',
    :'total_discounts' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/talon_one/models/customer_analytics.rb', line 165

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      accepted_coupons == o.accepted_coupons &&
      created_coupons == o.created_coupons &&
      free_items == o.free_items &&
      total_orders == o.total_orders &&
      total_discounted_orders == o.total_discounted_orders &&
      total_revenue == o.total_revenue &&
      total_discounts == o.total_discounts
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



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
252
253
254
255
 
# File 'lib/talon_one/models/customer_analytics.rb', line 220

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



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

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



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/talon_one/models/customer_analytics.rb', line 199

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


179
180
181
 
# File 'lib/talon_one/models/customer_analytics.rb', line 179

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



185
186
187
 
# File 'lib/talon_one/models/customer_analytics.rb', line 185

def hash
  [accepted_coupons, created_coupons, free_items, total_orders, total_discounted_orders, total_revenue, total_discounts].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/customer_analytics.rb', line 117

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

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

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

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

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

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

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



265
266
267
 
# File 'lib/talon_one/models/customer_analytics.rb', line 265

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



271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/talon_one/models/customer_analytics.rb', line 271

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



259
260
261
 
# File 'lib/talon_one/models/customer_analytics.rb', line 259

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/customer_analytics.rb', line 152

def valid?
  return false if @accepted_coupons.nil?
  return false if @created_coupons.nil?
  return false if @free_items.nil?
  return false if @total_orders.nil?
  return false if @total_discounted_orders.nil?
  return false if @total_revenue.nil?
  return false if @total_discounts.nil?
  true
end