Class: AuthorizationDocumentList

Twilio.Preview.HostedNumbers.AuthorizationDocumentList(version)

new AuthorizationDocumentList(version)

Initialize the AuthorizationDocumentList 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.
Parameters:
Name Type Description
version Twilio.Preview.HostedNumbers Version of the resource
Source:

Methods

create(opts, callbackopt) → {Promise}

create a AuthorizationDocumentInstance
Parameters:
Name Type Attributes Description
opts object Options for request
Properties
Name Type Attributes Description
hostedNumberOrderSids string | list A list of HostedNumberOrder sids.
addressSid string Address sid.
email string Email.
contactTitle string Title of signee of this Authorization Document.
contactPhoneNumber string Authorization Document's signee's phone number.
ccEmails string | list <optional>
 A list of emails.
callback function <optional>
 Callback to handle processed record
Source:
Returns:
Resolves to processed AuthorizationDocumentInstance
Type
Promise

each(optsopt, callbackopt)

Streams AuthorizationDocumentInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached. The results are passed into the callback function, so this operation is memory efficient. If a function is passed as the first argument, it will be used as the callback function.
Parameters:
Name Type Attributes Description
opts object <optional>
 Options for request
Properties
Name Type Attributes Description
email string <optional>
 Email.
status authorization_document.status <optional>
 The Status of this AuthorizationDocument.
limit number <optional>
 Upper limit for the number of records to return. each() guarantees never to return more than limit. Default is no limit
pageSize number <optional>
 Number of records to fetch per request, when not set will use the default value of 50 records. If no pageSize is defined but a limit is defined, each() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
callback function <optional>
 Function to process each record. If this and a positional callback are passed, this one will be used
done function <optional>
 Function to be called upon completion of streaming
callback function <optional>
 Function to process each record
Source:

get(sid) → {Twilio.Preview.HostedNumbers.AuthorizationDocumentContext}

Constructs a authorization_document
Parameters:
Name Type Description
sid string AuthorizationDocument sid.
Source:
Returns:
Type
Twilio.Preview.HostedNumbers.AuthorizationDocumentContext

getPage(targetUrlopt, callbackopt) → {Promise}

Retrieve a single target page of AuthorizationDocumentInstance records from the API. The request is executed immediately. If a function is passed as the first argument, it will be used as the callback function.
Parameters:
Name Type Attributes Description
targetUrl string <optional>
 API-generated URL for the requested results page
callback function <optional>
 Callback to handle list of records
Source:
Returns:
Resolves to a list of records
Type
Promise

list(optsopt, callbackopt) → {Promise}

Lists AuthorizationDocumentInstance records from the API as a list. If a function is passed as the first argument, it will be used as the callback function.
Parameters:
Name Type Attributes Description
opts object <optional>
 Options for request
Properties
Name Type Attributes Description
email string <optional>
 Email.
status authorization_document.status <optional>
 The Status of this AuthorizationDocument.
limit number <optional>
 Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit
pageSize number <optional>
 Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, list() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
callback function <optional>
 Callback to handle list of records
Source:
Returns:
Resolves to a list of records
Type
Promise

page(optsopt, callbackopt) → {Promise}

Retrieve a single page of AuthorizationDocumentInstance records from the API. The request is executed immediately. If a function is passed as the first argument, it will be used as the callback function.
Parameters:
Name Type Attributes Description
opts object <optional>
 Options for request
Properties
Name Type Attributes Description
email string <optional>
 Email.
status authorization_document.status <optional>
 The Status of this AuthorizationDocument.
pageToken string <optional>
 PageToken provided by the API
pageNumber number <optional>
 Page Number, this value is simply for client state
pageSize number <optional>
 Number of records to return, defaults to 50
callback function <optional>
 Callback to handle list of records
Source:
Returns:
Resolves to a list of records
Type
Promise

toJSON()

Provide a user-friendly representation
Source:
Returns:
Object