Class: Freeclimb::IncomingNumberResult

Inherits:
Object
  • Object
show all
Defined in:
lib/freeclimb/models/incoming_number_result.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IncomingNumberResult

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/freeclimb/models/incoming_number_result.rb', line 145

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#_alias ⇒ Object

Description for this phone number. Typically the conventionally-formatted version of the phone number.



48
49
50
 
# File 'lib/freeclimb/models/incoming_number_result.rb', line 48

def _alias
  @_alias
end

#account_id ⇒ Object

ID of the account that owns this phone number.



39
40
41
 
# File 'lib/freeclimb/models/incoming_number_result.rb', line 39

def 
  @account_id
end

#application_id ⇒ Object

ID of the Application that FreeClimb should contact if a Call or SMS arrives for this phone number or a Call from this number is placed. An incoming phone number is not useful until associated with an applicationId.



42
43
44
 
# File 'lib/freeclimb/models/incoming_number_result.rb', line 42

def application_id
  @application_id
end

#campaign_id ⇒ Object

The campaign ID generated by the campaign registry



33
34
35
 
# File 'lib/freeclimb/models/incoming_number_result.rb', line 33

def campaign_id
  @campaign_id
end

#capabilities ⇒ Object

Returns the value of attribute capabilities.



30
31
32
 
# File 'lib/freeclimb/models/incoming_number_result.rb', line 30

def capabilities
  @capabilities
end

#country ⇒ Object

Country of this phone number.



54
55
56
 
# File 'lib/freeclimb/models/incoming_number_result.rb', line 54

def country
  @country
end

#date_created ⇒ Object

The date that this resource was created (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT).



22
23
24
 
# File 'lib/freeclimb/models/incoming_number_result.rb', line 22

def date_created
  @date_created
end

#date_updated ⇒ Object

The date that this resource was last updated (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT).



25
26
27
 
# File 'lib/freeclimb/models/incoming_number_result.rb', line 25

def date_updated
  @date_updated
end

#offnet ⇒ Object

The offnet field is a boolean representing whether the number is offnet registered or not. This field will be rendered only for requests to the IncomingPhone number resource.



63
64
65
 
# File 'lib/freeclimb/models/incoming_number_result.rb', line 63

def offnet
  @offnet
end

#phone_number ⇒ Object

Phone number in E.164 format.



45
46
47
 
# File 'lib/freeclimb/models/incoming_number_result.rb', line 45

def phone_number
  @phone_number
end

#phone_number_id ⇒ Object

String that uniquely identifies this phone number resource.



36
37
38
 
# File 'lib/freeclimb/models/incoming_number_result.rb', line 36

def phone_number_id
  @phone_number_id
end

#region ⇒ Object

State or province of this phone number.



51
52
53
 
# File 'lib/freeclimb/models/incoming_number_result.rb', line 51

def region
  @region
end

#revision ⇒ Object

Revision count for the resource. This count is set to 1 on creation and is incremented every time it is updated.



28
29
30
 
# File 'lib/freeclimb/models/incoming_number_result.rb', line 28

def revision
  @revision
end

#sms_enabled ⇒ Object

Indication of whether the phone number can handle sending and receiving SMS messages. Typically set to true for all numbers.



60
61
62
 
# File 'lib/freeclimb/models/incoming_number_result.rb', line 60

def sms_enabled
  @sms_enabled
end

#tfn ⇒ Object

Returns the value of attribute tfn.



65
66
67
 
# File 'lib/freeclimb/models/incoming_number_result.rb', line 65

def tfn
  @tfn
end

#uri ⇒ Object

The URI for this resource, relative to /apiserver.



19
20
21
 
# File 'lib/freeclimb/models/incoming_number_result.rb', line 19

def uri
  @uri
end

#voice_enabled ⇒ Object

Indicates whether the phone number can handle Calls. Typically set to true for all numbers.



57
58
59
 
# File 'lib/freeclimb/models/incoming_number_result.rb', line 57

def voice_enabled
  @voice_enabled
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



91
92
93
 
# File 'lib/freeclimb/models/incoming_number_result.rb', line 91

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/freeclimb/models/incoming_number_result.rb', line 68

