Class: SibApiV3Sdk::UpdateEmailCampaign

Inherits:
Object
  • Object
show all
Defined in:
lib/sib-api-v3-sdk/models/update_email_campaign.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateEmailCampaign

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/sib-api-v3-sdk/models/update_email_campaign.rb', line 177

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'inlineImageActivation')
    self.inline_image_activation = attributes[:'inlineImageActivation']
  else
    self.inline_image_activation = false
  end

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

  if attributes.has_key?(:'recurring')
    self.recurring = attributes[:'recurring']
  else
    self.recurring = false
  end

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

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

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

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

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

  if attributes.has_key?(:'abTesting')
    self.ab_testing = attributes[:'abTesting']
  else
    self.ab_testing = false
  end

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

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

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

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

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

end

Instance Attribute Details

#ab_testing ⇒ Object

Status of A/B Test. abTesting = false means it is disabled, & abTesting = true means it is enabled. ‘subjectA’, ‘subjectB’, ‘splitRule’, ‘winnerCriteria’ & ‘winnerDelay’ will be considered if abTesting is set to true. ‘subject’ if passed is ignored. Can be set to true only if ‘sendAtBestTime’ is ‘false’. You will be able to set up two subject lines for your campaign and send them to a random sample of your total recipients. Half of the test group will receive version A, and the other half will receive version B



74
75
76
 
# File 'lib/sib-api-v3-sdk/models/update_email_campaign.rb', line 74

def ab_testing
  @ab_testing
end

#attachment_url ⇒ Object

Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps



47
48
49
 
# File 'lib/sib-api-v3-sdk/models/update_email_campaign.rb', line 47

def attachment_url
  @attachment_url
end

#footer ⇒ Object

Footer of the email campaign



59
60
61
 
# File 'lib/sib-api-v3-sdk/models/update_email_campaign.rb', line 59

def footer
  @footer
end

#header ⇒ Object

Header of the email campaign



62
63
64
 
# File 'lib/sib-api-v3-sdk/models/update_email_campaign.rb', line 62

def header
  @header
end

#html_content ⇒ Object

Body of the message (HTML version). REQUIRED if htmlUrl is empty



27
28
29
 
# File 'lib/sib-api-v3-sdk/models/update_email_campaign.rb', line 27

def html_content
  @html_content
end

#html_url ⇒ Object

Url which contents the body of the email message. REQUIRED if htmlContent is empty



30
31
32
 
# File 'lib/sib-api-v3-sdk/models/update_email_campaign.rb', line 30

def html_url
  @html_url
end

#inline_image_activation ⇒ Object

Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. You cannot send a campaign of more than 4MB with images embedded in the email. Campaigns with the images embedded in the email must be sent to less than 5000 contacts.



50
51
52
 
# File 'lib/sib-api-v3-sdk/models/update_email_campaign.rb', line 50

def inline_image_activation
  @inline_image_activation
end

#mirror_active ⇒ Object

Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign



53
54
55
 
# File 'lib/sib-api-v3-sdk/models/update_email_campaign.rb', line 53

def mirror_active
  @mirror_active
end

#name ⇒ Object

Name of the campaign



24
25
26
 
# File 'lib/sib-api-v3-sdk/models/update_email_campaign.rb', line 24

def name
  @name
end

#params ⇒ Object

Pass the set of attributes to customize the type ‘classic’ campaign. For example, ‘LNAME’:‘Doe’. The ‘params’ field will get updated, only if the campaign is in New Template Language, else ignored. The New Template Language is dependent on the values of ‘subject’, ‘htmlContent/htmlUrl’, ‘sender.name’ & ‘toField’



68
69
70
 
# File 'lib/sib-api-v3-sdk/models/update_email_campaign.rb', line 68

def params
  @params
end

#recipients ⇒ Object

Returns the value of attribute recipients.



44
45
46
 
# File 'lib/sib-api-v3-sdk/models/update_email_campaign.rb', line 44

def recipients
  @recipients
end

#recurring ⇒ Object

FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times



56
57
58
 
# File 'lib/sib-api-v3-sdk/models/update_email_campaign.rb', line 56

def recurring
  @recurring
end

#reply_to ⇒ Object

Email on which campaign recipients will be able to reply to



39
40
41
 
# File 'lib/sib-api-v3-sdk/models/update_email_campaign.rb', line 39

def reply_to
  @reply_to
end

#scheduled_at ⇒ Object

UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part).



33
34
35
 
# File 'lib/sib-api-v3-sdk/models/update_email_campaign.rb', line 33

def scheduled_at
  @scheduled_at
end

#send_at_best_time ⇒ Object

