Class: Twilio::REST::Messaging::V1::ServiceContext::PhoneNumberInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/messaging/v1/service/phone_number.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, service_sid: nil, sid: nil) ⇒ PhoneNumberInstance

Initialize the PhoneNumberInstance

Parameters:

  • version (Version)

    Version that contains the resource

  • payload (Hash)

    payload that contains response from Twilio

  • account_sid (String)

    The SID of the Account that created this PhoneNumber resource.

  • sid (String) (defaults to: nil)

    The SID of the Call resource to fetch.



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
# File 'lib/twilio-ruby/rest/messaging/v1/service/phone_number.rb', line 242

def initialize(version, payload , service_sid: nil, sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'account_sid' => payload['account_sid'],
        'service_sid' => payload['service_sid'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'phone_number' => payload['phone_number'],
        'country_code' => payload['country_code'],
        'capabilities' => payload['capabilities'],
        'url' => payload['url'],
    }

    # Context
    @instance_context = nil
    @params = { 'service_sid' => service_sid  || @properties['service_sid']  ,'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sidString

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the PhoneNumber resource.

Returns:



282
283
284
# File 'lib/twilio-ruby/rest/messaging/v1/service/phone_number.rb', line 282

def 
    @properties['account_sid']
end

#capabilitiesArray<String>

Returns An array of values that describe whether the number can receive calls or messages. Can be: ‘Voice`, `SMS`, and `MMS`.

Returns:

  • (Array<String>)

    An array of values that describe whether the number can receive calls or messages. Can be: ‘Voice`, `SMS`, and `MMS`.



318
319
320
# File 'lib/twilio-ruby/rest/messaging/v1/service/phone_number.rb', line 318

def capabilities
    @properties['capabilities']
end

#contextPhoneNumberContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



267
268
269
270
271
272
# File 'lib/twilio-ruby/rest/messaging/v1/service/phone_number.rb', line 267

def context
    unless @instance_context
        @instance_context = PhoneNumberContext.new(@version , @params['service_sid'], @params['sid'])
    end
    @instance_context
end

#country_codeString

Returns The 2-character [ISO Country Code](www.iso.org/iso-3166-country-codes.html) of the number.

Returns:



312
313
314
# File 'lib/twilio-ruby/rest/messaging/v1/service/phone_number.rb', line 312

def country_code
    @properties['country_code']
end

#date_createdTime

Returns The date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



294
295
296
# File 'lib/twilio-ruby/rest/messaging/v1/service/phone_number.rb', line 294

def date_created
    @properties['date_created']
end

#date_updatedTime

Returns The date and time in GMT when the resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



300
301
302
# File 'lib/twilio-ruby/rest/messaging/v1/service/phone_number.rb', line 300

def date_updated
    @properties['date_updated']
end

#deleteBoolean

Delete the PhoneNumberInstance

Returns:

  • (Boolean)

    True if delete succeeds, false otherwise



331
332
333
334
# File 'lib/twilio-ruby/rest/messaging/v1/service/phone_number.rb', line 331

def delete

    context.delete
end

#fetchPhoneNumberInstance

Fetch the PhoneNumberInstance

Returns:



339
340
341
342
# File 'lib/twilio-ruby/rest/messaging/v1/service/phone_number.rb', line 339

def fetch

    context.fetch
end

#inspectObject

Provide a detailed, user friendly representation



353
354
355
356
# File 'lib/twilio-ruby/rest/messaging/v1/service/phone_number.rb', line 353

def inspect
    values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Messaging.V1.PhoneNumberInstance #{values}>"
end

#phone_numberString

Returns The phone number in [E.164](www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number.

Returns:



306
307
308
# File 'lib/twilio-ruby/rest/messaging/v1/service/phone_number.rb', line 306

def phone_number
    @properties['phone_number']
end

#service_sidString

Returns The SID of the [Service](www.twilio.com/docs/chat/rest/service-resource) the resource is associated with.

Returns:



288
289
290
# File 'lib/twilio-ruby/rest/messaging/v1/service/phone_number.rb', line 288

def service_sid
    @properties['service_sid']
end

#sidString

Returns The unique string that we created to identify the PhoneNumber resource.

Returns:

  • (String)

    The unique string that we created to identify the PhoneNumber resource.



276
277
278
# File 'lib/twilio-ruby/rest/messaging/v1/service/phone_number.rb', line 276

def sid
    @properties['sid']
end

#to_sObject

Provide a user friendly representation



346
347
348
349
# File 'lib/twilio-ruby/rest/messaging/v1/service/phone_number.rb', line 346

def to_s
    values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Messaging.V1.PhoneNumberInstance #{values}>"
end

#urlString

Returns The absolute URL of the PhoneNumber resource.

Returns:

  • (String)

    The absolute URL of the PhoneNumber resource.



324
325
326
# File 'lib/twilio-ruby/rest/messaging/v1/service/phone_number.rb', line 324

def url
    @properties['url']
end