Class: Twilio::REST::Preview::Proxy::ServiceContext::ShortCodeInstance

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

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected].

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

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

    The unique SID identifier of the Service.

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

    The shortcode Sid that uniquely identifies this resource



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/short_code.rb', line 249

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'],
      'country_code' => payload['country_code'],
      'capabilities' => payload['capabilities'],
      'url' => payload['url'],
  }

  # Context
  @instance_context = nil
  @params = {
      'service_sid' => service_sid,
      'sid' => sid || @properties['sid'],
  }
end

Instance Method Details

#account_sid ⇒ String

Returns Account Sid.

Returns:

  • (String) —

    Account Sid.



296
297
298
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/short_code.rb', line 296

def 
  @properties['account_sid']
end

#capabilities ⇒ Hash

Returns Indicate if a shortcode can receive messages.

Returns:

  • (Hash) —

    Indicate if a shortcode can receive messages



332
333
334
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/short_code.rb', line 332

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:



277
278
279
280
281
282
283
284
285
286
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/short_code.rb', line 277

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

#country_code ⇒ String

Returns The ISO 3166-1 alpha-2 country code.

Returns:

  • (String) —

    The ISO 3166-1 alpha-2 country code



326
327
328
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/short_code.rb', line 326

def country_code
  @properties['country_code']
end

#date_created ⇒ Time

Returns The date this resource was created.

Returns:

  • (Time) —

    The date this resource was created



308
309
310
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/short_code.rb', line 308

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



314
315
316
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/short_code.rb', line 314

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the ShortCodeInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#fetch ⇒ ShortCodeInstance

Fetch a ShortCodeInstance

Returns:



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



365
366
367
368
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/short_code.rb', line 365

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

#service_sid ⇒ String

Returns Service Sid.

Returns:

  • (String) —

    Service Sid.



302
303
304
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/short_code.rb', line 302

def service_sid
  @properties['service_sid']
end

#short_code ⇒ String

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

Returns:

  • (String) —

    The short code. e.g., 894546.



320
321
322
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/short_code.rb', line 320

def short_code
  @properties['short_code']
end

#sid ⇒ String

Returns A string that uniquely identifies this resource.

Returns:

  • (String) —

    A string that uniquely identifies this resource



290
291
292
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/short_code.rb', line 290

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#url ⇒ String

Returns The URL of this resource.

Returns:

  • (String) —

    The URL of this resource.



338
339
340
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/short_code.rb', line 338

def url
  @properties['url']
end