class Twilio::REST::Preview::HostedNumbers::AuthorizationDocumentInstance

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, payload, sid: nil) click to toggle source

Initialize the AuthorizationDocumentInstance @param [Version] version Version that contains the resource @param [Hash] payload payload that contains response from Twilio @param [String] sid A 34 character string that uniquely identifies this

AuthorizationDocument.

@return [AuthorizationDocumentInstance] AuthorizationDocumentInstance

Calls superclass method Twilio::REST::InstanceResource::new
    # File lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb
306 def initialize(version, payload, sid: nil)
307   super(version)
308 
309   # Marshaled Properties
310   @properties = {
311       'sid' => payload['sid'],
312       'address_sid' => payload['address_sid'],
313       'status' => payload['status'],
314       'email' => payload['email'],
315       'cc_emails' => payload['cc_emails'],
316       'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
317       'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
318       'url' => payload['url'],
319       'links' => payload['links'],
320   }
321 
322   # Context
323   @instance_context = nil
324   @params = {'sid' => sid || @properties['sid'], }
325 end

Public Instance Methods

address_sid() click to toggle source

@return [String] Address sid.

    # File lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb
346 def address_sid
347   @properties['address_sid']
348 end
cc_emails() click to toggle source

@return [Array] A list of emails.

    # File lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb
364 def cc_emails
365   @properties['cc_emails']
366 end
context() click to toggle source

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context @return [AuthorizationDocumentContext] AuthorizationDocumentContext for this AuthorizationDocumentInstance

    # File lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb
331 def context
332   unless @instance_context
333     @instance_context = AuthorizationDocumentContext.new(@version, @params['sid'], )
334   end
335   @instance_context
336 end
date_created() click to toggle source

@return [Time] The date this AuthorizationDocument was created.

    # File lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb
370 def date_created
371   @properties['date_created']
372 end
date_updated() click to toggle source

@return [Time] The date this AuthorizationDocument was updated.

    # File lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb
376 def date_updated
377   @properties['date_updated']
378 end
dependent_hosted_number_orders() click to toggle source

Access the dependent_hosted_number_orders @return [dependent_hosted_number_orders] dependent_hosted_number_orders

    # File lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb
435 def dependent_hosted_number_orders
436   context.dependent_hosted_number_orders
437 end
email() click to toggle source

@return [String] Email.

    # File lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb
358 def email
359   @properties['email']
360 end
fetch() click to toggle source

Fetch the AuthorizationDocumentInstance @return [AuthorizationDocumentInstance] Fetched AuthorizationDocumentInstance

    # File lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb
395 def fetch
396   context.fetch
397 end
inspect() click to toggle source

Provide a detailed, user friendly representation

    # File lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb
448 def inspect
449   values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
450   "<Twilio.Preview.HostedNumbers.AuthorizationDocumentInstance #{values}>"
451 end
sid() click to toggle source

@return [String] AuthorizationDocument sid.

    # File lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb
340 def sid
341   @properties['sid']
342 end
status() click to toggle source

@return [authorization_document.Status] The Status of this AuthorizationDocument.

    # File lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb
352 def status
353   @properties['status']
354 end
to_s() click to toggle source

Provide a user friendly representation

    # File lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb
441 def to_s
442   values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
443   "<Twilio.Preview.HostedNumbers.AuthorizationDocumentInstance #{values}>"
444 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
420 def update(hosted_number_order_sids: :unset, address_sid: :unset, email: :unset, cc_emails: :unset, status: :unset, contact_title: :unset, contact_phone_number: :unset)
421   context.update(
422       hosted_number_order_sids: hosted_number_order_sids,
423       address_sid: address_sid,
424       email: email,
425       cc_emails: cc_emails,
426       status: status,
427       contact_title: contact_title,
428       contact_phone_number: contact_phone_number,
429   )
430 end
url() click to toggle source

@return [String] The url

    # File lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb
382 def url
383   @properties['url']
384 end