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

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

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

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

  • service_sid (String) (defaults to: nil)

    The SID of the Service the resource is associated with.

  • sid (String) (defaults to: nil)

    The SID of the PhoneNumber resource to fetch.


230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
# File 'lib/twilio-ruby/rest/messaging/v1/service/phone_number.rb', line 230

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, 'sid' => sid || @properties['sid'], }
end

Instance Method Details

#account_sidString

Returns The SID of the Account that created the resource.

Returns:

  • (String)

    The SID of the Account that created the resource


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

def 
  @properties['account_sid']
end

#capabilitiesArray[String]

Returns An array of values that describe whether the number can receive calls or messages.

Returns:

  • (Array[String])

    An array of values that describe whether the number can receive calls or messages


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

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:


255
256
257
258
259
260
# File 'lib/twilio-ruby/rest/messaging/v1/service/phone_number.rb', line 255

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 of the number.

Returns:

  • (String)

    The 2-character ISO Country Code of the number


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

def country_code
  @properties['country_code']
end

#date_createdTime

Returns The ISO 8601 date and time in GMT when the resource was created.

Returns:

  • (Time)

    The ISO 8601 date and time in GMT when the resource was created


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

def date_created
  @properties['date_created']
end

#date_updatedTime

Returns The ISO 8601 date and time in GMT when the resource was last updated.

Returns:

  • (Time)

    The ISO 8601 date and time in GMT when the resource was last updated


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

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Delete the PhoneNumberInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


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

def delete
  context.delete
end

#fetchPhoneNumberInstance

Fetch the PhoneNumberInstance

Returns:


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

def fetch
  context.fetch
end

#inspectObject

Provide a detailed, user friendly representation


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

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

Returns:

  • (String)

    The phone number in E.164 format


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

def phone_number
  @properties['phone_number']
end

#service_sidString

Returns The SID of the Service that the resource is associated with.

Returns:

  • (String)

    The SID of the Service that the resource is associated with


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

def service_sid
  @properties['service_sid']
end

#sidString

Returns The unique string that identifies the resource.

Returns:

  • (String)

    The unique string that identifies the resource


264
265
266
# File 'lib/twilio-ruby/rest/messaging/v1/service/phone_number.rb', line 264

def sid
  @properties['sid']
end

#to_sObject

Provide a user friendly representation


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

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


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

def url
  @properties['url']
end