Skip to content

Latest commit

 

History

History
655 lines (452 loc) · 23.9 KB

TemplatesApi.md

File metadata and controls

655 lines (452 loc) · 23.9 KB
Raw

Docuseal\TemplatesApi

All URIs are relative to https://api.docuseal.com, except if the operation defines another base path.

Method HTTP request Description
addDocumentToTemplate() PUT /templates/{id}/documents Update template documents
archiveTemplate() DELETE /templates/{id} Archive a template
cloneTemplate() POST /templates/{id}/clone Clone a template
createTemplateFromDocx() POST /templates/docx Create a template from Word DOCX
createTemplateFromHtml() POST /templates/html Create a template from HTML
createTemplateFromPdf() POST /templates/pdf Create a template from existing PDF
getTemplate() GET /templates/{id} Get a template
getTemplates() GET /templates List all templates
mergeTemplate() POST /templates/merge Merge templates
updateTemplate() PUT /templates/{id} Update a template

addDocumentToTemplate()

addDocumentToTemplate($id, $add_document_to_template_request): \Docuseal\Model\GetTemplates200ResponseDataInner

Update template documents

The API endpoint allows you to add, remove or replace documents in the template with provided PDF/DOCX file or HTML content.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: AuthToken
$config = Docuseal\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Docuseal\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');


$apiInstance = new Docuseal\Api\TemplatesApi(
    // 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
);
$id = 1000001; // int | The unique identifier of the documents template.
$add_document_to_template_request = new \Docuseal\Model\AddDocumentToTemplateRequest(); // \Docuseal\Model\AddDocumentToTemplateRequest