Set this to true if you want to send your campaign at best time. Note:- if true, warmup ip will be disabled.



71
72
73
 
# File 'lib/sib-api-v3-sdk/models/update_email_campaign.rb', line 71

def send_at_best_time
  @send_at_best_time
end

#sender ⇒ Object

Returns the value of attribute sender.



21
22
23
 
# File 'lib/sib-api-v3-sdk/models/update_email_campaign.rb', line 21

def sender
  @sender
end

#split_rule ⇒ Object

Add the size of your test groups. Considered if abTesting = true. We’ll send version A and B to a random sample of recipients, and then the winning version to everyone else



83
84
85
 
# File 'lib/sib-api-v3-sdk/models/update_email_campaign.rb', line 83

def split_rule
  @split_rule
end

#subject ⇒ Object

Subject of the campaign



36
37
38
 
# File 'lib/sib-api-v3-sdk/models/update_email_campaign.rb', line 36

def subject
  @subject
end

#subject_a ⇒ Object

Subject A of the campaign. Considered if abTesting = true. subjectA & subjectB should have unique value



77
78
79
 
# File 'lib/sib-api-v3-sdk/models/update_email_campaign.rb', line 77

def subject_a
  @subject_a
end

#subject_b ⇒ Object

Subject B of the campaign. Considered if abTesting = true. subjectA & subjectB should have unique value



80
81
82
 
# File 'lib/sib-api-v3-sdk/models/update_email_campaign.rb', line 80

def subject_b
  @subject_b
end

#tag ⇒ Object

Tag of the campaign



19
20
21
 
# File 'lib/sib-api-v3-sdk/models/update_email_campaign.rb', line 19

def tag
  @tag
end

#to_field ⇒ Object

