Class: IntegrationApi::Email

Inherits:
Object
  • Object
show all
Defined in:
lib/integration_api/models/email.rb

Overview

Email Object

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Email

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/integration_api/models/email.rb', line 119

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#click ⇒ Object

Returns the value of attribute click.



18
19
20
 
# File 'lib/integration_api/models/email.rb', line 18

def click
  @click
end

#create_date ⇒ Object

Returns the value of attribute create_date.



20
21
22
 
# File 'lib/integration_api/models/email.rb', line 20

def create_date
  @create_date
end

#delivery_status ⇒ Object

deliveryStatus



23
24
25
 
# File 'lib/integration_api/models/email.rb', line 23

def delivery_status
  @delivery_status
end

#delivery_status_timestamp ⇒ Object

deliveryStatusTimestamp



26
27
28
 
# File 'lib/integration_api/models/email.rb', line 26

def delivery_status_timestamp
  @delivery_status_timestamp
end

#email_id ⇒ Object

Returns the value of attribute email_id.



28
29
30
 
# File 'lib/integration_api/models/email.rb', line 28

def email_id
  @email_id
end

#from ⇒ Object

from



31
32
33
 
# File 'lib/integration_api/models/email.rb', line 31

def from
  @from
end

#id ⇒ Object

Returns the value of attribute id.



33
34
35
 
# File 'lib/integration_api/models/email.rb', line 33

def id
  @id
end

#nucleus_business_id ⇒ Object

nucleusBusinessId



36
37
38
 
# File 'lib/integration_api/models/email.rb', line 36

def nucleus_business_id
  @nucleus_business_id
end

#nucleus_client_id ⇒ Object

nucleusClientId



39
40
41
 
# File 'lib/integration_api/models/email.rb', line 39

def nucleus_client_id
  @nucleus_client_id
end

#open ⇒ Object

Returns the value of attribute open.



41
42
43
 
# File 'lib/integration_api/models/email.rb', line 41

def open
  @open
end

#reason ⇒ Object

reason



44
45
46
 
# File 'lib/integration_api/models/email.rb', line 44

def reason
  @reason
end

#secondary_id ⇒ Object

Returns the value of attribute secondary_id.



46
47
48
 
# File 'lib/integration_api/models/email.rb', line 46

def secondary_id
  @secondary_id
end

#spam ⇒ Object

spam



49
50
51
 
# File 'lib/integration_api/models/email.rb', line 49

def spam
  @spam
end

#subject ⇒ Object

subject



52
53
54
 
# File 'lib/integration_api/models/email.rb', line 52

def subject
  @subject
end

#to ⇒ Object

to



55
56
57
 
# File 'lib/integration_api/models/email.rb', line 55

def to
  @to
end

#unsubscribe ⇒ Object

unsubscribe



58
59
60
 
# File 'lib/integration_api/models/email.rb', line 58

def unsubscribe
  @unsubscribe
end

#update_date ⇒ Object

Returns the value of attribute update_date.



60
61
62
 
# File 'lib/integration_api/models/email.rb', line 60

def update_date
  @update_date
end

#vendor_id ⇒ Object

vendorId



63
64
65
 
# File 'lib/integration_api/models/email.rb', line 63

def vendor_id
  @vendor_id
end

#vendor_name ⇒ Object

Returns the value of attribute vendor_name.



65
66
67
 
# File 'lib/integration_api/models/email.rb', line 65

def vendor_name
  @vendor_name
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'click' => :'click',
    :'create_date' => :'create_date',
    :'delivery_status' => :'delivery_status',
    :'delivery_status_timestamp' => :'delivery_status_timestamp',
    :'email_id' => :'email_id',
    :'from' => :'from',
    :'id' => :'id',
    :'nucleus_business_id' => :'nucleus_business_id',
    :'nucleus_client_id' => :'nucleus_client_id',
    :'open' => :'open',
    :'reason' => :'reason',
    :'secondary_id' => :'secondary_id',
    :'spam' => :'spam',
    :'subject' => :'subject',
    :'to' => :'to',
    :'unsubscribe' => :'unsubscribe',
    :'update_date' => :'update_date',
    :'vendor_id' => :'vendor_id',
    :'vendor_name' => :'vendor_name'
  }
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
114
115
 
# File 'lib/integration_api/models/email.rb', line 93

def self.swagger_types
  {
    :'click' => :'Array<EmailClick>',
    :'create_date' => :'DateTime',
    :'delivery_status' => :'String',
    :'delivery_status_timestamp' => :'DateTime',
    :'email_id' => :'String',
    :'from' => :'String',
    :'id' => :'String',
    :'nucleus_business_id' => :'String',
    :'nucleus_client_id' => :'String',
    :'open' => :'Array<EmailOpen>',
    :'reason' => :'String',
    :'secondary_id' => :'String',
    :'spam' => :'BOOLEAN',
    :'subject' => :'String',
    :'to' => :'String',
    :'unsubscribe' => :'BOOLEAN',
    :'update_date' => :'DateTime',
    :'vendor_id' => :'String',
    :'vendor_name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/integration_api/models/email.rb', line 221

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      click == o.click &&
      create_date == o.create_date &&
      delivery_status == o.delivery_status &&
      delivery_status_timestamp == o.delivery_status_timestamp &&
      email_id == o.email_id &&
      from == o.from &&
      id == o.id &&
      nucleus_business_id == o.nucleus_business_id &&
      nucleus_client_id == o.nucleus_client_id &&
      open == o.open &&
      reason == o.reason &&
      secondary_id == o.secondary_id &&
      spam == o.spam &&
      subject == o.subject &&
      to == o.to &&
      unsubscribe == o.unsubscribe &&
      update_date == o.update_date &&
      vendor_id == o.vendor_id &&
      vendor_name == o.vendor_name
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



280
281
282
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
 
# File 'lib/integration_api/models/email.rb', line 280

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    (value)
  when :Date
    (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 = IntegrationApi.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



345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/integration_api/models/email.rb', line 345

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



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/integration_api/models/email.rb', line 260

def build_from_hash(attributes)
  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


247
248
249
 
# File 'lib/integration_api/models/email.rb', line 247

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



253
254
255
 
# File 'lib/integration_api/models/email.rb', line 253

def hash
  [click, create_date, delivery_status, delivery_status_timestamp, email_id, from, id, nucleus_business_id, nucleus_client_id, open, reason, secondary_id, spam, subject, to, unsubscribe, update_date, vendor_id, vendor_name].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



208
209
210
211
 
# File 'lib/integration_api/models/email.rb', line 208

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



326
327
328
 
# File 'lib/integration_api/models/email.rb', line 326

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



332
333
334
335
336
337
338
339
 
# File 'lib/integration_api/models/email.rb', line 332

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    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



320
321
322
 
# File 'lib/integration_api/models/email.rb', line 320

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



215
216
217
 
# File 'lib/integration_api/models/email.rb', line 215

def valid?
  true
end