Class: Twilio::REST::Proxy::V1::ServiceContext::ShortCodeInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/proxy/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 that contains the resource

  • payload that contains response from Twilio

  • (defaults to: nil)

    The unique SID identifier of the Service.

  • (defaults to: nil)

    A 34 character string that uniquely identifies this Short Code.



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

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'],
      'iso_country' => payload['iso_country'],
      '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:

  • Account Sid.



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

def 
  @properties['account_sid']
end

#capabilities ⇒ Hash

Returns Nested resource URLs.

Returns:

  • Nested resource URLs.



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

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:

  • ShortCodeContext for this ShortCodeInstance



280
281
282
283
284
285
286
287
288
289
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 280

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

#date_created ⇒ Time

Returns The date this Short Code was created.

Returns:

  • The date this Short Code was created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date this Short Code was updated.

Returns:

  • The date this Short Code was updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the ShortCodeInstance

Returns:

  • true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#fetch ⇒ ShortCodeInstance

Fetch a ShortCodeInstance

Returns:

  • Fetched ShortCodeInstance



355
356
357
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 355

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



368
369
370
371
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 368

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

#iso_country ⇒ String

Returns ISO Country Code,.

Returns:

  • ISO Country Code,



329
330
331
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 329

def iso_country
  @properties['iso_country']
end

#service_sid ⇒ String

Returns Service Sid.

Returns:

  • Service Sid.



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

def service_sid
  @properties['service_sid']
end

#short_code ⇒ String

Returns Shortcode.

Returns:

  • Shortcode.



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

def short_code
  @properties['short_code']
end

#sid ⇒ String

Returns A string that uniquely identifies this Short Code.

Returns:

  • A string that uniquely identifies this Short Code.



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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



361
362
363
364
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 361

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

#url ⇒ String

Returns The URL of this resource.

Returns:

  • The URL of this resource.



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

def url
  @properties['url']
end