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



142
143
144
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
 
# File 'lib/freeclimb/models/incoming_number_result.rb', line 142

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.



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

def _alias
  @_alias
end

#account_id ⇒ Object

ID of the account that owns this phone number.



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

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.



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

def application_id
  @application_id
end

#campaign_id ⇒ Object

The campaign ID generated by the campaign registry



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

def campaign_id
  @campaign_id
end

#capabilities ⇒ Object

Returns the value of attribute capabilities.



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

def capabilities
  @capabilities
end

#country ⇒ Object

Country of this phone number.



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

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



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

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



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

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.



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

def offnet
  @offnet
end

#phone_number ⇒ Object

Phone number in E.164 format.



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

def phone_number
  @phone_number
end

#phone_number_id ⇒ Object

String that uniquely identifies this phone number resource.



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

def phone_number_id
  @phone_number_id
end

#region ⇒ Object

State or province of this phone number.



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

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.



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

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.



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

def sms_enabled
  @sms_enabled
end

#tfn ⇒ Object

Returns the value of attribute tfn.



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

def tfn
  @tfn
end

#uri ⇒ Object

The URI for this resource, relative to /apiserver.



17
18
19
 
# File 'lib/freeclimb/models/incoming_number_result.rb', line 17

def uri
  @uri
end

#voice_enabled ⇒ Object

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



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

def voice_enabled
  @voice_enabled
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



89
90
91
 
# File 'lib/freeclimb/models/incoming_number_result.rb', line 89

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

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



279
280
281
 
# File 'lib/freeclimb/models/incoming_number_result.rb', line 279

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



134
135
136
137
138
 
# File 'lib/freeclimb/models/incoming_number_result.rb', line 134

def self.openapi_all_of
  [
    :MutableResourceModel
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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.



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

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

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/freeclimb/models/incoming_number_result.rb', line 242

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



309
310
311
312
313
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
 
# File 'lib/freeclimb/models/incoming_number_result.rb', line 309

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



380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/freeclimb/models/incoming_number_result.rb', line 380

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



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/freeclimb/models/incoming_number_result.rb', line 286

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)
      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)
        send(:"#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      send(:"#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


266
267
268
 
# File 'lib/freeclimb/models/incoming_number_result.rb', line 266

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

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



226
227
228
 
# File 'lib/freeclimb/models/incoming_number_result.rb', line 226

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



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

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



362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/freeclimb/models/incoming_number_result.rb', line 362

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = 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



350
351
352
 
# File 'lib/freeclimb/models/incoming_number_result.rb', line 350

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



232
233
234
235
236
237
238
 
# File 'lib/freeclimb/models/incoming_number_result.rb', line 232

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