Skip to content

Latest commit

 

History

History
433 lines (286 loc) · 10.8 KB

FaxLineApi.md

File metadata and controls

433 lines (286 loc) · 10.8 KB

Dropbox\Sign\FaxLineApi

All URIs are relative to https://api.hellosign.com/v3.

Method HTTP request Description
faxLineAddUser() PUT /fax_line/add_user Add Fax Line User
faxLineAreaCodeGet() GET /fax_line/area_codes Get Available Fax Line Area Codes
faxLineCreate() POST /fax_line/create Purchase Fax Line
faxLineDelete() DELETE /fax_line Delete Fax Line
faxLineGet() GET /fax_line Get Fax Line
faxLineList() GET /fax_line/list List Fax Lines
faxLineRemoveUser() PUT /fax_line/remove_user Remove Fax Line Access

faxLineAddUser()

faxLineAddUser($fax_line_add_user_request): \Dropbox\Sign\Model\FaxLineResponse

Add Fax Line User

Grants a user access to the specified Fax Line.

Example

<?php

require_once __DIR__ . "/vendor/autoload.php";

$config = Dropbox\Sign\Configuration::getDefaultConfiguration();

// Configure HTTP basic authorization: api_key
$config->setUsername("YOUR_API_KEY");

$faxLineApi = new Dropbox\Sign\Api\FaxLineApi($config);

$data = new Dropbox\Sign\Model\FaxLineAddUserRequest();
$data->setNumber("[FAX_NUMBER]")
    ->setEmailAddress("member@dropboxsign.com");

try {
    $result = $faxLineApi->faxLineAddUser($data);
    print_r($result);
} catch (Dropbox\Sign\ApiException $e) {
    $error = $e->getResponseObject();
    echo "Exception when calling Dropbox Sign API: "
        . print_r($error->getError());
}

Parameters

Name Type Description Notes
fax_line_add_user_request \Dropbox\Sign\Model\FaxLineAddUserRequest

Return type

\Dropbox\Sign\Model\FaxLineResponse

Authorization

api_key

HTTP request headers

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

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

faxLineAreaCodeGet()

faxLineAreaCodeGet($country, $state, $province, $city): \Dropbox\Sign\Model\FaxLineAreaCodeGetResponse

Get Available Fax Line Area Codes

Returns a response with the area codes available for a given state/provice and city.

Example

<?php

require_once __DIR__ . "/vendor/autoload.php";

$config = Dropbox\Sign\Configuration::getDefaultConfiguration();

// Configure HTTP basic authorization: api_key
$config->setUsername("YOUR_API_KEY");

$faxLineApi = new Dropbox\Sign\Api\FaxLineApi($config);

try {
    $result = $faxLineApi->faxLineAreaCodeGet("US", "CA");
    print_r($result);
} catch (Dropbox\Sign\ApiException $e) {
    $error = $e->getResponseObject();
    echo "Exception when calling Dropbox Sign API: "
        . print_r($error->getError());
}

Parameters

Name Type Description Notes
country string Filter area codes by country.
state string Filter area codes by state. [optional]
province string Filter area codes by province. [optional]
city string Filter area codes by city. [optional]

Return type

\Dropbox\Sign\Model\FaxLineAreaCodeGetResponse

Authorization

api_key

HTTP request headers

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

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

faxLineCreate()

faxLineCreate($fax_line_create_request): \Dropbox\Sign\Model\FaxLineResponse

Purchase Fax Line

Purchases a new Fax Line.

Example

<?php

require_once __DIR__ . "/vendor/autoload.php";

$config = Dropbox\Sign\Configuration::getDefaultConfiguration();

// Configure HTTP basic authorization: api_key
$config->setUsername("YOUR_API_KEY");

$faxLineApi = new Dropbox\Sign\Api\FaxLineApi($config);

$data = new Dropbox\Sign\Model\FaxLineCreateRequest();
$data->setAreaCode(209)
    ->setCountry("US");

try {
    $result = $faxLineApi->faxLineCreate($data);
    print_r($result);
} catch (Dropbox\Sign\ApiException $e) {
    $error = $e->getResponseObject();
    echo "Exception when calling Dropbox Sign API: "
        . print_r($error->getError());
}

Parameters

Name Type Description Notes
fax_line_create_request \Dropbox\Sign\Model\FaxLineCreateRequest

Return type

\Dropbox\Sign\Model\FaxLineResponse

Authorization

