Class: UltracartClient::EmailStepStat

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/models/email_step_stat.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EmailStepStat

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
# File 'lib/ultracart_api/models/email_step_stat.rb', line 131

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#left_conversion_countObject

conversion count (left/default side)



18
19
20
# File 'lib/ultracart_api/models/email_step_stat.rb', line 18

def left_conversion_count
  @left_conversion_count
end

#left_conversion_count_formattedObject

conversion count formatted (left/default side)



21
22
23
# File 'lib/ultracart_api/models/email_step_stat.rb', line 21

def left_conversion_count_formatted
  @left_conversion_count_formatted
end

#left_customer_countObject

customer count (left/default side)



24
25
26
# File 'lib/ultracart_api/models/email_step_stat.rb', line 24

def left_customer_count
  @left_customer_count
end

#left_customer_count_formattedObject

customer count formatted (left/default side)



27
28
29
# File 'lib/ultracart_api/models/email_step_stat.rb', line 27

def left_customer_count_formatted
  @left_customer_count_formatted
end

#left_order_countObject

order count (left/default side)



30
31
32
# File 'lib/ultracart_api/models/email_step_stat.rb', line 30

def left_order_count
  @left_order_count
end

#left_order_count_formattedObject

order count formatted (left/default side)



33
34
35
# File 'lib/ultracart_api/models/email_step_stat.rb', line 33

def left_order_count_formatted
  @left_order_count_formatted
end

#left_profitObject

profit (left/default side)



36
37
38
# File 'lib/ultracart_api/models/email_step_stat.rb', line 36

def left_profit
  @left_profit
end

#left_profit_formattedObject

profit formatted (left/default side)



39
40
41
# File 'lib/ultracart_api/models/email_step_stat.rb', line 39

def left_profit_formatted
  @left_profit_formatted
end

#left_revenueObject

revenue (left/default side)



42
43
44
# File 'lib/ultracart_api/models/email_step_stat.rb', line 42

def left_revenue
  @left_revenue
end

#left_revenue_formattedObject

revenue formatted (left/default side)



45
46
47
# File 'lib/ultracart_api/models/email_step_stat.rb', line 45

def left_revenue_formatted
  @left_revenue_formatted
end

#right_conversion_countObject

conversion count (right side)



48
49
50
# File 'lib/ultracart_api/models/email_step_stat.rb', line 48

def right_conversion_count
  @right_conversion_count
end

#right_conversion_count_formattedObject

conversion count formatted (right side)



51
52
53
# File 'lib/ultracart_api/models/email_step_stat.rb', line 51

def right_conversion_count_formatted
  @right_conversion_count_formatted
end

#right_customer_countObject

customer count (right side)



54
55
56
# File 'lib/ultracart_api/models/email_step_stat.rb', line 54

def right_customer_count
  @right_customer_count
end

#right_customer_count_formattedObject

customer count formatted (right side)



57
58
59
# File 'lib/ultracart_api/models/email_step_stat.rb', line 57

def right_customer_count_formatted
  @right_customer_count_formatted
end

#right_order_countObject

order count (right side)



60
61
62
# File 'lib/ultracart_api/models/email_step_stat.rb', line 60

def right_order_count
  @right_order_count
end

#right_order_count_formattedObject

order count formatted (right side)



63
64
65
# File 'lib/ultracart_api/models/email_step_stat.rb', line 63

def right_order_count_formatted
  @right_order_count_formatted
end

#right_profitObject

profit (right side)



66
67
68
# File 'lib/ultracart_api/models/email_step_stat.rb', line 66

def right_profit
  @right_profit
end

#right_profit_formattedObject

profit formatted (right side)



69
70
71
# File 'lib/ultracart_api/models/email_step_stat.rb', line 69

def right_profit_formatted
  @right_profit_formatted
end

#right_revenueObject

revenue (right side)



72
73
74
# File 'lib/ultracart_api/models/email_step_stat.rb', line 72

def right_revenue
  @right_revenue
end

#right_revenue_formattedObject

revenue formatted (right side)



75
76
77
# File 'lib/ultracart_api/models/email_step_stat.rb', line 75

def right_revenue_formatted
  @right_revenue_formatted
end

Class Method Details

.attribute_mapObject

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/ultracart_api/models/email_step_stat.rb', line 78

