Class: Twilio::REST::Api::V2010::AccountContext::ShortCodeInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/short_code.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, account_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) (defaults to: nil) —

    The SID of the Account that created this ShortCode resource.

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

    The SID of the Call resource to fetch.



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/twilio-ruby/rest/api/v2010/account/short_code.rb', line 263

def initialize(version, payload , account_sid: nil, sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'api_version' => payload['api_version'],
        'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
        'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
        'friendly_name' => payload['friendly_name'],
        'short_code' => payload['short_code'],
        'sid' => payload['sid'],
        'sms_fallback_method' => payload['sms_fallback_method'],
        'sms_fallback_url' => payload['sms_fallback_url'],
        'sms_method' => payload['sms_method'],
        'sms_url' => payload['sms_url'],
        'uri' => payload['uri'],
    }

    # Context
    @instance_context = nil
    @params = { 'account_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 this ShortCode resource.

Returns:



300
301
302
 
# File 'lib/twilio-ruby/rest/api/v2010/account/short_code.rb', line 300

def 
    @properties['account_sid']
end

#api_version ⇒ String

Returns The API version used to start a new TwiML session when an SMS message is sent to this short code.

Returns:

  • (String) —

    The API version used to start a new TwiML session when an SMS message is sent to this short code.



306
307
308
 
# File 'lib/twilio-ruby/rest/api/v2010/account/short_code.rb', line 306

def api_version
    @properties['api_version']
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:



291
292
293
294
295
296
 
# File 'lib/twilio-ruby/rest/api/v2010/account/short_code.rb', line 291

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

#date_created ⇒ Time

Returns The date and time in GMT that this resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



312
313
314
 
# File 'lib/twilio-ruby/rest/api/v2010/account/short_code.rb', line 312

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT that this resource was last updated, specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



318
319
320
 
# File 'lib/twilio-ruby/rest/api/v2010/account/short_code.rb', line 318

def date_updated
    @properties['date_updated']
end

#fetch ⇒ ShortCodeInstance

Fetch the ShortCodeInstance

Returns:



373
374
375
376
 
# File 'lib/twilio-ruby/rest/api/v2010/account/short_code.rb', line 373

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns A string that you assigned to describe this resource. By default, the ‘FriendlyName` is the short code.

Returns:

  • (String) —

    A string that you assigned to describe this resource. By default, the ‘FriendlyName` is the short code.



324
325
326
 
# File 'lib/twilio-ruby/rest/api/v2010/account/short_code.rb', line 324

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



415
416
417
418
 
# File 'lib/twilio-ruby/rest/api/v2010/account/short_code.rb', line 415

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

#short_code ⇒ String

Returns The short code. e.g., 894546.

Returns:

  • (String) —

    The short code. e.g., 894546.



330
331
332
 
# File 'lib/twilio-ruby/rest/api/v2010/account/short_code.rb', line 330

def short_code
    @properties['short_code']
end

#sid ⇒ String

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

Returns:

  • (String) —

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



336
337
338
 
# File 'lib/twilio-ruby/rest/api/v2010/account/short_code.rb', line 336

def sid
    @properties['sid']
end

#sms_fallback_method ⇒ String

Returns The HTTP method we use to call the ‘sms_fallback_url`. Can be: `GET` or `POST`.

Returns:

  • (String) —

    The HTTP method we use to call the ‘sms_fallback_url`. Can be: `GET` or `POST`.



342
343
344
 
# File 'lib/twilio-ruby/rest/api/v2010/account/short_code.rb', line 342

def sms_fallback_method
    @properties['sms_fallback_method']
end

#sms_fallback_url ⇒ String

Returns The URL that we call if an error occurs while retrieving or executing the TwiML from ‘sms_url`.

Returns:

  • (String) —

    The URL that we call if an error occurs while retrieving or executing the TwiML from ‘sms_url`.



348
349
350
 
# File 'lib/twilio-ruby/rest/api/v2010/account/short_code.rb', line 348

def sms_fallback_url
    @properties['sms_fallback_url']
end

#sms_method ⇒ String

Returns The HTTP method we use to call the ‘sms_url`. Can be: `GET` or `POST`.

Returns:

  • (String) —

    The HTTP method we use to call the ‘sms_url`. Can be: `GET` or `POST`.



354
355
356
 
# File 'lib/twilio-ruby/rest/api/v2010/account/short_code.rb', line 354

def sms_method
    @properties['sms_method']
end

#sms_url ⇒ String

Returns The URL we call when receiving an incoming SMS message to this short code.

Returns:

  • (String) —

    The URL we call when receiving an incoming SMS message to this short code.



360
361
362
 
# File 'lib/twilio-ruby/rest/api/v2010/account/short_code.rb', line 360

def sms_url
    @properties['sms_url']
end

#to_s ⇒ Object

Provide a user friendly representation



408
409
410
411
 
# File 'lib/twilio-ruby/rest/api/v2010/account/short_code.rb', line 408

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

#update(friendly_name: :unset, api_version: :unset, sms_url: :unset, sms_method: :unset, sms_fallback_url: :unset, sms_fallback_method: :unset) ⇒ ShortCodeInstance

Update the ShortCodeInstance

Parameters:

  • friendly_name (String) (defaults to: :unset) —

    A descriptive string that you created to describe this resource. It can be up to 64 characters long. By default, the ‘FriendlyName` is the short code.

  • api_version (String) (defaults to: :unset) —

    The API version to use to start a new TwiML session. Can be: ‘2010-04-01` or `2008-08-01`.

  • sms_url (String) (defaults to: :unset) —

    The URL we should call when receiving an incoming SMS message to this short code.

  • sms_method (String) (defaults to: :unset) —

    The HTTP method we should use when calling the ‘sms_url`. Can be: `GET` or `POST`.

  • sms_fallback_url (String) (defaults to: :unset) —

    The URL that we should call if an error occurs while retrieving or executing the TwiML from ‘sms_url`.

  • sms_fallback_method (String) (defaults to: :unset) —

    The HTTP method that we should use to call the ‘sms_fallback_url`. Can be: `GET` or `POST`.

Returns:



387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/twilio-ruby/rest/api/v2010/account/short_code.rb', line 387

def update(
    friendly_name: :unset, 
    api_version: :unset, 
    sms_url: :unset, 
    sms_method: :unset, 
    sms_fallback_url: :unset, 
    sms_fallback_method: :unset
)

    context.update(
        friendly_name: friendly_name, 
        api_version: api_version, 
        sms_url: sms_url, 
        sms_method: sms_method, 
        sms_fallback_url: sms_fallback_url, 
        sms_fallback_method: sms_fallback_method, 
    )
end

#uri ⇒ String

Returns The URI of this resource, relative to ‘api.twilio.com`.

Returns:

  • (String) —

    The URI of this resource, relative to ‘api.twilio.com`.



366
367
368
 
# File 'lib/twilio-ruby/rest/api/v2010/account/short_code.rb', line 366

def uri
    @properties['uri']
end