class SibApiV3Sdk::CreateEmailCampaign

Attributes

ab_testing[RW]

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

attachment_url[RW]

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

header[RW]

Header of the email campaign

html_content[RW]

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

html_url[RW]

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

increase_rate[RW]

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

initial_quota[RW]

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.

inline_image_activation[RW]

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

ip_warmup_enable[RW]

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

mirror_active[RW]

Use true to enable the mirror link

name[RW]

Name of the campaign

params[RW]

Pass the set of attributes to customize the type classic campaign. For example, {"FNAME":"Joe", "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'

recipients[RW]
reply_to[RW]

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

scheduled_at[RW]

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

send_at_best_time[RW]

Set this to true if you want to send your campaign at best time.

sender[RW]
split_rule[RW]

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

subject[RW]

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

subject_a[RW]

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

subject_b[RW]

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

tag[RW]

Tag of the campaign

template_id[RW]

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.

to_field[RW]

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 {{contact.FNAME}} {{contact.LNAME}} for personalization

utm_campaign[RW]

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

winner_criteria[RW]

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

winner_delay[RW]

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

Public Class Methods

attribute_map() click to toggle source

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

# File lib/sib-api-v3-sdk/models/create_email_campaign.rb, line 122
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'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/sib-api-v3-sdk/models/create_email_campaign.rb, line 191
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
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/sib-api-v3-sdk/models/create_email_campaign.rb, line 156
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'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/sib-api-v3-sdk/models/create_email_campaign.rb, line 427
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
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/sib-api-v3-sdk/models/create_email_campaign.rb, line 496
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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/sib-api-v3-sdk/models/create_email_campaign.rb, line 562
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/sib-api-v3-sdk/models/create_email_campaign.rb, line 475
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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/sib-api-v3-sdk/models/create_email_campaign.rb, line 462
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/sib-api-v3-sdk/models/create_email_campaign.rb, line 468
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].hash
end
increase_rate=(increase_rate) click to toggle source

Custom attribute writer method with validation @param [Object] increase_rate Value to be assigned

# File lib/sib-api-v3-sdk/models/create_email_campaign.rb, line 413
def increase_rate=(increase_rate)
  if !increase_rate.nil? && increase_rate > 100
    fail ArgumentError, 'invalid value for "increase_rate", must be smaller than or equal to 100.'
  end

  if !increase_rate.nil? && increase_rate < 0
    fail ArgumentError, 'invalid value for "increase_rate", must be greater than or equal to 0.'
  end

  @increase_rate = increase_rate
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/sib-api-v3-sdk/models/create_email_campaign.rb, line 320
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
split_rule=(split_rule) click to toggle source

Custom attribute writer method with validation @param [Object] split_rule Value to be assigned

# File lib/sib-api-v3-sdk/models/create_email_campaign.rb, line 375
def split_rule=(split_rule)
  if !split_rule.nil? && split_rule > 50
    fail ArgumentError, 'invalid value for "split_rule", must be smaller than or equal to 50.'
  end

  if !split_rule.nil? && split_rule < 1
    fail ArgumentError, 'invalid value for "split_rule", must be greater than or equal to 1.'
  end

  @split_rule = split_rule
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/sib-api-v3-sdk/models/create_email_campaign.rb, line 542
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/sib-api-v3-sdk/models/create_email_campaign.rb, line 548
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/sib-api-v3-sdk/models/create_email_campaign.rb, line 536
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/sib-api-v3-sdk/models/create_email_campaign.rb, line 359
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
winner_criteria=(winner_criteria) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] winner_criteria Object to be assigned

# File lib/sib-api-v3-sdk/models/create_email_campaign.rb, line 389
def winner_criteria=(winner_criteria)
  validator = EnumAttributeValidator.new('String', ['open', 'click'])
  unless validator.valid?(winner_criteria)
    fail ArgumentError, 'invalid value for "winner_criteria", must be one of #{validator.allowable_values}.'
  end
  @winner_criteria = winner_criteria
end
winner_delay=(winner_delay) click to toggle source

Custom attribute writer method with validation @param [Object] winner_delay Value to be assigned

# File lib/sib-api-v3-sdk/models/create_email_campaign.rb, line 399
def winner_delay=(winner_delay)
  if !winner_delay.nil? && winner_delay > 168
    fail ArgumentError, 'invalid value for "winner_delay", must be smaller than or equal to 168.'
  end

  if !winner_delay.nil? && winner_delay < 1
    fail ArgumentError, 'invalid value for "winner_delay", must be greater than or equal to 1.'
  end

  @winner_delay = winner_delay
end