def self.attribute_map
  {
    :'left_conversion_count' => :'left_conversion_count',
    :'left_conversion_count_formatted' => :'left_conversion_count_formatted',
    :'left_customer_count' => :'left_customer_count',
    :'left_customer_count_formatted' => :'left_customer_count_formatted',
    :'left_order_count' => :'left_order_count',
    :'left_order_count_formatted' => :'left_order_count_formatted',
    :'left_profit' => :'left_profit',
    :'left_profit_formatted' => :'left_profit_formatted',
    :'left_revenue' => :'left_revenue',
    :'left_revenue_formatted' => :'left_revenue_formatted',
    :'right_conversion_count' => :'right_conversion_count',
    :'right_conversion_count_formatted' => :'right_conversion_count_formatted',
    :'right_customer_count' => :'right_customer_count',
    :'right_customer_count_formatted' => :'right_customer_count_formatted',
    :'right_order_count' => :'right_order_count',
    :'right_order_count_formatted' => :'right_order_count_formatted',
    :'right_profit' => :'right_profit',
    :'right_profit_formatted' => :'right_profit_formatted',
    :'right_revenue' => :'right_revenue',
    :'right_revenue_formatted' => :'right_revenue_formatted'
  }
end

.swagger_typesObject

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/ultracart_api/models/email_step_stat.rb', line 104

def self.swagger_types
  {
    :'left_conversion_count' => :'Integer',
    :'left_conversion_count_formatted' => :'String',
    :'left_customer_count' => :'Integer',
    :'left_customer_count_formatted' => :'String',
    :'left_order_count' => :'Integer',
    :'left_order_count_formatted' => :'String',
    :'left_profit' => :'Float',
    :'left_profit_formatted' => :'String',
    :'left_revenue' => :'Float',
    :'left_revenue_formatted' => :'String',
    :'right_conversion_count' => :'Integer',
    :'right_conversion_count_formatted' => :'String',
    :'right_customer_count' => :'Integer',
    :'right_customer_count_formatted' => :'String',
    :'right_order_count' => :'Integer',
    :'right_order_count_formatted' => :'String',
    :'right_profit' => :'Float',
    :'right_profit_formatted' => :'String',
    :'right_revenue' => :'Float',
    :'right_revenue_formatted' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
# File 'lib/ultracart_api/models/email_step_stat.rb', line 233

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      left_conversion_count == o.left_conversion_count &&
      left_conversion_count_formatted == o.left_conversion_count_formatted &&
      left_customer_count == o.left_customer_count &&
      left_customer_count_formatted == o.left_customer_count_formatted &&
      left_order_count == o.left_order_count &&
      left_order_count_formatted == o.left_order_count_formatted &&
      left_profit == o.left_profit &&
      left_profit_formatted == o.left_profit_formatted &&
      left_revenue == o.left_revenue &&
      left_revenue_formatted == o.left_revenue_formatted &&
      right_conversion_count == o.right_conversion_count &&
      right_conversion_count_formatted == o.right_conversion_count_formatted &&
      right_customer_count == o.right_customer_count &&
      right_customer_count_formatted == o.right_customer_count_formatted &&
      right_order_count == o.right_order_count &&
      right_order_count_formatted == o.right_order_count_formatted &&
      right_profit == o.right_profit &&
      right_profit_formatted == o.right_profit_formatted &&
      right_revenue == o.right_revenue &&
      right_revenue_formatted == o.right_revenue_formatted
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



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
# File 'lib/ultracart_api/models/email_step_stat.rb', line 294

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 = UltracartClient.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



360
361
362
363
364
365
366
367
368
369
370
371
372
# File 'lib/ultracart_api/models/email_step_stat.rb', line 360

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



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
# File 'lib/ultracart_api/models/email_step_stat.rb', line 273

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_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


260
261
262
# File 'lib/ultracart_api/models/email_step_stat.rb', line 260

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



266
267
268
# File 'lib/ultracart_api/models/email_step_stat.rb', line 266

def hash
  [left_conversion_count, left_conversion_count_formatted, left_customer_count, left_customer_count_formatted, left_order_count, left_order_count_formatted, left_profit, left_profit_formatted, left_revenue, left_revenue_formatted, right_conversion_count, right_conversion_count_formatted, right_customer_count, right_customer_count_formatted, right_order_count, right_order_count_formatted, right_profit, right_profit_formatted, right_revenue, right_revenue_formatted].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



220
221
222
223
# File 'lib/ultracart_api/models/email_step_stat.rb', line 220

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



340
341
342
# File 'lib/ultracart_api/models/email_step_stat.rb', line 340

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



346
347
348
349
350
351
352
353
354
# File 'lib/ultracart_api/models/email_step_stat.rb', line 346

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



334
335
336
# File 'lib/ultracart_api/models/email_step_stat.rb', line 334

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



227
228
229
# File 'lib/ultracart_api/models/email_step_stat.rb', line 227

def valid?
  true
end