Class: MailSlurpClient::CampaignProbeInsightsDto

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CampaignProbeInsightsDto

Initializes the object

Parameters:

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

    Model attributes in the form of hash



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
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
# File 'lib/mailslurp_client/models/campaign_probe_insights_dto.rb', line 97

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#attention_signalsObject

Returns the value of attribute attention_signals.



41
42
43
# File 'lib/mailslurp_client/models/campaign_probe_insights_dto.rb', line 41

def attention_signals
  @attention_signals
end

#average_health_scoreObject

Returns the value of attribute average_health_score.



33
34
35
# File 'lib/mailslurp_client/models/campaign_probe_insights_dto.rb', line 33

def average_health_score
  @average_health_score
end

#beforeObject

Returns the value of attribute before.



21
22
23
# File 'lib/mailslurp_client/models/campaign_probe_insights_dto.rb', line 21

def before
  @before
end

#best_healthy_streakObject

Returns the value of attribute best_healthy_streak.



37
38
39
# File 'lib/mailslurp_client/models/campaign_probe_insights_dto.rb', line 37

def best_healthy_streak
  @best_healthy_streak
end

#current_healthy_streakObject

Returns the value of attribute current_healthy_streak.



35
36
37
# File 'lib/mailslurp_client/models/campaign_probe_insights_dto.rb', line 35

def current_healthy_streak
  @current_healthy_streak
end

#failed_runsObject

Returns the value of attribute failed_runs.



29
30
31
# File 'lib/mailslurp_client/models/campaign_probe_insights_dto.rb', line 29

def failed_runs
  @failed_runs
end

#good_performance_signalsObject

Returns the value of attribute good_performance_signals.



39
40
41
# File 'lib/mailslurp_client/models/campaign_probe_insights_dto.rb', line 39

def good_performance_signals
  @good_performance_signals
end

#healthy_runsObject

Returns the value of attribute healthy_runs.



25
26
27
# File 'lib/mailslurp_client/models/campaign_probe_insights_dto.rb', line 25

def healthy_runs
  @healthy_runs
end

#latest_runObject

Returns the value of attribute latest_run.



45
46
47
# File 'lib/mailslurp_client/models/campaign_probe_insights_dto.rb', line 45

def latest_run
  @latest_run
end

#probe_idObject

Returns the value of attribute probe_id.



17
18
19
# File 'lib/mailslurp_client/models/campaign_probe_insights_dto.rb', line 17

def probe_id
  @probe_id
end

#sinceObject

Returns the value of attribute since.



19
20
21
# File 'lib/mailslurp_client/models/campaign_probe_insights_dto.rb', line 19

def since
  @since
end

#success_rateObject

Returns the value of attribute success_rate.



31
32
33
# File 'lib/mailslurp_client/models/campaign_probe_insights_dto.rb', line 31

def success_rate
  @success_rate
end

#top_findingsObject

Returns the value of attribute top_findings.



43
44
45
# File 'lib/mailslurp_client/models/campaign_probe_insights_dto.rb', line 43

def top_findings
  @top_findings
end

#total_runsObject

Returns the value of attribute total_runs.



23
24
25
# File 'lib/mailslurp_client/models/campaign_probe_insights_dto.rb', line 23

def total_runs
  @total_runs
end

#warning_runsObject

Returns the value of attribute warning_runs.



27
28
29
# File 'lib/mailslurp_client/models/campaign_probe_insights_dto.rb', line 27

def warning_runs
  @warning_runs
end

Class Method Details

.attribute_mapObject

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



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
# File 'lib/mailslurp_client/models/campaign_probe_insights_dto.rb', line 48

