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

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

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

  • account_sid (String) —

    The SID of the Account that created this ShortCode resource.

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

    The SID of the Call resource to fetch.



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

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  || @properties['service_sid']  ,'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the ShortCode resource.

Returns:



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

def 
    @properties['account_sid']
end

#capabilities ⇒ Array<String>

Returns An array of values that describe whether the number can receive calls or messages. Can be: ‘SMS` and `MMS`.

Returns:

  • (Array<String>) —

    An array of values that describe whether the number can receive calls or messages. Can be: ‘SMS` and `MMS`.



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

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:



267
268
269
270
271
272
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/short_code.rb', line 267

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](www.iso.org/iso-3166-country-codes.html) of the number.

Returns:



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

def country_code
    @properties['country_code']
end

#date_created ⇒ Time

Returns The date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT when the resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the ShortCodeInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



331
332
333
334
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/short_code.rb', line 331

def delete

    context.delete
end

#fetch ⇒ ShortCodeInstance

Fetch the ShortCodeInstance

Returns:



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

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



353
354
355
356
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/short_code.rb', line 353

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

Returns:



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

def service_sid
    @properties['service_sid']
end

#short_code ⇒ String

Returns The [E.164](www.twilio.com/docs/glossary/what-e164) format of the short code.

Returns:



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

def short_code
    @properties['short_code']
end

#sid ⇒ String

Returns The unique string that we created to identify the ShortCode resource.

Returns:

  • (String) —

    The unique string that we created to identify the ShortCode resource.



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

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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.



324
325
326
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/short_code.rb', line 324

def url
    @properties['url']
end