Class: Twilio::REST::Proxy::V1::ServiceContext::ShortCodeInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Proxy::V1::ServiceContext::ShortCodeInstance
- Defined in:
- lib/twilio-ruby/rest/proxy/v1/service/short_code.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the ShortCode resource.
- #capabilities ⇒ ProxyV1ServiceShortCodeCapabilities
-
#context ⇒ ShortCodeContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#date_created ⇒ Time
The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the resource was created.
-
#date_updated ⇒ Time
The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the resource was last updated.
-
#delete ⇒ Boolean
Delete the ShortCodeInstance.
-
#fetch ⇒ ShortCodeInstance
Fetch the ShortCodeInstance.
-
#initialize(version, payload, service_sid: nil, sid: nil) ⇒ ShortCodeInstance
constructor
Initialize the ShortCodeInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#is_reserved ⇒ Boolean
Whether the short code should be reserved and not be assigned to a participant using proxy pool logic.
-
#iso_country ⇒ String
The ISO Country Code for the short code.
-
#service_sid ⇒ String
The SID of the ShortCode resource’s parent [Service](www.twilio.com/docs/proxy/api/service) resource.
-
#short_code ⇒ String
The short code’s number.
-
#sid ⇒ String
The unique string that we created to identify the ShortCode resource.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#update(is_reserved: :unset) ⇒ ShortCodeInstance
Update the ShortCodeInstance.
-
#url ⇒ String
The absolute URL of the ShortCode resource.
Constructor Details
#initialize(version, payload, service_sid: nil, sid: nil) ⇒ ShortCodeInstance
Initialize the ShortCodeInstance
264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 |
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 264 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']), 'short_code' => payload['short_code'], 'iso_country' => payload['iso_country'], 'capabilities' => payload['capabilities'], 'url' => payload['url'], 'is_reserved' => payload['is_reserved'], } # Context @instance_context = nil @params = { 'service_sid' => service_sid || @properties['service_sid'] ,'sid' => sid || @properties['sid'] , } end |
Instance Method Details
#account_sid ⇒ String
Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the ShortCode resource.
305 306 307 |
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 305 def account_sid @properties['account_sid'] end |
#capabilities ⇒ ProxyV1ServiceShortCodeCapabilities
341 342 343 |
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 341 def capabilities @properties['capabilities'] end |
#context ⇒ ShortCodeContext
Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context
290 291 292 293 294 295 |
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 290 def context unless @instance_context @instance_context = ShortCodeContext.new(@version , @params['service_sid'], @params['sid']) end @instance_context end |
#date_created ⇒ Time
Returns The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the resource was created.
317 318 319 |
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 317 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
Returns The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the resource was last updated.
323 324 325 |
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 323 def date_updated @properties['date_updated'] end |
#delete ⇒ Boolean
Delete the ShortCodeInstance
360 361 362 363 |
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 360 def delete context.delete end |
#fetch ⇒ ShortCodeInstance
Fetch the ShortCodeInstance
368 369 370 371 |
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 368 def fetch context.fetch end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
395 396 397 398 |
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 395 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Proxy.V1.ShortCodeInstance #{values}>" end |
#is_reserved ⇒ Boolean
Returns Whether the short code should be reserved and not be assigned to a participant using proxy pool logic. See [Reserved Phone Numbers](www.twilio.com/docs/proxy/reserved-phone-numbers) for more information.
353 354 355 |
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 353 def is_reserved @properties['is_reserved'] end |
#iso_country ⇒ String
Returns The ISO Country Code for the short code.
335 336 337 |
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 335 def iso_country @properties['iso_country'] end |
#service_sid ⇒ String
Returns The SID of the ShortCode resource’s parent [Service](www.twilio.com/docs/proxy/api/service) resource.
311 312 313 |
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 311 def service_sid @properties['service_sid'] end |
#short_code ⇒ String
Returns The short code’s number.
329 330 331 |
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 329 def short_code @properties['short_code'] end |
#sid ⇒ String
Returns The unique string that we created to identify the ShortCode resource.
299 300 301 |
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 299 def sid @properties['sid'] end |
#to_s ⇒ Object
Provide a user friendly representation
388 389 390 391 |
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 388 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Proxy.V1.ShortCodeInstance #{values}>" end |
#update(is_reserved: :unset) ⇒ ShortCodeInstance
Update the ShortCodeInstance
377 378 379 380 381 382 383 384 |
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 377 def update( is_reserved: :unset ) context.update( is_reserved: is_reserved, ) end |
#url ⇒ String
Returns The absolute URL of the ShortCode resource.
347 348 349 |
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 347 def url @properties['url'] end |