Skip to content

FAXApi.md

Latest commit

 

History

History
398 lines (282 loc) · 12.3 KB

FAXApi.md

File metadata and controls

398 lines (282 loc) · 12.3 KB

clicksend_client.FAXApi

All URIs are relative to https://rest.clicksend.com/v3

Method HTTP request Description
fax_history_get GET /fax/history Get a list of Fax History.
fax_price_post POST /fax/price Calculate Total Price for Fax Messages sent
fax_receipts_by_message_id_get GET /fax/receipts/{message_id} Get a single fax receipt based on message id.
fax_receipts_get GET /fax/receipts Get all delivery receipts
fax_receipts_post POST /fax/receipts Add a delivery receipt
fax_receipts_read_put PUT /fax/receipts-read Mark delivery receipts as read
fax_send_post POST /fax/send Send a fax using supplied supported file-types.

fax_history_get

str fax_history_get(date_from=date_from, date_to=date_to, q=q, order=order, page=page, limit=limit)

Get a list of Fax History.

Get a list of Fax History.

Example

from __future__ import print_function
import time
import clicksend_client
from clicksend_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuth
configuration = clicksend_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = clicksend_client.FAXApi(clicksend_client.ApiClient(configuration))
date_from = 56 # int | Customize result by setting from date (timestsamp) Example: 1457572619. (optional)
date_to = 56 # int | Customize result by setting to date (timestamp) Example: 1457573000. (optional)
q = 'q_example' # str | Custom query Example: status:Sent,status_code:201. (optional)
order = 'order_example' # str | Order result by Example: date_added:desc,list_id:desc. (optional)
page = 1 # int | Page number (optional) (default to 1)
limit = 10 # int | Number of records per page (optional) (default to 10)

try:
    # Get a list of Fax History.
    api_response = api_instance.fax_history_get(date_from=date_from, date_to=date_to, q=q, order=order, page=page, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FAXApi->fax_history_get: %s\n" % e)

Parameters

Name Type Description Notes
date_from int Customize result by setting from date (timestsamp) Example: 1457572619. [optional]
date_to int Customize result by setting to date (timestamp) Example: 1457573000. [optional]
q str Custom query Example: status:Sent,status_code:201. [optional]
order str Order result by Example: date_added:desc,list_id:desc. [optional]
page int Page number [optional] [default to 1]
limit int Number of records per page [optional] [default to 10]

Return type

str

Authorization

BasicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

fax_price_post

str fax_price_post(fax_message)

Calculate Total Price for Fax Messages sent

Calculate Total Price for Fax Messages sent

Example

from __future__ import print_function
import time
import clicksend_client
from clicksend_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuth
configuration = clicksend_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = clicksend_client.FAXApi(clicksend_client.ApiClient(configuration))
fax_message = clicksend_client.FaxMessageCollection() # FaxMessageCollection | FaxMessageCollection model

try:
    # Calculate Total Price for Fax Messages sent
    api_response = api_instance.fax_price_post(fax_message)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FAXApi->fax_price_post: %s\n" % e)

Parameters

Name Type Description Notes
fax_message FaxMessageCollection FaxMessageCollection model

Return type

str

Authorization

BasicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

fax_receipts_by_message_id_get

str fax_receipts_by_message_id_get(message_id)

Get a single fax receipt based on message id.

Get a single fax receipt based on message id.

Example

from __future__ import print_function
import time
import clicksend_client
from clicksend_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuth
configuration = clicksend_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = clicksend_client.FAXApi(clicksend_client.ApiClient(configuration))
message_id = 'message_id_example' # str | ID of the message receipt to retrieve

try:
    # Get a single fax receipt based on message id.
    api_response = api_instance.fax_receipts_by_message_id_get(message_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FAXApi->fax_receipts_by_message_id_get: %s\n" % e)

Parameters

Name Type Description Notes
message_id str ID of the message receipt to retrieve

Return type

str

Authorization

BasicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

fax_receipts_get

str fax_receipts_get(page=page, limit=limit)

Get all delivery receipts

Get all delivery receipts

Example

from __future__ import print_function
import time
import clicksend_client
from clicksend_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuth
configuration = clicksend_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = clicksend_client.FAXApi(clicksend_client.ApiClient(configuration))
page = 1 # int | Page number (optional) (default to 1)
limit = 10 # int | Number of records per page (optional) (default to 10)

try:
    # Get all delivery receipts
    api_response = api_instance.fax_receipts_get(page=page, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FAXApi->fax_receipts_get: %s\n" % e)

Parameters

Name Type Description Notes
page int Page number [optional] [default to 1]
limit int Number of records per page [optional] [default to 10]

Return type

str

Authorization

BasicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

fax_receipts_post

str fax_receipts_post(url)

Add a delivery receipt

Add a delivery receipt

Example

from __future__ import print_function
import time
import clicksend_client
from clicksend_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuth
configuration = clicksend_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = clicksend_client.FAXApi(clicksend_client.ApiClient(configuration))
url = clicksend_client.Url() # Url | Url model

try:
    # Add a delivery receipt
    api_response = api_instance.fax_receipts_post(url)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FAXApi->fax_receipts_post: %s\n" % e)

Parameters

Name Type Description Notes
url Url Url model

Return type

str

Authorization

BasicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

fax_receipts_read_put

str fax_receipts_read_put(date_before=date_before)

Mark delivery receipts as read

Mark delivery receipts as read

Example

from __future__ import print_function
import time
import clicksend_client
from clicksend_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuth
configuration = clicksend_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = clicksend_client.FAXApi(clicksend_client.ApiClient(configuration))
date_before = clicksend_client.DateBefore() # DateBefore | DateBefore model (optional)

try:
    # Mark delivery receipts as read
    api_response = api_instance.fax_receipts_read_put(date_before=date_before)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FAXApi->fax_receipts_read_put: %s\n" % e)

Parameters

Name Type Description Notes
date_before DateBefore DateBefore model [optional]

Return type

str

Authorization

BasicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

fax_send_post

str fax_send_post(fax_message)

Send a fax using supplied supported file-types.

Send a fax using supplied supported file-types.

Example

from __future__ import print_function
import time
import clicksend_client
from clicksend_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuth
configuration = clicksend_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = clicksend_client.FAXApi(clicksend_client.ApiClient(configuration))
fax_message = clicksend_client.FaxMessageCollection() # FaxMessageCollection | FaxMessageCollection model

try:
    # Send a fax using supplied supported file-types.
    api_response = api_instance.fax_send_post(fax_message)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FAXApi->fax_send_post: %s\n" % e)

Parameters

Name Type Description Notes
fax_message FaxMessageCollection FaxMessageCollection model

Return type

str

Authorization

BasicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]