Class: ElasticEmail::EmailJobStatus

Inherits:
Object
  • Object
show all
Defined in:
lib/ElasticEmail/models/email_job_status.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EmailJobStatus

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/ElasticEmail/models/email_job_status.rb', line 135

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `ElasticEmail::EmailJobStatus` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `ElasticEmail::EmailJobStatus`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

  if attributes.key?(:'status')
    self.status = attributes[:'status']
  end

  if attributes.key?(:'recipients_count')
    self.recipients_count = attributes[:'recipients_count']
  end

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

  if attributes.key?(:'failed_count')
    self.failed_count = attributes[:'failed_count']
  end

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

  if attributes.key?(:'sent_count')
    self.sent_count = attributes[:'sent_count']
  end

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

  if attributes.key?(:'delivered_count')
    self.delivered_count = attributes[:'delivered_count']
  end

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

  if attributes.key?(:'pending_count')
    self.pending_count = attributes[:'pending_count']
  end

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

  if attributes.key?(:'opened_count')
    self.opened_count = attributes[:'opened_count']
  end

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

  if attributes.key?(:'clicked_count')
    self.clicked_count = attributes[:'clicked_count']
  end

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

  if attributes.key?(:'unsubscribed_count')
    self.unsubscribed_count = attributes[:'unsubscribed_count']
  end

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

  if attributes.key?(:'abuse_reports_count')
    self.abuse_reports_count = attributes[:'abuse_reports_count']
  end

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

Instance Attribute Details

#abuse_reports ⇒ Object

Returns the value of attribute abuse_reports.



63
64
65
 
# File 'lib/ElasticEmail/models/email_job_status.rb', line 63

def abuse_reports
  @abuse_reports
end

#abuse_reports_count ⇒ Object

Returns the value of attribute abuse_reports_count.



65
66
67
 
# File 'lib/ElasticEmail/models/email_job_status.rb', line 65

def abuse_reports_count
  @abuse_reports_count
end

#clicked ⇒ Object

Number of clicked messages



52
53
54
 
# File 'lib/ElasticEmail/models/email_job_status.rb', line 52

def clicked
  @clicked
end

#clicked_count ⇒ Object

Total emails clicked



55
56
57
 
# File 'lib/ElasticEmail/models/email_job_status.rb', line 55

def clicked_count
  @clicked_count
end

#delivered ⇒ Object

Number of delivered messages



37
38
39
 
# File 'lib/ElasticEmail/models/email_job_status.rb', line 37

def delivered
  @delivered
end

#delivered_count ⇒ Object

Returns the value of attribute delivered_count.



39
40
41
 
# File 'lib/ElasticEmail/models/email_job_status.rb', line 39

def delivered_count
  @delivered_count
end

#failed ⇒ Object

Returns the value of attribute failed.



26
27
28
 
# File 'lib/ElasticEmail/models/email_job_status.rb', line 26

def failed
  @failed
end

#failed_count ⇒ Object

Total emails failed.



29
30
31
 
# File 'lib/ElasticEmail/models/email_job_status.rb', line 29

def failed_count
  @failed_count
end

#id ⇒ Object

ID number of your attachment



19
20
21
 
# File 'lib/ElasticEmail/models/email_job_status.rb', line 19

def id
  @id
end

#message_ids ⇒ Object

List of all MessageIDs for this job.



68
69
70
 
# File 'lib/ElasticEmail/models/email_job_status.rb', line 68

def message_ids
  @message_ids
end

#opened ⇒ Object

Number of opened messages



46
47
48
 
# File 'lib/ElasticEmail/models/email_job_status.rb', line 46

def opened
  @opened
end

#opened_count ⇒ Object

Total emails opened.



49
50
51
 
# File 'lib/ElasticEmail/models/email_job_status.rb', line 49

def opened_count
  @opened_count
end

#pending ⇒ Object

Returns the value of attribute pending.



41
42
43
 
# File 'lib/ElasticEmail/models/email_job_status.rb', line 41

def pending
  @pending
end

#pending_count ⇒ Object

Returns the value of attribute pending_count.



43
44
45
 
# File 'lib/ElasticEmail/models/email_job_status.rb', line 43

def pending_count
  @pending_count
end

#recipients_count ⇒ Object

Returns the value of attribute recipients_count.



24
25
26
 
# File 'lib/ElasticEmail/models/email_job_status.rb', line 24

def recipients_count
  @recipients_count
end

#sent ⇒ Object

Returns the value of attribute sent.



31
32
33
 
# File 'lib/ElasticEmail/models/email_job_status.rb', line 31

def sent
  @sent
end

#sent_count ⇒ Object

Total emails sent.



34
35
36
 
# File 'lib/ElasticEmail/models/email_job_status.rb', line 34

def sent_count
  @sent_count
end

#status ⇒ Object

