Class: UltracartClient::EmailCampaign

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EmailCampaign

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
289
290
291
 
# File 'lib/ultracart_api/models/email_campaign.rb', line 173

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'memberships')
    if (value = attributes[:'memberships']).is_a?(Array)
      self.memberships = value
    end
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#click_rate_formatted ⇒ Object

Click rate of emails



19
20
21
 
# File 'lib/ultracart_api/models/email_campaign.rb', line 19

def click_rate_formatted
  @click_rate_formatted
end

#created_dts ⇒ Object

Created date



22
23
24
 
# File 'lib/ultracart_api/models/email_campaign.rb', line 22

def created_dts
  @created_dts
end

#deleted ⇒ Object

True if this campaign was deleted



25
26
27
 
# File 'lib/ultracart_api/models/email_campaign.rb', line 25

def deleted
  @deleted
end

#email_campaign_uuid ⇒ Object

Email campaign UUID



28
29
30
 
# File 'lib/ultracart_api/models/email_campaign.rb', line 28

def email_campaign_uuid
  @email_campaign_uuid
end

#email_communication_sequence_uuid ⇒ Object

Email communication sequence UUID



31
32
33
 
# File 'lib/ultracart_api/models/email_campaign.rb', line 31

def email_communication_sequence_uuid
  @email_communication_sequence_uuid
end

#end_once_customer_purchases ⇒ Object

True if the customer should end the flow once they purchase from this campaign



34
35
36
 
# File 'lib/ultracart_api/models/email_campaign.rb', line 34

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 anywhere



37
38
39
 
# File 'lib/ultracart_api/models/email_campaign.rb', line 37

def end_once_customer_purchases_anywhere
  @end_once_customer_purchases_anywhere
end

#esp_campaign_folder_uuid ⇒ Object

Campaign folder UUID. Null for uncategorized



40
41
42
 
# File 'lib/ultracart_api/models/email_campaign.rb', line 40

def esp_campaign_folder_uuid
  @esp_campaign_folder_uuid
end

#esp_domain_user ⇒ Object

User of the sending address



43
44
45
 
# File 'lib/ultracart_api/models/email_campaign.rb', line 43

def esp_domain_user
  @esp_domain_user
end

#esp_domain_uuid ⇒ Object

UUID of the sending domain



46
47
48
 
# File 'lib/ultracart_api/models/email_campaign.rb', line 46

def esp_domain_uuid
  @esp_domain_uuid
end

#esp_friendly_name ⇒ Object

Friendly name of the sending email



49
50
51
 
# File 'lib/ultracart_api/models/email_campaign.rb', line 49

def esp_friendly_name
  @esp_friendly_name
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.



52
53
54
 
# File 'lib/ultracart_api/models/email_campaign.rb', line 52

def library_item_oid
  @library_item_oid
end

#memberships ⇒ Object

List and segment memberships



55
56
57
 
# File 'lib/ultracart_api/models/email_campaign.rb', line 55

def memberships
  @memberships
end

#merchant_id ⇒ Object

Merchant ID



58
59
60
 
# File 'lib/ultracart_api/models/email_campaign.rb', line 58

def merchant_id
  @merchant_id
end

#name ⇒ Object

Name of email campaign



61
62
63
 
# File 'lib/ultracart_api/models/email_campaign.rb', line 61

def name
  @name
end

#open_rate_formatted ⇒ Object

Open rate of emails



64
65
66
 
# File 'lib/ultracart_api/models/email_campaign.rb', line 64

def open_rate_formatted
  @open_rate_formatted
end

#prevent_sending_due_to_spam ⇒ Object

True if this campaign is prevented from sending at this time due to spam complaints.



67
68
69
 
# File 'lib/ultracart_api/models/email_campaign.rb', line 67

def prevent_sending_due_to_spam
  @prevent_sending_due_to_spam
end

#revenue_formatted ⇒ Object

Revenue associated with campaign



70
71
72
 
# File 'lib/ultracart_api/models/email_campaign.rb', line 70

def revenue_formatted
  @revenue_formatted
end