def self.attribute_map
  {
    :'probe_id' => :'probeId',
    :'since' => :'since',
    :'before' => :'before',
    :'total_runs' => :'totalRuns',
    :'healthy_runs' => :'healthyRuns',
    :'warning_runs' => :'warningRuns',
    :'failed_runs' => :'failedRuns',
    :'success_rate' => :'successRate',
    :'average_health_score' => :'averageHealthScore',
    :'current_healthy_streak' => :'currentHealthyStreak',
    :'best_healthy_streak' => :'bestHealthyStreak',
    :'good_performance_signals' => :'goodPerformanceSignals',
    :'attention_signals' => :'attentionSignals',
    :'top_findings' => :'topFindings',
    :'latest_run' => :'latestRun'
  }
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



297
298
299
# File 'lib/mailslurp_client/models/campaign_probe_insights_dto.rb', line 297

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

.openapi_nullableObject

List of attributes with nullable: true



90
91
92
93
# File 'lib/mailslurp_client/models/campaign_probe_insights_dto.rb', line 90

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

.openapi_typesObject

Attribute type mapping.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
# File 'lib/mailslurp_client/models/campaign_probe_insights_dto.rb', line 69

def self.openapi_types
  {
    :'probe_id' => :'String',
    :'since' => :'DateTime',
    :'before' => :'DateTime',
    :'total_runs' => :'Integer',
    :'healthy_runs' => :'Integer',
    :'warning_runs' => :'Integer',
    :'failed_runs' => :'Integer',
    :'success_rate' => :'Float',
    :'average_health_score' => :'Float',
    :'current_healthy_streak' => :'Integer',
    :'best_healthy_streak' => :'Integer',
    :'good_performance_signals' => :'Array<String>',
    :'attention_signals' => :'Array<String>',
    :'top_findings' => :'Array<String>',
    :'latest_run' => :'CampaignProbeRunDto'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
# File 'lib/mailslurp_client/models/campaign_probe_insights_dto.rb', line 262

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      probe_id == o.probe_id &&
      since == o.since &&
      before == o.before &&
      total_runs == o.total_runs &&
      healthy_runs == o.healthy_runs &&
      warning_runs == o.warning_runs &&
      failed_runs == o.failed_runs &&
      success_rate == o.success_rate &&
      average_health_score == o.average_health_score &&
      current_healthy_streak == o.current_healthy_streak &&
      best_healthy_streak == o.best_healthy_streak &&
      good_performance_signals == o.good_performance_signals &&
      attention_signals == o.attention_signals &&
      top_findings == o.top_findings &&
      latest_run == o.latest_run
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



325
326
327
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
# File 'lib/mailslurp_client/models/campaign_probe_insights_dto.rb', line 325

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



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

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



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
# File 'lib/mailslurp_client/models/campaign_probe_insights_dto.rb', line 304

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


284
285
286
# File 'lib/mailslurp_client/models/campaign_probe_insights_dto.rb', line 284

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



290
291
292
# File 'lib/mailslurp_client/models/campaign_probe_insights_dto.rb', line 290

def hash
  [probe_id, since, before, total_runs, healthy_runs, warning_runs, failed_runs, success_rate, average_health_score, current_healthy_streak, best_healthy_streak, good_performance_signals, attention_signals, top_findings, latest_run].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



370
371
372
# File 'lib/mailslurp_client/models/campaign_probe_insights_dto.rb', line 370

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



376
377
378
379
380
381
382
383
384
385
386
387
388
# File 'lib/mailslurp_client/models/campaign_probe_insights_dto.rb', line 376

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



364
365
366
# File 'lib/mailslurp_client/models/campaign_probe_insights_dto.rb', line 364

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



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
# File 'lib/mailslurp_client/models/campaign_probe_insights_dto.rb', line 242

def valid?
  return false if @probe_id.nil?
  return false if @since.nil?
  return false if @before.nil?
  return false if @total_runs.nil?
  return false if @healthy_runs.nil?
  return false if @warning_runs.nil?
  return false if @failed_runs.nil?
  return false if @success_rate.nil?
  return false if @average_health_score.nil?
  return false if @current_healthy_streak.nil?
  return false if @best_healthy_streak.nil?
  return false if @good_performance_signals.nil?
  return false if @attention_signals.nil?
  return false if @top_findings.nil?
  true
end