Class: BrevoRuby::GetSmtpTemplateOverview

Inherits:
Object
  • Object
show all
Defined in:
lib/brevo-ruby/models/get_smtp_template_overview.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GetSmtpTemplateOverview

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/brevo-ruby/models/get_smtp_template_overview.rb', line 95

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#created_at ⇒ Object

Creation UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ)



47
48
49
 
# File 'lib/brevo-ruby/models/get_smtp_template_overview.rb', line 47

def created_at
  @created_at
end

#doi_template ⇒ Object

It is true if template is a valid Double opt-in (DOI) template, otherwise it is false. This field will be available only in case of single template detail call.



53
54
55
 
# File 'lib/brevo-ruby/models/get_smtp_template_overview.rb', line 53

def doi_template
  @doi_template
end

#html_content ⇒ Object

HTML content of the template



44
45
46
 
# File 'lib/brevo-ruby/models/get_smtp_template_overview.rb', line 44

def html_content
  @html_content
end

#id ⇒ Object

ID of the template



18
19
20
 
# File 'lib/brevo-ruby/models/get_smtp_template_overview.rb', line 18

def id
  @id
end

#is_active ⇒ Object

Status of template (true=active, false=inactive)



27
28
29
 
# File 'lib/brevo-ruby/models/get_smtp_template_overview.rb', line 27

def is_active
  @is_active
end

#modified_at ⇒ Object

Last modification UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ)



50
51
52
 
# File 'lib/brevo-ruby/models/get_smtp_template_overview.rb', line 50

def modified_at
  @modified_at
end

#name ⇒ Object

Name of the template



21
22
23
 
# File 'lib/brevo-ruby/models/get_smtp_template_overview.rb', line 21

def name
  @name
end

#reply_to ⇒ Object

Email defined as the "Reply to" for the template



35
36
37
 
# File 'lib/brevo-ruby/models/get_smtp_template_overview.rb', line 35

def reply_to
  @reply_to
end

#sender ⇒ Object

Returns the value of attribute sender.



32
33
34
 
# File 'lib/brevo-ruby/models/get_smtp_template_overview.rb', line 32

def sender
  @sender
end

#subject ⇒ Object

Subject of the template



24
25
26
 
# File 'lib/brevo-ruby/models/get_smtp_template_overview.rb', line 24

def subject
  @subject
end

#tag ⇒ Object

Tag of the template



41
42
43
 
# File 'lib/brevo-ruby/models/get_smtp_template_overview.rb', line 41

def tag
  @tag
end

#test_sent ⇒ Object

Status of test sending for the template (true=test email has been sent, false=test email has not been sent)



30
31
32
 
# File 'lib/brevo-ruby/models/get_smtp_template_overview.rb', line 30

def test_sent
  @test_sent
end

#to_field ⇒ Object

Customisation of the "to" field for the template



38
39
40
 
# File 'lib/brevo-ruby/models/get_smtp_template_overview.rb', line 38

def to_field
  @to_field
end

Class Method Details

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/brevo-ruby/models/get_smtp_template_overview.rb', line 56

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'subject' => :'subject',
    :'is_active' => :'isActive',
    :'test_sent' => :'testSent',
    :'sender' => :'sender',
    :'reply_to' => :'replyTo',
    :'to_field' => :'toField',
    :'tag' => :'tag',
    :'html_content' => :'htmlContent',
    :'created_at' => :'createdAt',
    :'modified_at' => :'modifiedAt',
    :'doi_template' => :'doiTemplate'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/brevo-ruby/models/get_smtp_template_overview.rb', line 75

def self.swagger_types
  {
    :'id' => :'Integer',
    :'name' => :'String',
    :'subject' => :'String',
    :'is_active' => :'BOOLEAN',
    :'test_sent' => :'BOOLEAN',
    :'sender' => :'GetSmtpTemplateOverviewSender',
    :'reply_to' => :'String',
    :'to_field' => :'String',
    :'tag' => :'String',
    :'html_content' => :'String',
    :'created_at' => :'String',
    :'modified_at' => :'String',
    :'doi_template' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/brevo-ruby/models/get_smtp_template_overview.rb', line 229

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      subject == o.subject &&
      is_active == o.is_active &&
      test_sent == o.test_sent &&
      sender == o.sender &&
      reply_to == o.reply_to &&
      to_field == o.to_field &&
      tag == o.tag &&
      html_content == o.html_content &&
      created_at == o.created_at &&
      modified_at == o.modified_at &&
      doi_template == o.doi_template
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



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/brevo-ruby/models/get_smtp_template_overview.rb', line 283

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



349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/brevo-ruby/models/get_smtp_template_overview.rb', line 349

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



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/brevo-ruby/models/get_smtp_template_overview.rb', line 262

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) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


249
250
251
 
# File 'lib/brevo-ruby/models/get_smtp_template_overview.rb', line 249

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



255
256
257
 
# File 'lib/brevo-ruby/models/get_smtp_template_overview.rb', line 255

def hash
  [id, name, subject, is_active, test_sent, sender, reply_to, to_field, tag, html_content, created_at, modified_at, doi_template].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



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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/brevo-ruby/models/get_smtp_template_overview.rb', line 156

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

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

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

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

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

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

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

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

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

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



329
330
331
 
# File 'lib/brevo-ruby/models/get_smtp_template_overview.rb', line 329

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



335
336
337
338
339
340
341
342
343
 
# File 'lib/brevo-ruby/models/get_smtp_template_overview.rb', line 335

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



323
324
325
 
# File 'lib/brevo-ruby/models/get_smtp_template_overview.rb', line 323

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



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/brevo-ruby/models/get_smtp_template_overview.rb', line 211

def valid?
  return false if @id.nil?
  return false if @name.nil?
  return false if @subject.nil?
  return false if @is_active.nil?
  return false if @test_sent.nil?
  return false if @sender.nil?
  return false if @reply_to.nil?
  return false if @to_field.nil?
  return false if @tag.nil?
  return false if @html_content.nil?
  return false if @created_at.nil?
  return false if @modified_at.nil?
  true
end