Class: MailchimpTransactional::Body28

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Body28

Initializes the object

Parameters:

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

    Model attributes in the form of hash



65
66
67
68
69
70
71
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
 
# File 'lib/mailchimp_transactional/models/body_28.rb', line 65

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

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

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

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

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

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

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

Instance Attribute Details

#async ⇒ Object

enable a background sending mode that is optimized for bulk sending. In async mode, messages/send will immediately return a status of "queued" for every recipient. To handle rejections when sending in async mode, set up a webhook for the ‘reject’ event. Defaults to false for messages with no more than 10 recipients; messages with more than 10 recipients are always sent asynchronously, regardless of the value of async.



29
30
31
 
# File 'lib/mailchimp_transactional/models/body_28.rb', line 29

def async
  @async
end

#ip_pool ⇒ Object

the name of the dedicated ip pool that should be used to send the message. If you do not have any dedicated IPs, this parameter has no effect. If you specify a pool that does not exist, your default pool will be used instead.



32
33
34
 
# File 'lib/mailchimp_transactional/models/body_28.rb', line 32

def ip_pool
  @ip_pool
end

#key ⇒ Object

a valid api key



18
19
20
 
# File 'lib/mailchimp_transactional/models/body_28.rb', line 18

def key
  @key
end

#message ⇒ Object

Returns the value of attribute message.



26
27
28
 
# File 'lib/mailchimp_transactional/models/body_28.rb', line 26

def message
  @message
end

#send_at ⇒ Object

when this message should be sent as a UTC timestamp in YYYY-MM-DD HH:MM:SS format. If you specify a time in the past, the message will be sent immediately. An additional fee applies for scheduled email, and this feature is only available to accounts with a positive balance.



35
36
37
 
# File 'lib/mailchimp_transactional/models/body_28.rb', line 35

def send_at
  @send_at
end

#template_content ⇒ Object

an array of template content to send. Each item in the array should be a struct with two keys - name: the name of the content block to set the content for, and content: the actual content to put into the block



24
25
26
 
# File 'lib/mailchimp_transactional/models/body_28.rb', line 24

def template_content
  @template_content
end

#template_name ⇒ Object

the immutable name or slug of a template that exists in the user’s account. For backwards-compatibility, the template name may also be used but the immutable slug is preferred.



21
22
23
 
# File 'lib/mailchimp_transactional/models/body_28.rb', line 21

def template_name
  @template_name
end

Class Method Details

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/mailchimp_transactional/models/body_28.rb', line 38

def self.attribute_map
  {
    :'key' => :'key',
    :'template_name' => :'template_name',
    :'template_content' => :'template_content',
    :'message' => :'message',
    :'async' => :'async',
    :'ip_pool' => :'ip_pool',
    :'send_at' => :'send_at'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/mailchimp_transactional/models/body_28.rb', line 51

def self.swagger_types
  {
    :'key' => :'String',
    :'template_name' => :'String',
    :'template_content' => :'Array<MessagessendtemplateTemplateContent>',
    :'message' => :'MessagessendtemplateMessage',
    :'async' => :'BOOLEAN',
    :'ip_pool' => :'String',
    :'send_at' => :'DateTime'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/mailchimp_transactional/models/body_28.rb', line 137

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      key == o.key &&
      template_name == o.template_name &&
      template_content == o.template_content &&
      message == o.message &&
      async == o.async &&
      ip_pool == o.ip_pool &&
      send_at == o.send_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



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/mailchimp_transactional/models/body_28.rb', line 185

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



251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/mailchimp_transactional/models/body_28.rb', line 251

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



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/mailchimp_transactional/models/body_28.rb', line 164

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


151
152
153
 
# File 'lib/mailchimp_transactional/models/body_28.rb', line 151

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



157
158
159
 
# File 'lib/mailchimp_transactional/models/body_28.rb', line 157

def hash
  [key, template_name, template_content, message, async, ip_pool, send_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



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/mailchimp_transactional/models/body_28.rb', line 104

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

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

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

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



231
232
233
 
# File 'lib/mailchimp_transactional/models/body_28.rb', line 231

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



237
238
239
240
241
242
243
244
245
 
# File 'lib/mailchimp_transactional/models/body_28.rb', line 237

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



225
226
227
 
# File 'lib/mailchimp_transactional/models/body_28.rb', line 225

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



127
128
129
130
131
132
133
 
# File 'lib/mailchimp_transactional/models/body_28.rb', line 127

def valid?
  return false if @key.nil?
  return false if @template_name.nil?
  return false if @template_content.nil?
  return false if @message.nil?
  true
end