#revenue_per_customer_formatted ⇒ Object

Revenue per customer associated with campaign



73
74
75
 
# File 'lib/ultracart_api/models/email_campaign.rb', line 73

def revenue_per_customer_formatted
  @revenue_per_customer_formatted
end

#scheduled_dts ⇒ Object

Scheduled date



76
77
78
 
# File 'lib/ultracart_api/models/email_campaign.rb', line 76

def scheduled_dts
  @scheduled_dts
end

#screenshot_large_full_url ⇒ Object

URL to a large full length screenshot



79
80
81
 
# File 'lib/ultracart_api/models/email_campaign.rb', line 79

def screenshot_large_full_url
  @screenshot_large_full_url
end

#sms_esp_twilio_uuid ⇒ Object

Twilio Account UUID. Null for none



82
83
84
 
# File 'lib/ultracart_api/models/email_campaign.rb', line 82

def sms_esp_twilio_uuid
  @sms_esp_twilio_uuid
end

#sms_phone_number ⇒ Object

Twilio SMS Phone Number. Null for none



85
86
87
 
# File 'lib/ultracart_api/models/email_campaign.rb', line 85

def sms_phone_number
  @sms_phone_number
end

#status ⇒ Object

Status of the campaign of draft, archived, and sent



88
89
90
 
# File 'lib/ultracart_api/models/email_campaign.rb', line 88

def status
  @status
end

#status_dts ⇒ Object

Timestamp when the last status change happened



91
92
93
 
# File 'lib/ultracart_api/models/email_campaign.rb', line 91

def status_dts
  @status_dts
end

#storefront_oid ⇒ Object

Storefront oid



94
95
96
 
# File 'lib/ultracart_api/models/email_campaign.rb', line 94

def storefront_oid
  @storefront_oid
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



129
130
131
 
# File 'lib/ultracart_api/models/email_campaign.rb', line 129

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'click_rate_formatted' => :'click_rate_formatted',
    :'created_dts' => :'created_dts',
    :'deleted' => :'deleted',
    :'email_campaign_uuid' => :'email_campaign_uuid',
    :'email_communication_sequence_uuid' => :'email_communication_sequence_uuid',
    :'end_once_customer_purchases' => :'end_once_customer_purchases',
    :'end_once_customer_purchases_anywhere' => :'end_once_customer_purchases_anywhere',
    :'esp_campaign_folder_uuid' => :'esp_campaign_folder_uuid',
    :'esp_domain_user' => :'esp_domain_user',
    :'esp_domain_uuid' => :'esp_domain_uuid',
    :'esp_friendly_name' => :'esp_friendly_name',
    :'library_item_oid' => :'library_item_oid',
    :'memberships' => :'memberships',
    :'merchant_id' => :'merchant_id',
    :'name' => :'name',
    :'open_rate_formatted' => :'open_rate_formatted',
    :'prevent_sending_due_to_spam' => :'prevent_sending_due_to_spam',
    :'revenue_formatted' => :'revenue_formatted',
    :'revenue_per_customer_formatted' => :'revenue_per_customer_formatted',
    :'scheduled_dts' => :'scheduled_dts',
    :'screenshot_large_full_url' => :'screenshot_large_full_url',
    :'sms_esp_twilio_uuid' => :'sms_esp_twilio_uuid',
    :'sms_phone_number' => :'sms_phone_number',
    :'status' => :'status',
    :'status_dts' => :'status_dts',
    :'storefront_oid' => :'storefront_oid'
  }
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



369
370
371
 
# File 'lib/ultracart_api/models/email_campaign.rb', line 369

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



166
167
168
169
 
