Class: PhoneComClient::ExtensionFull

Inherits:
Object
  • Object
show all
Defined in:
lib/phone_com_client/models/extension_full.rb

Overview

The Full Extension Object has the same properties as the Extension Summary Object, along with the following:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ExtensionFull

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/phone_com_client/models/extension_full.rb', line 114

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.has_key?(:'extension')
    self.extension = attributes[:'extension']
  end

  if attributes.has_key?(:'voip_id')
    self.voip_id = attributes[:'voip_id']
  end

  if attributes.has_key?(:'full_name')
    self.full_name = attributes[:'full_name']
  end

  if attributes.has_key?(:'usage_type')
    self.usage_type = attributes[:'usage_type']
  end

  if attributes.has_key?(:'device_membership')
    self.device_membership = attributes[:'device_membership']
  end

  if attributes.has_key?(:'timezone')
    self.timezone = attributes[:'timezone']
  end

  if attributes.has_key?(:'name_greeting')
    self.name_greeting = attributes[:'name_greeting']
  end

  if attributes.has_key?(:'include_in_directory')
    self.include_in_directory = attributes[:'include_in_directory']
  end

  if attributes.has_key?(:'caller_id')
    self.caller_id = attributes[:'caller_id']
  end

  if attributes.has_key?(:'local_area_code')
    self.local_area_code = attributes[:'local_area_code']
  end

  if attributes.has_key?(:'enable_call_waiting')
    self.enable_call_waiting = attributes[:'enable_call_waiting']
  end

  if attributes.has_key?(:'enable_outbound_calls')
    self.enable_outbound_calls = attributes[:'enable_outbound_calls']
  end

  if attributes.has_key?(:'voicemail')
    self.voicemail = attributes[:'voicemail']
  end

  if attributes.has_key?(:'call_notifications')
    self.call_notifications = attributes[:'call_notifications']
  end

  if attributes.has_key?(:'route')
    self.route = attributes[:'route']
  end
end

Instance Attribute Details

#call_notifications ⇒ Object

Returns the value of attribute call_notifications.



61
62
63
 
# File 'lib/phone_com_client/models/extension_full.rb', line 61

def call_notifications
  @call_notifications
end

#caller_id ⇒ Object

Phone number to use as Caller ID for outgoing calls. Must be a phone number belonging to this account, or one of any additional authorized phone numbers. You can use our List Caller Ids service to see a current list. To unassign, you may set this to "private", NULL, or an empty string.



48
49
50
 
# File 'lib/phone_com_client/models/extension_full.rb', line 48

def caller_id
  @caller_id
end

#device_membership ⇒ Object

Returns the value of attribute device_membership.



36
37
38
 
# File 'lib/phone_com_client/models/extension_full.rb', line 36

def device_membership
  @device_membership
end

#enable_call_waiting ⇒ Object

Whether Call Waiting is enabled. Boolean. Default is TRUE.



54
55
56
 
# File 'lib/phone_com_client/models/extension_full.rb', line 54

def enable_call_waiting
  @enable_call_waiting
end

#enable_outbound_calls ⇒ Object

Whether outgoing calls are enabled. Boolean. Default is TRUE.



57
58
59
 
# File 'lib/phone_com_client/models/extension_full.rb', line 57

def enable_outbound_calls
  @enable_outbound_calls
end

#extension ⇒ Object

Extension number that callers may dial. On POST, leaving this empty will result in an auto-generated value. On PUT, this field is required.



25
26
27
 
# File 'lib/phone_com_client/models/extension_full.rb', line 25

def extension
  @extension
end

#full_name ⇒ Object

Full name of the individual or department to which this extension is assigned



31
32
33
 
# File 'lib/phone_com_client/models/extension_full.rb', line 31

def full_name
  @full_name
end

#id ⇒ Object

ID of the extension. This is the internal Phone.com ID, not the extension number callers may dial.



19
20
21
 
# File 'lib/phone_com_client/models/extension_full.rb', line 19

def id
  @id
end

#include_in_directory ⇒ Object

Whether this extension should be included in the dial-by-name directory for this account. Boolean.



45
46
47
 
# File 'lib/phone_com_client/models/extension_full.rb', line 45

def include_in_directory
  @include_in_directory
end

#local_area_code ⇒ Object

For outbound calls, this is the North American area code that this extension is calling from.



51
52
53
 
# File 'lib/phone_com_client/models/extension_full.rb', line 51

def local_area_code
  @local_area_code
end

#name ⇒ Object

User-supplied name for the extension. On POST, leaving this empty will result in an auto-generated value. On PUT, this field is required.



22
23
24
 
# File 'lib/phone_com_client/models/extension_full.rb', line 22

def name
  @name
end

#name_greeting ⇒ Object

Greeting that communicates the extension’s name. Output is a Greeting Summary Object. Input must be a Greeting Lookup Object.