def self.attribute_map
  {
    :'uri' => :'uri',
    :'date_created' => :'dateCreated',
    :'date_updated' => :'dateUpdated',
    :'revision' => :'revision',
    :'capabilities' => :'capabilities',
    :'campaign_id' => :'campaignId',
    :'phone_number_id' => :'phoneNumberId',
    :'account_id' => :'accountId',
    :'application_id' => :'applicationId',
    :'phone_number' => :'phoneNumber',
    :'_alias' => :'alias',
    :'region' => :'region',
    :'country' => :'country',
    :'voice_enabled' => :'voiceEnabled',
    :'sms_enabled' => :'smsEnabled',
    :'offnet' => :'offnet',
    :'tfn' => :'tfn'
  }
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



284
285
286
 
# File 'lib/freeclimb/models/incoming_number_result.rb', line 284

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



136
137
138
139
140
141
 
# File 'lib/freeclimb/models/incoming_number_result.rb', line 136

def self.openapi_all_of
  [
  :'IncomingNumberResultAllOf',
  :'MutableResourceModel'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/freeclimb/models/incoming_number_result.rb', line 119

def self.openapi_nullable
  Set.new([
    :'campaign_id',
    :'phone_number_id',
    :'account_id',
    :'application_id',
    :'phone_number',
    :'_alias',
    :'region',
    :'country',
    :'voice_enabled',
    :'sms_enabled',
    :'offnet',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/freeclimb/models/incoming_number_result.rb', line 96

def self.openapi_types
  {
    :'uri' => :'String',
    :'date_created' => :'String',
    :'date_updated' => :'String',
    :'revision' => :'Integer',
    :'capabilities' => :'Capabilities',
    :'campaign_id' => :'String',
    :'phone_number_id' => :'String',
    :'account_id' => :'String',
    :'application_id' => :'String',
    :'phone_number' => :'String',
    :'_alias' => :'String',
    :'region' => :'String',
    :'country' => :'String',
    :'voice_enabled' => :'Boolean',
    :'sms_enabled' => :'Boolean',
    :'offnet' => :'Boolean',
    :'tfn' => :'TFN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/freeclimb/models/incoming_number_result.rb', line 247

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      uri == o.uri &&
      date_created == o.date_created &&
      date_updated == o.date_updated &&
      revision == o.revision &&
      capabilities == o.capabilities &&
      campaign_id == o.campaign_id &&
      phone_number_id == o.phone_number_id &&
       == o. &&
      application_id == o.application_id &&
      phone_number == o.phone_number &&
      _alias == o._alias &&
      region == o.region &&
      country == o.country &&
      voice_enabled == o.voice_enabled &&
      sms_enabled == o.sms_enabled &&
      offnet == o.offnet &&
      tfn == o.tfn
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



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/freeclimb/models/incoming_number_result.rb', line 314

def _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 = Freeclimb.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/freeclimb/models/incoming_number_result.rb', line 385

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



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/freeclimb/models/incoming_number_result.rb', line 291

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


271
272
273
 
# File 'lib/freeclimb/models/incoming_number_result.rb', line 271

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



277
278
279
 
# File 'lib/freeclimb/models/incoming_number_result.rb', line 277

def hash
  [uri, date_created, date_updated, revision, capabilities, campaign_id, phone_number_id, , application_id, phone_number, _alias, region, country, voice_enabled, sms_enabled, offnet, tfn].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



229
230
231
232
 
# File 'lib/freeclimb/models/incoming_number_result.rb', line 229

def list_invalid_properties
  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



361
362
363
 
# File 'lib/freeclimb/models/incoming_number_result.rb', line 361

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



367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/freeclimb/models/incoming_number_result.rb', line 367

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



355
356
357
 
# File 'lib/freeclimb/models/incoming_number_result.rb', line 355

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



236
237
238
239
240
241
242
243
 
# File 'lib/freeclimb/models/incoming_number_result.rb', line 236

def valid?
  
  if @uri.nil?
    false
  else
    list_invalid_properties.length() == 0
  end
end