twilio.rest.fax.v1.fax package¶
Submodules¶
twilio.rest.fax.v1.fax.fax_media module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.fax.v1.fax.fax_media.
FaxMediaContext
(version, fax_sid, sid)[source]¶ Bases:
twilio.base.instance_context.InstanceContext
PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-
delete
()[source]¶ Deletes the FaxMediaInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch
()[source]¶ Fetch the FaxMediaInstance
Returns: The fetched FaxMediaInstance Return type: twilio.rest.fax.v1.fax.fax_media.FaxMediaInstance
-
-
class
twilio.rest.fax.v1.fax.fax_media.
FaxMediaInstance
(version, payload, fax_sid, sid=None)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource
PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-
account_sid
¶ Returns: The SID of the Account that created the resource Return type: unicode
-
content_type
¶ Returns: The content type of the stored fax media Return type: unicode
-
date_created
¶ Returns: The ISO 8601 date and time in GMT when the resource was created Return type: datetime
-
date_updated
¶ Returns: The ISO 8601 date and time in GMT when the resource was last updated Return type: datetime
-
delete
()[source]¶ Deletes the FaxMediaInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fax_sid
¶ Returns: The SID of the fax the FaxMedia resource is associated with Return type: unicode
-
fetch
()[source]¶ Fetch the FaxMediaInstance
Returns: The fetched FaxMediaInstance Return type: twilio.rest.fax.v1.fax.fax_media.FaxMediaInstance
-
sid
¶ Returns: The unique string that identifies the resource Return type: unicode
-
url
¶ Returns: The absolute URL of the FaxMedia resource Return type: unicode
-
-
class
twilio.rest.fax.v1.fax.fax_media.
FaxMediaList
(version, fax_sid)[source]¶ Bases:
twilio.base.list_resource.ListResource
PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-
get
(sid)[source]¶ Constructs a FaxMediaContext
Parameters: sid – The unique string that identifies the resource to fetch Returns: twilio.rest.fax.v1.fax.fax_media.FaxMediaContext Return type: twilio.rest.fax.v1.fax.fax_media.FaxMediaContext
-
get_page
(target_url)[source]¶ Retrieve a specific page of FaxMediaInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of FaxMediaInstance Return type: twilio.rest.fax.v1.fax.fax_media.FaxMediaPage
-
list
(limit=None, page_size=None)[source]¶ Lists FaxMediaInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.
Parameters: - 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:
-
page
(page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of FaxMediaInstance records from the API. Request is executed immediately
Parameters: Returns: Page of FaxMediaInstance
Return type:
-
stream
(limit=None, page_size=None)[source]¶ Streams FaxMediaInstance 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: - 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:
-
-
class
twilio.rest.fax.v1.fax.fax_media.
FaxMediaPage
(version, response, solution)[source]¶ Bases:
twilio.base.page.Page
PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-
get_instance
(payload)[source]¶ Build an instance of FaxMediaInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.fax.v1.fax.fax_media.FaxMediaInstance Return type: twilio.rest.fax.v1.fax.fax_media.FaxMediaInstance
-
Module contents¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.fax.v1.fax.
FaxContext
(version, sid)[source]¶ Bases:
twilio.base.instance_context.InstanceContext
PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-
delete
()[source]¶ Deletes the FaxInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch
()[source]¶ Fetch the FaxInstance
Returns: The fetched FaxInstance Return type: twilio.rest.fax.v1.fax.FaxInstance
-
media
¶ Access the media
Returns: twilio.rest.fax.v1.fax.fax_media.FaxMediaList Return type: twilio.rest.fax.v1.fax.fax_media.FaxMediaList
-
update
(status=<object object>)[source]¶ Update the FaxInstance
Parameters: status (FaxInstance.UpdateStatus) – The new status of the resource Returns: The updated FaxInstance Return type: twilio.rest.fax.v1.fax.FaxInstance
-
-
class
twilio.rest.fax.v1.fax.
FaxInstance
(version, payload, sid=None)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource
PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-
class
Status
[source]¶ Bases:
object
-
BUSY
= 'busy'¶
-
CANCELED
= 'canceled'¶
-
DELIVERED
= 'delivered'¶
-
FAILED
= 'failed'¶
-
NO_ANSWER
= 'no-answer'¶
-
PROCESSING
= 'processing'¶
-
QUEUED
= 'queued'¶
-
RECEIVED
= 'received'¶
-
RECEIVING
= 'receiving'¶
-
SENDING
= 'sending'¶
-
-
account_sid
¶ Returns: The SID of the Account that created the resource Return type: unicode
-
api_version
¶ Returns: The API version used to transmit the fax Return type: unicode
-
date_created
¶ Returns: The ISO 8601 formatted date and time in GMT when the resource was created Return type: datetime
-
date_updated
¶ Returns: The ISO 8601 formatted date and time in GMT when the resource was last updated Return type: datetime
-
delete
()[source]¶ Deletes the FaxInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
direction
¶ Returns: The direction of the fax Return type: FaxInstance.Direction
-
duration
¶ Returns: The time it took to transmit the fax Return type: unicode
-
fetch
()[source]¶ Fetch the FaxInstance
Returns: The fetched FaxInstance Return type: twilio.rest.fax.v1.fax.FaxInstance
-
from_
¶ Returns: The number the fax was sent from Return type: unicode
-
links
¶ Returns: The URLs of the fax’s related resources Return type: unicode
-
media
¶ Access the media
Returns: twilio.rest.fax.v1.fax.fax_media.FaxMediaList Return type: twilio.rest.fax.v1.fax.fax_media.FaxMediaList
-
media_sid
¶ Returns: The SID of the FaxMedia resource that is associated with the Fax Return type: unicode
-
media_url
¶ Returns: The Twilio-hosted URL that can be used to download fax media Return type: unicode
-
num_pages
¶ Returns: The number of pages contained in the fax document Return type: unicode
-
price
¶ Returns: The fax transmission price Return type: unicode
-
price_unit
¶ Returns: The ISO 4217 currency used for billing Return type: unicode
-
quality
¶ Returns: The quality of the fax Return type: FaxInstance.Quality
-
sid
¶ Returns: The unique string that identifies the resource Return type: unicode
-
status
¶ Returns: The status of the fax Return type: FaxInstance.Status
-
to
¶ Returns: The phone number that received the fax Return type: unicode
-
update
(status=<object object>)[source]¶ Update the FaxInstance
Parameters: status (FaxInstance.UpdateStatus) – The new status of the resource Returns: The updated FaxInstance Return type: twilio.rest.fax.v1.fax.FaxInstance
-
url
¶ Returns: The absolute URL of the fax resource Return type: unicode
-
class
-
class
twilio.rest.fax.v1.fax.
FaxList
(version)[source]¶ Bases:
twilio.base.list_resource.ListResource
PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-
create
(to, media_url, quality=<object object>, status_callback=<object object>, from_=<object object>, sip_auth_username=<object object>, sip_auth_password=<object object>, store_media=<object object>, ttl=<object object>)[source]¶ Create the FaxInstance
Parameters: - to (unicode) – The phone number to receive the fax
- media_url (unicode) – The URL of the PDF that contains the fax
- quality (FaxInstance.Quality) – The quality of this fax
- status_callback (unicode) – The URL we should call to send status information to your application
- from (unicode) – The number the fax was sent from
- sip_auth_username (unicode) – The username for SIP authentication
- sip_auth_password (unicode) – The password for SIP authentication
- store_media (bool) – Whether to store a copy of the sent media
- ttl (unicode) – How long in minutes to try to send the fax
Returns: The created FaxInstance
Return type:
-
get
(sid)[source]¶ Constructs a FaxContext
Parameters: sid – The unique string that identifies the resource Returns: twilio.rest.fax.v1.fax.FaxContext Return type: twilio.rest.fax.v1.fax.FaxContext
-
get_page
(target_url)[source]¶ Retrieve a specific page of FaxInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of FaxInstance Return type: twilio.rest.fax.v1.fax.FaxPage
-
list
(from_=<object object>, to=<object object>, date_created_on_or_before=<object object>, date_created_after=<object object>, limit=None, page_size=None)[source]¶ Lists FaxInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.
Parameters: - from (unicode) – Retrieve only those faxes sent from this phone number
- to (unicode) – Retrieve only those faxes sent to this phone number
- date_created_on_or_before (datetime) – Retrieve only faxes created on or before this date
- date_created_after (datetime) – Retrieve only faxes created after this date
- 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:
-
page
(from_=<object object>, to=<object object>, date_created_on_or_before=<object object>, date_created_after=<object object>, page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of FaxInstance records from the API. Request is executed immediately
Parameters: - from (unicode) – Retrieve only those faxes sent from this phone number
- to (unicode) – Retrieve only those faxes sent to this phone number
- date_created_on_or_before (datetime) – Retrieve only faxes created on or before this date
- date_created_after (datetime) – Retrieve only faxes created after this date
- 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 FaxInstance
Return type:
-
stream
(from_=<object object>, to=<object object>, date_created_on_or_before=<object object>, date_created_after=<object object>, limit=None, page_size=None)[source]¶ Streams FaxInstance 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: - from (unicode) – Retrieve only those faxes sent from this phone number
- to (unicode) – Retrieve only those faxes sent to this phone number
- date_created_on_or_before (datetime) – Retrieve only faxes created on or before this date
- date_created_after (datetime) – Retrieve only faxes created after this date
- 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:
-
-
class
twilio.rest.fax.v1.fax.
FaxPage
(version, response, solution)[source]¶ Bases:
twilio.base.page.Page
PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-
get_instance
(payload)[source]¶ Build an instance of FaxInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.fax.v1.fax.FaxInstance Return type: twilio.rest.fax.v1.fax.FaxInstance
-