42
43
44
 
# File 'lib/phone_com_client/models/extension_full.rb', line 42

def name_greeting
  @name_greeting
end

#route ⇒ Object

Route which will handle incoming voice and fax calls. Only valid on PUT requests, not POST. Output is a Route Summary Object if the route is named, otherwise the Full Route Object will be shown. Input must be a Route Lookup Object pointing to a named route. Route must belong to this extension already.



64
65
66
 
# File 'lib/phone_com_client/models/extension_full.rb', line 64

def route
  @route
end

#timezone ⇒ Object

Time zone. Can be in any commonly recognized format, such as "America/Los_Angeles".



39
40
41
 
# File 'lib/phone_com_client/models/extension_full.rb', line 39

def timezone
  @timezone
end

#usage_type ⇒ Object

Can be "limited" or "unlimited". In most cases, changing this will affect your monthly bill. Please see our Control Panel or contact Customer Service for pricing.



34
35
36
 
# File 'lib/phone_com_client/models/extension_full.rb', line 34

def usage_type
  @usage_type
end

#voicemail ⇒ Object

Returns the value of attribute voicemail.



59
60
61
 
# File 'lib/phone_com_client/models/extension_full.rb', line 59

def voicemail
  @voicemail
end

#voip_id ⇒ Object

API Account ID. Optional, object may return the voip_id.



28
29
30
 
# File 'lib/phone_com_client/models/extension_full.rb', line 28

def voip_id
  @voip_id
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'extension' => :'extension',
    :'voip_id' => :'voip_id',
    :'full_name' => :'full_name',
    :'usage_type' => :'usage_type',
    :'device_membership' => :'device_membership',
    :'timezone' => :'timezone',
    :'name_greeting' => :'name_greeting',
    :'include_in_directory' => :'include_in_directory',
    :'caller_id' => :'caller_id',
    :'local_area_code' => :'local_area_code',
    :'enable_call_waiting' => :'enable_call_waiting',
    :'enable_outbound_calls' => :'enable_outbound_calls',
    :'voicemail' => :'voicemail',
    :'call_notifications' => :'call_notifications',
    :'route' => :'route'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/phone_com_client/models/extension_full.rb', line 90

def self.swagger_types
  {
    :'id' => :'Integer',
    :'name' => :'String',
    :'extension' => :'Integer',
    :'voip_id' => :'Integer',
    :'full_name' => :'String',
    :'usage_type' => :'String',
    :'device_membership' => :'DeviceMembership',
    :'timezone' => :'String',
    :'name_greeting' => :'MediaSummary',
    :'include_in_directory' => :'BOOLEAN',
    :'caller_id' => :'String',
    :'local_area_code' => :'String',
    :'enable_call_waiting' => :'BOOLEAN',
    :'enable_outbound_calls' => :'BOOLEAN',
    :'voicemail' => :'Voicemail',
    :'call_notifications' => :'Notification',
    :'route' => :'RouteSummary'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/phone_com_client/models/extension_full.rb', line 204

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      extension == o.extension &&
      voip_id == o.voip_id &&
      full_name == o.full_name &&
      usage_type == o.usage_type &&
      device_membership == o.device_membership &&
      timezone == o.timezone &&
      name_greeting == o.name_greeting &&
      include_in_directory == o.include_in_directory &&
      caller_id == o.caller_id &&
      local_area_code == o.local_area_code &&
      enable_call_waiting == o.enable_call_waiting &&
      enable_outbound_calls == o.enable_outbound_calls &&
      voicemail == o.voicemail &&
      call_notifications == o.call_notifications &&
      route == o.route
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



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/phone_com_client/models/extension_full.rb', line 262

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
    temp_model = PhoneComClient.const_get(type).new
    temp_model.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



328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/phone_com_client/models/extension_full.rb', line 328

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



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/phone_com_client/models/extension_full.rb', line 241

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the 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


228
229
230
 
# File 'lib/phone_com_client/models/extension_full.rb', line 228

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



234
235
236
 
# File 'lib/phone_com_client/models/extension_full.rb', line 234

def hash
  [id, name, extension, voip_id, full_name, usage_type, device_membership, timezone, name_greeting, include_in_directory, caller_id, local_area_code, enable_call_waiting, enable_outbound_calls, voicemail, call_notifications, route].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



191
192
193
194
 
# File 'lib/phone_com_client/models/extension_full.rb', line 191

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



308
309
310
 
# File 'lib/phone_com_client/models/extension_full.rb', line 308

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



314
315
316
317
318
319
320
321
322
 
# File 'lib/phone_com_client/models/extension_full.rb', line 314

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



302
303
304
 
# File 'lib/phone_com_client/models/extension_full.rb', line 302

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



198
199
200
 
# File 'lib/phone_com_client/models/extension_full.rb', line 198

def valid?
  true
end