Class: Bandwidth::LookupResult

Inherits:
Object
  • Object
show all
Defined in:
lib/bandwidth-sdk/models/lookup_result.rb

Overview

Carrier information results for the specified telephone number.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LookupResult

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/bandwidth-sdk/models/lookup_result.rb', line 89

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

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

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

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

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

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

  if attributes.key?(:'line_provider')
    self.line_provider = attributes[:'line_provider']
  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
end

Instance Attribute Details

#country ⇒ Object

The country of the telephone number.



32
33
34
 
# File 'lib/bandwidth-sdk/models/lookup_result.rb', line 32

def country
  @country
end

#e_164_format ⇒ Object

The telephone number in E.164 format.



26
27
28
 
# File 'lib/bandwidth-sdk/models/lookup_result.rb', line 26

def e_164_format
  @e_164_format
end

#formatted ⇒ Object

The formatted version of the telephone number.



29
30
31
 
# File 'lib/bandwidth-sdk/models/lookup_result.rb', line 29

def formatted
  @formatted
end

#line_provider ⇒ Object

The messaging service provider of the telephone number.



38
39
40
 
# File 'lib/bandwidth-sdk/models/lookup_result.rb', line 38

def line_provider
  @line_provider
end

#line_type ⇒ Object

The line type of the telephone number.



35
36
37
 
# File 'lib/bandwidth-sdk/models/lookup_result.rb', line 35

def line_type
  @line_type
end

#message ⇒ Object

Message associated with the response code.



23
24
25
 
# File 'lib/bandwidth-sdk/models/lookup_result.rb', line 23

def message
  @message
end

#mobile_country_code ⇒ Object

The first half of the Home Network Identity (HNI).



41
42
43
 
# File 'lib/bandwidth-sdk/models/lookup_result.rb', line 41

def mobile_country_code
  @mobile_country_code
end

#mobile_network_code ⇒ Object

The second half of the HNI.



44
45
46
 
# File 'lib/bandwidth-sdk/models/lookup_result.rb', line 44

def mobile_network_code
  @mobile_network_code
end

#response_code ⇒ Object

Our vendor’s response code.



20
21
22
 
# File 'lib/bandwidth-sdk/models/lookup_result.rb', line 20

def response_code
  @response_code
end

Class Method Details

._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



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
239
240
241
242
243
244
245
246
 
# File 'lib/bandwidth-sdk/models/lookup_result.rb', line 209

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = Bandwidth.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



62
63
64
 
# File 'lib/bandwidth-sdk/models/lookup_result.rb', line 62

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/bandwidth-sdk/models/lookup_result.rb', line 47

def self.attribute_map
  {
    :'response_code' => :'Response Code',
    :'message' => :'Message',
    :'e_164_format' => :'E.164 Format',
    :'formatted' => :'Formatted',
    :'country' => :'Country',
    :'line_type' => :'Line Type',
    :'line_provider' => :'Line Provider',
    :'mobile_country_code' => :'Mobile Country Code',
    :'mobile_network_code' => :'Mobile Network Code'
  }
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



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/bandwidth-sdk/models/lookup_result.rb', line 185

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



82
83
84
85
 
# File 'lib/bandwidth-sdk/models/lookup_result.rb', line 82

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

.openapi_types ⇒ Object

Attribute type mapping.



67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/bandwidth-sdk/models/lookup_result.rb', line 67

def self.openapi_types
  {
    :'response_code' => :'Integer',
    :'message' => :'String',
    :'e_164_format' => :'String',
    :'formatted' => :'String',
    :'country' => :'String',
    :'line_type' => :'String',
    :'line_provider' => :'String',
    :'mobile_country_code' => :'String',
    :'mobile_network_code' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/bandwidth-sdk/models/lookup_result.rb', line 156

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      response_code == o.response_code &&
      message == o.message &&
      e_164_format == o.e_164_format &&
      formatted == o.formatted &&
      country == o.country &&
      line_type == o.line_type &&
      line_provider == o.line_provider &&
      mobile_country_code == o.mobile_country_code &&
      mobile_network_code == o.mobile_network_code
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



280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/bandwidth-sdk/models/lookup_result.rb', line 280

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


172
173
174
 
# File 'lib/bandwidth-sdk/models/lookup_result.rb', line 172

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



178
179
180
 
# File 'lib/bandwidth-sdk/models/lookup_result.rb', line 178

def hash
  [response_code, message, e_164_format, formatted, country, line_type, line_provider, mobile_country_code, mobile_network_code].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



141
142
143
144
145
 
# File 'lib/bandwidth-sdk/models/lookup_result.rb', line 141

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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



256
257
258
 
# File 'lib/bandwidth-sdk/models/lookup_result.rb', line 256

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



262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/bandwidth-sdk/models/lookup_result.rb', line 262

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



250
251
252
 
# File 'lib/bandwidth-sdk/models/lookup_result.rb', line 250

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



149
150
151
152
 
# File 'lib/bandwidth-sdk/models/lookup_result.rb', line 149

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end