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
Return type:AccountStatusData
message
Return type:str
success
Return type:bool

models.account_status_data module

class phaxio.swagger_client.models.account_status_data.AccountStatusData(balance=None, faxes_today=None, faxes_this_month=None)
balance
Return type:int
faxes_this_month
Return type:int
faxes_today
Return type:int

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
Return type:int
city
Return type:str
country
Return type:str
country_code
Return type:int
state
Return type:str
toll_free
Return type:bool

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
Return type:str
country_code
Return type:int
name
Return type:str
price_per_page
Return type:int
receive_support
Return type:str
send_support
Return type:str

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
Return type:datetime
cost
Return type:int
created_at
Return type:datetime
direction
Return type:str
error_id
Return type:int
error_message
Return type:str
error_type
Return type:str
from_number
Return type:str
id
Return type:int
is_test
Return type:bool
num_pages
Return type:int
recipients
Return type:list[Recipient]
status
Return type:str
tags
Return type:dict(str, str)
to_number
Return type:str

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
Return type:GeneratePhaxCodeJsonResponseData
message
Return type:str
success
Return type:bool

models.generate_phax_code_json_response_data module

class phaxio.swagger_client.models.generate_phax_code_json_response_data.GeneratePhaxCodeJsonResponseData(identifier=None)
identifier
Return type:str

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
Return type:list[AreaCode]
message
Return type:str
paging
Return type:Paging
success
Return type:bool

models.get_countries_response module

class phaxio.swagger_client.models.get_countries_response.GetCountriesResponse(success=None, message=None, data=None, paging=None)
data
Return type:list[Country]
message
Return type:str
paging
Return type:Paging
success
Return type:bool

models.get_fax_info_response module

class phaxio.swagger_client.models.get_fax_info_response.GetFaxInfoResponse(success=None, message=None, data=None)
data
Return type:FaxInfo
message
Return type:str
success
Return type:bool

models.get_faxes_response module

class phaxio.swagger_client.models.get_faxes_response.GetFaxesResponse(success=None, message=None, data=None, paging=None)
data
Return type:list[FaxInfo]
message
Return type:str
paging
Return type:Paging
success
Return type:bool

models.list_phone_numbers_response module

class phaxio.swagger_client.models.list_phone_numbers_response.ListPhoneNumbersResponse(success=None, message=None, data=None)
data
Return type:list[PhoneNumber]
message
Return type:str
success
Return type:bool

models.message module

models.operation_status module

class phaxio.swagger_client.models.operation_status.OperationStatus(success=None, message=None)
message
Return type:str
success
Return type:bool

models.paging module

class phaxio.swagger_client.models.paging.Paging(total=None, per_page=None, page=None)
page
Return type:int
per_page
Return type:int
total
Return type:int

models.phax_code module

class phaxio.swagger_client.models.phax_code.PhaxCode(success=None, message=None, data=None)
data
Return type:PhaxCodeData
message
Return type:str
success
Return type:bool

models.phax_code_data module

class phaxio.swagger_client.models.phax_code_data.PhaxCodeData(created_at=None, identifier=None, metadata=None)
created_at
Return type:datetime
identifier
Return type:str
metadata
Return type:str

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
Return type:str
city
Return type:str
cost
Return type:int
country
Return type:str
last_billed_at
Return type:datetime
phone_number
Return type:str
provisioned_at
Return type:datetime
state
Return type:str

models.phone_number_response module

class phaxio.swagger_client.models.phone_number_response.PhoneNumberResponse(success=None, message=None, data=None)
data
Return type:PhoneNumber
message
Return type:str
success
Return type:bool

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
Return type:int
completed_at
Return type:datetime
error_id
Return type:int
error_message
Return type:str
error_type
Return type:str
phone_number
Return type:str
resolution
Return type:int
status
Return type:str

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
Return type:SendFaxResponseData
message
Return type:str
success
Return type:bool

models.send_fax_response_data module

class phaxio.swagger_client.models.send_fax_response_data.SendFaxResponseData(id=None)
id
Return type:int

models.status module

class phaxio.swagger_client.models.status.Status

models.success module

Module contents