models package
These are the model types that are returned by the Phaxio API. You should not instantiate them directly.
Submodules
models.account_status module
-
class
phaxio.swagger_client.models.account_status.
AccountStatus
(success=None, message=None, data=None)
-
data
-
-
message
-
-
success
-
models.account_status_data module
-
class
phaxio.swagger_client.models.account_status_data.
AccountStatusData
(balance=None, faxes_today=None, faxes_this_month=None)
-
balance
-
-
faxes_this_month
-
-
faxes_today
-
models.area_code module
-
class
phaxio.swagger_client.models.area_code.
AreaCode
(country_code=None, area_code=None, city=None, state=None, country=None, toll_free=None)
-
area_code
-
-
city
-
-
country
-
-
country_code
-
-
state
-
-
toll_free
-
models.country module
-
class
phaxio.swagger_client.models.country.
Country
(name=None, alpha2=None, country_code=None, price_per_page=None, send_support=None, receive_support=None)
-
alpha2
-
-
country_code
-
-
name
-
-
price_per_page
-
-
receive_support
-
-
send_support
-
models.create_phone_number_response module
models.error module
-
class
phaxio.swagger_client.models.error.
Error
models.failure_response module
models.fax module
models.fax_info module
-
class
phaxio.swagger_client.models.fax_info.
FaxInfo
(id=None, direction=None, num_pages=None, cost=None, status=None, is_test=None, created_at=None, from_number=None, to_number=None, recipients=None, tags=None, error_type=None, error_message=None, error_id=None, completed_at=None)
-
completed_at
-
-
cost
-
-
created_at
-
-
direction
-
-
error_id
-
-
error_message
-
-
error_type
-
-
from_number
-
-
id
-
-
is_test
-
-
num_pages
-
-
recipients
-
-
status
-
-
tags
-
-
to_number
-
models.fax_info_data module
models.generate_phax_code_json_response module
-
class
phaxio.swagger_client.models.generate_phax_code_json_response.
GeneratePhaxCodeJsonResponse
(success=None, message=None, data=None)
-
data
-
-
message
-
-
success
-
models.generate_phax_code_json_response_data module
-
class
phaxio.swagger_client.models.generate_phax_code_json_response_data.
GeneratePhaxCodeJsonResponseData
(identifier=None)
-
identifier
-
models.get_area_codes_response module
-
class
phaxio.swagger_client.models.get_area_codes_response.
GetAreaCodesResponse
(success=None, message=None, data=None, paging=None)
-
data
-
-
message
-
-
paging
-
-
success
-
models.get_countries_response module
-
class
phaxio.swagger_client.models.get_countries_response.
GetCountriesResponse
(success=None, message=None, data=None, paging=None)
-
data
-
-
message
-
-
paging
-
-
success
-
models.get_fax_info_response module
-
class
phaxio.swagger_client.models.get_fax_info_response.
GetFaxInfoResponse
(success=None, message=None, data=None)
-
data
-
-
message
-
-
success
-
models.get_faxes_response module
-
class
phaxio.swagger_client.models.get_faxes_response.
GetFaxesResponse
(success=None, message=None, data=None, paging=None)
-
data
-
-
message
-
-
paging
-
-
success
-
models.list_phone_numbers_response module
-
class
phaxio.swagger_client.models.list_phone_numbers_response.
ListPhoneNumbersResponse
(success=None, message=None, data=None)
-
data
-
-
message
-
-
success
-
models.message module
models.operation_status module
-
class
phaxio.swagger_client.models.operation_status.
OperationStatus
(success=None, message=None)
-
message
-
-
success
-
models.paging module
-
class
phaxio.swagger_client.models.paging.
Paging
(total=None, per_page=None, page=None)
-
page
-
-
per_page
-
-
total
-
models.phax_code module
-
class
phaxio.swagger_client.models.phax_code.
PhaxCode
(success=None, message=None, data=None)
-
data
-
-
message
-
-
success
-
models.phax_code_data module
-
class
phaxio.swagger_client.models.phax_code_data.
PhaxCodeData
(created_at=None, identifier=None, metadata=None)
-
created_at
-
-
identifier
-
-
metadata
-
models.phone_number module
-
class
phaxio.swagger_client.models.phone_number.
PhoneNumber
(phone_number=None, city=None, state=None, country=None, cost=None, last_billed_at=None, provisioned_at=None, callback_url=None)
-
callback_url
-
-
city
-
-
cost
-
-
country
-
-
last_billed_at
-
-
phone_number
-
-
provisioned_at
-
-
state
-
models.phone_number_response module
-
class
phaxio.swagger_client.models.phone_number_response.
PhoneNumberResponse
(success=None, message=None, data=None)
-
data
-
-
message
-
-
success
-
models.recipient module
-
class
phaxio.swagger_client.models.recipient.
Recipient
(phone_number=None, status=None, completed_at=None, bitrate=None, resolution=None, error_type=None, error_message=None, error_id=None)
-
bitrate
-
-
completed_at
-
-
error_id
-
-
error_message
-
-
error_type
-
-
phone_number
-
-
resolution
-
-
status
-
models.response_base module
models.send_fax_response module
-
class
phaxio.swagger_client.models.send_fax_response.
SendFaxResponse
(success=None, message=None, data=None)
-
data
-
-
message
-
-
success
-
models.send_fax_response_data module
-
class
phaxio.swagger_client.models.send_fax_response_data.
SendFaxResponseData
(id=None)
-
id
-
models.status module
-
class
phaxio.swagger_client.models.status.
Status
models.success module
Module contents