Class: BrevoRuby::CreateEmailCampaign

Inherits:
Object
  • Object
show all
Defined in:
lib/brevo-ruby/models/create_email_campaign.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateEmailCampaign

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
292
293
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
331
332
333
334
 
# File 'lib/brevo-ruby/models/create_email_campaign.rb', line 201

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?(:'templateId')
    self.template_id = attributes[:'templateId']
  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?(:'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']
  else
    self.send_at_best_time = false
  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

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

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

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

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

  if attributes.has_key?(:'updateFormId')
    self.update_form_id = attributes[:'updateFormId']
  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 when abTesting is set to true. ‘subjectA’ & ‘subjectB’ are mandatory together & ‘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



73
74
75
 
# File 'lib/brevo-ruby/models/create_email_campaign.rb', line 73

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



49
50
51
 
# File 'lib/brevo-ruby/models/create_email_campaign.rb', line 49

def attachment_url
  @attachment_url
end

#footer ⇒ Object

Footer of the email campaign



58
59
60
 
# File 'lib/brevo-ruby/models/create_email_campaign.rb', line 58

def footer
  @footer
end

#header ⇒ Object

Header of the email campaign



61
62
63
 
# File 'lib/brevo-ruby/models/create_email_campaign.rb', line 61

def header
  @header
end

#html_content ⇒ Object

Mandatory if htmlUrl and templateId are empty. Body of the message (HTML)



26
27
28
 
# File 'lib/brevo-ruby/models/create_email_campaign.rb', line 26

def html_content
  @html_content
end

#html_url ⇒ Object

Mandatory if htmlContent and templateId are empty. Url to the message (HTML)



29
30
31
 
# File 'lib/brevo-ruby/models/create_email_campaign.rb', line 29

def html_url
  @html_url
end

#increase_rate ⇒ Object

Mandatory if ipWarmupEnable is set to true. Set a percentage increase rate for warming up your ip. We recommend you set the increase rate to 30% per day. If you want to send the same number of emails every day, set the daily increase value to 0%.



97
98
99
 
# File 'lib/brevo-ruby/models/create_email_campaign.rb', line 97

def increase_rate
  @increase_rate
end

#initial_quota ⇒ Object

Mandatory if ipWarmupEnable is set to true. Set an initial quota greater than 1 for warming up your ip. We recommend you set a value of 3000.



94
95
96
 
# File 'lib/brevo-ruby/models/create_email_campaign.rb', line 94

def initial_quota
  @initial_quota
end

#inline_image_activation ⇒ Object

Use true to embedded the images in your email. Final size of the email should be less than 4MB. Campaigns with embedded images can not be sent to more than 5000 contacts



52
53
54
 
# File 'lib/brevo-ruby/models/create_email_campaign.rb', line 52

def inline_image_activation
  @inline_image_activation
end

#ip_warmup_enable ⇒ Object

Available for dedicated ip clients. Set this to true if you wish to warm up your ip.



91
92
93
 
# File 'lib/brevo-ruby/models/create_email_campaign.rb', line 91

def ip_warmup_enable
  @ip_warmup_enable
end

#mirror_active ⇒ Object

Use true to enable the mirror link



55
56
57
 
# File 'lib/brevo-ruby/models/create_email_campaign.rb', line 55

def mirror_active
  @mirror_active
end

#name ⇒ Object

Name of the campaign



23
24
25
 
# File 'lib/brevo-ruby/models/create_email_campaign.rb', line 23

def name
  @name
end

#params ⇒ Object

Pass the set of attributes to customize the type classic campaign. For example, "LNAME":"Doe". Only available if ‘type’ is ‘classic’. It’s considered only if campaign is in New Template Language format. The New Template Language is dependent on the values of ‘subject’, ‘htmlContent/htmlUrl’, ‘sender.name’ & ‘toField’



67
68
69
 
# File 'lib/brevo-ruby/models/create_email_campaign.rb', line 67

def params
  @params
end

#recipients ⇒ Object

Returns the value of attribute recipients.



