class UltracartClient::EmailCampaign

Attributes

click_rate_formatted[RW]

Click rate of emails

created_dts[RW]

Created date

deleted[RW]

True if this campaign was deleted

email_campaign_uuid[RW]

Email campaign UUID

email_communication_sequence_uuid[RW]

Email communication sequence UUID

end_once_customer_purchases[RW]

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

end_once_customer_purchases_anywhere[RW]

True if the customer should end the flow once they purchase from anywhere

esp_campaign_folder_uuid[RW]

Campaign folder UUID. Null for uncategorized

esp_domain_user[RW]

User of the sending address

esp_domain_uuid[RW]

UUID of the sending domain

esp_friendly_name[RW]

Friendly name of the sending email

library_item_oid[RW]

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.

memberships[RW]

List and segment memberships

merchant_id[RW]

Merchant ID

name[RW]

Name of email campaign

open_rate_formatted[RW]

Open rate of emails

prevent_sending_due_to_spam[RW]

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

revenue_formatted[RW]

Revenue associated with campaign

revenue_per_customer_formatted[RW]

Revenue per customer associated with campaign

scheduled_dts[RW]

Scheduled date

screenshot_large_full_url[RW]

URL to a large full length screenshot

status[RW]

Status of the campaign of draft, archived, and sent

status_dts[RW]

Timestamp when the last status change happened

storefront_oid[RW]

Storefront oid

Public Class Methods

attribute_map() click to toggle source

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

# File lib/ultracart_api/models/email_campaign.rb, line 90
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',
    :'status' => :'status',
    :'status_dts' => :'status_dts',
    :'storefront_oid' => :'storefront_oid'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/ultracart_api/models/email_campaign.rb, line 151
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?(:'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_campaign_uuid')
    self.email_campaign_uuid = attributes[:'email_campaign_uuid']
  end

  if attributes.has_key?(:'email_communication_sequence_uuid')
    self.email_communication_sequence_uuid = attributes[:'email_communication_sequence_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?(:'esp_campaign_folder_uuid')
    self.esp_campaign_folder_uuid = attributes[:'esp_campaign_folder_uuid']
  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_friendly_name')
    self.esp_friendly_name = attributes[:'esp_friendly_name']
  end

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

  if attributes.has_key?(:'memberships')
    if (value = attributes[:'memberships']).is_a?(Array)
      self.memberships = value
    end
  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?(:'prevent_sending_due_to_spam')
    self.prevent_sending_due_to_spam = attributes[:'prevent_sending_due_to_spam']
  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?(:'scheduled_dts')
    self.scheduled_dts = attributes[:'scheduled_dts']
  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
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/ultracart_api/models/email_campaign.rb, line 120
def self.swagger_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',
    :'status' => :'String',
    :'status_dts' => :'String',
    :'storefront_oid' => :'Integer'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/ultracart_api/models/email_campaign.rb, line 286
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 &&
      status == o.status &&
      status_dts == o.status_dts &&
      storefront_oid == o.storefront_oid
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/ultracart_api/models/email_campaign.rb, line 351
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) 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/ultracart_api/models/email_campaign.rb, line 417
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/ultracart_api/models/email_campaign.rb, line 330
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/ultracart_api/models/email_campaign.rb, line 317
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/ultracart_api/models/email_campaign.rb, line 323
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, status, status_dts, storefront_oid].hash
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/ultracart_api/models/email_campaign.rb, line 258
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
name=(name) click to toggle source

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

# File lib/ultracart_api/models/email_campaign.rb, line 276
def name=(name)
  if !name.nil? && name.to_s.length > 250
    fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 250.'
  end

  @name = name
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/ultracart_api/models/email_campaign.rb, line 397
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/ultracart_api/models/email_campaign.rb, line 403
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/ultracart_api/models/email_campaign.rb, line 391
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/ultracart_api/models/email_campaign.rb, line 269
def valid?
  return false if !@name.nil? && @name.to_s.length > 250
  true
end