Name of status: submitted, complete, in_progress



22
23
24
 
# File 'lib/ElasticEmail/models/email_job_status.rb', line 22

def status
  @status
end

#unsubscribed ⇒ Object

Number of unsubscribed messages



58
59
60
 
# File 'lib/ElasticEmail/models/email_job_status.rb', line 58

def unsubscribed
  @unsubscribed
end

#unsubscribed_count ⇒ Object

Total emails unsubscribed



61
62
63
 
# File 'lib/ElasticEmail/models/email_job_status.rb', line 61

def unsubscribed_count
  @unsubscribed_count
end

Class Method Details

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



328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/ElasticEmail/models/email_job_status.rb', line 328

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = ElasticEmail.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



97
98
99
 
# File 'lib/ElasticEmail/models/email_job_status.rb', line 97

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/ElasticEmail/models/email_job_status.rb', line 71

def self.attribute_map
  {
    :'id' => :'ID',
    :'status' => :'Status',
    :'recipients_count' => :'RecipientsCount',
    :'failed' => :'Failed',
    :'failed_count' => :'FailedCount',
    :'sent' => :'Sent',
    :'sent_count' => :'SentCount',
    :'delivered' => :'Delivered',
    :'delivered_count' => :'DeliveredCount',
    :'pending' => :'Pending',
    :'pending_count' => :'PendingCount',
    :'opened' => :'Opened',
    :'opened_count' => :'OpenedCount',
    :'clicked' => :'Clicked',
    :'clicked_count' => :'ClickedCount',
    :'unsubscribed' => :'Unsubscribed',
    :'unsubscribed_count' => :'UnsubscribedCount',
    :'abuse_reports' => :'AbuseReports',
    :'abuse_reports_count' => :'AbuseReportsCount',
    :'message_ids' => :'MessageIDs'
  }
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



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/ElasticEmail/models/email_job_status.rb', line 304

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



128
129
130
131
 
# File 'lib/ElasticEmail/models/email_job_status.rb', line 128

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/ElasticEmail/models/email_job_status.rb', line 102

def self.openapi_types
  {
    :'id' => :'String',
    :'status' => :'String',
    :'recipients_count' => :'Integer',
    :'failed' => :'Array<EmailJobFailedStatus>',
    :'failed_count' => :'Integer',
    :'sent' => :'Array<String>',
    :'sent_count' => :'Integer',
    :'delivered' => :'Array<String>',
    :'delivered_count' => :'Integer',
    :'pending' => :'Array<String>',
    :'pending_count' => :'Integer',
    :'opened' => :'Array<String>',
    :'opened_count' => :'Integer',
    :'clicked' => :'Array<String>',
    :'clicked_count' => :'Integer',
    :'unsubscribed' => :'Array<String>',
    :'unsubscribed_count' => :'Integer',
    :'abuse_reports' => :'Array<String>',
    :'abuse_reports_count' => :'Integer',
    :'message_ids' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/ElasticEmail/models/email_job_status.rb', line 264

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      status == o.status &&
      recipients_count == o.recipients_count &&
      failed == o.failed &&
      failed_count == o.failed_count &&
      sent == o.sent &&
      sent_count == o.sent_count &&
      delivered == o.delivered &&
      delivered_count == o.delivered_count &&
      pending == o.pending &&
      pending_count == o.pending_count &&
      opened == o.opened &&
      opened_count == o.opened_count &&
      clicked == o.clicked &&
      clicked_count == o.clicked_count &&
      unsubscribed == o.unsubscribed &&
      unsubscribed_count == o.unsubscribed_count &&
      abuse_reports == o.abuse_reports &&
      abuse_reports_count == o.abuse_reports_count &&
      message_ids == o.message_ids
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



399
400
401
402
403
404
405
406
407
408
409
410
411
 
# File 'lib/ElasticEmail/models/email_job_status.rb', line 399

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


291
292
293
 
# File 'lib/ElasticEmail/models/email_job_status.rb', line 291

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



297
298
299
 
# File 'lib/ElasticEmail/models/email_job_status.rb', line 297

def hash
  [id, status, recipients_count, failed, failed_count, sent, sent_count, delivered, delivered_count, pending, pending_count, opened, opened_count, clicked, clicked_count, unsubscribed, unsubscribed_count, abuse_reports, abuse_reports_count, message_ids].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



249
250
251
252
253
 
# File 'lib/ElasticEmail/models/email_job_status.rb', line 249

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  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



375
376
377
 
# File 'lib/ElasticEmail/models/email_job_status.rb', line 375

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



381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/ElasticEmail/models/email_job_status.rb', line 381

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



369
370
371
 
# File 'lib/ElasticEmail/models/email_job_status.rb', line 369

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



257
258
259
260
 
# File 'lib/ElasticEmail/models/email_job_status.rb', line 257

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end