46
47
48
 
# File 'lib/brevo-ruby/models/create_email_campaign.rb', line 46

def recipients
  @recipients
end

#reply_to ⇒ Object

Email on which the campaign recipients will be able to reply to



41
42
43
 
# File 'lib/brevo-ruby/models/create_email_campaign.rb', line 41

def reply_to
  @reply_to
end

#scheduled_at ⇒ Object

Sending UTC date-time (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).



35
36
37
 
# File 'lib/brevo-ruby/models/create_email_campaign.rb', line 35

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.



70
71
72
 
# File 'lib/brevo-ruby/models/create_email_campaign.rb', line 70

def send_at_best_time
  @send_at_best_time
end

#sender ⇒ Object

Returns the value of attribute sender.



20
21
22
 
# File 'lib/brevo-ruby/models/create_email_campaign.rb', line 20

def sender
  @sender
end

#split_rule ⇒ Object

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



82
83
84
 
# File 'lib/brevo-ruby/models/create_email_campaign.rb', line 82

def split_rule
  @split_rule
end

#subject ⇒ Object

Subject of the campaign. Mandatory if abTesting is false. Ignored if abTesting is true.



38
39
40
 
# File 'lib/brevo-ruby/models/create_email_campaign.rb', line 38

def subject
  @subject
end

#subject_a ⇒ Object

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



76
77
78
 
# File 'lib/brevo-ruby/models/create_email_campaign.rb', line 76

def subject_a
  @subject_a
end

#subject_b ⇒ Object

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



79
80
81
 
# File 'lib/brevo-ruby/models/create_email_campaign.rb', line 79

def subject_b
  @subject_b
end

#tag ⇒ Object

Tag of the campaign



18
19
20
 
# File 'lib/brevo-ruby/models/create_email_campaign.rb', line 18

def tag
  @tag
end

#template_id ⇒ Object

Mandatory if htmlContent and htmlUrl are empty. Id of the transactional email template with status ‘active’. Used to copy only its content fetched from htmlContent/htmlUrl to an email campaign for RSS feature.



32
33
34
 
# File 'lib/brevo-ruby/models/create_email_campaign.rb', line 32

