Class: ConstantContactClient::EmailCampaignActivityInput

Inherits:
Object
  • Object
show all
Defined in:
lib/constant_contact_client/models/email_campaign_activity_input.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EmailCampaignActivityInput

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/constant_contact_client/models/email_campaign_activity_input.rb', line 82

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

  if attributes.key?(:'from_name')
    self.from_name = attributes[:'from_name']
  else
    self.from_name = nil
  end

  if attributes.key?(:'from_email')
    self.from_email = attributes[:'from_email']
  else
    self.from_email = nil
  end

  if attributes.key?(:'reply_to_email')
    self.reply_to_email = attributes[:'reply_to_email']
  else
    self.reply_to_email = nil
  end

  if attributes.key?(:'subject')
    self.subject = attributes[:'subject']
  else
    self.subject = nil
  end

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

  if attributes.key?(:'html_content')
    self.html_content = attributes[:'html_content']
  else
    self.html_content = nil
  end

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

Instance Attribute Details

#format_type ⇒ Object

The email format you are using to create the email campaign activity. The V3 API supports creating emails using format_type 5 (custom code emails).



19
20
21
 
# File 'lib/constant_contact_client/models/email_campaign_activity_input.rb', line 19

def format_type
  @format_type
end

#from_email ⇒ Object

The sender’s email address to use for the email campaign activity. You must use a confirmed Constant Contact account email address. Make a GET call to /account/emails to return a collection of account emails and their confirmation status.



25
26
27
 
# File 'lib/constant_contact_client/models/email_campaign_activity_input.rb', line 25

def from_email
  @from_email
end

#from_name ⇒ Object

The email sender’s name to display for the email campaign activity.



22
23
24
 
# File 'lib/constant_contact_client/models/email_campaign_activity_input.rb', line 22

def from_name
  @from_name
end

#html_content ⇒ Object

The HTML content for the email campaign activity. Only format_type 5 (custom code emails) can contain html_content. When creating a format_type 5 custom code email, make sure that you include [[trackingImage]] in the <body> element of your HTML.



37
38
39
 
# File 'lib/constant_contact_client/models/email_campaign_activity_input.rb', line 37

def html_content
  @html_content
end

#physical_address_in_footer ⇒ Object

Returns the value of attribute physical_address_in_footer.



39
40
41
 
# File 'lib/constant_contact_client/models/email_campaign_activity_input.rb', line 39

def physical_address_in_footer
  @physical_address_in_footer
end

#preheader ⇒ Object

The email preheader for the email campaign activity. Contacts will view your preheader as a short summary that follows the subject line in their email client. Only format_type 3, 4, and 5 email campaign activities use the preheader property.



34
35
36
 
# File 'lib/constant_contact_client/models/email_campaign_activity_input.rb', line 34

def preheader
  @preheader
end

#reply_to_email ⇒ Object

The sender’s email address to use if the contact replies to the email campaign activity. You must use a confirmed Constant Contact account email address. Make a GET call to /account/emails to return a collection of account emails and their confirmation status.



28
29
30
 
# File 'lib/constant_contact_client/models/email_campaign_activity_input.rb', line 28

def reply_to_email
  @reply_to_email
end

#subject ⇒ Object

The text to display in the subject line that describes the email campaign activity.



31
32
33
 
# File 'lib/constant_contact_client/models/email_campaign_activity_input.rb', line 31

def subject
  @subject
end

Class Method Details

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



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/constant_contact_client/models/email_campaign_activity_input.rb', line 315

def self._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 = ConstantContactClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



56
57
58
 
# File 'lib/constant_contact_client/models/email_campaign_activity_input.rb', line 56

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/constant_contact_client/models/email_campaign_activity_input.rb', line 42

def self.attribute_map
  {
    :'format_type' => :'format_type',
    :'from_name' => :'from_name',
    :'from_email' => :'from_email',
    :'reply_to_email' => :'reply_to_email',
    :'subject' => :'subject',
    :'preheader' => :'preheader',
    :'html_content' => :'html_content',
    :'physical_address_in_footer' => :'physical_address_in_footer'
  }
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



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/constant_contact_client/models/email_campaign_activity_input.rb', line 291

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



75
76
77
78
 
# File 'lib/constant_contact_client/models/email_campaign_activity_input.rb', line 75

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/constant_contact_client/models/email_campaign_activity_input.rb', line 61

def self.openapi_types
  {
    :'format_type' => :'Integer',
    :'from_name' => :'String',
    :'from_email' => :'String',
    :'reply_to_email' => :'String',
    :'subject' => :'String',
    :'preheader' => :'String',
    :'html_content' => :'String',
    :'physical_address_in_footer' => :'CreateEmailCampaignRequestEmailCampaignActivitiesInnerPhysicalAddressInFooter'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/constant_contact_client/models/email_campaign_activity_input.rb', line 263

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      format_type == o.format_type &&
      from_name == o.from_name &&
      from_email == o.from_email &&
      reply_to_email == o.reply_to_email &&
      subject == o.subject &&
      preheader == o.preheader &&
      html_content == o.html_content &&
      physical_address_in_footer == o.physical_address_in_footer
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



386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/constant_contact_client/models/email_campaign_activity_input.rb', line 386

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


278
279
280
 
# File 'lib/constant_contact_client/models/email_campaign_activity_input.rb', line 278

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



284
285
286
 
# File 'lib/constant_contact_client/models/email_campaign_activity_input.rb', line 284

def hash
  [format_type, from_name, from_email, reply_to_email, subject, preheader, html_content, physical_address_in_footer].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



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/constant_contact_client/models/email_campaign_activity_input.rb', line 142

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @format_type.nil?
    invalid_properties.push('invalid value for "format_type", format_type cannot be nil.')
  end

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

  if @from_name.to_s.length > 100
    invalid_properties.push('invalid value for "from_name", the character length must be smaller than or equal to 100.')
  end

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

  if @from_email.to_s.length > 80
    invalid_properties.push('invalid value for "from_email", the character length must be smaller than or equal to 80.')
  end

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

  if @reply_to_email.to_s.length > 80
    invalid_properties.push('invalid value for "reply_to_email", the character length must be smaller than or equal to 80.')
  end

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

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

  if @html_content.to_s.length > 150000
    invalid_properties.push('invalid value for "html_content", the character length must be smaller than or equal to 150000.')
  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



362
363
364
 
# File 'lib/constant_contact_client/models/email_campaign_activity_input.rb', line 362

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



368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/constant_contact_client/models/email_campaign_activity_input.rb', line 368

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



356
357
358
 
# File 'lib/constant_contact_client/models/email_campaign_activity_input.rb', line 356

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



190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/constant_contact_client/models/email_campaign_activity_input.rb', line 190

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @format_type.nil?
  return false if @from_name.nil?
  return false if @from_name.to_s.length > 100
  return false if @from_email.nil?
  return false if @from_email.to_s.length > 80
  return false if @reply_to_email.nil?
  return false if @reply_to_email.to_s.length > 80
  return false if @subject.nil?
  return false if @html_content.nil?
  return false if @html_content.to_s.length > 150000
  true
end