Class: Twilio::REST::Messaging::V1::ServiceContext::ShortCodeContext

Inherits:
InstanceContext
  • 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, service_sid, sid) ⇒ ShortCodeContext

Initialize the ShortCodeContext

Parameters:

  • version (Version)

    Version that contains the resource

  • service_sid (String)

    The SID of the Service to fetch the resource from.

  • sid (String)

    The SID of the ShortCode resource to fetch.


174
175
176
177
178
179
180
# File 'lib/twilio-ruby/rest/messaging/v1/service/short_code.rb', line 174

def initialize(version, service_sid, sid)
  super(version)

  # Path Solution
  @solution = {service_sid: service_sid, sid: sid, }
  @uri = "/Services/#{@solution[:service_sid]}/ShortCodes/#{@solution[:sid]}"
end

Instance Method Details

#deleteBoolean

Delete the ShortCodeInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


185
186
187
# File 'lib/twilio-ruby/rest/messaging/v1/service/short_code.rb', line 185

def delete
   @version.delete('DELETE', @uri)
end

#fetchShortCodeInstance

Fetch the ShortCodeInstance

Returns:


192
193
194
195
196
# File 'lib/twilio-ruby/rest/messaging/v1/service/short_code.rb', line 192

def fetch
  payload = @version.fetch('GET', @uri)

  ShortCodeInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
end

#inspectObject

Provide a detailed, user friendly representation


207
208
209
210
# File 'lib/twilio-ruby/rest/messaging/v1/service/short_code.rb', line 207

def inspect
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Messaging.V1.ShortCodeContext #{context}>"
end

#to_sObject

Provide a user friendly representation


200
201
202
203
# File 'lib/twilio-ruby/rest/messaging/v1/service/short_code.rb', line 200

def to_s
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Messaging.V1.ShortCodeContext #{context}>"
end