Class: MailSlurpClient::SearchAvailablePhoneNumbersOptions

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

Overview

Search criteria for advanced phone provisioning

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SearchAvailablePhoneNumbersOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#carrier_name ⇒ Object

Returns the value of attribute carrier_name.



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

def carrier_name
  @carrier_name
end

#limit ⇒ Object

Returns the value of attribute limit.



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

def limit
  @limit
end

#line_type ⇒ Object

Returns the value of attribute line_type.



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

def line_type
  @line_type
end

#mobile_country_code ⇒ Object

Returns the value of attribute mobile_country_code.



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

def mobile_country_code
  @mobile_country_code
end

#mobile_network_code ⇒ Object

Returns the value of attribute mobile_network_code.



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

def mobile_network_code
  @mobile_network_code
end

#phone_country ⇒ Object

Returns the value of attribute phone_country.



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

def phone_country
  @phone_country
end

#phone_variant ⇒ Object

Returns the value of attribute phone_variant.



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

def phone_variant
  @phone_variant
end

#provider_labels ⇒ Object

Returns the value of attribute provider_labels.



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

def provider_labels
  @provider_labels
end

#quality_filter ⇒ Object

Quality filter for advanced phone provisioning search



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

def quality_filter
  @quality_filter
end

Class Method Details

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/mailslurp_client/models/search_available_phone_numbers_options.rb', line 60

def self.attribute_map
  {
    :'phone_country' => :'phoneCountry',
    :'phone_variant' => :'phoneVariant',
    :'quality_filter' => :'qualityFilter',
    :'line_type' => :'lineType',
    :'carrier_name' => :'carrierName',
    :'mobile_country_code' => :'mobileCountryCode',
    :'mobile_network_code' => :'mobileNetworkCode',
    :'provider_labels' => :'providerLabels',
    :'limit' => :'limit'
  }
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



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

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/mailslurp_client/models/search_available_phone_numbers_options.rb', line 90

def self.openapi_nullable
  Set.new([
    :'phone_variant',
    :'quality_filter',
    :'line_type',
    :'carrier_name',
    :'mobile_country_code',
    :'mobile_network_code',
    :'provider_labels',
    :'limit'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'phone_country' => :'String',
    :'phone_variant' => :'String',
    :'quality_filter' => :'String',
    :'line_type' => :'String',
    :'carrier_name' => :'String',
    :'mobile_country_code' => :'String',
    :'mobile_network_code' => :'String',
    :'provider_labels' => :'Array<String>',
    :'limit' => :'Integer'
  }
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
 
# File 'lib/mailslurp_client/models/search_available_phone_numbers_options.rb', line 237

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      phone_country == o.phone_country &&
      phone_variant == o.phone_variant &&
      quality_filter == o.quality_filter &&
      line_type == o.line_type &&
      carrier_name == o.carrier_name &&
      mobile_country_code == o.mobile_country_code &&
      mobile_network_code == o.mobile_network_code &&
      provider_labels == o.provider_labels &&
      limit == o.limit
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



294
295
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
 
# File 'lib/mailslurp_client/models/search_available_phone_numbers_options.rb', line 294

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



363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/mailslurp_client/models/search_available_phone_numbers_options.rb', line 363

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



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

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


253
254
255
 
# File 'lib/mailslurp_client/models/search_available_phone_numbers_options.rb', line 253

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



259
260
261
 
# File 'lib/mailslurp_client/models/search_available_phone_numbers_options.rb', line 259

def hash
  [phone_country, phone_variant, quality_filter, line_type, carrier_name, mobile_country_code, mobile_network_code, provider_labels, limit].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



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/mailslurp_client/models/search_available_phone_numbers_options.rb', line 159

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

  if !@limit.nil? && @limit > 100
    invalid_properties.push('invalid value for "limit", must be smaller than or equal to 100.')
  end

  if !@limit.nil? && @limit < 1
    invalid_properties.push('invalid value for "limit", must be greater than or equal to 1.')
  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



339
340
341
 
# File 'lib/mailslurp_client/models/search_available_phone_numbers_options.rb', line 339

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



345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/mailslurp_client/models/search_available_phone_numbers_options.rb', line 345

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



333
334
335
 
# File 'lib/mailslurp_client/models/search_available_phone_numbers_options.rb', line 333

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



178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/mailslurp_client/models/search_available_phone_numbers_options.rb', line 178

def valid?
  return false if @phone_country.nil?
  phone_country_validator = EnumAttributeValidator.new('String', ["US", "GB", "AU", "CA", "EE", "HK", "PL", "PT", "NL", "IL", "FI", "SE"])
  return false unless phone_country_validator.valid?(@phone_country)
  phone_variant_validator = EnumAttributeValidator.new('String', ["LOCAL", "MOBILE", "TOLL_FREE"])
  return false unless phone_variant_validator.valid?(@phone_variant)
  quality_filter_validator = EnumAttributeValidator.new('String', ["OTP", "NON_VOIP", "MOBILE_ONLY", "ANY"])
  return false unless quality_filter_validator.valid?(@quality_filter)
  return false if !@limit.nil? && @limit > 100
  return false if !@limit.nil? && @limit < 1
  true
end