Package pamfax :: Class PamFax
[hide private]
[frames] | no frames]

Class PamFax

source code

Class encapsulating the PamFax API. Actions related to the sending of faxes are called on objects of this class. For example, the 'create' action resides in the FaxJob class, but you can just use the following 'shortcut' logic:

from pamfax import PamFax p = PamFax(<args>) p.create()

Instance Methods [hide private]
 
__init__(self, username, password, host='api.pamfax.biz', apikey='', apisecret='')
Creates an instance of the PamFax class and initiates an HTTPS session.
source code
 
verify_user(self, http, api_credentials, username, password)
Verifies a user via username/password
source code
 
get_user_token(self, http, api_credentials, username, password)
Gets the user token to use with subsequent requests.
source code
 
get_state(self, blocking=False, interval=1)
Obtains the state of the FaxJob build, may block until a state is received, or just return immediately
source code
 
is_converting(self, fax_state)
Returns whether or not a file in the fax job is still in a converting state.
source code