Class: ZipMoney::ShopperStatistics

Inherits:
Object
  • Object
show all
Defined in:
lib/zip_money/models/shopper_statistics.rb

Overview

Statistics relating to the shopper

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ShopperStatistics

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
130
131
132
133
134
 
# File 'lib/zip_money/models/shopper_statistics.rb', line 92

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'account_created')
    self. = attributes[:'account_created']
  end

  if attributes.has_key?(:'sales_total_count')
    self.sales_total_count = attributes[:'sales_total_count']
  end

  if attributes.has_key?(:'sales_total_amount')
    self.sales_total_amount = attributes[:'sales_total_amount']
  end

  if attributes.has_key?(:'sales_avg_amount')
    self.sales_avg_amount = attributes[:'sales_avg_amount']
  end

  if attributes.has_key?(:'sales_max_amount')
    self.sales_max_amount = attributes[:'sales_max_amount']
  end

  if attributes.has_key?(:'refunds_total_amount')
    self.refunds_total_amount = attributes[:'refunds_total_amount']
  end

  if attributes.has_key?(:'previous_chargeback')
    self.previous_chargeback = attributes[:'previous_chargeback']
  end

  if attributes.has_key?(:'currency')
    self.currency = attributes[:'currency']
  end

  if attributes.has_key?(:'last_login')
    self. = attributes[:'last_login']
  end

end

Instance Attribute Details

#account_created ⇒ Object

The time at which the shopper’s account was created



12
13
14
 
# File 'lib/zip_money/models/shopper_statistics.rb', line 12

def 
  @account_created
end

#currency ⇒ Object

The currency of all all amount values



33
34
35
 
# File 'lib/zip_money/models/shopper_statistics.rb', line 33

def currency
  @currency
end

#last_login ⇒ Object

The date at which the shopper last logged in to your store.



36
37
38
 
# File 'lib/zip_money/models/shopper_statistics.rb', line 36

def 
  @last_login
end

#previous_chargeback ⇒ Object

Has the shopper had a previous chargeback?



30
31
32
 
# File 'lib/zip_money/models/shopper_statistics.rb', line 30

def previous_chargeback
  @previous_chargeback
end

#refunds_total_amount ⇒ Object

The total amount of all refunds linked to this shopper’s account



27
28
29
 
# File 'lib/zip_money/models/shopper_statistics.rb', line 27

def refunds_total_amount
  @refunds_total_amount
end

#sales_avg_amount ⇒ Object

The average value of sales made by the shopper through the store



21
22
23
 
# File 'lib/zip_money/models/shopper_statistics.rb', line 21

def sales_avg_amount
  @sales_avg_amount
end

#sales_max_amount ⇒ Object

The maximum purchase amount the shopper has previously purchased from the store.



24
25
26
 
# File 'lib/zip_money/models/shopper_statistics.rb', line 24

def sales_max_amount
  @sales_max_amount
end

#sales_total_amount ⇒ Object

The total purchase amount of all orders previously captured through the store.



18
19
20
 
# File 'lib/zip_money/models/shopper_statistics.rb', line 18

def sales_total_amount
  @sales_total_amount
end

#sales_total_count ⇒ Object

The total number of separate purchases the shopper has made through the store



15
16
17
 
# File 'lib/zip_money/models/shopper_statistics.rb', line 15

def sales_total_count
  @sales_total_count
end

Class Method Details

.attribute_map ⇒ Object

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



61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/zip_money/models/shopper_statistics.rb', line 61

def self.attribute_map
  {
    :'account_created' => :'account_created',
    :'sales_total_count' => :'sales_total_count',
    :'sales_total_amount' => :'sales_total_amount',
    :'sales_avg_amount' => :'sales_avg_amount',
    :'sales_max_amount' => :'sales_max_amount',
    :'refunds_total_amount' => :'refunds_total_amount',
    :'previous_chargeback' => :'previous_chargeback',
    :'currency' => :'currency',
    :'last_login' => :'last_login'
  }
end

.zip_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/zip_money/models/shopper_statistics.rb', line 76

def self.zip_types
  {
    :'account_created' => :'DateTime',
    :'sales_total_count' => :'Integer',
    :'sales_total_amount' => :'Float',
    :'sales_avg_amount' => :'Float',
    :'sales_max_amount' => :'Float',
    :'refunds_total_amount' => :'Float',
    :'previous_chargeback' => :'BOOLEAN',
    :'currency' => :'String',
    :'last_login' => :'DateTime'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/zip_money/models/shopper_statistics.rb', line 163

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      sales_total_count == o.sales_total_count &&
      sales_total_amount == o.sales_total_amount &&
      sales_avg_amount == o.sales_avg_amount &&
      sales_max_amount == o.sales_max_amount &&
      refunds_total_amount == o.refunds_total_amount &&
      previous_chargeback == o.previous_chargeback &&
      currency == o.currency &&
       == o.
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



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
 
# File 'lib/zip_money/models/shopper_statistics.rb', line 213

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
    temp_model = ZipMoney.const_get(type).new
    temp_model.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



279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/zip_money/models/shopper_statistics.rb', line 279

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



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/zip_money/models/shopper_statistics.rb', line 192

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.zip_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the 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/zip_money/models/shopper_statistics.rb', line 179

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



185
186
187
 
# File 'lib/zip_money/models/shopper_statistics.rb', line 185

def hash
  [, sales_total_count, sales_total_amount, sales_avg_amount, sales_max_amount, refunds_total_amount, previous_chargeback, currency, ].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



138
139
140
141
 
# File 'lib/zip_money/models/shopper_statistics.rb', line 138

def list_invalid_properties
  invalid_properties = Array.new
  return 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



259
260
261
 
# File 'lib/zip_money/models/shopper_statistics.rb', line 259

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



265
266
267
268
269
270
271
272
273
 
# File 'lib/zip_money/models/shopper_statistics.rb', line 265

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



253
254
255
 
# File 'lib/zip_money/models/shopper_statistics.rb', line 253

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



145
146
147
148
149
 
# File 'lib/zip_money/models/shopper_statistics.rb', line 145

def valid?
  currency_validator = EnumAttributeValidator.new('String', ["AUD", "NZD"])
  return false unless currency_validator.valid?(@currency)
  return true
end