Class: ClickSendClient::EmailCampaign

Inherits:
Object
  • Object
show all
Defined in:
lib/clicksend_client/models/email_campaign.rb

Overview

Campaign Model for Email

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EmailCampaign

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
105
106
107
108
109
110
111
 
# File 'lib/clicksend_client/models/email_campaign.rb', line 72

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

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

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

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

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

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

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

  if attributes.has_key?(:'schedule')
    self.schedule = attributes[:'schedule']
  else
    self.schedule = 0
  end
end

Instance Attribute Details

#body ⇒ Object

Your campaign message.



25
26
27
 
# File 'lib/clicksend_client/models/email_campaign.rb', line 25

def body
  @body
end

#from_email_address_id ⇒ Object

The allowed email address id.



28
29
30
 
# File 'lib/clicksend_client/models/email_campaign.rb', line 28

def from_email_address_id
  @from_email_address_id
end

#from_name ⇒ Object

Your name or business name.



31
32
33
 
# File 'lib/clicksend_client/models/email_campaign.rb', line 31

def from_name
  @from_name
end

#list_id ⇒ Object

Your contact list id.



37
38
39
 
# File 'lib/clicksend_client/models/email_campaign.rb', line 37

def list_id
  @list_id
end

#name ⇒ Object

Your campaign name.



19
20
21
 
# File 'lib/clicksend_client/models/email_campaign.rb', line 19

def name
  @name
end

#schedule ⇒ Object

Your schedule timestamp.



40
41
42
 
# File 'lib/clicksend_client/models/email_campaign.rb', line 40

def schedule
  @schedule
end

#subject ⇒ Object

Your campaign subject.



22
23
24
 
# File 'lib/clicksend_client/models/email_campaign.rb', line 22

def subject
  @subject
end

#template_id ⇒ Object

Your template id.



34
35
36
 
# File 'lib/clicksend_client/models/email_campaign.rb', line 34

def template_id
  @template_id
end

Class Method Details

.attribute_map ⇒ Object

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



43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/clicksend_client/models/email_campaign.rb', line 43

def self.attribute_map
  {
    :'name' => :'name',
    :'subject' => :'subject',
    :'body' => :'body',
    :'from_email_address_id' => :'from_email_address_id',
    :'from_name' => :'from_name',
    :'template_id' => :'template_id',
    :'list_id' => :'list_id',
    :'schedule' => :'schedule'
  }
end

.clicksend_types ⇒ Object

Attribute type mapping.



57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/clicksend_client/models/email_campaign.rb', line 57

def self.clicksend_types
  {
    :'name' => :'String',
    :'subject' => :'String',
    :'body' => :'String',
    :'from_email_address_id' => :'Float',
    :'from_name' => :'String',
    :'template_id' => :'Float',
    :'list_id' => :'Float',
    :'schedule' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/clicksend_client/models/email_campaign.rb', line 158

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      subject == o.subject &&
      body == o.body &&
      from_email_address_id == o.from_email_address_id &&
      from_name == o.from_name &&
      template_id == o.template_id &&
      list_id == o.list_id &&
      schedule == o.schedule
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



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
 
# File 'lib/clicksend_client/models/email_campaign.rb', line 207

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



273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/clicksend_client/models/email_campaign.rb', line 273

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



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/clicksend_client/models/email_campaign.rb', line 186

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.clicksend_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


173
174
175
 
# File 'lib/clicksend_client/models/email_campaign.rb', line 173

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



179
180
181
 
# File 'lib/clicksend_client/models/email_campaign.rb', line 179

def hash
  [name, subject, body, from_email_address_id, from_name, template_id, list_id, schedule].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



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/clicksend_client/models/email_campaign.rb', line 115

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

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

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

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

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

  if @list_id.nil?
    invalid_properties.push('invalid value for "list_id", list_id cannot be nil.')
  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



253
254
255
 
# File 'lib/clicksend_client/models/email_campaign.rb', line 253

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



259
260
261
262
263
264
265
266
267
 
# File 'lib/clicksend_client/models/email_campaign.rb', line 259

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



247
248
249
 
# File 'lib/clicksend_client/models/email_campaign.rb', line 247

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



146
147
148
149
150
151
152
153
154
 
# File 'lib/clicksend_client/models/email_campaign.rb', line 146

def valid?
  return false if @name.nil?
  return false if @subject.nil?
  return false if @body.nil?
  return false if @from_email_address_id.nil?
  return false if @from_name.nil?
  return false if @list_id.nil?
  true
end