try {
    $result = $apiInstance->addDocumentToTemplate($id, $add_document_to_template_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->addDocumentToTemplate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id int The unique identifier of the documents template.
add_document_to_template_request \Docuseal\Model\AddDocumentToTemplateRequest

Return type

\Docuseal\Model\GetTemplates200ResponseDataInner

Authorization

AuthToken

HTTP request headers

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

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

archiveTemplate()

archiveTemplate($id): \Docuseal\Model\ArchiveTemplate200Response

Archive a template

The API endpoint allows you to archive a document template.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: AuthToken
$config = Docuseal\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Docuseal\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');


$apiInstance = new Docuseal\Api\TemplatesApi(
    // 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
);
$id = 1000001; // int | The unique identifier of the document template.

try {
    $result = $apiInstance->archiveTemplate($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->archiveTemplate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id int The unique identifier of the document template.

Return type

\Docuseal\Model\ArchiveTemplate200Response

Authorization

AuthToken

HTTP request headers

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

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

cloneTemplate()

cloneTemplate($id, $clone_template_request): \Docuseal\Model\GetTemplates200ResponseDataInner

Clone a template

The API endpoint allows you to clone existing template into a new template.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: AuthToken
$config = Docuseal\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Docuseal\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');


$apiInstance = new Docuseal\Api\TemplatesApi(
    // 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
);
$id = 1000001; // int | The unique identifier of the documents template.
$clone_template_request = new \Docuseal\Model\CloneTemplateRequest(); // \Docuseal\Model\CloneTemplateRequest

try {
    $result = $apiInstance->cloneTemplate($id, $clone_template_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->cloneTemplate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id int The unique identifier of the documents template.
clone_template_request \Docuseal\Model\CloneTemplateRequest

Return type

\Docuseal\Model\GetTemplates200ResponseDataInner

Authorization

AuthToken

HTTP request headers

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

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

createTemplateFromDocx()

createTemplateFromDocx($create_template_from_docx_request): \Docuseal\Model\GetTemplates200ResponseDataInner

Create a template from Word DOCX

The API endpoint provides the functionality to create a fillable document template for existing Microsoft Word document. Use {{Field Name;role=Signer1;type=date}} text tags to define fillable fields in the document. See <a href="https://www.docuseal.com/examples/fieldtags.docx\" target="_blank" class="link font-bold" >https://www.docuseal.com/examples/fieldtags.docx for more text tag formats. Or specify the exact pixel coordinates of the document fields using fields param.
Related Guides
<a href="https://www.docuseal.com/guides/use-embedded-text-field-tags-in-the-pdf-to-create-a-fillable-form\" class="link">Use embedded text field tags to create a fillable form

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: AuthToken
$config = Docuseal\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Docuseal\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');


$apiInstance = new Docuseal\Api\TemplatesApi(
    // 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
);
$create_template_from_docx_request = new \Docuseal\Model\CreateTemplateFromDocxRequest(); // \Docuseal\Model\CreateTemplateFromDocxRequest

try {
    $result = $apiInstance->createTemplateFromDocx($create_template_from_docx_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->createTemplateFromDocx: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
create_template_from_docx_request \Docuseal\Model\CreateTemplateFromDocxRequest

Return type

\Docuseal\Model\GetTemplates200ResponseDataInner

Authorization

AuthToken

HTTP request headers

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

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

createTemplateFromHtml()

createTemplateFromHtml($create_template_from_html_request): \Docuseal\Model\GetTemplates200ResponseDataInner

Create a template from HTML

The API endpoint provides the functionality to seamlessly generate a PDF document template by utilizing the provided HTML content while incorporating pre-defined fields.
Related Guides
<a href="https://www.docuseal.com/guides/create-pdf-document-fillable-form-with-html-api\" class="link">Create PDF document fillable form with HTML

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: AuthToken
$config = Docuseal\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Docuseal\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');


$apiInstance = new Docuseal\Api\TemplatesApi(
    // 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
);
$create_template_from_html_request = new \Docuseal\Model\CreateTemplateFromHtmlRequest(); // \Docuseal\Model\CreateTemplateFromHtmlRequest

try {
    $result = $apiInstance->createTemplateFromHtml($create_template_from_html_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->createTemplateFromHtml: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
create_template_from_html_request \Docuseal\Model\CreateTemplateFromHtmlRequest

Return type

\Docuseal\Model\GetTemplates200ResponseDataInner

Authorization

AuthToken

HTTP request headers

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

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

createTemplateFromPdf()

createTemplateFromPdf($create_template_from_pdf_request): \Docuseal\Model\GetTemplates200ResponseDataInner

Create a template from existing PDF

The API endpoint provides the functionality to create a fillable document template for existing PDF file. Use {{Field Name;role=Signer1;type=date}} text tags to define fillable fields in the document. See <a href="https://www.docuseal.com/examples/fieldtags.pdf\" target="_blank" class="link font-bold">https://www.docuseal.com/examples/fieldtags.pdf for more text tag formats. Or specify the exact pixel coordinates of the document fields using fields param.
Related Guides
<a href="https://www.docuseal.com/guides/use-embedded-text-field-tags-in-the-pdf-to-create-a-fillable-form\" class="link">Use embedded text field tags to create a fillable form

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: AuthToken
$config = Docuseal\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Docuseal\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');


$apiInstance = new Docuseal\Api\TemplatesApi(
    // 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
);
$create_template_from_pdf_request = new \Docuseal\Model\CreateTemplateFromPdfRequest(); // \Docuseal\Model\CreateTemplateFromPdfRequest

try {
    $result = $apiInstance->createTemplateFromPdf($create_template_from_pdf_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->createTemplateFromPdf: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
create_template_from_pdf_request \Docuseal\Model\CreateTemplateFromPdfRequest

Return type

\Docuseal\Model\GetTemplates200ResponseDataInner

Authorization

AuthToken

HTTP request headers

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

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

getTemplate()

getTemplate($id): \Docuseal\Model\GetTemplates200ResponseDataInner

Get a template

The API endpoint provides the functionality to retrieve information about a document template.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: AuthToken
$config = Docuseal\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Docuseal\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');


$apiInstance = new Docuseal\Api\TemplatesApi(
    // 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
);
$id = 1000001; // int | The unique identifier of the document template.

try {
    $result = $apiInstance->getTemplate($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->getTemplate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id int The unique identifier of the document template.

Return type

\Docuseal\Model\GetTemplates200ResponseDataInner

Authorization

AuthToken

HTTP request headers

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

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

getTemplates()

getTemplates($q, $external_id, $folder, $archived, $limit, $after, $before): \Docuseal\Model\GetTemplates200Response

List all templates

The API endpoint provides the ability to retrieve a list of available document templates.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: AuthToken
$config = Docuseal\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Docuseal\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');


$apiInstance = new Docuseal\Api\TemplatesApi(
    // 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
);
$q = 'q_example'; // string | Filter templates based on the name partial match.
$external_id = 'external_id_example'; // string | The unique applications-specific identifier provided for the template via API or Embedded template form builder. It allows you to receive only templates with your specified external id.
$folder = 'folder_example'; // string | Filter templates by folder name.
$archived = True; // bool | Get only archived templates instead of active ones.
$limit = 56; // int | The number of templates to return. Default value is 10. Maximum value is 100.
$after = 56; // int | The unique identifier of the template to start the list from. It allows you to receive only templates with id greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of templates.
$before = 56; // int | The unique identifier of the template to end the list with. It allows you to receive only templates with id less than the specified value.

try {
    $result = $apiInstance->getTemplates($q, $external_id, $folder, $archived, $limit, $after, $before);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->getTemplates: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
q string Filter templates based on the name partial match. [optional]
external_id string The unique applications-specific identifier provided for the template via API or Embedded template form builder. It allows you to receive only templates with your specified external id. [optional]
folder string Filter templates by folder name. [optional]
archived bool Get only archived templates instead of active ones. [optional]
limit int The number of templates to return. Default value is 10. Maximum value is 100. [optional]
after int The unique identifier of the template to start the list from. It allows you to receive only templates with id greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of templates. [optional]
before int The unique identifier of the template to end the list with. It allows you to receive only templates with id less than the specified value. [optional]

Return type

\Docuseal\Model\GetTemplates200Response

Authorization

AuthToken

HTTP request headers

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

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

mergeTemplate()

mergeTemplate($merge_template_request): \Docuseal\Model\GetTemplates200ResponseDataInner

Merge templates

The API endpoint allows you to merge multiple templates with documents and fields into a new combined template.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: AuthToken
$config = Docuseal\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Docuseal\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');


$apiInstance = new Docuseal\Api\TemplatesApi(
    // 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
);
$merge_template_request = new \Docuseal\Model\MergeTemplateRequest(); // \Docuseal\Model\MergeTemplateRequest

try {
    $result = $apiInstance->mergeTemplate($merge_template_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->mergeTemplate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
merge_template_request \Docuseal\Model\MergeTemplateRequest

Return type

\Docuseal\Model\GetTemplates200ResponseDataInner

Authorization

AuthToken

HTTP request headers

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

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

updateTemplate()

updateTemplate($id, $update_template_request): \Docuseal\Model\UpdateTemplate200Response

Update a template

The API endpoint provides the functionality to move a document template to a different folder and update the name of the template.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: AuthToken
$config = Docuseal\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Docuseal\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');


$apiInstance = new Docuseal\Api\TemplatesApi(
    // 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
);
$id = 1000001; // int | The unique identifier of the document template.
$update_template_request = new \Docuseal\Model\UpdateTemplateRequest(); // \Docuseal\Model\UpdateTemplateRequest

try {
    $result = $apiInstance->updateTemplate($id, $update_template_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->updateTemplate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id int The unique identifier of the document template.
update_template_request \Docuseal\Model\UpdateTemplateRequest

Return type

\Docuseal\Model\UpdateTemplate200Response

Authorization

AuthToken

HTTP request headers

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

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