Class: Twilio::REST::Proxy::V1::ServiceContext::ShortCodeInstance

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

Instance Method Summary collapse

Constructor Details

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

Initialize the ShortCodeInstance

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 ShortCode resource.

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

    The SID of the Call resource to fetch.



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 287

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.

Returns:



328
329
330
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 328

def 
    @properties['account_sid']
end

#capabilities ⇒ ProxyV1ServiceShortCodeCapabilities

Returns:

  • (ProxyV1ServiceShortCodeCapabilities) 


364
365
366
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 364

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

Returns:



313
314
315
316
317
318
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 313

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.

Returns:



340
341
342
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 340

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.

Returns:



346
347
348
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 346

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the ShortCodeInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



383
384
385
386
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 383

def delete

    context.delete
end

#fetch ⇒ ShortCodeInstance

Fetch the ShortCodeInstance

Returns:



391
392
393
394
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 391

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



418
419
420
421
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 418

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.

Returns:



376
377
378
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 376

def is_reserved
    @properties['is_reserved']
end

#iso_country ⇒ String

Returns The ISO Country Code for the short code.

Returns:

  • (String) —

    The ISO Country Code for the short code.



358
359
360
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 358

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.

Returns:



334
335
336
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 334

def service_sid
    @properties['service_sid']
end

#short_code ⇒ String

Returns The short code’s number.

Returns:

  • (String) —

    The short code’s number.



352
353
354
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 352

def short_code
    @properties['short_code']
end

#sid ⇒ String

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

Returns:

  • (String) —

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



322
323
324
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 322

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



411
412
413
414
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 411

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

Parameters:

  • is_reserved (Boolean) (defaults to: :unset) —

    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.

Returns:



400
401
402
403
404
405
406
407
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 400

def update(
    is_reserved: :unset
)

    context.update(
        is_reserved: is_reserved, 
    )
end

#url ⇒ String

Returns The absolute URL of the ShortCode resource.

Returns:

  • (String) —

    The absolute URL of the ShortCode resource.



370
371
372
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 370

def url
    @properties['url']
end