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

  • sid (String) —

    A 34 character string that uniquely identifies the Phone Number to fetch (e.g. ‘PN1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d`).



185
186
187
188
189
190
191
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 185

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



196
197
198
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 196

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

#fetch ⇒ PhoneNumberInstance

Fetch a PhoneNumberInstance

Returns:



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 203

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

#to_s ⇒ Object

Provide a user friendly representation



244
245
246
247
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 244

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 or not the number should be excluded from being assigned to a participant using proxy pool logic

Returns:



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 225

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