def template_id
  @template_id
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 Brevo account. If input parameter ‘params’ used please use BrevoRuby::CreateEmailCampaign.{contact{contact.FNAME} BrevoRuby::CreateEmailCampaign.{contact{contact.LNAME} for personalization



44
45
46
 
# File 'lib/brevo-ruby/models/create_email_campaign.rb', line 44

def to_field
  @to_field
end

#unsubscription_page_id ⇒ Object

Enter an unsubscription page id. The page id is a 24 digit alphanumeric id that can be found in the URL when editing the page. If not entered, then the default unsubscription page will be used.



100
101
102
 
# File 'lib/brevo-ruby/models/create_email_campaign.rb', line 100

def unsubscription_page_id
  @unsubscription_page_id
end

#update_form_id ⇒ Object

Mandatory if templateId is used containing the update_profile } tag. Enter an update profile form id. The form id is a 24 digit alphanumeric id that can be found in the URL when editing the form. If not entered, then the default update profile form will be used.



103
104
105
 
# File 'lib/brevo-ruby/models/create_email_campaign.rb', line 103

def update_form_id
  @update_form_id
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



64
65
66
 
# File 'lib/brevo-ruby/models/create_email_campaign.rb', line 64

def utm_campaign
  @utm_campaign
end

#winner_criteria ⇒ Object

Choose the metrics that will determinate the winning version. Mandatory if ‘splitRule’ >= 1 and < 50. If splitRule = 50, ‘winnerCriteria’ is ignored if passed



85
86
87
 
# File 'lib/brevo-ruby/models/create_email_campaign.rb', line 85

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. Mandatory if ‘splitRule’ >= 1 and < 50. If splitRule = 50, ‘winnerDelay’ is ignored if passed



88
89
90
 
# File 'lib/brevo-ruby/models/create_email_campaign.rb', line 88

def winner_delay
  @winner_delay
end

Class Method Details

.attribute_map ⇒ Object

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



128
129
130
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
 
# File 'lib/brevo-ruby/models/create_email_campaign.rb', line 128

def self.attribute_map
  {
    :'tag' => :'tag',
    :'sender' => :'sender',
    :'name' => :'name',
    :'html_content' => :'htmlContent',
    :'html_url' => :'htmlUrl',
    :'template_id' => :'templateId',
    :'scheduled_at' => :'scheduledAt',
    :'subject' => :'subject',
    :'reply_to' => :'replyTo',
    :'to_field' => :'toField',
    :'recipients' => :'recipients',
    :'attachment_url' => :'attachmentUrl',
    :'inline_image_activation' => :'inlineImageActivation',
    :'mirror_active' => :'mirrorActive',
    :'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',
    :'ip_warmup_enable' => :'ipWarmupEnable',
    :'initial_quota' => :'initialQuota',
    :'increase_rate' => :'increaseRate',
    :'unsubscription_page_id' => :'unsubscriptionPageId',
    :'update_form_id' => :'updateFormId'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/brevo-ruby/models/create_email_campaign.rb', line 164

def self.swagger_types
  {
    :'tag' => :'String',
    :'sender' => :'CreateEmailCampaignSender',
    :'name' => :'String',
    :'html_content' => :'String',
    :'html_url' => :'String',
    :'template_id' => :'Integer',
    :'scheduled_at' => :'String',
    :'subject' => :'String',
    :'reply_to' => :'String',
    :'to_field' => :'String',
    :'recipients' => :'CreateEmailCampaignRecipients',
    :'attachment_url' => :'String',
    :'inline_image_activation' => :'BOOLEAN',
    :'mirror_active' => :'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',
    :'ip_warmup_enable' => :'BOOLEAN',
    :'initial_quota' => :'Integer',
    :'increase_rate' => :'Integer',
    :'unsubscription_page_id' => :'String',
    :'update_form_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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
471
472
473
474
475
476
477
478
 
# File 'lib/brevo-ruby/models/create_email_campaign.rb', line 445

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 &&
      template_id == o.template_id &&
      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 &&
      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 &&
      ip_warmup_enable == o.ip_warmup_enable &&
      initial_quota == o.initial_quota &&
      increase_rate == o.increase_rate &&
      unsubscription_page_id == o.unsubscription_page_id &&
      update_form_id == o.update_form_id
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



516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
 
# File 'lib/brevo-ruby/models/create_email_campaign.rb', line 516

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



582
583
584
585
586
587
588
589
590
591
592
593
594
 
# File 'lib/brevo-ruby/models/create_email_campaign.rb', line 582

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



495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
 
# File 'lib/brevo-ruby/models/create_email_campaign.rb', line 495

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


482
483
484
 
# File 'lib/brevo-ruby/models/create_email_campaign.rb', line 482

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



488
489
490
 
# File 'lib/brevo-ruby/models/create_email_campaign.rb', line 488

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



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/brevo-ruby/models/create_email_campaign.rb', line 338

def list_invalid_properties
  invalid_properties = Array.new
  if @sender.nil?
    invalid_properties.push('invalid value for "sender", sender cannot be nil.')
  end

  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  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

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

  if !@increase_rate.nil? && @increase_rate < 0
    invalid_properties.push('invalid value for "increase_rate", must be greater than or equal to 0.')
  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



562
563
564
 
# File 'lib/brevo-ruby/models/create_email_campaign.rb', line 562

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



568
569
570
571
572
573
574
575
576
 
# File 'lib/brevo-ruby/models/create_email_campaign.rb', line 568

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



556
557
558
 
# File 'lib/brevo-ruby/models/create_email_campaign.rb', line 556

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



377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/brevo-ruby/models/create_email_campaign.rb', line 377

def valid?
  return false if @sender.nil?
  return false if @name.nil?
  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 false if !@increase_rate.nil? && @increase_rate > 100
  return false if !@increase_rate.nil? && @increase_rate < 0
  true
end