Class: SibApiV3Sdk::CreateSmtpTemplate

Inherits:
Object
  • Object
show all
Defined in:
lib/sib-api-v3-sdk/models/create_smtp_template.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateSmtpTemplate

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
 
# File 'lib/sib-api-v3-sdk/models/create_smtp_template.rb', line 82

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

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

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

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

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

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

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

end

Instance Attribute Details

#attachment_url ⇒ Object

Absolute url of the attachment (no local file). Extensions allowed xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff and rtf



42
43
44
 
# File 'lib/sib-api-v3-sdk/models/create_smtp_template.rb', line 42

def attachment_url
  @attachment_url
end

#html_content ⇒ Object

Body of the message (HTML version). The field must have more than 10 characters. REQUIRED if htmlUrl is empty



27
28
29
 
# File 'lib/sib-api-v3-sdk/models/create_smtp_template.rb', line 27

def html_content
  @html_content
end

#html_url ⇒ Object

Url which contents the body of the email message. REQUIRED if htmlContent is empty



30
31
32
 
# File 'lib/sib-api-v3-sdk/models/create_smtp_template.rb', line 30

def html_url
  @html_url
end

#is_active ⇒ Object

Status of template. isActive = true means template is active and isActive = false means template is inactive



45
46
47
 
# File 'lib/sib-api-v3-sdk/models/create_smtp_template.rb', line 45

def is_active
  @is_active
end

#reply_to ⇒ Object

Email on which campaign recipients will be able to reply to



36
37
38
 
# File 'lib/sib-api-v3-sdk/models/create_smtp_template.rb', line 36

def reply_to
  @reply_to
end

#sender ⇒ Object

Returns the value of attribute sender.



21
22
23
 
# File 'lib/sib-api-v3-sdk/models/create_smtp_template.rb', line 21

def sender
  @sender
end

#subject ⇒ Object

Subject of the template



33
34
35
 
# File 'lib/sib-api-v3-sdk/models/create_smtp_template.rb', line 33

def subject
  @subject
end

#tag ⇒ Object

Tag of the template



19
20
21
 
# File 'lib/sib-api-v3-sdk/models/create_smtp_template.rb', line 19

def tag
  @tag
end

#template_name ⇒ Object

Name of the template



24
25
26
 
# File 'lib/sib-api-v3-sdk/models/create_smtp_template.rb', line 24

def template_name
  @template_name
end

#to_field ⇒ Object

This is to personalize the «To» Field. If you want to include the first name and last name of your recipient, add [FNAME] [LNAME]. To use the contact attributes here, these must already exist in SendinBlue account



39
40
41
 
# File 'lib/sib-api-v3-sdk/models/create_smtp_template.rb', line 39

def to_field
  @to_field
end

Class Method Details

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/sib-api-v3-sdk/models/create_smtp_template.rb', line 49

def self.attribute_map
  {
    :'tag' => :'tag',
    :'sender' => :'sender',
    :'template_name' => :'templateName',
    :'html_content' => :'htmlContent',
    :'html_url' => :'htmlUrl',
    :'subject' => :'subject',
    :'reply_to' => :'replyTo',
    :'to_field' => :'toField',
    :'attachment_url' => :'attachmentUrl',
    :'is_active' => :'isActive'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/sib-api-v3-sdk/models/create_smtp_template.rb', line 65

def self.swagger_types
  {
    :'tag' => :'String',
    :'sender' => :'CreateSmtpTemplateSender',
    :'template_name' => :'String',
    :'html_content' => :'String',
    :'html_url' => :'String',
    :'subject' => :'String',
    :'reply_to' => :'String',
    :'to_field' => :'String',
    :'attachment_url' => :'String',
    :'is_active' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/sib-api-v3-sdk/models/create_smtp_template.rb', line 155

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      tag == o.tag &&
      sender == o.sender &&
      template_name == o.template_name &&
      html_content == o.html_content &&
      html_url == o.html_url &&
      subject == o.subject &&
      reply_to == o.reply_to &&
      to_field == o.to_field &&
      attachment_url == o.attachment_url &&
      is_active == o.is_active
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



206
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
 
# File 'lib/sib-api-v3-sdk/models/create_smtp_template.rb', line 206

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



272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/sib-api-v3-sdk/models/create_smtp_template.rb', line 272

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



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/sib-api-v3-sdk/models/create_smtp_template.rb', line 185

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


172
173
174
 
# File 'lib/sib-api-v3-sdk/models/create_smtp_template.rb', line 172

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



178
179
180
 
# File 'lib/sib-api-v3-sdk/models/create_smtp_template.rb', line 178

def hash
  [tag, sender, template_name, html_content, html_url, subject, reply_to, to_field, attachment_url, is_active].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/sib-api-v3-sdk/models/create_smtp_template.rb', line 132

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

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

  return 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



252
253
254
 
# File 'lib/sib-api-v3-sdk/models/create_smtp_template.rb', line 252

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



258
259
260
261
262
263
264
265
266
 
# File 'lib/sib-api-v3-sdk/models/create_smtp_template.rb', line 258

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



246
247
248
 
# File 'lib/sib-api-v3-sdk/models/create_smtp_template.rb', line 246

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



147
148
149
150
151
 
# File 'lib/sib-api-v3-sdk/models/create_smtp_template.rb', line 147

def valid?
  return false if @template_name.nil?
  return false if @subject.nil?
  return true
end