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 SID of the parent [Service](www.twilio.com/docs/proxy/api/service) to fetch the resource from.

  • sid (String) —

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



182
183
184
185
186
187
188
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 182

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



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

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

#fetch ⇒ ShortCodeInstance

Fetch a ShortCodeInstance

Returns:



200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 200

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



240
241
242
243
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 240

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

#to_s ⇒ Object

Provide a user friendly representation



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

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



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

def update(is_reserved: :unset)
  data = Twilio::Values.of({'IsReserved' => is_reserved, })

  payload = @version.update(
      'POST',
      @uri,
      data: data,
  )

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