To personalize the «To» Field. If you want to include the first name and last name of your recipient, add FNAME LNAME. These contact attributes must already exist in your SendinBlue account. If input parameter ‘params’ used please use SibApiV3Sdk::UpdateEmailCampaign.{contact{contact.FNAME} SibApiV3Sdk::UpdateEmailCampaign.{contact{contact.LNAME} for personalization



42
43
44
 
# File 'lib/sib-api-v3-sdk/models/update_email_campaign.rb', line 42

def to_field
  @to_field
end

#utm_campaign ⇒ Object

Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed



65
66
67
 
# File 'lib/sib-api-v3-sdk/models/update_email_campaign.rb', line 65

def utm_campaign
  @utm_campaign
end

#winner_criteria ⇒ Object

Choose the metrics that will determinate the winning version. Considered if ‘splitRule’ >= 1 and < 50. If splitRule = 50, ‘winnerCriteria’ is ignored if passed or alreday exist in record



86
87
88
 
# File 'lib/sib-api-v3-sdk/models/update_email_campaign.rb', line 86

def winner_criteria
  @winner_criteria
end

#winner_delay ⇒ Object

Choose the duration of the test in hours. Maximum is 7 days, pass 24*7 = 168 hours. The winning version will be sent at the end of the test. Considered if ‘splitRule’ >= 1 and < 50. If splitRule = 50, ‘winnerDelay’ is ignored if passed or alreday exist in record



89
90
91
 
# File 'lib/sib-api-v3-sdk/models/update_email_campaign.rb', line 89

def winner_delay
  @winner_delay
end

Class Method Details

.attribute_map ⇒ Object

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



114
115
116
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
 
# File 'lib/sib-api-v3-sdk/models/update_email_campaign.rb', line 114

def self.attribute_map
  {
    :'tag' => :'tag',
    :'sender' => :'sender',
    :'name' => :'name',
    :'html_content' => :'htmlContent',
    :'html_url' => :'htmlUrl',
    :'scheduled_at' => :'scheduledAt',
    :'subject' => :'subject',
    :'reply_to' => :'replyTo',
    :'to_field' => :'toField',
    :'recipients' => :'recipients',
    :'attachment_url' => :'attachmentUrl',
    :'inline_image_activation' => :'inlineImageActivation',
    :'mirror_active' => :'mirrorActive',
    :'recurring' => :'recurring',
    :'footer' => :'footer',
    :'header' => :'header',
    :'utm_campaign' => :'utmCampaign',
    :'params' => :'params',
    :'send_at_best_time' => :'sendAtBestTime',
    :'ab_testing' => :'abTesting',
    :'subject_a' => :'subjectA',
    :'subject_b' => :'subjectB',
    :'split_rule' => :'splitRule',
    :'winner_criteria' => :'winnerCriteria',
    :'winner_delay' => :'winnerDelay'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/sib-api-v3-sdk/models/update_email_campaign.rb', line 145

def self.swagger_types
  {
    :'tag' => :'String',
    :'sender' => :'UpdateEmailCampaignSender',
    :'name' => :'String',
    :'html_content' => :'String',
    :'html_url' => :'String',
    :'scheduled_at' => :'DateTime',
    :'subject' => :'String',
    :'reply_to' => :'String',
    :'to_field' => :'String',
    :'recipients' => :'UpdateEmailCampaignRecipients',
    :'attachment_url' => :'String',
    :'inline_image_activation' => :'BOOLEAN',
    :'mirror_active' => :'BOOLEAN',
    :'recurring' => :'BOOLEAN',
    :'footer' => :'String',
    :'header' => :'String',
    :'utm_campaign' => :'String',
    :'params' => :'Object',
    :'send_at_best_time' => :'BOOLEAN',
    :'ab_testing' => :'BOOLEAN',
    :'subject_a' => :'String',
    :'subject_b' => :'String',
    :'split_rule' => :'Integer',
    :'winner_criteria' => :'String',
    :'winner_delay' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/sib-api-v3-sdk/models/update_email_campaign.rb', line 368

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      tag == o.tag &&
      sender == o.sender &&
      name == o.name &&
      html_content == o.html_content &&
      html_url == o.html_url &&
      scheduled_at == o.scheduled_at &&
      subject == o.subject &&
      reply_to == o.reply_to &&
      to_field == o.to_field &&
      recipients == o.recipients &&
      attachment_url == o.attachment_url &&
      inline_image_activation == o.inline_image_activation &&
      mirror_active == o.mirror_active &&
      recurring == o.recurring &&
      footer == o.footer &&
      header == o.header &&
      utm_campaign == o.utm_campaign &&
      params == o.params &&
      send_at_best_time == o.send_at_best_time &&
      ab_testing == o.ab_testing &&
      subject_a == o.subject_a &&
      subject_b == o.subject_b &&
      split_rule == o.split_rule &&
      winner_criteria == o.winner_criteria &&
      winner_delay == o.winner_delay
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



434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
 
# File 'lib/sib-api-v3-sdk/models/update_email_campaign.rb', line 434

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



500
501
502
503
504
505
506
507
508
509
510
511
512
 
# File 'lib/sib-api-v3-sdk/models/update_email_campaign.rb', line 500

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



413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/sib-api-v3-sdk/models/update_email_campaign.rb', line 413

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 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


400
401
402
 
# File 'lib/sib-api-v3-sdk/models/update_email_campaign.rb', line 400

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



406
407
408
 
# File 'lib/sib-api-v3-sdk/models/update_email_campaign.rb', line 406

def hash
  [tag, sender, name, html_content, html_url, scheduled_at, subject, reply_to, to_field, recipients, attachment_url, inline_image_activation, mirror_active, recurring, footer, header, utm_campaign, params, send_at_best_time, ab_testing, subject_a, subject_b, split_rule, winner_criteria, winner_delay].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



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/sib-api-v3-sdk/models/update_email_campaign.rb', line 293

def list_invalid_properties
  invalid_properties = Array.new
  if !@split_rule.nil? && @split_rule > 50
    invalid_properties.push("invalid value for 'split_rule', must be smaller than or equal to 50.")
  end

  if !@split_rule.nil? && @split_rule < 1
    invalid_properties.push("invalid value for 'split_rule', must be greater than or equal to 1.")
  end

  if !@winner_delay.nil? && @winner_delay > 168
    invalid_properties.push("invalid value for 'winner_delay', must be smaller than or equal to 168.")
  end

  if !@winner_delay.nil? && @winner_delay < 1
    invalid_properties.push("invalid value for 'winner_delay', must be greater than or equal to 1.")
  end

  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



480
481
482
 
# File 'lib/sib-api-v3-sdk/models/update_email_campaign.rb', line 480

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



486
487
488
489
490
491
492
493
494
 
# File 'lib/sib-api-v3-sdk/models/update_email_campaign.rb', line 486

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



474
475
476
 
# File 'lib/sib-api-v3-sdk/models/update_email_campaign.rb', line 474

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



316
317
318
319
320
321
322
323
324
 
# File 'lib/sib-api-v3-sdk/models/update_email_campaign.rb', line 316

def valid?
  return false if !@split_rule.nil? && @split_rule > 50
  return false if !@split_rule.nil? && @split_rule < 1
  winner_criteria_validator = EnumAttributeValidator.new('String', ["open", "click"])
  return false unless winner_criteria_validator.valid?(@winner_criteria)
  return false if !@winner_delay.nil? && @winner_delay > 168
  return false if !@winner_delay.nil? && @winner_delay < 1
  return true
end