Class: MailchimpTransactional::InlineResponse20057

Inherits:
Object
  • Object
show all
Defined in:
lib/mailchimp_transactional/models/inline_response_200_57.rb

Overview

the information saved about the new template

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InlineResponse20057

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
187
188
189
190
191
192
 
# File 'lib/mailchimp_transactional/models/inline_response_200_57.rb', line 117

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

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

  if attributes.has_key?(:'labels')
    if (value = attributes[:'labels']).is_a?(Array)
      self.labels = value
    end
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#code ⇒ Object

the full HTML code of the template, with mc:edit attributes marking the editable elements - draft version



28
29
30
 
# File 'lib/mailchimp_transactional/models/inline_response_200_57.rb', line 28

def code
  @code
end

#created_at ⇒ Object

the date and time the template was first created as a UTC string in YYYY-MM-DD HH:MM:SS format



64
65
66
 
# File 'lib/mailchimp_transactional/models/inline_response_200_57.rb', line 64

def created_at
  @created_at
end

#from_email ⇒ Object

the default sender address for the template, if provided - draft version



34
35
36
 
# File 'lib/mailchimp_transactional/models/inline_response_200_57.rb', line 34

def from_email
  @from_email
end

#from_name ⇒ Object

the default sender from name for the template, if provided - draft version



37
38
39
 
# File 'lib/mailchimp_transactional/models/inline_response_200_57.rb', line 37

def from_name
  @from_name
end

#labels ⇒ Object

the list of labels applied to the template



25
26
27
 
# File 'lib/mailchimp_transactional/models/inline_response_200_57.rb', line 25

def labels
  @labels
end

#name ⇒ Object

the name of the template



22
23
24
 
# File 'lib/mailchimp_transactional/models/inline_response_200_57.rb', line 22

def name
  @name
end

#publish_code ⇒ Object

the full HTML code of the template, with mc:edit attributes marking the editable elements that are available as published, if it has been published



46
47
48
 
# File 'lib/mailchimp_transactional/models/inline_response_200_57.rb', line 46

def publish_code
  @publish_code
end

#publish_from_email ⇒ Object

the default sender address for the template, if provided



52
53
54
 
# File 'lib/mailchimp_transactional/models/inline_response_200_57.rb', line 52

def publish_from_email
  @publish_from_email
end

#publish_from_name ⇒ Object

the default sender from name for the template, if provided



55
56
57
 
# File 'lib/mailchimp_transactional/models/inline_response_200_57.rb', line 55

def publish_from_name
  @publish_from_name
end

#publish_name ⇒ Object

the same as the template name - kept as a separate field for backwards compatibility



43
44
45
 
# File 'lib/mailchimp_transactional/models/inline_response_200_57.rb', line 43

def publish_name
  @publish_name
end

#publish_subject ⇒ Object

the subject line of the template, if provided



49
50
51
 
# File 'lib/mailchimp_transactional/models/inline_response_200_57.rb', line 49

def publish_subject
  @publish_subject
end

#publish_text ⇒ Object

the default text part of messages sent with the template, if provided



58
59
60
 
# File 'lib/mailchimp_transactional/models/inline_response_200_57.rb', line 58

def publish_text
  @publish_text
end

#published_at ⇒ Object

the date and time the template was last published as a UTC string in YYYY-MM-DD HH:MM:SS format, or null if it has not been published



61
62
63
 
# File 'lib/mailchimp_transactional/models/inline_response_200_57.rb', line 61

def published_at
  @published_at
end

#slug ⇒ Object

the immutable unique code name of the template



19
20
21
 
# File 'lib/mailchimp_transactional/models/inline_response_200_57.rb', line 19

def slug
  @slug
end

#subject ⇒ Object

the subject line of the template, if provided - draft version



31
32
33
 
# File 'lib/mailchimp_transactional/models/inline_response_200_57.rb', line 31

