All URIs are relative to https://signrequest.com/api/v1
| Method | HTTP request | Description |
|---|---|---|
| documentsCreate | POST /documents/ | Create a Document |
| documentsDelete | DELETE /documents/{uuid}/ | Delete a Document |
| documentsList | GET /documents/ | Retrieve a list of Documents |
| documentsRead | GET /documents/{uuid}/ | Retrieve a Document |
\SignRequest\Model\Document documentsCreate($data)
Create a Document
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Token
$config = SignRequest\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
$config = SignRequest\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Token');
$apiInstance = new SignRequest\Api\DocumentsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$data = new \SignRequest\Model\Document(); // \SignRequest\Model\Document |
try {
$result = $apiInstance->documentsCreate($data);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DocumentsApi->documentsCreate: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| data | \SignRequest\Model\Document |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
documentsDelete($uuid)
Delete a Document
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Token
$config = SignRequest\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
$config = SignRequest\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Token');
$apiInstance = new SignRequest\Api\DocumentsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$uuid = "uuid_example"; // string |
try {
$apiInstance->documentsDelete($uuid);
} catch (Exception $e) {
echo 'Exception when calling DocumentsApi->documentsDelete: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| uuid | string |
void (empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\SignRequest\Model\InlineResponse2003 documentsList($external_id, $signrequest__who, $signrequest__from_email, $status, $user__email, $user__first_name, $user__last_name, $created, $modified, $page, $limit)
Retrieve a list of Documents
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Token
$config = SignRequest\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
$config = SignRequest\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Token');
$apiInstance = new SignRequest\Api\DocumentsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$external_id = "external_id_example"; // string |
$signrequest__who = "signrequest__who_example"; // string |
$signrequest__from_email = "signrequest__from_email_example"; // string |
$status = "status_example"; // string |
$user__email = "user__email_example"; // string |
$user__first_name = "user__first_name_example"; // string |
$user__last_name = "user__last_name_example"; // string |
$created = "created_example"; // string |
$modified = "modified_example"; // string |
$page = 56; // int | A page number within the paginated result set.
$limit = 56; // int | Number of results to return per page.
try {
$result = $apiInstance->documentsList($external_id, $signrequest__who, $signrequest__from_email, $status, $user__email, $user__first_name, $user__last_name, $created, $modified, $page, $limit);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DocumentsApi->documentsList: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| external_id | string | [optional] | |
| signrequest__who | string | [optional] | |
| signrequest__from_email | string | [optional] | |
| status | string | [optional] | |
| user__email | string | [optional] | |
| user__first_name | string | [optional] | |
| user__last_name | string | [optional] | |
| created | string | [optional] | |
| modified | string | [optional] | |
| page | int | A page number within the paginated result set. | [optional] |
| limit | int | Number of results to return per page. | [optional] |
\SignRequest\Model\InlineResponse2003
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\SignRequest\Model\Document documentsRead($uuid)
Retrieve a Document
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Token
$config = SignRequest\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
$config = SignRequest\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Token');
$apiInstance = new SignRequest\Api\DocumentsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$uuid = "uuid_example"; // string |
try {
$result = $apiInstance->documentsRead($uuid);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DocumentsApi->documentsRead: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| uuid | string |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]