Class: Twilio::REST::Proxy::V1::ServiceContext::ShortCodeContext

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

Initialize the ShortCodeContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • service_sid (String) —

    The unique SID identifier of the Service.

  • sid (String) —

    A 34 character string that uniquely identifies this Short Code.



195
196
197
198
199
200
201
202
203
204
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 195

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

#delete ⇒ Boolean

Deletes the ShortCodeInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



209
210
211
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 209

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

#fetch ⇒ ShortCodeInstance

Fetch a ShortCodeInstance

Returns:



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 216

def fetch
  params = Twilio::Values.of({})

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

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

#to_s ⇒ Object

Provide a user friendly representation



235
236
237
238
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 235

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