Class: MailSlurpClient::WaitForSmsConditions

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

Overview

Conditions to apply to emails that you are waiting for

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WaitForSmsConditions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#before ⇒ Object

ISO Date Time latest time of SMS to consider. Filter for matching SMSs that were received before this date



49
50
51
 
# File 'lib/mailslurp_client/models/wait_for_sms_conditions.rb', line 49

def before
  @before
end

#count ⇒ Object

Number of results that should match conditions. Either exactly or at least this amount based on the ‘countType`. If count condition is not met and the timeout has not been reached the `waitFor` method will retry the operation.



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

def count
  @count
end

#count_type ⇒ Object

How result size should be compared with the expected size. Exactly or at-least matching result?



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

def count_type
  @count_type
end

#delay_timeout ⇒ Object

Max time in milliseconds to wait between retries if a ‘timeout` is specified.



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

def delay_timeout
  @delay_timeout
end

#limit ⇒ Object

Limit results



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

def limit
  @limit
end

#matches ⇒ Object

Conditions that should be matched for an SMS to qualify for results. Each condition will be applied in order to each SMS within a phone number to filter a result list of matching SMSs you are waiting for.



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

def matches
  @matches
end

#phone_number_id ⇒ Object

ID of phone number to search within and apply conditions to. Essentially filtering the SMS found to give a count.



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

def phone_number_id
  @phone_number_id
end

#since ⇒ Object

ISO Date Time earliest time of SMS to consider. Filter for matching SMSs that were received after this date



46
47
48
 
# File 'lib/mailslurp_client/models/wait_for_sms_conditions.rb', line 46

def since
  @since
end

#sort_direction ⇒ Object

Direction to sort matching SMSs by created time



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

def sort_direction
  @sort_direction
end

#timeout ⇒ Object

Max time in milliseconds to retry the ‘waitFor` operation until conditions are met.



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

def timeout
  @timeout
end

#unread_only ⇒ Object

Apply conditions only to unread SMS. All SMS messages begin with ‘read=false`. An SMS is marked `read=true` when an `SMS` has been returned to the user at least once. For example you have called `getSms` or `waitForSms` etc., or you have viewed the SMS in the dashboard.



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

def unread_only
  @unread_only
end

Class Method Details

.attribute_map ⇒ Object

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/mailslurp_client/models/wait_for_sms_conditions.rb', line 74

def self.attribute_map
  {
    :'phone_number_id' => :'phoneNumberId',
    :'limit' => :'limit',
    :'count' => :'count',
    :'delay_timeout' => :'delayTimeout',
    :'timeout' => :'timeout',
    :'unread_only' => :'unreadOnly',
    :'count_type' => :'countType',
    :'matches' => :'matches',
    :'sort_direction' => :'sortDirection',
    :'since' => :'since',
    :'before' => :'before'
  }
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



268
269
270
 
# File 'lib/mailslurp_client/models/wait_for_sms_conditions.rb', line 268

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/mailslurp_client/models/wait_for_sms_conditions.rb', line 108

def self.openapi_nullable
  Set.new([
    :'limit',
    :'delay_timeout',
    :'unread_only',
    :'count_type',
    :'matches',
    :'sort_direction',
    :'since',
    :'before'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/mailslurp_client/models/wait_for_sms_conditions.rb', line 91

def self.openapi_types
  {
    :'phone_number_id' => :'String',
    :'limit' => :'Integer',
    :'count' => :'Integer',
    :'delay_timeout' => :'Integer',
    :'timeout' => :'Integer',
    :'unread_only' => :'Boolean',
    :'count_type' => :'String',
    :'matches' => :'Array<SmsMatchOption>',
    :'sort_direction' => :'String',
    :'since' => :'DateTime',
    :'before' => :'DateTime'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/mailslurp_client/models/wait_for_sms_conditions.rb', line 237

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      phone_number_id == o.phone_number_id &&
      limit == o.limit &&
      count == o.count &&
      delay_timeout == o.delay_timeout &&
      timeout == o.timeout &&
      unread_only == o.unread_only &&
      count_type == o.count_type &&
      matches == o.matches &&
      sort_direction == o.sort_direction &&
      since == o.since &&
      before == o.before
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



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/mailslurp_client/models/wait_for_sms_conditions.rb', line 296

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



365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/mailslurp_client/models/wait_for_sms_conditions.rb', line 365

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



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/mailslurp_client/models/wait_for_sms_conditions.rb', line 275

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


255
256
257
 
# File 'lib/mailslurp_client/models/wait_for_sms_conditions.rb', line 255

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



261
262
263
 
# File 'lib/mailslurp_client/models/wait_for_sms_conditions.rb', line 261

def hash
  [phone_number_id, limit, count, delay_timeout, timeout, unread_only, count_type, matches, sort_direction, since, before].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



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/mailslurp_client/models/wait_for_sms_conditions.rb', line 185

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

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

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



341
342
343
 
# File 'lib/mailslurp_client/models/wait_for_sms_conditions.rb', line 341

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



347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/mailslurp_client/models/wait_for_sms_conditions.rb', line 347

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



335
336
337
 
# File 'lib/mailslurp_client/models/wait_for_sms_conditions.rb', line 335

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



204
205
206
207
208
209
210
211
212
213
 
# File 'lib/mailslurp_client/models/wait_for_sms_conditions.rb', line 204

def valid?
  return false if @phone_number_id.nil?
  return false if @count.nil?
  return false if @timeout.nil?
  count_type_validator = EnumAttributeValidator.new('String', ["EXACTLY", "ATLEAST"])
  return false unless count_type_validator.valid?(@count_type)
  sort_direction_validator = EnumAttributeValidator.new('String', ["ASC", "DESC"])
  return false unless sort_direction_validator.valid?(@sort_direction)
  true
end