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 unique id of the Account that owns this short code.

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

    The short-code Sid that uniquely identifies this resource



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/twilio-ruby/rest/api/v2010/account/short_code.rb', line 271

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 unique sid that identifies this account.

Returns:

  • (String) —

    The unique sid that identifies this account



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

def 
  @properties['account_sid']
end

#api_version ⇒ String

Returns The API version to use.

Returns:

  • (String) —

    The API version to use



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

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:



302
303
304
305
306
307
308
309
310
311
 
# File 'lib/twilio-ruby/rest/api/v2010/account/short_code.rb', line 302

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

Returns:

  • (Time) —

    The date this resource was created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date this resource was last updated.

Returns:

  • (Time) —

    The date this resource was last updated



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

def date_updated
  @properties['date_updated']
end

#fetch ⇒ ShortCodeInstance

Fetch a ShortCodeInstance

Returns:



388
389
390
 
# File 'lib/twilio-ruby/rest/api/v2010/account/short_code.rb', line 388

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns A human readable description of this resource.

Returns:

  • (String) —

    A human readable description of this resource



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



428
429
430
431
 
# File 'lib/twilio-ruby/rest/api/v2010/account/short_code.rb', line 428

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.



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

def short_code
  @properties['short_code']
end

#sid ⇒ String

Returns A string that uniquely identifies this short-codes.

Returns:

  • (String) —

    A string that uniquely identifies this short-codes



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

def sid
  @properties['sid']
end

#sms_fallback_method ⇒ String

Returns HTTP method Twilio will use with sms fallback url.

Returns:

  • (String) —

    HTTP method Twilio will use with sms fallback url



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

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



363
364
365
 
# File 'lib/twilio-ruby/rest/api/v2010/account/short_code.rb', line 363

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



369
370
371
 
# File 'lib/twilio-ruby/rest/api/v2010/account/short_code.rb', line 369

def sms_method
  @properties['sms_method']
end

#sms_url ⇒ String

Returns URL Twilio will request when receiving an SMS.

Returns:

  • (String) —

    URL Twilio will request when receiving an SMS



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

def sms_url
  @properties['sms_url']
end

#to_s ⇒ Object

Provide a user friendly representation



421
422
423
424
 
# File 'lib/twilio-ruby/rest/api/v2010/account/short_code.rb', line 421

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 human readable descriptive text for this resource, up to 64 characters long. By default, the ‘FriendlyName` is just the short code.

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

    SMSs to this short code will start a new TwiML session with this API version.

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

    The URL Twilio will request when receiving an incoming SMS message to this short code.

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

    The HTTP method Twilio will use when making requests to the ‘SmsUrl`. Either `GET` or `POST`.

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

    The URL that Twilio will request if an error occurs retrieving or executing the TwiML from ‘SmsUrl`.

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

    The HTTP method Twilio will use when requesting the above URL. Either ‘GET` or `POST`.

Returns:



408
409
410
411
412
413
414
415
416
417
 
# File 'lib/twilio-ruby/rest/api/v2010/account/short_code.rb', line 408

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 for this resource.

Returns:

  • (String) —

    The URI for this resource



381
382
383
 
# File 'lib/twilio-ruby/rest/api/v2010/account/short_code.rb', line 381

def uri
  @properties['uri']
end