Class: Twilio::REST::Messaging::V1::ServiceContext::ShortCodeInstance

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

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

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 SID of the [Service](www.twilio.com/docs/chat/rest/service-resource) the resource is associated with.

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

    The SID of the ShortCode resource to fetch.



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/short_code.rb', line 238

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 The SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



278
279
280
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/short_code.rb', line 278

def 
  @properties['account_sid']
end

#capabilities ⇒ String

Returns An array of values that describe whether the number can receive calls or messages.

Returns:

  • (String) —

    An array of values that describe whether the number can receive calls or messages



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

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:



263
264
265
266
267
268
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/short_code.rb', line 263

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

#country_code ⇒ String

Returns The 2-character ISO Country Code of the number.

Returns:

  • (String) —

    The 2-character ISO Country Code of the number



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

def country_code
  @properties['country_code']
end

#date_created ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was created.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was last updated.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was last updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the ShortCodeInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



327
328
329
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/short_code.rb', line 327

def delete
  context.delete
end

#fetch ⇒ ShortCodeInstance

Fetch a ShortCodeInstance

Returns:



334
335
336
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/short_code.rb', line 334

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



347
348
349
350
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/short_code.rb', line 347

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

#service_sid ⇒ String

Returns The SID of the Service that the resource is associated with.

Returns:

  • (String) —

    The SID of the Service that the resource is associated with



284
285
286
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/short_code.rb', line 284

def service_sid
  @properties['service_sid']
end

#short_code ⇒ String

Returns The E.164 format of the short code.

Returns:

  • (String) —

    The E.164 format of the short code



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

def short_code
  @properties['short_code']
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource



272
273
274
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/short_code.rb', line 272

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



340
341
342
343
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/short_code.rb', line 340

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

#url ⇒ String

Returns The absolute URL of the ShortCode resource.

Returns:

  • (String) —

    The absolute URL of the ShortCode resource



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

def url
  @properties['url']
end