Class: MailSlurpClient::DeliverabilityAnalyticsRunDto

Inherits:
Object
  • Object
show all
Defined in:
lib/mailslurp_client/models/deliverability_analytics_run_dto.rb

Overview

Run-level metrics for analytics tables

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DeliverabilityAnalyticsRunDto

Initializes the object

Parameters:

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

    Model attributes in the form of hash



115
116
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
 
# File 'lib/mailslurp_client/models/deliverability_analytics_run_dto.rb', line 115

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `MailSlurpClient::DeliverabilityAnalyticsRunDto` 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 `MailSlurpClient::DeliverabilityAnalyticsRunDto`. 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?(:'name')
    self.name = attributes[:'name']
  end

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#completed_at ⇒ Object

Returns the value of attribute completed_at.



30
31
32
 
# File 'lib/mailslurp_client/models/deliverability_analytics_run_dto.rb', line 30

def completed_at
  @completed_at
end

#completion_percentage ⇒ Object

Returns the value of attribute completion_percentage.



38
39
40
 
# File 'lib/mailslurp_client/models/deliverability_analytics_run_dto.rb', line 38

def completion_percentage
  @completion_percentage
end

#created_at ⇒ Object

Returns the value of attribute created_at.



26
27
28
 
# File 'lib/mailslurp_client/models/deliverability_analytics_run_dto.rb', line 26

def created_at
  @created_at
end

#id ⇒ Object

Returns the value of attribute id.



18
19
20
 
# File 'lib/mailslurp_client/models/deliverability_analytics_run_dto.rb', line 18

def id
  @id
end

#matched_entities ⇒ Object

Returns the value of attribute matched_entities.



34
35
36
 
# File 'lib/mailslurp_client/models/deliverability_analytics_run_dto.rb', line 34

def matched_entities
  @matched_entities
end

#name ⇒ Object

Returns the value of attribute name.



20
21
22
 
# File 'lib/mailslurp_client/models/deliverability_analytics_run_dto.rb', line 20

def name
  @name
end

#scope ⇒ Object

Returns the value of attribute scope.



22
23
24
 
# File 'lib/mailslurp_client/models/deliverability_analytics_run_dto.rb', line 22

def scope
  @scope
end

#start_at ⇒ Object

Returns the value of attribute start_at.



28
29
30
 
# File 'lib/mailslurp_client/models/deliverability_analytics_run_dto.rb', line 28

def start_at
  @start_at
end

#status ⇒ Object

Returns the value of attribute status.



24
25
26
 
# File 'lib/mailslurp_client/models/deliverability_analytics_run_dto.rb', line 24

def status
  @status
end

#success_threshold_percent ⇒ Object

Returns the value of attribute success_threshold_percent.



40
41
42
 
# File 'lib/mailslurp_client/models/deliverability_analytics_run_dto.rb', line 40

def success_threshold_percent
  @success_threshold_percent
end

#threshold_status ⇒ Object

Returns the value of attribute threshold_status.



42
43
44
 
# File 'lib/mailslurp_client/models/deliverability_analytics_run_dto.rb', line 42

def threshold_status
  @threshold_status
end

#total_entities ⇒ Object

Returns the value of attribute total_entities.



32
33
34
 
# File 'lib/mailslurp_client/models/deliverability_analytics_run_dto.rb', line 32

def total_entities
  @total_entities
end

#unmatched_entities ⇒ Object

Returns the value of attribute unmatched_entities.



36
37
38
 
# File 'lib/mailslurp_client/models/deliverability_analytics_run_dto.rb', line 36

def unmatched_entities
  @unmatched_entities
end

Class Method Details

.attribute_map ⇒ Object

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



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/mailslurp_client/models/deliverability_analytics_run_dto.rb', line 67

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'scope' => :'scope',
    :'status' => :'status',
    :'created_at' => :'createdAt',
    :'start_at' => :'startAt',
    :'completed_at' => :'completedAt',
    :'total_entities' => :'totalEntities',
    :'matched_entities' => :'matchedEntities',
    :'unmatched_entities' => :'unmatchedEntities',
    :'completion_percentage' => :'completionPercentage',
    :'success_threshold_percent' => :'successThresholdPercent',
    :'threshold_status' => :'thresholdStatus'
  }
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



