Class: MailchimpTransactional::Body34

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Body34

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/mailchimp_transactional/models/body_34.rb', line 76

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?(:'raw_message')
    self.raw_message = attributes[:'raw_message']
  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?(:'to')
    if (value = attributes[:'to']).is_a?(Array)
      self.to = value
    end
  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

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

Instance Attribute Details

#async ⇒ Object

enable a background sending mode that is optimized for bulk sending. In async mode, messages/sendRaw 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.



33
34
35
 
# File 'lib/mailchimp_transactional/models/body_34.rb', line 33

def async
  @async
end

#from_email ⇒ Object

optionally define the sender address - otherwise we’ll use the address found in the provided headers



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

def from_email
  @from_email
end

#from_name ⇒ Object

optionally define the sender alias



27
28
29
 
# File 'lib/mailchimp_transactional/models/body_34.rb', line 27

def from_name
  @from_name
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.



36
37
38
 
# File 'lib/mailchimp_transactional/models/body_34.rb', line 36

def ip_pool
  @ip_pool
end

#key ⇒ Object

a valid api key



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

def key
  @key
end

#raw_message ⇒ Object

the full MIME document of an email message



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

def raw_message
  @raw_message
end

#return_path_domain ⇒ Object

a custom domain to use for the messages’s return-path



42
43
44
 
# File 'lib/mailchimp_transactional/models/body_34.rb', line 42

def return_path_domain
  @return_path_domain
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.



39
40
41
 
# File 'lib/mailchimp_transactional/models/body_34.rb', line 39

def send_at
  @send_at
end

#to ⇒ Object

optionally define the recipient to receive the message - otherwise we’ll use the To, Cc, and Bcc headers provided in the document



30
31
32
 
# File 'lib/mailchimp_transactional/models/body_34.rb', line 30

def to
  @to
end

Class Method Details

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/mailchimp_transactional/models/body_34.rb', line 45

def self.attribute_map
  {
    :'key' => :'key',
    :'raw_message' => :'raw_message',
    :'from_email' => :'from_email',
    :'from_name' => :'from_name',
    :'to' => :'to',
    :'async' => :'async',
    :'ip_pool' => :'ip_pool',
    :'send_at' => :'send_at',
    :'return_path_domain' => :'return_path_domain'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'key' => :'String',
    :'raw_message' => :'String',
    :'from_email' => :'String',
    :'from_name' => :'String',
    :'to' => :'Array<String>',
    :'async' => :'BOOLEAN',
    :'ip_pool' => :'String',
    :'send_at' => :'DateTime',
    :'return_path_domain' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/mailchimp_transactional/models/body_34.rb', line 146

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      key == o.key &&
      raw_message == o.raw_message &&
      from_email == o.from_email &&
      from_name == o.from_name &&
      to == o.to &&
      async == o.async &&
      ip_pool == o.ip_pool &&
      send_at == o.send_at &&
      return_path_domain == o.return_path_domain
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



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
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/mailchimp_transactional/models/body_34.rb', line 196

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



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

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



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/mailchimp_transactional/models/body_34.rb', line 175

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


162
163
164
 
# File 'lib/mailchimp_transactional/models/body_34.rb', line 162

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



168
169
170
 
# File 'lib/mailchimp_transactional/models/body_34.rb', line 168

def hash
  [key, raw_message, from_email, from_name, to, async, ip_pool, send_at, return_path_domain].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



123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/mailchimp_transactional/models/body_34.rb', line 123

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

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



242
243
244
 
# File 'lib/mailchimp_transactional/models/body_34.rb', line 242

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



248
249
250
251
252
253
254
255
256
 
# File 'lib/mailchimp_transactional/models/body_34.rb', line 248

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



236
237
238
 
# File 'lib/mailchimp_transactional/models/body_34.rb', line 236

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



138
139
140
141
142
 
# File 'lib/mailchimp_transactional/models/body_34.rb', line 138

def valid?
  return false if @key.nil?
  return false if @raw_message.nil?
  true
end