Class: UltracartClient::EmailFlow

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EmailFlow

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/ultracart_api/models/email_flow.rb', line 171

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#allow_multiple_concurrent_enrollments ⇒ Object

True if a customer may be enrolled in this flow multiple times



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

def allow_multiple_concurrent_enrollments
  @allow_multiple_concurrent_enrollments
end

#back_populating ⇒ Object

True if the flow is currently performing a back population.



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

def back_populating
  @back_populating
end

#click_rate_formatted ⇒ Object

Click rate of emails, formatted



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

def click_rate_formatted
  @click_rate_formatted
end

#created_dts ⇒ Object

Created date



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

def created_dts
  @created_dts
end

#deleted ⇒ Object

True if this campaign was deleted



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

def deleted
  @deleted
end

#email_communication_sequence_uuid ⇒ Object

Email communication sequence UUID



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

def email_communication_sequence_uuid
  @email_communication_sequence_uuid
end

#email_flow_uuid ⇒ Object

Email flow UUID



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

def email_flow_uuid
  @email_flow_uuid
end

#end_once_customer_purchases ⇒ Object

True if the customer should end the flow once they purchase from an email on this flow



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

def end_once_customer_purchases
  @end_once_customer_purchases
end

#end_once_customer_purchases_anywhere ⇒ Object

True if the customer should end the flow once they purchase from any source



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

def end_once_customer_purchases_anywhere
  @end_once_customer_purchases_anywhere
end

#enrolled_customers ⇒ Object

Number of enrolled customers.



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

def enrolled_customers
  @enrolled_customers
end

#esp_domain_user ⇒ Object

Username of sending email



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

def esp_domain_user
  @esp_domain_user
end

#esp_domain_uuid ⇒ Object

UUID of sending domain



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

def esp_domain_uuid
  @esp_domain_uuid
end

#esp_flow_folder_uuid ⇒ Object

Flow folder UUID. Null for uncategorized



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

def esp_flow_folder_uuid
  @esp_flow_folder_uuid
end

#esp_friendly_name ⇒ Object

Friendly name of the sending email



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

def esp_friendly_name
  @esp_friendly_name
end

#filter_profile_equation_json ⇒ Object

File profile equation json



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

def filter_profile_equation_json
  @filter_profile_equation_json
end

#library_item_oid ⇒ Object

If this item was ever added to the Code Library, this is the oid for that library item, or 0 if never added before. This value is used to determine if a library item should be inserted or updated.



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

def library_item_oid
  @library_item_oid
end

#merchant_id ⇒ Object

Merchant ID



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

def merchant_id
  @merchant_id
end

#name ⇒ Object

Name of email flow



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

def name
  @name
end

#open_rate_formatted ⇒ Object

Open rate of emails, formatted



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

def open_rate_formatted
  @open_rate_formatted
end

#revenue_formatted ⇒ Object

Revenue, formatted



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

def revenue_formatted
  @revenue_formatted
end

#revenue_per_customer_formatted ⇒ Object

Revenue per customer, formatted



78
79
80
 
# File 'lib/ultracart_api/models/email_flow.rb', line 78

def revenue_per_customer_formatted
  @revenue_per_customer_formatted
end

#screenshot_large_full_url ⇒ Object

URL to a large full length screenshot



81
82
83
 
# File 'lib/ultracart_api/models/email_flow.rb', line 81

def screenshot_large_full_url
  @screenshot_large_full_url
end

#status ⇒ Object

Status of the campaign of draft, archived, active, and inactive



84
85
86
 
# File 'lib/ultracart_api/models/email_flow.rb', line 84

def status
  @status
end

#status_dts ⇒ Object

Timestamp when the last status change happened



87
88
89
 
# File 'lib/ultracart_api/models/email_flow.rb', line 87

def status_dts
  @status_dts
end

#storefront_oid ⇒ Object

Storefront oid



90
91
92
 
# File 'lib/ultracart_api/models/email_flow.rb', line 90

def storefront_oid
  @storefront_oid
end

#trigger_parameter ⇒ Object

Trigger parameter



93
94
95
 
# File 'lib/ultracart_api/models/email_flow.rb', line 93

def trigger_parameter
  @trigger_parameter
end

#trigger_parameter_name ⇒ Object

Trigger parameter name



96
97
98
 
# File 'lib/ultracart_api/models/email_flow.rb', line 96

def trigger_parameter_name
  @trigger_parameter_name
end

#trigger_type ⇒ Object

Trigger type



99
100
101
 
# File 'lib/ultracart_api/models/email_flow.rb', line 99

