Class: Twilio::REST::Proxy::V1::ServiceContext::PhoneNumberContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/proxy/v1/service/phone_number.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) ⇒ PhoneNumberContext

Initialize the PhoneNumberContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • service_sid (String) —

    The SID of the parent [Service](www.twilio.com/docs/proxy/api/service) of the PhoneNumber resource to fetch.

  • sid (String) —

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



189
190
191
192
193
194
195
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 189

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

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

Instance Method Details

#delete ⇒ Boolean

Deletes the PhoneNumberInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



200
201
202
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 200

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

#fetch ⇒ PhoneNumberInstance

Fetch a PhoneNumberInstance

Returns:



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 207

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

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

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



257
258
259
260
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 257

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

#to_s ⇒ Object

Provide a user friendly representation



250
251
252
253
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 250

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

#update(is_reserved: :unset) ⇒ PhoneNumberInstance

Update the PhoneNumberInstance

Parameters:

  • is_reserved (Boolean) (defaults to: :unset) —

    Whether the phone number 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:



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 231

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

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

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