Class: Zernio::CheckPhoneNumberPortability200ResponseResultsInner

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/zernio-sdk/models/check_phone_number_portability200_response_results_inner.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ CheckPhoneNumberPortability200ResponseResultsInner

Initializes the object

Parameters:

  • (defaults to: {})

    Model attributes in the form of hash



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
 
# File 'lib/zernio-sdk/models/check_phone_number_portability200_response_results_inner.rb', line 107

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Zernio::CheckPhoneNumberPortability200ResponseResultsInner` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Zernio::CheckPhoneNumberPortability200ResponseResultsInner`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

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

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

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

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

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

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

Instance Attribute Details

#carrier_name ⇒ Object

The number's current carrier, when the lookup knows it. US/CA portable numbers only.



32
33
34
 
# File 'lib/zernio-sdk/models/check_phone_number_portability200_response_results_inner.rb', line 32

def carrier_name
  @carrier_name
end

#claim_id ⇒ Object

Keyless calls and claimLinks=true only, on portable results. Resolve it with GET /v1/phone-numbers/port-in/claims/claimId. Expires after 7 days.



44
45
46
 
# File 'lib/zernio-sdk/models/check_phone_number_portability200_response_results_inner.rb', line 44

def claim_id
  @claim_id
end

#claim_url ⇒ Object

Keyless calls and claimLinks=true only, on portable results. A signup link that lands on the dashboard's port form with this number filled in.



47
48
49
 
# File 'lib/zernio-sdk/models/check_phone_number_portability200_response_results_inner.rb', line 47

def claim_url
  @claim_url
end

#country_code ⇒ Object

ISO country of the number. Pass it to GET /v1/phone-numbers/port-in/requirements for international numbers.



35
36
37
 
# File 'lib/zernio-sdk/models/check_phone_number_portability200_response_results_inner.rb', line 35

def country_code
  @country_code
end

#fast_portable ⇒ Object

Qualifies for the carrier's accelerated FastPort lane.



23
24
25
 
# File 'lib/zernio-sdk/models/check_phone_number_portability200_response_results_inner.rb', line 23

def fast_portable
  @fast_portable
end

#line_type ⇒ Object

Line type when known (mobile, landline, voip, toll-free, unknown). US/CA portable numbers only. A US/CA mobile number requires the transfer PIN at submit.



29
30
31
 
# File 'lib/zernio-sdk/models/check_phone_number_portability200_response_results_inner.rb', line 29

def line_type
  @line_type
end

#messaging_capable ⇒ Object

Whether texting can be enabled on the number once ported; null when the carrier does not say.



26
27
28
 
# File 'lib/zernio-sdk/models/check_phone_number_portability200_response_results_inner.rb', line 26

def messaging_capable
  @messaging_capable
end

#not_portable_reason ⇒ Object

Carrier reason when not portable; null when portable.



41
42
43
 
# File 'lib/zernio-sdk/models/check_phone_number_portability200_response_results_inner.rb', line 41

def not_portable_reason
  @not_portable_reason
end

#phone_number ⇒ Object

Returns the value of attribute phone_number.



18
19
20
 
# File 'lib/zernio-sdk/models/check_phone_number_portability200_response_results_inner.rb', line 18

def phone_number
  @phone_number
end

#phone_number_type ⇒ Object

Carrier number-type classification (local, mobile, national, toll_free...), the numberType for the requirements endpoint.



38
39
40
 
# File 'lib/zernio-sdk/models/check_phone_number_portability200_response_results_inner.rb', line 38

def phone_number_type
  @phone_number_type
end

#portable ⇒ Object

Returns the value of attribute portable.



20
21
22
 
# File 'lib/zernio-sdk/models/check_phone_number_portability200_response_results_inner.rb', line 20

def portable
  @portable
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



67
68
69
 
# File 'lib/zernio-sdk/models/check_phone_number_portability200_response_results_inner.rb', line 67

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



72
73
74
 
# File 'lib/zernio-sdk/models/check_phone_number_portability200_response_results_inner.rb', line 72

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/zernio-sdk/models/check_phone_number_portability200_response_results_inner.rb', line 50

def self.attribute_map
  {
    :'phone_number' => :'phoneNumber',
    :'portable' => :'portable',
    :'fast_portable' => :'fastPortable',
    :'messaging_capable' => :'messagingCapable',
    :'line_type' => :'lineType',
    :'carrier_name' => :'carrierName',
    :'country_code' => :'countryCode',
    :'phone_number_type' => :'phoneNumberType',
    :'not_portable_reason' => :'notPortableReason',
    :'claim_id' => :'claimId',
    :'claim_url' => :'claimUrl'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/zernio-sdk/models/check_phone_number_portability200_response_results_inner.rb', line 214

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



94
95
96
97
98
99
100
101
102
103
 
# File 'lib/zernio-sdk/models/check_phone_number_portability200_response_results_inner.rb', line 94

def self.openapi_nullable
  Set.new([
    :'messaging_capable',
    :'line_type',
    :'carrier_name',
    :'country_code',
    :'phone_number_type',
    :'not_portable_reason',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/zernio-sdk/models/check_phone_number_portability200_response_results_inner.rb', line 77

def self.openapi_types
  {
    :'phone_number' => :'String',
    :'portable' => :'Boolean',
    :'fast_portable' => :'Boolean',
    :'messaging_capable' => :'Boolean',
    :'line_type' => :'String',
    :'carrier_name' => :'String',
    :'country_code' => :'String',
    :'phone_number_type' => :'String',
    :'not_portable_reason' => :'String',
    :'claim_id' => :'String',
    :'claim_url' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • to be compared



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/zernio-sdk/models/check_phone_number_portability200_response_results_inner.rb', line 183

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      phone_number == o.phone_number &&
      portable == o.portable &&
      fast_portable == o.fast_portable &&
      messaging_capable == o.messaging_capable &&
      line_type == o.line_type &&
      carrier_name == o.carrier_name &&
      country_code == o.country_code &&
      phone_number_type == o.phone_number_type &&
      not_portable_reason == o.not_portable_reason &&
      claim_id == o.claim_id &&
      claim_url == o.claim_url
end

#eql?(o) ⇒ Boolean

Parameters:

  • to be compared

Returns:

See Also:

  • `==` method


201
202
203
 
# File 'lib/zernio-sdk/models/check_phone_number_portability200_response_results_inner.rb', line 201

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • Hash code



207
208
209
 
# File 'lib/zernio-sdk/models/check_phone_number_portability200_response_results_inner.rb', line 207

def hash
  [phone_number, portable, fast_portable, messaging_capable, line_type, carrier_name, country_code, phone_number_type, not_portable_reason, claim_id, claim_url].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



168
169
170
171
172
 
# File 'lib/zernio-sdk/models/check_phone_number_portability200_response_results_inner.rb', line 168

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • Returns the object in the form of hash



236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/zernio-sdk/models/check_phone_number_portability200_response_results_inner.rb', line 236

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

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • true if the model is valid



176
177
178
179
 
# File 'lib/zernio-sdk/models/check_phone_number_portability200_response_results_inner.rb', line 176

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