class Twilio::REST::Preview::HostedNumbers::AuthorizationDocumentContext

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 help@twilio.com.

Public Class Methods

new(version, sid) click to toggle source

Initialize the AuthorizationDocumentContext @param [Version] version Version that contains the resource @param [String] sid A 34 character string that uniquely identifies this

AuthorizationDocument.

@return [AuthorizationDocumentContext] AuthorizationDocumentContext

Calls superclass method Twilio::REST::InstanceContext::new
    # File lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb
209 def initialize(version, sid)
210   super(version)
211 
212   # Path Solution
213   @solution = {sid: sid, }
214   @uri = "/AuthorizationDocuments/#{@solution[:sid]}"
215 
216   # Dependents
217   @dependent_hosted_number_orders = nil
218 end

Public Instance Methods

dependent_hosted_number_orders() click to toggle source

Access the dependent_hosted_number_orders @return [DependentHostedNumberOrderList] @return [DependentHostedNumberOrderContext]

    # File lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb
270 def dependent_hosted_number_orders
271   unless @dependent_hosted_number_orders
272     @dependent_hosted_number_orders = DependentHostedNumberOrderList.new(
273         @version,
274         signing_document_sid: @solution[:sid],
275     )
276   end
277 
278   @dependent_hosted_number_orders
279 end
fetch() click to toggle source

Fetch the AuthorizationDocumentInstance @return [AuthorizationDocumentInstance] Fetched AuthorizationDocumentInstance

    # File lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb
223 def fetch
224   payload = @version.fetch('GET', @uri)
225 
226   AuthorizationDocumentInstance.new(@version, payload, sid: @solution[:sid], )
227 end
inspect() click to toggle source

Provide a detailed, user friendly representation

    # File lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb
290 def inspect
291   context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
292   "#<Twilio.Preview.HostedNumbers.AuthorizationDocumentContext #{context}>"
293 end
to_s() click to toggle source

Provide a user friendly representation

    # File lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb
283 def to_s
284   context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
285   "#<Twilio.Preview.HostedNumbers.AuthorizationDocumentContext #{context}>"
286 end
update(hosted_number_order_sids: :unset, address_sid: :unset, email: :unset, cc_emails: :unset, status: :unset, contact_title: :unset, contact_phone_number: :unset) click to toggle source

Update the AuthorizationDocumentInstance @param [Array] hosted_number_order_sids A list of HostedNumberOrder sids

that this AuthorizationDocument will authorize for hosting phone number
capabilities on Twilio's platform.

@param [String] address_sid A 34 character string that uniquely identifies the

Address resource that is associated with this AuthorizationDocument.

@param [String] email Email that this AuthorizationDocument will be sent to for

signing.

@param [Array] cc_emails Email recipients who will be informed when an

Authorization Document has been sent and signed

@param [authorization_document.Status] status Status of an instance resource. It

can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5.
failed. See the section entitled {Status
Values}[https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values]
for more information on each of these statuses.

@param [String] contact_title The title of the person authorized to sign the

Authorization Document for this phone number.

@param [String] contact_phone_number The contact phone number of the person

authorized to sign the Authorization Document.

@return [AuthorizationDocumentInstance] Updated AuthorizationDocumentInstance

    # File lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb
250 def update(hosted_number_order_sids: :unset, address_sid: :unset, email: :unset, cc_emails: :unset, status: :unset, contact_title: :unset, contact_phone_number: :unset)
251   data = Twilio::Values.of({
252       'HostedNumberOrderSids' => Twilio.serialize_list(hosted_number_order_sids) { |e| e },
253       'AddressSid' => address_sid,
254       'Email' => email,
255       'CcEmails' => Twilio.serialize_list(cc_emails) { |e| e },
256       'Status' => status,
257       'ContactTitle' => contact_title,
258       'ContactPhoneNumber' => contact_phone_number,
259   })
260 
261   payload = @version.update('POST', @uri, data: data)
262 
263   AuthorizationDocumentInstance.new(@version, payload, sid: @solution[:sid], )
264 end