api_key

HTTP request headers

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

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

faxLineDelete()

faxLineDelete($fax_line_delete_request)

Delete Fax Line

Deletes the specified Fax Line from the subscription.

Example

<?php

require_once __DIR__ . "/vendor/autoload.php";

$config = Dropbox\Sign\Configuration::getDefaultConfiguration();

// Configure HTTP basic authorization: api_key
$config->setUsername("YOUR_API_KEY");

$faxLineApi = new Dropbox\Sign\Api\FaxLineApi($config);

$data = new Dropbox\Sign\Model\FaxLineDeleteRequest();
$data->setNumber("[FAX_NUMBER]");

try {
    $faxLineApi->faxLineDelete($data);
} catch (Dropbox\Sign\ApiException $e) {
    $error = $e->getResponseObject();
    echo "Exception when calling Dropbox Sign API: "
        . print_r($error->getError());
}

Parameters

Name Type Description Notes
fax_line_delete_request \Dropbox\Sign\Model\FaxLineDeleteRequest

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

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

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

faxLineGet()

faxLineGet($number): \Dropbox\Sign\Model\FaxLineResponse

Get Fax Line

Returns the properties and settings of a Fax Line.

Example

<?php

require_once __DIR__ . "/vendor/autoload.php";

$config = Dropbox\Sign\Configuration::getDefaultConfiguration();

// Configure HTTP basic authorization: api_key
$config->setUsername("YOUR_API_KEY");

$faxLineApi = new Dropbox\Sign\Api\FaxLineApi($config);

try {
    $result = $faxLineApi->faxLineGet("[FAX_NUMBER]");
    print_r($result);
} catch (Dropbox\Sign\ApiException $e) {
    $error = $e->getResponseObject();
    echo "Exception when calling Dropbox Sign API: "
        . print_r($error->getError());
}

Parameters

Name Type Description Notes
number string The Fax Line number.

Return type

\Dropbox\Sign\Model\FaxLineResponse

Authorization

api_key

HTTP request headers

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

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

faxLineList()

faxLineList($account_id, $page, $page_size, $show_team_lines): \Dropbox\Sign\Model\FaxLineListResponse

List Fax Lines

Returns the properties and settings of multiple Fax Lines.

Example

<?php

require_once __DIR__ . "/vendor/autoload.php";

$config = Dropbox\Sign\Configuration::getDefaultConfiguration();

// Configure HTTP basic authorization: api_key
$config->setUsername("YOUR_API_KEY");

$faxLineApi = new Dropbox\Sign\Api\FaxLineApi($config);

try {
    $result = $faxLineApi->faxLineList();
    print_r($result);
} catch (Dropbox\Sign\ApiException $e) {
    $error = $e->getResponseObject();
    echo "Exception when calling Dropbox Sign API: "
        . print_r($error->getError());
}

Parameters

Name Type Description Notes
account_id string Account ID [optional]
page int Page [optional] [default to 1]
page_size int Page size [optional] [default to 20]
show_team_lines bool Show team lines [optional]

Return type

\Dropbox\Sign\Model\FaxLineListResponse

Authorization

api_key

HTTP request headers

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

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

faxLineRemoveUser()

faxLineRemoveUser($fax_line_remove_user_request): \Dropbox\Sign\Model\FaxLineResponse

Remove Fax Line Access

Removes a user's access to the specified Fax Line.

Example

<?php

require_once __DIR__ . "/vendor/autoload.php";

$config = Dropbox\Sign\Configuration::getDefaultConfiguration();

// Configure HTTP basic authorization: api_key
$config->setUsername("YOUR_API_KEY");

$faxLineApi = new Dropbox\Sign\Api\FaxLineApi($config);

$data = new Dropbox\Sign\Model\FaxLineRemoveUserRequest();
$data->setNumber("[FAX_NUMBER]")
    ->setEmailAddress("member@dropboxsign.com");

try {
    $result = $faxLineApi->faxLineRemoveUser($data);
    print_r($result);
} catch (Dropbox\Sign\ApiException $e) {
    $error = $e->getResponseObject();
    echo "Exception when calling Dropbox Sign API: "
        . print_r($error->getError());
}

Parameters

Name Type Description Notes
fax_line_remove_user_request \Dropbox\Sign\Model\FaxLineRemoveUserRequest

Return type

\Dropbox\Sign\Model\FaxLineResponse

Authorization

api_key

HTTP request headers

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

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