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](www.twilio.com/docs/chat/rest/service-resource) the resource is associated with.

  • sid (String) (defaults to: nil) —

    The SID of the PhoneNumber resource to fetch.



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

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_sid ⇒ String

Returns The SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



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

def 
  @properties['account_sid']
end

#capabilities ⇒ String

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

Returns:

  • (String) —

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



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

def capabilities
  @properties['capabilities']
end

#context ⇒ PhoneNumberContext

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

Returns:



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

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

#country_code ⇒ String

Returns The 2-character ISO Country Code of the number.

Returns:

  • (String) —

    The 2-character ISO Country Code of the number



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

def country_code
  @properties['country_code']
end

#date_created ⇒ Time

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



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

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



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the PhoneNumberInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



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

def delete
  context.delete
end

#fetch ⇒ PhoneNumberInstance

Fetch a PhoneNumberInstance

Returns:



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#phone_number ⇒ String

Returns The phone number in E.164 format.

Returns:

  • (String) —

    The phone number in E.164 format



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

def phone_number
  @properties['phone_number']
end

#service_sid ⇒ String

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



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

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource



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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#url ⇒ String

Returns The absolute URL of the PhoneNumber resource.

Returns:

  • (String) —

    The absolute URL of the PhoneNumber resource



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

def url
  @properties['url']
end