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](www.twilio.com/docs/iam/api/account) that created this ShortCode resource.

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

    The Twilio-provided string that uniquely identifies the ShortCode resource to fetch



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/twilio-ruby/rest/api/v2010/account/short_code.rb', line 256

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 that created this resource.

Returns:

  • (String) —

    The SID of the Account that created this resource



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

def 
  @properties['account_sid']
end

#api_version ⇒ String

Returns The API version used to start a new TwiML session.

Returns:

  • (String) —

    The API version used to start a new TwiML session



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

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:



284
285
286
287
288
289
 
# File 'lib/twilio-ruby/rest/api/v2010/account/short_code.rb', line 284

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

#date_created ⇒ Time

Returns The RFC 2822 date and time in GMT that this resource was created.

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT that this resource was created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The RFC 2822 date and time in GMT that this resource was last updated.

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT that this resource was last updated



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

def date_updated
  @properties['date_updated']
end

#fetch ⇒ ShortCodeInstance

Fetch the ShortCodeInstance

Returns:



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

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns A string that you assigned to describe this resource.

Returns:

  • (String) —

    A string that you assigned to describe this resource



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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.



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

def short_code
  @properties['short_code']
end

#sid ⇒ String

Returns The unique string that identifies this resource.

Returns:

  • (String) —

    The unique string that identifies this resource



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

def sid
  @properties['sid']
end

#sms_fallback_method ⇒ String

Returns HTTP method we use to call the sms_fallback_url.

Returns:

  • (String) —

    HTTP method we use to call the sms_fallback_url



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

def sms_fallback_method
  @properties['sms_fallback_method']
end

#sms_fallback_url ⇒ String

Returns URL Twilio will request if an error occurs in executing TwiML.

Returns:

  • (String) —

    URL Twilio will request if an error occurs in executing TwiML



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

def sms_fallback_url
  @properties['sms_fallback_url']
end

#sms_method ⇒ String

Returns HTTP method to use when requesting the sms url.

Returns:

  • (String) —

    HTTP method to use when requesting the sms url



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

def sms_method
  @properties['sms_method']
end

#sms_url ⇒ String

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

Returns:

  • (String) —

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



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

def sms_url
  @properties['sms_url']
end

#to_s ⇒ Object

Provide a user friendly representation



399
400
401
402
 
# File 'lib/twilio-ruby/rest/api/v2010/account/short_code.rb', line 399

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:



386
387
388
389
390
391
392
393
394
395
 
# File 'lib/twilio-ruby/rest/api/v2010/account/short_code.rb', line 386

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`



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

def uri
  @properties['uri']
end