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

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb

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 update.

  • sid (String) —

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



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

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

Delete the PhoneNumberInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    

    @version.delete('DELETE', @uri, headers: headers)
end

#delete_with_metadata ⇒ Boolean

Delete the PhoneNumberInstanceMetadata

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 258

def delete_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
      response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
      phoneNumber_instance = PhoneNumberInstance.new(
          @version,
          response.body,
          account_sid: @solution[:account_sid],
          sid: @solution[:sid],
      )
      PhoneNumberInstanceMetadata.new(@version, phoneNumber_instance, response.headers, response.status_code)
end

#fetch ⇒ PhoneNumberInstance

Fetch the PhoneNumberInstance

Returns:



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 277

def fetch

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.fetch('GET', @uri, headers: headers)
    PhoneNumberInstance.new(
        @version,
        payload,
        service_sid: @solution[:service_sid],
        sid: @solution[:sid],
    )
end

#fetch_with_metadata ⇒ PhoneNumberInstance

Fetch the PhoneNumberInstanceMetadata

Returns:



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 297

def fetch_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.fetch_with_metadata('GET', @uri, headers: headers)
    phone_number_instance = PhoneNumberInstance.new(
        @version,
        response.body,
        service_sid: @solution[:service_sid],
        sid: @solution[:sid],
    )
    PhoneNumberInstanceMetadata.new(
        @version,
        phone_number_instance,
        response.headers,
        response.status_code
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



390
391
392
393
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 390

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

#to_s ⇒ Object

Provide a user friendly representation



383
384
385
386
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 383

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:



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 324

def update(
    is_reserved: :unset
)

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

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.update('POST', @uri, data: data, headers: headers)
    PhoneNumberInstance.new(
        @version,
        payload,
        service_sid: @solution[:service_sid],
        sid: @solution[:sid],
    )
end

#update_with_metadata(is_reserved: :unset) ⇒ PhoneNumberInstance

Update the PhoneNumberInstanceMetadata

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:



351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 351

def update_with_metadata(
  is_reserved: :unset
)

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

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
    phone_number_instance = PhoneNumberInstance.new(
        @version,
        response.body,
        service_sid: @solution[:service_sid],
        sid: @solution[:sid],
    )
    PhoneNumberInstanceMetadata.new(
        @version,
        phone_number_instance,
        response.headers,
        response.status_code
    )
end