# File 'lib/ultracart_api/models/email_campaign.rb', line 166

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'click_rate_formatted' => :'String',
    :'created_dts' => :'String',
    :'deleted' => :'Boolean',
    :'email_campaign_uuid' => :'String',
    :'email_communication_sequence_uuid' => :'String',
    :'end_once_customer_purchases' => :'Boolean',
    :'end_once_customer_purchases_anywhere' => :'Boolean',
    :'esp_campaign_folder_uuid' => :'String',
    :'esp_domain_user' => :'String',
    :'esp_domain_uuid' => :'String',
    :'esp_friendly_name' => :'String',
    :'library_item_oid' => :'Integer',
    :'memberships' => :'Array<EmailListSegmentMembership>',
    :'merchant_id' => :'String',
    :'name' => :'String',
    :'open_rate_formatted' => :'String',
    :'prevent_sending_due_to_spam' => :'Boolean',
    :'revenue_formatted' => :'String',
    :'revenue_per_customer_formatted' => :'String',
    :'scheduled_dts' => :'String',
    :'screenshot_large_full_url' => :'String',
    :'sms_esp_twilio_uuid' => :'String',
    :'sms_phone_number' => :'String',
    :'status' => :'String',
    :'status_dts' => :'String',
    :'storefront_oid' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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
352
 
# File 'lib/ultracart_api/models/email_campaign.rb', line 323

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      click_rate_formatted == o.click_rate_formatted &&
      created_dts == o.created_dts &&
      deleted == o.deleted &&
      email_campaign_uuid == o.email_campaign_uuid &&
      email_communication_sequence_uuid == o.email_communication_sequence_uuid &&
      end_once_customer_purchases == o.end_once_customer_purchases &&
      end_once_customer_purchases_anywhere == o.end_once_customer_purchases_anywhere &&
      esp_campaign_folder_uuid == o.esp_campaign_folder_uuid &&
      esp_domain_user == o.esp_domain_user &&
      esp_domain_uuid == o.esp_domain_uuid &&
      esp_friendly_name == o.esp_friendly_name &&
      library_item_oid == o.library_item_oid &&
      memberships == o.memberships &&
      merchant_id == o.merchant_id &&
      name == o.name &&
      open_rate_formatted == o.open_rate_formatted &&
      prevent_sending_due_to_spam == o.prevent_sending_due_to_spam &&
      revenue_formatted == o.revenue_formatted &&
      revenue_per_customer_formatted == o.revenue_per_customer_formatted &&
      scheduled_dts == o.scheduled_dts &&
      screenshot_large_full_url == o.screenshot_large_full_url &&
      sms_esp_twilio_uuid == o.sms_esp_twilio_uuid &&
      sms_phone_number == o.sms_phone_number &&
      status == o.status &&
      status_dts == o.status_dts &&
      storefront_oid == o.storefront_oid
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



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
426
427
428
429
430
431
432
433
434
435
436
437
 
# File 'lib/ultracart_api/models/email_campaign.rb', line 400

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = UltracartClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



471
472
473
474
475
476
477
478
479
480
481
482
483
 
# File 'lib/ultracart_api/models/email_campaign.rb', line 471

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



376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/ultracart_api/models/email_campaign.rb', line 376

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif 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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


356
357
358
 
# File 'lib/ultracart_api/models/email_campaign.rb', line 356

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



362
363
364
 
# File 'lib/ultracart_api/models/email_campaign.rb', line 362

def hash
  [click_rate_formatted, created_dts, deleted, email_campaign_uuid, email_communication_sequence_uuid, end_once_customer_purchases, end_once_customer_purchases_anywhere, esp_campaign_folder_uuid, esp_domain_user, esp_domain_uuid, esp_friendly_name, library_item_oid, memberships, merchant_id, name, open_rate_formatted, prevent_sending_due_to_spam, revenue_formatted, revenue_per_customer_formatted, scheduled_dts, screenshot_large_full_url, sms_esp_twilio_uuid, sms_phone_number, status, status_dts, storefront_oid].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



295
296
297
298
299
300
301
302
 
# File 'lib/ultracart_api/models/email_campaign.rb', line 295

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



447
448
449
 
# File 'lib/ultracart_api/models/email_campaign.rb', line 447

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



453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/ultracart_api/models/email_campaign.rb', line 453

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



441
442
443
 
# File 'lib/ultracart_api/models/email_campaign.rb', line 441

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



306
307
308
309
 
# File 'lib/ultracart_api/models/email_campaign.rb', line 306

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