315
316
317
 
# File 'lib/mailslurp_client/models/deliverability_analytics_run_dto.rb', line 315

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



105
106
107
108
109
110
111
 
# File 'lib/mailslurp_client/models/deliverability_analytics_run_dto.rb', line 105

def self.openapi_nullable
  Set.new([
    :'name',
    :'completed_at',
    :'success_threshold_percent',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/mailslurp_client/models/deliverability_analytics_run_dto.rb', line 86

def self.openapi_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'scope' => :'String',
    :'status' => :'String',
    :'created_at' => :'DateTime',
    :'start_at' => :'DateTime',
    :'completed_at' => :'DateTime',
    :'total_entities' => :'Integer',
    :'matched_entities' => :'Integer',
    :'unmatched_entities' => :'Integer',
    :'completion_percentage' => :'Float',
    :'success_threshold_percent' => :'Float',
    :'threshold_status' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/mailslurp_client/models/deliverability_analytics_run_dto.rb', line 282

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      scope == o.scope &&
      status == o.status &&
      created_at == o.created_at &&
      start_at == o.start_at &&
      completed_at == o.completed_at &&
      total_entities == o.total_entities &&
      matched_entities == o.matched_entities &&
      unmatched_entities == o.unmatched_entities &&
      completion_percentage == o.completion_percentage &&
      success_threshold_percent == o.success_threshold_percent &&
      threshold_status == o.threshold_status
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



343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/mailslurp_client/models/deliverability_analytics_run_dto.rb', line 343

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
    MailSlurpClient.const_get(type).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



412
413
414
415
416
417
418
419
420
421
422
423
424
 
# File 'lib/mailslurp_client/models/deliverability_analytics_run_dto.rb', line 412

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



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/mailslurp_client/models/deliverability_analytics_run_dto.rb', line 322

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_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


302
303
304
 
# File 'lib/mailslurp_client/models/deliverability_analytics_run_dto.rb', line 302

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



308
309
310
 
# File 'lib/mailslurp_client/models/deliverability_analytics_run_dto.rb', line 308

def hash
  [id, name, scope, status, created_at, start_at, completed_at, total_entities, matched_entities, unmatched_entities, completion_percentage, success_threshold_percent, threshold_status].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



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
 
# File 'lib/mailslurp_client/models/deliverability_analytics_run_dto.rb', line 183

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

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

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

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

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

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

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

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

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

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



388
389
390
 
# File 'lib/mailslurp_client/models/deliverability_analytics_run_dto.rb', line 388

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



394
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'lib/mailslurp_client/models/deliverability_analytics_run_dto.rb', line 394

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



382
383
384
 
# File 'lib/mailslurp_client/models/deliverability_analytics_run_dto.rb', line 382

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



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/mailslurp_client/models/deliverability_analytics_run_dto.rb', line 230

def valid?
  return false if @id.nil?
  return false if @scope.nil?
  scope_validator = EnumAttributeValidator.new('String', ["INBOX", "PHONE"])
  return false unless scope_validator.valid?(@scope)
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ["CREATED", "SCHEDULED", "RUNNING", "PAUSED", "STOPPED", "COMPLETE", "FAILED"])
  return false unless status_validator.valid?(@status)
  return false if @created_at.nil?
  return false if @start_at.nil?
  return false if @total_entities.nil?
  return false if @matched_entities.nil?
  return false if @unmatched_entities.nil?
  return false if @completion_percentage.nil?
  return false if @threshold_status.nil?
  threshold_status_validator = EnumAttributeValidator.new('String', ["NOT_CONFIGURED", "PASSING", "FAILING"])
  return false unless threshold_status_validator.valid?(@threshold_status)
  true
end