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



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/twilio-ruby/rest/api/v2010/account/short_code.rb', line 246

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



283
284
285
 
# File 'lib/twilio-ruby/rest/api/v2010/account/short_code.rb', line 283

def 
  @properties['account_sid']
end

#api_version ⇒ String

Returns The API version to use.

Returns:

  • (String) —

    The API version to use



289
290
291
 
# File 'lib/twilio-ruby/rest/api/v2010/account/short_code.rb', line 289

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:



274
275
276
277
278
279
 
# File 'lib/twilio-ruby/rest/api/v2010/account/short_code.rb', line 274

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



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

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



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

def date_updated
  @properties['date_updated']
end

#fetch ⇒ ShortCodeInstance

Fetch a ShortCodeInstance

Returns:



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

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



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



396
397
398
399
 
# File 'lib/twilio-ruby/rest/api/v2010/account/short_code.rb', line 396

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.



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

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



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

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



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

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



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

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



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

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



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

def sms_url
  @properties['sms_url']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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:



376
377
378
379
380
381
382
383
384
385
 
# File 'lib/twilio-ruby/rest/api/v2010/account/short_code.rb', line 376

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



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

def uri
  @properties['uri']
end