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 to fetch the resource from.

  • sid (String) —

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


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

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

Delete the ShortCodeInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise


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

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

#fetch ⇒ ShortCodeInstance

Fetch the ShortCodeInstance

Returns:


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

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

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

#inspect ⇒ Object

Provide a detailed, user friendly representation


223
224
225
226
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 223

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

#to_s ⇒ Object

Provide a user friendly representation


216
217
218
219
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 216

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 for more information.

Returns:


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

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