twilio.rest.preview.hosted_numbers.authorization_document package

Submodules

twilio.rest.preview.hosted_numbers.authorization_document.dependent_hosted_number_order module

This code was generated by / _ _ _| _ _

(_)/(_)(_|/| |(/_ v1.0.0 / /
class twilio.rest.preview.hosted_numbers.authorization_document.dependent_hosted_number_order.DependentHostedNumberOrderInstance(version, payload, signing_document_sid)[source]

Bases: twilio.base.instance_resource.InstanceResource

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.

class Status[source]

Bases: object

ACTION_REQUIRED = 'action-required'
CARRIER_PROCESSING = 'carrier-processing'
COMPLETED = 'completed'
FAILED = 'failed'
PENDING_LOA = 'pending-loa'
PENDING_VERIFICATION = 'pending-verification'
RECEIVED = 'received'
TESTING = 'testing'
VERIFIED = 'verified'
class VerificationType[source]

Bases: object

PHONE_BILL = 'phone-bill'
PHONE_CALL = 'phone-call'
account_sid
Returns:Account sid.
Return type:unicode
address_sid
Returns:Address sid.
Return type:unicode
call_delay
Returns:Seconds (0-30) to delay ownership verification call by.
Return type:unicode
capabilities
Returns:A mapping of phone number capabilities.
Return type:unicode
cc_emails
Returns:A list of emails.
Return type:list[unicode]
date_created
Returns:The date this HostedNumberOrder was created.
Return type:datetime
date_updated
Returns:The date this HostedNumberOrder was updated.
Return type:datetime
email
Returns:Email.
Return type:unicode
extension
Returns:Phone extension to use for ownership verification call.
Return type:unicode
failure_reason
Returns:Why a hosted_number_order reached status “action-required”
Return type:unicode
friendly_name
Returns:A human readable description of this resource.
Return type:unicode
incoming_phone_number_sid
Returns:IncomingPhoneNumber sid.
Return type:unicode
phone_number
Returns:An E164 formatted phone number.
Return type:unicode
sid
Returns:HostedNumberOrder sid.
Return type:unicode
signing_document_sid
Returns:LOA document sid.
Return type:unicode
status
Returns:The Status of this HostedNumberOrder.
Return type:DependentHostedNumberOrderInstance.Status
unique_name
Returns:A unique, developer assigned name of this HostedNumberOrder.
Return type:unicode
verification_attempts
Returns:The number of attempts made to verify ownership of the phone number.
Return type:unicode
verification_call_sids
Returns:List of IDs for ownership verification calls.
Return type:list[unicode]
verification_code
Returns:The digits passed during the ownership verification call.
Return type:unicode
verification_document_sid
Returns:Verification Document Sid.
Return type:unicode
verification_type
Returns:The method used for verifying ownership of the number to be hosted.
Return type:DependentHostedNumberOrderInstance.VerificationType
class twilio.rest.preview.hosted_numbers.authorization_document.dependent_hosted_number_order.DependentHostedNumberOrderList(version, signing_document_sid)[source]

Bases: twilio.base.list_resource.ListResource

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.

get_page(target_url)[source]

Retrieve a specific page of DependentHostedNumberOrderInstance records from the API. Request is executed immediately

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of DependentHostedNumberOrderInstance
Return type:twilio.rest.preview.hosted_numbers.authorization_document.dependent_hosted_number_order.DependentHostedNumberOrderPage
list(status=<object object>, phone_number=<object object>, incoming_phone_number_sid=<object object>, friendly_name=<object object>, unique_name=<object object>, limit=None, page_size=None)[source]

Lists DependentHostedNumberOrderInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.

Parameters:
  • status (DependentHostedNumberOrderInstance.Status) – The Status of this HostedNumberOrder.
  • phone_number (unicode) – An E164 formatted phone number.
  • incoming_phone_number_sid (unicode) – IncomingPhoneNumber sid.
  • friendly_name (unicode) – A human readable description of this resource.
  • unique_name (unicode) – A unique, developer assigned name of this HostedNumberOrder.
  • limit (int) – Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit
  • page_size (int) – 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)
Returns:

Generator that will yield up to limit results

Return type:

list[twilio.rest.preview.hosted_numbers.authorization_document.dependent_hosted_number_order.DependentHostedNumberOrderInstance]

page(status=<object object>, phone_number=<object object>, incoming_phone_number_sid=<object object>, friendly_name=<object object>, unique_name=<object object>, page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]

Retrieve a single page of DependentHostedNumberOrderInstance records from the API. Request is executed immediately

Parameters:
  • status (DependentHostedNumberOrderInstance.Status) – The Status of this HostedNumberOrder.
  • phone_number (unicode) – An E164 formatted phone number.
  • incoming_phone_number_sid (unicode) – IncomingPhoneNumber sid.
  • friendly_name (unicode) – A human readable description of this resource.
  • unique_name (unicode) – A unique, developer assigned name of this HostedNumberOrder.
  • page_token (str) – PageToken provided by the API
  • page_number (int) – Page Number, this value is simply for client state
  • page_size (int) – Number of records to return, defaults to 50
Returns:

Page of DependentHostedNumberOrderInstance

Return type:

twilio.rest.preview.hosted_numbers.authorization_document.dependent_hosted_number_order.DependentHostedNumberOrderPage

stream(status=<object object>, phone_number=<object object>, incoming_phone_number_sid=<object object>, friendly_name=<object object>, unique_name=<object object>, limit=None, page_size=None)[source]

Streams DependentHostedNumberOrderInstance records from the API as a generator stream. This operation lazily loads records as efficiently as possible until the limit is reached. The results are returned as a generator, so this operation is memory efficient.

Parameters:
  • status (DependentHostedNumberOrderInstance.Status) – The Status of this HostedNumberOrder.
  • phone_number (unicode) – An E164 formatted phone number.
  • incoming_phone_number_sid (unicode) – IncomingPhoneNumber sid.
  • friendly_name (unicode) – A human readable description of this resource.
  • unique_name (unicode) – A unique, developer assigned name of this HostedNumberOrder.
  • limit (int) – Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit
  • page_size (int) – 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, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
Returns:

Generator that will yield up to limit results

Return type:

list[twilio.rest.preview.hosted_numbers.authorization_document.dependent_hosted_number_order.DependentHostedNumberOrderInstance]

class twilio.rest.preview.hosted_numbers.authorization_document.dependent_hosted_number_order.DependentHostedNumberOrderPage(version, response, solution)[source]

Bases: twilio.base.page.Page

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.

get_instance(payload)[source]

Build an instance of DependentHostedNumberOrderInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.preview.hosted_numbers.authorization_document.dependent_hosted_number_order.DependentHostedNumberOrderInstance
Return type:twilio.rest.preview.hosted_numbers.authorization_document.dependent_hosted_number_order.DependentHostedNumberOrderInstance

Module contents

This code was generated by / _ _ _| _ _

(_)/(_)(_|/| |(/_ v1.0.0 / /
class twilio.rest.preview.hosted_numbers.authorization_document.AuthorizationDocumentContext(version, sid)[source]

Bases: twilio.base.instance_context.InstanceContext

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.

dependent_hosted_number_orders

Access the dependent_hosted_number_orders

Returns:twilio.rest.preview.hosted_numbers.authorization_document.dependent_hosted_number_order.DependentHostedNumberOrderList
Return type:twilio.rest.preview.hosted_numbers.authorization_document.dependent_hosted_number_order.DependentHostedNumberOrderList
fetch()[source]

Fetch the AuthorizationDocumentInstance

Returns:The fetched AuthorizationDocumentInstance
Return type:twilio.rest.preview.hosted_numbers.authorization_document.AuthorizationDocumentInstance
update(hosted_number_order_sids=<object object>, address_sid=<object object>, email=<object object>, cc_emails=<object object>, status=<object object>, contact_title=<object object>, contact_phone_number=<object object>)[source]

Update the AuthorizationDocumentInstance

Parameters:
  • hosted_number_order_sids (list[unicode]) – A list of HostedNumberOrder sids.
  • address_sid (unicode) – Address sid.
  • email (unicode) – Email.
  • cc_emails (list[unicode]) – A list of emails.
  • status (AuthorizationDocumentInstance.Status) – The Status of this AuthorizationDocument.
  • contact_title (unicode) – Title of signee of this Authorization Document.
  • contact_phone_number (unicode) – Authorization Document’s signee’s phone number.
Returns:

The updated AuthorizationDocumentInstance

Return type:

twilio.rest.preview.hosted_numbers.authorization_document.AuthorizationDocumentInstance

class twilio.rest.preview.hosted_numbers.authorization_document.AuthorizationDocumentInstance(version, payload, sid=None)[source]

Bases: twilio.base.instance_resource.InstanceResource

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.

class Status[source]

Bases: object

CANCELED = 'canceled'
FAILED = 'failed'
OPENED = 'opened'
SIGNED = 'signed'
SIGNING = 'signing'
address_sid
Returns:Address sid.
Return type:unicode
cc_emails
Returns:A list of emails.
Return type:list[unicode]
date_created
Returns:The date this AuthorizationDocument was created.
Return type:datetime
date_updated
Returns:The date this AuthorizationDocument was updated.
Return type:datetime
dependent_hosted_number_orders

Access the dependent_hosted_number_orders

Returns:twilio.rest.preview.hosted_numbers.authorization_document.dependent_hosted_number_order.DependentHostedNumberOrderList
Return type:twilio.rest.preview.hosted_numbers.authorization_document.dependent_hosted_number_order.DependentHostedNumberOrderList
email
Returns:Email.
Return type:unicode
fetch()[source]

Fetch the AuthorizationDocumentInstance

Returns:The fetched AuthorizationDocumentInstance
Return type:twilio.rest.preview.hosted_numbers.authorization_document.AuthorizationDocumentInstance
Returns:The links
Return type:unicode
sid
Returns:AuthorizationDocument sid.
Return type:unicode
status
Returns:The Status of this AuthorizationDocument.
Return type:AuthorizationDocumentInstance.Status
update(hosted_number_order_sids=<object object>, address_sid=<object object>, email=<object object>, cc_emails=<object object>, status=<object object>, contact_title=<object object>, contact_phone_number=<object object>)[source]

Update the AuthorizationDocumentInstance

Parameters:
  • hosted_number_order_sids (list[unicode]) – A list of HostedNumberOrder sids.
  • address_sid (unicode) – Address sid.
  • email (unicode) – Email.
  • cc_emails (list[unicode]) – A list of emails.
  • status (AuthorizationDocumentInstance.Status) – The Status of this AuthorizationDocument.
  • contact_title (unicode) – Title of signee of this Authorization Document.
  • contact_phone_number (unicode) – Authorization Document’s signee’s phone number.
Returns:

The updated AuthorizationDocumentInstance

Return type:

twilio.rest.preview.hosted_numbers.authorization_document.AuthorizationDocumentInstance

url
Returns:The url
Return type:unicode
class twilio.rest.preview.hosted_numbers.authorization_document.AuthorizationDocumentList(version)[source]

Bases: twilio.base.list_resource.ListResource

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.

create(hosted_number_order_sids, address_sid, email, contact_title, contact_phone_number, cc_emails=<object object>)[source]

Create the AuthorizationDocumentInstance

Parameters:
  • hosted_number_order_sids (list[unicode]) – A list of HostedNumberOrder sids.
  • address_sid (unicode) – Address sid.
  • email (unicode) – Email.
  • contact_title (unicode) – Title of signee of this Authorization Document.
  • contact_phone_number (unicode) – Authorization Document’s signee’s phone number.
  • cc_emails (list[unicode]) – A list of emails.
Returns:

The created AuthorizationDocumentInstance

Return type:

twilio.rest.preview.hosted_numbers.authorization_document.AuthorizationDocumentInstance

get(sid)[source]

Constructs a AuthorizationDocumentContext

Parameters:sid – AuthorizationDocument sid.
Returns:twilio.rest.preview.hosted_numbers.authorization_document.AuthorizationDocumentContext
Return type:twilio.rest.preview.hosted_numbers.authorization_document.AuthorizationDocumentContext
get_page(target_url)[source]

Retrieve a specific page of AuthorizationDocumentInstance records from the API. Request is executed immediately

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of AuthorizationDocumentInstance
Return type:twilio.rest.preview.hosted_numbers.authorization_document.AuthorizationDocumentPage
list(email=<object object>, status=<object object>, limit=None, page_size=None)[source]

Lists AuthorizationDocumentInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.

Parameters:
  • email (unicode) – Email.
  • status (AuthorizationDocumentInstance.Status) – The Status of this AuthorizationDocument.
  • limit (int) – Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit
  • page_size (int) – 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)
Returns:

Generator that will yield up to limit results

Return type:

list[twilio.rest.preview.hosted_numbers.authorization_document.AuthorizationDocumentInstance]

page(email=<object object>, status=<object object>, page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]

Retrieve a single page of AuthorizationDocumentInstance records from the API. Request is executed immediately

Parameters:
  • email (unicode) – Email.
  • status (AuthorizationDocumentInstance.Status) – The Status of this AuthorizationDocument.
  • page_token (str) – PageToken provided by the API
  • page_number (int) – Page Number, this value is simply for client state
  • page_size (int) – Number of records to return, defaults to 50
Returns:

Page of AuthorizationDocumentInstance

Return type:

twilio.rest.preview.hosted_numbers.authorization_document.AuthorizationDocumentPage

stream(email=<object object>, status=<object object>, limit=None, page_size=None)[source]

Streams AuthorizationDocumentInstance records from the API as a generator stream. This operation lazily loads records as efficiently as possible until the limit is reached. The results are returned as a generator, so this operation is memory efficient.

Parameters:
  • email (unicode) – Email.
  • status (AuthorizationDocumentInstance.Status) – The Status of this AuthorizationDocument.
  • limit (int) – Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit
  • page_size (int) – 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, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
Returns:

Generator that will yield up to limit results

Return type:

list[twilio.rest.preview.hosted_numbers.authorization_document.AuthorizationDocumentInstance]

class twilio.rest.preview.hosted_numbers.authorization_document.AuthorizationDocumentPage(version, response, solution)[source]

Bases: twilio.base.page.Page

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.

get_instance(payload)[source]

Build an instance of AuthorizationDocumentInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.preview.hosted_numbers.authorization_document.AuthorizationDocumentInstance
Return type:twilio.rest.preview.hosted_numbers.authorization_document.AuthorizationDocumentInstance