def subject
  @subject
end

#text ⇒ Object

the default text part of messages sent with the template, if provided - draft version



40
41
42
 
# File 'lib/mailchimp_transactional/models/inline_response_200_57.rb', line 40

def text
  @text
end

#updated_at ⇒ Object

the date and time the template was last modified as a UTC string in YYYY-MM-DD HH:MM:SS format



67
68
69
 
# File 'lib/mailchimp_transactional/models/inline_response_200_57.rb', line 67

def updated_at
  @updated_at
end

Class Method Details

.attribute_map ⇒ Object

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



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/mailchimp_transactional/models/inline_response_200_57.rb', line 70

def self.attribute_map
  {
    :'slug' => :'slug',
    :'name' => :'name',
    :'labels' => :'labels',
    :'code' => :'code',
    :'subject' => :'subject',
    :'from_email' => :'from_email',
    :'from_name' => :'from_name',
    :'text' => :'text',
    :'publish_name' => :'publish_name',
    :'publish_code' => :'publish_code',
    :'publish_subject' => :'publish_subject',
    :'publish_from_email' => :'publish_from_email',
    :'publish_from_name' => :'publish_from_name',
    :'publish_text' => :'publish_text',
    :'published_at' => :'published_at',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/mailchimp_transactional/models/inline_response_200_57.rb', line 93

def self.swagger_types
  {
    :'slug' => :'String',
    :'name' => :'String',
    :'labels' => :'Array<String>',
    :'code' => :'String',
    :'subject' => :'String',
    :'from_email' => :'String',
    :'from_name' => :'String',
    :'text' => :'String',
    :'publish_name' => :'String',
    :'publish_code' => :'String',
    :'publish_subject' => :'String',
    :'publish_from_email' => :'String',
    :'publish_from_name' => :'String',
    :'publish_text' => :'String',
    :'published_at' => :'DateTime',
    :'created_at' => :'DateTime',
    :'updated_at' => :'DateTime'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/mailchimp_transactional/models/inline_response_200_57.rb', line 209

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      slug == o.slug &&
      name == o.name &&
      labels == o.labels &&
      code == o.code &&
      subject == o.subject &&
      from_email == o.from_email &&
      from_name == o.from_name &&
      text == o.text &&
      publish_name == o.publish_name &&
      publish_code == o.publish_code &&
      publish_subject == o.publish_subject &&
      publish_from_email == o.publish_from_email &&
      publish_from_name == o.publish_from_name &&
      publish_text == o.publish_text &&
      published_at == o.published_at &&
      created_at == o.created_at &&
      updated_at == o.updated_at
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



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/mailchimp_transactional/models/inline_response_200_57.rb', line 267

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



333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/mailchimp_transactional/models/inline_response_200_57.rb', line 333

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



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/mailchimp_transactional/models/inline_response_200_57.rb', line 246

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


233
234
235
 
# File 'lib/mailchimp_transactional/models/inline_response_200_57.rb', line 233

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



239
240
241
 
# File 'lib/mailchimp_transactional/models/inline_response_200_57.rb', line 239

def hash
  [slug, name, labels, code, subject, from_email, from_name, text, publish_name, publish_code, publish_subject, publish_from_email, publish_from_name, publish_text, published_at, created_at, updated_at].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



196
197
198
199
 
# File 'lib/mailchimp_transactional/models/inline_response_200_57.rb', line 196

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



313
314
315
 
# File 'lib/mailchimp_transactional/models/inline_response_200_57.rb', line 313

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



319
320
321
322
323
324
325
326
327
 
# File 'lib/mailchimp_transactional/models/inline_response_200_57.rb', line 319

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



307
308
309
 
# File 'lib/mailchimp_transactional/models/inline_response_200_57.rb', line 307

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



203
204
205
 
# File 'lib/mailchimp_transactional/models/inline_response_200_57.rb', line 203

def valid?
  true
end