Class: Twilio::REST::Numbers::V2::HostedNumberOrderContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ HostedNumberOrderContext

Initialize the HostedNumberOrderContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • sid (String) —

    The SID of the HostedNumberOrder resource to update.



353
354
355
356
357
358
359
360
361
362
 
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 353

def initialize(version, sid)
    super(version)
    

    # Path Solution
    @solution = { sid: sid,  }
    @uri = "/HostedNumber/Orders/#{@solution[:sid]}"

    
end

Instance Method Details

#delete ⇒ Boolean

Delete the HostedNumberOrderInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



366
367
368
369
370
371
372
373
374
 
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 366

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 HostedNumberOrderInstanceMetadata

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 379

def delete_with_metadata

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

#fetch ⇒ HostedNumberOrderInstance

Fetch the HostedNumberOrderInstance

Returns:



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 398

def fetch

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

#fetch_with_metadata ⇒ HostedNumberOrderInstance

Fetch the HostedNumberOrderInstanceMetadata

Returns:



417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
 
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 417

def fetch_with_metadata

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



519
520
521
522
 
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 519

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

#to_s ⇒ Object

Provide a user friendly representation



512
513
514
515
 
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 512

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

#update(status: nil, verification_call_delay: :unset, verification_call_extension: :unset) ⇒ HostedNumberOrderInstance

Update the HostedNumberOrderInstance

Parameters:

  • status (Status) (defaults to: nil)
  • verification_call_delay (String) (defaults to: :unset) —

    The number of seconds to wait before initiating the ownership verification call. Can be a value between 0 and 60, inclusive.

  • verification_call_extension (String) (defaults to: :unset) —

    The numerical extension to dial when making the ownership verification call.

Returns:



445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
 
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 445

def update(
  status: nil, 
  verification_call_delay: :unset, 
  verification_call_extension: :unset
)

    data = Twilio::Values.of({
        'Status' => status,
        'VerificationCallDelay' => verification_call_delay,
        'VerificationCallExtension' => verification_call_extension,
    })

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

#update_with_metadata(status: nil, verification_call_delay: :unset, verification_call_extension: :unset) ⇒ HostedNumberOrderInstance

Update the HostedNumberOrderInstanceMetadata

Parameters:

  • status (Status) (defaults to: nil)
  • verification_call_delay (String) (defaults to: :unset) —

    The number of seconds to wait before initiating the ownership verification call. Can be a value between 0 and 60, inclusive.

  • verification_call_extension (String) (defaults to: :unset) —

    The numerical extension to dial when making the ownership verification call.

Returns:



477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
 
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 477

def update_with_metadata(
  status: nil, 
  verification_call_delay: :unset, 
  verification_call_extension: :unset
)

    data = Twilio::Values.of({
        'Status' => status,
        'VerificationCallDelay' => verification_call_delay,
        'VerificationCallExtension' => verification_call_extension,
    })

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