Class: ElasticEmail::CampaignOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/ElasticEmail/models/campaign_options.rb

Overview

Different send options for a Campaign

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CampaignOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/ElasticEmail/models/campaign_options.rb', line 70

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

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

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

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

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

Instance Attribute Details

#delivery_optimization ⇒ Object

Returns the value of attribute delivery_optimization.



19
20
21
 
# File 'lib/ElasticEmail/models/campaign_options.rb', line 19

def delivery_optimization
  @delivery_optimization
end

#schedule_for ⇒ Object

Date when this Campaign is scheduled to be sent on



28
29
30
 
# File 'lib/ElasticEmail/models/campaign_options.rb', line 28

def schedule_for
  @schedule_for
end

#split_options ⇒ Object

Returns the value of attribute split_options.



30
31
32
 
# File 'lib/ElasticEmail/models/campaign_options.rb', line 30

def split_options
  @split_options
end

#track_clicks ⇒ Object

Should the clicks be tracked? If no value has been provided, Account's default setting will be used.



25
26
27
 
# File 'lib/ElasticEmail/models/campaign_options.rb', line 25

def track_clicks
  @track_clicks
end

#track_opens ⇒ Object

Should the opens be tracked? If no value has been provided, Account's default setting will be used.



22
23
24
 
# File 'lib/ElasticEmail/models/campaign_options.rb', line 22

def track_opens
  @track_opens
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



44
45
46
 
# File 'lib/ElasticEmail/models/campaign_options.rb', line 44

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
40
41
 
# File 'lib/ElasticEmail/models/campaign_options.rb', line 33

def self.attribute_map
  {
    :'delivery_optimization' => :'DeliveryOptimization',
    :'track_opens' => :'TrackOpens',
    :'track_clicks' => :'TrackClicks',
    :'schedule_for' => :'ScheduleFor',
    :'split_options' => :'SplitOptions'
  }
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



146
147
148
 
# File 'lib/ElasticEmail/models/campaign_options.rb', line 146

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



60
61
62
63
64
65
66
 
# File 'lib/ElasticEmail/models/campaign_options.rb', line 60

def self.openapi_nullable
  Set.new([
    :'track_opens',
    :'track_clicks',
    :'schedule_for',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



49
50
51
52
53
54
55
56
57
 
# File 'lib/ElasticEmail/models/campaign_options.rb', line 49

def self.openapi_types
  {
    :'delivery_optimization' => :'DeliveryOptimizationType',
    :'track_opens' => :'Boolean',
    :'track_clicks' => :'Boolean',
    :'schedule_for' => :'Time',
    :'split_options' => :'SplitOptions'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



121
122
123
124
125
126
127
128
129
 
# File 'lib/ElasticEmail/models/campaign_options.rb', line 121

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      delivery_optimization == o.delivery_optimization &&
      track_opens == o.track_opens &&
      track_clicks == o.track_clicks &&
      schedule_for == o.schedule_for &&
      split_options == o.split_options
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



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
 
# File 'lib/ElasticEmail/models/campaign_options.rb', line 177

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



248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/ElasticEmail/models/campaign_options.rb', line 248

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



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/ElasticEmail/models/campaign_options.rb', line 153

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


133
134
135
 
# File 'lib/ElasticEmail/models/campaign_options.rb', line 133

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



139
140
141
 
# File 'lib/ElasticEmail/models/campaign_options.rb', line 139

def hash
  [delivery_optimization, track_opens, track_clicks, schedule_for, split_options].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



108
109
110
111
 
# File 'lib/ElasticEmail/models/campaign_options.rb', line 108

def list_invalid_properties
  invalid_properties = Array.new
  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



224
225
226
 
# File 'lib/ElasticEmail/models/campaign_options.rb', line 224

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



230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/ElasticEmail/models/campaign_options.rb', line 230

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



218
219
220
 
# File 'lib/ElasticEmail/models/campaign_options.rb', line 218

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



115
116
117
 
# File 'lib/ElasticEmail/models/campaign_options.rb', line 115

def valid?
  true
end