Class: MailSlurpClient::WaitForSingleSmsOptions

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WaitForSingleSmsOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



87
88
89
90
91
92
93
94
95
96
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
# File 'lib/mailslurp_client/models/wait_for_single_sms_options.rb', line 87

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

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

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

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

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

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

Instance Attribute Details

#beforeObject

Returns the value of attribute before.



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

def before
  @before
end

#delayObject

Returns the value of attribute delay.



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

def delay
  @delay
end

#phone_number_idObject

Returns the value of attribute phone_number_id.



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

def phone_number_id
  @phone_number_id
end

#sinceObject

Returns the value of attribute since.



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

def since
  @since
end

#sort_directionObject

Returns the value of attribute sort_direction.



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

def sort_direction
  @sort_direction
end

#timeoutObject

Returns the value of attribute timeout.



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

def timeout
  @timeout
end

#unread_onlyObject

Returns the value of attribute unread_only.



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

def unread_only
  @unread_only
end

Class Method Details

.attribute_mapObject

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



54
55
56
57
58
59
60
61
62
63
64
# File 'lib/mailslurp_client/models/wait_for_single_sms_options.rb', line 54

def self.attribute_map
  {
    :'phone_number_id' => :'phoneNumberId',
    :'timeout' => :'timeout',
    :'unread_only' => :'unreadOnly',
    :'before' => :'before',
    :'since' => :'since',
    :'sort_direction' => :'sortDirection',
    :'delay' => :'delay'
  }
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



193
194
195
# File 'lib/mailslurp_client/models/wait_for_single_sms_options.rb', line 193

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

.openapi_nullableObject

List of attributes with nullable: true



80
81
82
83
# File 'lib/mailslurp_client/models/wait_for_single_sms_options.rb', line 80

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

.openapi_typesObject

Attribute type mapping.



67
68
69
70
71
72
73
74
75
76
77
# File 'lib/mailslurp_client/models/wait_for_single_sms_options.rb', line 67

def self.openapi_types
  {
    :'phone_number_id' => :'String',
    :'timeout' => :'Integer',
    :'unread_only' => :'Boolean',
    :'before' => :'DateTime',
    :'since' => :'DateTime',
    :'sort_direction' => :'String',
    :'delay' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



166
167
168
169
170
171
172
173
174
175
176
# File 'lib/mailslurp_client/models/wait_for_single_sms_options.rb', line 166

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



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
246
247
248
249
250
251
252
253
254
255
256
# File 'lib/mailslurp_client/models/wait_for_single_sms_options.rb', line 221

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



290
291
292
293
294
295
296
297
298
299
300
301
302
# File 'lib/mailslurp_client/models/wait_for_single_sms_options.rb', line 290

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



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
# File 'lib/mailslurp_client/models/wait_for_single_sms_options.rb', line 200

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


180
181
182
# File 'lib/mailslurp_client/models/wait_for_single_sms_options.rb', line 180

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



186
187
188
# File 'lib/mailslurp_client/models/wait_for_single_sms_options.rb', line 186

def hash
  [phone_number_id, timeout, unread_only, before, since, sort_direction, delay].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



131
132
133
134
135
136
137
138
139
140
141
142
# File 'lib/mailslurp_client/models/wait_for_single_sms_options.rb', line 131

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



266
267
268
# File 'lib/mailslurp_client/models/wait_for_single_sms_options.rb', line 266

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



272
273
274
275
276
277
278
279
280
281
282
283
284
# File 'lib/mailslurp_client/models/wait_for_single_sms_options.rb', line 272

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



260
261
262
# File 'lib/mailslurp_client/models/wait_for_single_sms_options.rb', line 260

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



146
147
148
149
150
151
152
# File 'lib/mailslurp_client/models/wait_for_single_sms_options.rb', line 146

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