Class: Twilio::REST::Preview::HostedNumbers::HostedNumberOrderContext

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

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected]

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ HostedNumberOrderContext

Initialize the HostedNumberOrderContext

Parameters:

  • version (Version)

    Version that contains the resource

  • sid (String)

    A 34 character string that uniquely identifies this HostedNumberOrder.


285
286
287
288
289
290
291
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 285

def initialize(version, sid)
  super(version)

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

Instance Method Details

#deleteBoolean

Delete the HostedNumberOrderInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


305
306
307
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 305

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

#fetchHostedNumberOrderInstance

Fetch the HostedNumberOrderInstance

Returns:


296
297
298
299
300
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 296

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

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

#inspectObject

Provide a detailed, user friendly representation


363
364
365
366
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 363

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

#to_sObject

Provide a user friendly representation


356
357
358
359
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 356

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

#update(friendly_name: :unset, unique_name: :unset, email: :unset, cc_emails: :unset, status: :unset, verification_code: :unset, verification_type: :unset, verification_document_sid: :unset, extension: :unset, call_delay: :unset) ⇒ HostedNumberOrderInstance

Update the HostedNumberOrderInstance

Parameters:

  • friendly_name (String) (defaults to: :unset)

    A 64 character string that is a human readable text that describes this resource.

  • unique_name (String) (defaults to: :unset)

    Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.

  • email (String) (defaults to: :unset)

    Email of the owner of this phone number that is being hosted.

  • cc_emails (Array[String]) (defaults to: :unset)

    Optional. A list of emails that LOA document for this HostedNumberOrder will be carbon copied to.

  • status (hosted_number_order.Status) (defaults to: :unset)

    User can only post to `pending-verification` status to transition the HostedNumberOrder to initiate a verification call or verification of ownership with a copy of a phone bill.

  • verification_code (String) (defaults to: :unset)

    A verification code that is given to the user via a phone call to the phone number that is being hosted.

  • verification_type (hosted_number_order.VerificationType) (defaults to: :unset)

    Optional. The method used for verifying ownership of the number to be hosted. One of phone-call (default) or phone-bill.

  • verification_document_sid (String) (defaults to: :unset)

    Optional. The unique sid identifier of the Identity Document that represents the document for verifying ownership of the number to be hosted. Required when VerificationType is phone-bill.

  • extension (String) (defaults to: :unset)

    Digits to dial after connecting the verification call.

  • call_delay (String) (defaults to: :unset)

    The number of seconds, between 0 and 60, to delay before initiating the verification call. Defaults to 0.

Returns:


335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 335

def update(friendly_name: :unset, unique_name: :unset, email: :unset, cc_emails: :unset, status: :unset, verification_code: :unset, verification_type: :unset, verification_document_sid: :unset, extension: :unset, call_delay: :unset)
  data = Twilio::Values.of({
      'FriendlyName' => friendly_name,
      'UniqueName' => unique_name,
      'Email' => email,
      'CcEmails' => Twilio.serialize_list(cc_emails) { |e| e },
      'Status' => status,
      'VerificationCode' => verification_code,
      'VerificationType' => verification_type,
      'VerificationDocumentSid' => verification_document_sid,
      'Extension' => extension,
      'CallDelay' => call_delay,
  })

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

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