twilio.rest.preview.hosted_numbers package¶
Subpackages¶
Submodules¶
twilio.rest.preview.hosted_numbers.hosted_number_order module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.preview.hosted_numbers.hosted_number_order.HostedNumberOrderContext(version, sid)[source]¶ Bases:
twilio.base.instance_context.InstanceContextPLEASE 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.
-
delete()[source]¶ Deletes the HostedNumberOrderInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch()[source]¶ Fetch the HostedNumberOrderInstance
Returns: The fetched HostedNumberOrderInstance Return type: twilio.rest.preview.hosted_numbers.hosted_number_order.HostedNumberOrderInstance
-
update(friendly_name=<object object>, unique_name=<object object>, email=<object object>, cc_emails=<object object>, status=<object object>, verification_code=<object object>, verification_type=<object object>, verification_document_sid=<object object>, extension=<object object>, call_delay=<object object>)[source]¶ Update the HostedNumberOrderInstance
Parameters: - friendly_name (unicode) – A human readable description of this resource.
- unique_name (unicode) – A unique, developer assigned name of this HostedNumberOrder.
- email (unicode) – Email.
- cc_emails (list[unicode]) – A list of emails.
- status (HostedNumberOrderInstance.Status) – The Status of this HostedNumberOrder.
- verification_code (unicode) – A verification code.
- verification_type (HostedNumberOrderInstance.VerificationType) – Verification Type.
- verification_document_sid (unicode) – Verification Document Sid
- extension (unicode) – Digits to dial after connecting the verification call.
- call_delay (unicode) – The number of seconds, between 0 and 60, to delay before initiating the verification call.
Returns: The updated HostedNumberOrderInstance
Return type: twilio.rest.preview.hosted_numbers.hosted_number_order.HostedNumberOrderInstance
-
-
class
twilio.rest.preview.hosted_numbers.hosted_number_order.HostedNumberOrderInstance(version, payload, sid=None)[source]¶ Bases:
twilio.base.instance_resource.InstanceResourcePLEASE 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'¶
-
-
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
-
date_created¶ Returns: The date this HostedNumberOrder was created. Return type: datetime
-
date_updated¶ Returns: The date this HostedNumberOrder was updated. Return type: datetime
-
delete()[source]¶ Deletes the HostedNumberOrderInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
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
-
fetch()[source]¶ Fetch the HostedNumberOrderInstance
Returns: The fetched HostedNumberOrderInstance Return type: twilio.rest.preview.hosted_numbers.hosted_number_order.HostedNumberOrderInstance
-
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: HostedNumberOrderInstance.Status
-
unique_name¶ Returns: A unique, developer assigned name of this HostedNumberOrder. Return type: unicode
-
update(friendly_name=<object object>, unique_name=<object object>, email=<object object>, cc_emails=<object object>, status=<object object>, verification_code=<object object>, verification_type=<object object>, verification_document_sid=<object object>, extension=<object object>, call_delay=<object object>)[source]¶ Update the HostedNumberOrderInstance
Parameters: - friendly_name (unicode) – A human readable description of this resource.
- unique_name (unicode) – A unique, developer assigned name of this HostedNumberOrder.
- email (unicode) – Email.
- cc_emails (list[unicode]) – A list of emails.
- status (HostedNumberOrderInstance.Status) – The Status of this HostedNumberOrder.
- verification_code (unicode) – A verification code.
- verification_type (HostedNumberOrderInstance.VerificationType) – Verification Type.
- verification_document_sid (unicode) – Verification Document Sid
- extension (unicode) – Digits to dial after connecting the verification call.
- call_delay (unicode) – The number of seconds, between 0 and 60, to delay before initiating the verification call.
Returns: The updated HostedNumberOrderInstance
Return type: twilio.rest.preview.hosted_numbers.hosted_number_order.HostedNumberOrderInstance
-
url¶ Returns: The URL 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: HostedNumberOrderInstance.VerificationType
-
class
-
class
twilio.rest.preview.hosted_numbers.hosted_number_order.HostedNumberOrderList(version)[source]¶ Bases:
twilio.base.list_resource.ListResourcePLEASE 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(phone_number, sms_capability, account_sid=<object object>, friendly_name=<object object>, unique_name=<object object>, cc_emails=<object object>, sms_url=<object object>, sms_method=<object object>, sms_fallback_url=<object object>, sms_fallback_method=<object object>, status_callback_url=<object object>, status_callback_method=<object object>, sms_application_sid=<object object>, address_sid=<object object>, email=<object object>, verification_type=<object object>, verification_document_sid=<object object>)[source]¶ Create the HostedNumberOrderInstance
Parameters: - phone_number (unicode) – An E164 formatted phone number.
- sms_capability (bool) – Specify SMS capability to host.
- account_sid (unicode) – Account Sid.
- friendly_name (unicode) – A human readable description of this resource.
- unique_name (unicode) – A unique, developer assigned name of this HostedNumberOrder.
- cc_emails (list[unicode]) – A list of emails.
- sms_url (unicode) – SMS URL.
- sms_method (unicode) – SMS Method.
- sms_fallback_url (unicode) – SMS Fallback URL.
- sms_fallback_method (unicode) – SMS Fallback Method.
- status_callback_url (unicode) – Status Callback URL.
- status_callback_method (unicode) – Status Callback Method.
- sms_application_sid (unicode) – SMS Application Sid.
- address_sid (unicode) – Address sid.
- email (unicode) – Email.
- verification_type (HostedNumberOrderInstance.VerificationType) – Verification Type.
- verification_document_sid (unicode) – Verification Document Sid
Returns: The created HostedNumberOrderInstance
Return type: twilio.rest.preview.hosted_numbers.hosted_number_order.HostedNumberOrderInstance
-
get(sid)[source]¶ Constructs a HostedNumberOrderContext
Parameters: sid – HostedNumberOrder sid. Returns: twilio.rest.preview.hosted_numbers.hosted_number_order.HostedNumberOrderContext Return type: twilio.rest.preview.hosted_numbers.hosted_number_order.HostedNumberOrderContext
-
get_page(target_url)[source]¶ Retrieve a specific page of HostedNumberOrderInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of HostedNumberOrderInstance Return type: twilio.rest.preview.hosted_numbers.hosted_number_order.HostedNumberOrderPage
-
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 HostedNumberOrderInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.
Parameters: - status (HostedNumberOrderInstance.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.hosted_number_order.HostedNumberOrderInstance]
-
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 HostedNumberOrderInstance records from the API. Request is executed immediately
Parameters: - status (HostedNumberOrderInstance.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 HostedNumberOrderInstance
Return type: twilio.rest.preview.hosted_numbers.hosted_number_order.HostedNumberOrderPage
-
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 HostedNumberOrderInstance 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 (HostedNumberOrderInstance.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.hosted_number_order.HostedNumberOrderInstance]
-
-
class
twilio.rest.preview.hosted_numbers.hosted_number_order.HostedNumberOrderPage(version, response, solution)[source]¶ Bases:
twilio.base.page.PagePLEASE 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 HostedNumberOrderInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.preview.hosted_numbers.hosted_number_order.HostedNumberOrderInstance Return type: twilio.rest.preview.hosted_numbers.hosted_number_order.HostedNumberOrderInstance
-
Module contents¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.preview.hosted_numbers.HostedNumbers(domain)[source]¶ Bases:
twilio.base.version.Version-
hosted_number_orders¶ Return type: twilio.rest.preview.hosted_numbers.hosted_number_order.HostedNumberOrderList
-