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 (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    The SID of the ShortCode resource’s parent [Service](www.twilio.com/docs/proxy/api/service) resource.

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

    The Twilio-provided string that uniquely identifies the ShortCode resource to fetch.



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 258

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'],
      'is_reserved' => payload['is_reserved'],
  }

  # 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



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

def 
  @properties['account_sid']
end

#capabilities ⇒ String

Returns The capabilities of the short code.

Returns:

  • (String) —

    The capabilities of the short code



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:



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

def context
  unless @instance_context
    @instance_context = ShortCodeContext.new(@version, @params['service_sid'], @params['sid'], )
  end
  @instance_context
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



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 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



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:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#fetch ⇒ ShortCodeInstance

Fetch a ShortCodeInstance

Returns:



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



385
386
387
388
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 385

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

#is_reserved ⇒ Boolean

Returns Whether the short code should be reserved for manual assignment to participants only.

Returns:

  • (Boolean) —

    Whether the short code should be reserved for manual assignment to participants only



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

def is_reserved
  @properties['is_reserved']
end

#iso_country ⇒ String

Returns The ISO Country Code.

Returns:

  • (String) —

    The 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 The SID of the resource’s parent Service.

Returns:

  • (String) —

    The SID of the resource’s parent Service



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 The short code’s number.

Returns:

  • (String) —

    The short code’s number



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 The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource



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



378
379
380
381
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 378

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

#update(is_reserved: :unset) ⇒ ShortCodeInstance

Update the ShortCodeInstance

Parameters:

  • is_reserved (Boolean) (defaults to: :unset) —

    Whether the short code should be reserved and not be assigned to a participant using proxy pool logic. See [Reserved Phone Numbers](www.twilio.com/docs/proxy/reserved-phone-numbers) for more information.

Returns:



372
373
374
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 372

def update(is_reserved: :unset)
  context.update(is_reserved: is_reserved, )
end

#url ⇒ String

Returns The absolute URL of the ShortCode resource.

Returns:

  • (String) —

    The absolute URL of the ShortCode resource



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

def url
  @properties['url']
end