Class: Twilio::REST::Messaging::V1::ServiceContext::PhoneNumberInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Messaging::V1::ServiceContext::PhoneNumberInstance
- 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
-
#account_sid ⇒ String
The SID of the Account that created the resource.
-
#capabilities ⇒ Array[String]
An array of values that describe whether the number can receive calls or messages.
-
#context ⇒ PhoneNumberContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#country_code ⇒ String
The 2-character ISO Country Code of the number.
-
#date_created ⇒ Time
The ISO 8601 date and time in GMT when the resource was created.
-
#date_updated ⇒ Time
The ISO 8601 date and time in GMT when the resource was last updated.
-
#delete ⇒ Boolean
Delete the PhoneNumberInstance.
-
#fetch ⇒ PhoneNumberInstance
Fetch the PhoneNumberInstance.
-
#initialize(version, payload, service_sid: nil, sid: nil) ⇒ PhoneNumberInstance
constructor
Initialize the PhoneNumberInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#phone_number ⇒ String
The phone number in E.164 format.
-
#service_sid ⇒ String
The SID of the Service that the resource is associated with.
-
#sid ⇒ String
The unique string that identifies the resource.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#url ⇒ String
The absolute URL of the PhoneNumber resource.
Constructor Details
#initialize(version, payload, service_sid: nil, sid: nil) ⇒ PhoneNumberInstance
Initialize the PhoneNumberInstance
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_sid ⇒ String
Returns 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 account_sid @properties['account_sid'] end |
#capabilities ⇒ Array[String]
Returns 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 |
#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
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_code ⇒ String
Returns 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_created ⇒ Time
Returns 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_updated ⇒ Time
Returns 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 |
#delete ⇒ Boolean
Delete the PhoneNumberInstance
319 320 321 |
# File 'lib/twilio-ruby/rest/messaging/v1/service/phone_number.rb', line 319 def delete context.delete end |
#fetch ⇒ PhoneNumberInstance
Fetch the PhoneNumberInstance
326 327 328 |
# File 'lib/twilio-ruby/rest/messaging/v1/service/phone_number.rb', line 326 def fetch context.fetch end |
#inspect ⇒ Object
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_number ⇒ String
Returns 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_sid ⇒ String
Returns 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 |
#sid ⇒ String
Returns 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_s ⇒ Object
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 |
#url ⇒ String
Returns 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 |