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 the resource is associated with.

  • sid (String) (defaults to: nil)

    The SID of the ShortCode resource to fetch.


225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
# File 'lib/twilio-ruby/rest/messaging/v1/service/short_code.rb', line 225

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_sidString

Returns The SID of the Account that created the resource.

Returns:

  • (String)

    The SID of the Account that created the resource


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

def 
  @properties['account_sid']
end

#capabilitiesArray[String]

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

Returns:

  • (Array[String])

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


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

def capabilities
  @properties['capabilities']
end

#contextShortCodeContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:


250
251
252
253
254
255
# File 'lib/twilio-ruby/rest/messaging/v1/service/short_code.rb', line 250

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

#country_codeString

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

Returns:

  • (String)

    The 2-character ISO Country Code of the number


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

def country_code
  @properties['country_code']
end

#date_createdTime

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


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

def date_created
  @properties['date_created']
end

#date_updatedTime

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


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

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Delete the ShortCodeInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


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

def delete
  context.delete
end

#fetchShortCodeInstance

Fetch the ShortCodeInstance

Returns:


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

def fetch
  context.fetch
end

#inspectObject

Provide a detailed, user friendly representation


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

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

#service_sidString

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


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

def service_sid
  @properties['service_sid']
end

#short_codeString

Returns The E.164 format of the short code.

Returns:

  • (String)

    The E.164 format of the short code


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

def short_code
  @properties['short_code']
end

#sidString

Returns The unique string that identifies the resource.

Returns:

  • (String)

    The unique string that identifies the resource


259
260
261
# File 'lib/twilio-ruby/rest/messaging/v1/service/short_code.rb', line 259

def sid
  @properties['sid']
end

#to_sObject

Provide a user friendly representation


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

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

#urlString

Returns The absolute URL of the ShortCode resource.

Returns:

  • (String)

    The absolute URL of the ShortCode resource


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

def url
  @properties['url']
end