def trigger_type
  @trigger_type
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'allow_multiple_concurrent_enrollments' => :'allow_multiple_concurrent_enrollments',
    :'back_populating' => :'back_populating',
    :'click_rate_formatted' => :'click_rate_formatted',
    :'created_dts' => :'created_dts',
    :'deleted' => :'deleted',
    :'email_communication_sequence_uuid' => :'email_communication_sequence_uuid',
    :'email_flow_uuid' => :'email_flow_uuid',
    :'end_once_customer_purchases' => :'end_once_customer_purchases',
    :'end_once_customer_purchases_anywhere' => :'end_once_customer_purchases_anywhere',
    :'enrolled_customers' => :'enrolled_customers',
    :'esp_domain_user' => :'esp_domain_user',
    :'esp_domain_uuid' => :'esp_domain_uuid',
    :'esp_flow_folder_uuid' => :'esp_flow_folder_uuid',
    :'esp_friendly_name' => :'esp_friendly_name',
    :'filter_profile_equation_json' => :'filter_profile_equation_json',
    :'library_item_oid' => :'library_item_oid',
    :'merchant_id' => :'merchant_id',
    :'name' => :'name',
    :'open_rate_formatted' => :'open_rate_formatted',
    :'revenue_formatted' => :'revenue_formatted',
    :'revenue_per_customer_formatted' => :'revenue_per_customer_formatted',
    :'screenshot_large_full_url' => :'screenshot_large_full_url',
    :'status' => :'status',
    :'status_dts' => :'status_dts',
    :'storefront_oid' => :'storefront_oid',
    :'trigger_parameter' => :'trigger_parameter',
    :'trigger_parameter_name' => :'trigger_parameter_name',
    :'trigger_type' => :'trigger_type'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'allow_multiple_concurrent_enrollments' => :'BOOLEAN',
    :'back_populating' => :'BOOLEAN',
    :'click_rate_formatted' => :'String',
    :'created_dts' => :'String',
    :'deleted' => :'BOOLEAN',
    :'email_communication_sequence_uuid' => :'String',
    :'email_flow_uuid' => :'String',
    :'end_once_customer_purchases' => :'BOOLEAN',
    :'end_once_customer_purchases_anywhere' => :'BOOLEAN',
    :'enrolled_customers' => :'Integer',
    :'esp_domain_user' => :'String',
    :'esp_domain_uuid' => :'String',
    :'esp_flow_folder_uuid' => :'String',
    :'esp_friendly_name' => :'String',
    :'filter_profile_equation_json' => :'String',
    :'library_item_oid' => :'Integer',
    :'merchant_id' => :'String',
    :'name' => :'String',
    :'open_rate_formatted' => :'String',
    :'revenue_formatted' => :'String',
    :'revenue_per_customer_formatted' => :'String',
    :'screenshot_large_full_url' => :'String',
    :'status' => :'String',
    :'status_dts' => :'String',
    :'storefront_oid' => :'Integer',
    :'trigger_parameter' => :'String',
    :'trigger_parameter_name' => :'String',
    :'trigger_type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



320
321
322
323
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
 
# File 'lib/ultracart_api/models/email_flow.rb', line 320

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      allow_multiple_concurrent_enrollments == o.allow_multiple_concurrent_enrollments &&
      back_populating == o.back_populating &&
      click_rate_formatted == o.click_rate_formatted &&
      created_dts == o.created_dts &&
      deleted == o.deleted &&
      email_communication_sequence_uuid == o.email_communication_sequence_uuid &&
      email_flow_uuid == o.email_flow_uuid &&
      end_once_customer_purchases == o.end_once_customer_purchases &&
      end_once_customer_purchases_anywhere == o.end_once_customer_purchases_anywhere &&
      enrolled_customers == o.enrolled_customers &&
      esp_domain_user == o.esp_domain_user &&
      esp_domain_uuid == o.esp_domain_uuid &&
      esp_flow_folder_uuid == o.esp_flow_folder_uuid &&
      esp_friendly_name == o.esp_friendly_name &&
      filter_profile_equation_json == o.filter_profile_equation_json &&
      library_item_oid == o.library_item_oid &&
      merchant_id == o.merchant_id &&
      name == o.name &&
      open_rate_formatted == o.open_rate_formatted &&
      revenue_formatted == o.revenue_formatted &&
      revenue_per_customer_formatted == o.revenue_per_customer_formatted &&
      screenshot_large_full_url == o.screenshot_large_full_url &&
      status == o.status &&
      status_dts == o.status_dts &&
      storefront_oid == o.storefront_oid &&
      trigger_parameter == o.trigger_parameter &&
      trigger_parameter_name == o.trigger_parameter_name &&
      trigger_type == o.trigger_type
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



389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/ultracart_api/models/email_flow.rb', line 389

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



455
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'lib/ultracart_api/models/email_flow.rb', line 455

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



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/ultracart_api/models/email_flow.rb', line 368

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


355
356
357
 
# File 'lib/ultracart_api/models/email_flow.rb', line 355

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



361
362
363
 
# File 'lib/ultracart_api/models/email_flow.rb', line 361

def hash
  [allow_multiple_concurrent_enrollments, back_populating, click_rate_formatted, created_dts, deleted, email_communication_sequence_uuid, email_flow_uuid, end_once_customer_purchases, end_once_customer_purchases_anywhere, enrolled_customers, esp_domain_user, esp_domain_uuid, esp_flow_folder_uuid, esp_friendly_name, filter_profile_equation_json, library_item_oid, merchant_id, name, open_rate_formatted, revenue_formatted, revenue_per_customer_formatted, screenshot_large_full_url, status, status_dts, storefront_oid, trigger_parameter, trigger_parameter_name, trigger_type].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



292
293
294
295
296
297
298
299
 
# File 'lib/ultracart_api/models/email_flow.rb', line 292

def list_invalid_properties
  invalid_properties = Array.new
  if !@name.nil? && @name.to_s.length > 250
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 250.')
  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



435
436
437
 
# File 'lib/ultracart_api/models/email_flow.rb', line 435

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



441
442
443
444
445
446
447
448
449
 
# File 'lib/ultracart_api/models/email_flow.rb', line 441

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



429
430
431
 
# File 'lib/ultracart_api/models/email_flow.rb', line 429

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



303
304
305
306
 
# File 'lib/ultracart_api/models/email_flow.rb', line 303

def valid?
  return false if !@name.nil? && @name.to_s.length > 250
  true
end