DocSpring\PDFApi

All URIs are relative to https://api.docspring.com/api/v1

Method	HTTP request	Description
addFieldsToTemplate	PUT /templates/{template_id}/add_fields	Add new fields to a Template
batchGeneratePdfV1	POST /templates/{template_id}/submissions/batch	Generates multiple PDFs
batchGeneratePdfs	POST /submissions/batches	Generates multiple PDFs
combinePdfs	POST /combined_submissions?v=2	Merge submission PDFs, template PDFs, or custom files
combineSubmissions	POST /combined_submissions	Merge generated PDFs together
copyTemplate	POST /templates/{template_id}/copy	Copy a Template
createCustomFileFromUpload	POST /custom_files	Create a new custom file from a cached presign upload
createDataRequestToken	POST /data_requests/{data_request_id}/tokens	Creates a new data request token for form authentication
createFolder	POST /folders/	Create a folder
createHTMLTemplate	POST /templates?desc=html	Create a new HTML template
createPDFTemplate	POST /templates	Create a new PDF template with a form POST file upload
createPDFTemplateFromUpload	POST /templates?desc=cached_upload	Create a new PDF template from a cached presign upload
deleteFolder	DELETE /folders/{folder_id}	Delete a folder
expireCombinedSubmission	DELETE /combined_submissions/{combined_submission_id}	Expire a combined submission
expireSubmission	DELETE /submissions/{submission_id}	Expire a PDF submission
generatePDF	POST /templates/{template_id}/submissions	Generates a new PDF
getCombinedSubmission	GET /combined_submissions/{combined_submission_id}	Check the status of a combined submission (merged PDFs)
getDataRequest	GET /data_requests/{data_request_id}	Look up a submission data request
getFullTemplate	GET /templates/{template_id}?full=true	Fetch the full template attributes
getPresignUrl	GET /uploads/presign	Get a presigned URL so that you can upload a file to our AWS S3 bucket
getSubmission	GET /submissions/{submission_id}	Check the status of a PDF
getSubmissionBatch	GET /submissions/batches/{submission_batch_id}	Check the status of a submission batch job
getTemplate	GET /templates/{template_id}	Check the status of an uploaded template
getTemplateSchema	GET /templates/{template_id}/schema	Fetch the JSON schema for a template
listFolders	GET /folders/	Get a list of all folders
listSubmissions	GET /submissions	List all submissions
listSubmissions_0	GET /templates/{template_id}/submissions	List all submissions for a given template
listTemplates	GET /templates	Get a list of all templates
moveFolderToFolder	POST /folders/{folder_id}/move	Move a folder
moveTemplateToFolder	POST /templates/{template_id}/move	Move Template to folder
renameFolder	POST /folders/{folder_id}/rename	Rename a folder
testAuthentication	GET /authentication	Test Authentication
updateDataRequest	PUT /data_requests/{data_request_id}	Update a submission data request
updateTemplate	PUT /templates/{template_id}	Update a Template

addFieldsToTemplate

\DocSpring\Model\AddFieldsTemplateResponse addFieldsToTemplate($template_id, $add_fields_data)

Add new fields to a Template

Example

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

// Configure HTTP basic authorization: api_token_basic
$config = DocSpring\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new DocSpring\Api\PDFApi(
    // 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
);
$template_id = tpl_000000000000000002; // string | 
$add_fields_data = new \DocSpring\Model\AddFieldsData(); // \DocSpring\Model\AddFieldsData | 

try {
    $result = $apiInstance->addFieldsToTemplate($template_id, $add_fields_data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PDFApi->addFieldsToTemplate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
template_id	string
add_fields_data	\DocSpring\Model\AddFieldsData

Return type

\DocSpring\Model\AddFieldsTemplateResponse

Authorization

api_token_basic

HTTP request headers

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

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

batchGeneratePdfV1

\DocSpring\Model\CreateSubmissionResponse[] batchGeneratePdfV1($template_id, $request_body)

Generates multiple PDFs

Example

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

// Configure HTTP basic authorization: api_token_basic
$config = DocSpring\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new DocSpring\Api\PDFApi(
    // 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
);
$template_id = tpl_000000000000000001; // string | 
$request_body = array(new \DocSpring\Model\array()); // object[] | 

try {
    $result = $apiInstance->batchGeneratePdfV1($template_id, $request_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PDFApi->batchGeneratePdfV1: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
template_id	string
request_body	object[]

Return type

\DocSpring\Model\CreateSubmissionResponse[]

Authorization

api_token_basic

HTTP request headers

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

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

batchGeneratePdfs

\DocSpring\Model\CreateSubmissionBatchResponse batchGeneratePdfs($submission_batch_data)

Generates multiple PDFs

Example

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

// Configure HTTP basic authorization: api_token_basic
$config = DocSpring\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new DocSpring\Api\PDFApi(
    // 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
);
$submission_batch_data = new \DocSpring\Model\SubmissionBatchData(); // \DocSpring\Model\SubmissionBatchData | 

try {
    $result = $apiInstance->batchGeneratePdfs($submission_batch_data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PDFApi->batchGeneratePdfs: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
submission_batch_data	\DocSpring\Model\SubmissionBatchData

Return type

\DocSpring\Model\CreateSubmissionBatchResponse

Authorization

api_token_basic

HTTP request headers

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

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

combinePdfs

\DocSpring\Model\CreateCombinedSubmissionResponse combinePdfs($combine_pdfs_data)

Merge submission PDFs, template PDFs, or custom files

Example

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

// Configure HTTP basic authorization: api_token_basic
$config = DocSpring\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new DocSpring\Api\PDFApi(
    // 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
);
$combine_pdfs_data = new \DocSpring\Model\CombinePdfsData(); // \DocSpring\Model\CombinePdfsData | 

try {
    $result = $apiInstance->combinePdfs($combine_pdfs_data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PDFApi->combinePdfs: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
combine_pdfs_data	\DocSpring\Model\CombinePdfsData

Return type

\DocSpring\Model\CreateCombinedSubmissionResponse

Authorization

api_token_basic

HTTP request headers

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

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

combineSubmissions

\DocSpring\Model\CreateCombinedSubmissionResponse combineSubmissions($combined_submission_data)

Merge generated PDFs together

Example

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

// Configure HTTP basic authorization: api_token_basic
$config = DocSpring\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new DocSpring\Api\PDFApi(
    // 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
);
$combined_submission_data = new \DocSpring\Model\CombinedSubmissionData(); // \DocSpring\Model\CombinedSubmissionData | 

try {
    $result = $apiInstance->combineSubmissions($combined_submission_data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PDFApi->combineSubmissions: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
combined_submission_data	\DocSpring\Model\CombinedSubmissionData

Return type

\DocSpring\Model\CreateCombinedSubmissionResponse

Authorization

api_token_basic

HTTP request headers

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

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

copyTemplate

\DocSpring\Model\Template copyTemplate($template_id, $copy_template_data)

Copy a Template

Example

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

// Configure HTTP basic authorization: api_token_basic
$config = DocSpring\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new DocSpring\Api\PDFApi(
    // 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
);
$template_id = tpl_000000000000000001; // string | 
$copy_template_data = new \DocSpring\Model\CopyTemplateData(); // \DocSpring\Model\CopyTemplateData | 

try {
    $result = $apiInstance->copyTemplate($template_id, $copy_template_data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PDFApi->copyTemplate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
template_id	string
copy_template_data	\DocSpring\Model\CopyTemplateData

Return type

\DocSpring\Model\Template

Authorization

api_token_basic

HTTP request headers

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

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

createCustomFileFromUpload

\DocSpring\Model\CreateCustomFileResponse createCustomFileFromUpload($create_custom_file_data)

Create a new custom file from a cached presign upload

Example

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

// Configure HTTP basic authorization: api_token_basic
$config = DocSpring\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new DocSpring\Api\PDFApi(
    // 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_custom_file_data = new \DocSpring\Model\CreateCustomFileData(); // \DocSpring\Model\CreateCustomFileData | 

try {
    $result = $apiInstance->createCustomFileFromUpload($create_custom_file_data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PDFApi->createCustomFileFromUpload: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
create_custom_file_data	\DocSpring\Model\CreateCustomFileData

Return type

\DocSpring\Model\CreateCustomFileResponse

Authorization

api_token_basic

HTTP request headers

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

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

createDataRequestToken

\DocSpring\Model\CreateSubmissionDataRequestTokenResponse createDataRequestToken($data_request_id)

Creates a new data request token for form authentication

Example

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

// Configure HTTP basic authorization: api_token_basic
$config = DocSpring\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new DocSpring\Api\PDFApi(
    // 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_request_id = drq_000000000000000001; // string | 

try {
    $result = $apiInstance->createDataRequestToken($data_request_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PDFApi->createDataRequestToken: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
data_request_id	string

Return type

\DocSpring\Model\CreateSubmissionDataRequestTokenResponse

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

createFolder

\DocSpring\Model\Folder createFolder($create_folder_data)

Create a folder

Example

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

// Configure HTTP basic authorization: api_token_basic
$config = DocSpring\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new DocSpring\Api\PDFApi(
    // 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_folder_data = new \DocSpring\Model\CreateFolderData(); // \DocSpring\Model\CreateFolderData | 

try {
    $result = $apiInstance->createFolder($create_folder_data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PDFApi->createFolder: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
create_folder_data	\DocSpring\Model\CreateFolderData

Return type

\DocSpring\Model\Folder

Authorization

api_token_basic

HTTP request headers

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

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

createHTMLTemplate

\DocSpring\Model\PendingTemplate createHTMLTemplate($create_html_template_data)

Create a new HTML template

Example

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

// Configure HTTP basic authorization: api_token_basic
$config = DocSpring\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new DocSpring\Api\PDFApi(
    // 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_html_template_data = new \DocSpring\Model\CreateHtmlTemplateData(); // \DocSpring\Model\CreateHtmlTemplateData | 

try {
    $result = $apiInstance->createHTMLTemplate($create_html_template_data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PDFApi->createHTMLTemplate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
create_html_template_data	\DocSpring\Model\CreateHtmlTemplateData

Return type

\DocSpring\Model\PendingTemplate

Authorization

api_token_basic

HTTP request headers

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

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

createPDFTemplate

\DocSpring\Model\PendingTemplate createPDFTemplate($template_document, $template_name, $template_parent_folder_id)

Create a new PDF template with a form POST file upload

Example

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

// Configure HTTP basic authorization: api_token_basic
$config = DocSpring\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new DocSpring\Api\PDFApi(
    // 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
);
$template_document = "/path/to/file.txt"; // \SplFileObject | 
$template_name = 'template_name_example'; // string | 
$template_parent_folder_id = 'template_parent_folder_id_example'; // string | 

try {
    $result = $apiInstance->createPDFTemplate($template_document, $template_name, $template_parent_folder_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PDFApi->createPDFTemplate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Notes
template_document	\SplFileObject\SplFileObject
template_name	string
template_parent_folder_id	string	[optional]

Return type

\DocSpring\Model\PendingTemplate

Authorization

api_token_basic

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

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

createPDFTemplateFromUpload

\DocSpring\Model\PendingTemplate createPDFTemplateFromUpload($create_template_from_upload_data)

Create a new PDF template from a cached presign upload

Example

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

// Configure HTTP basic authorization: api_token_basic
$config = DocSpring\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new DocSpring\Api\PDFApi(
    // 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_upload_data = new \DocSpring\Model\CreateTemplateFromUploadData(); // \DocSpring\Model\CreateTemplateFromUploadData | 

try {
    $result = $apiInstance->createPDFTemplateFromUpload($create_template_from_upload_data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PDFApi->createPDFTemplateFromUpload: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
create_template_from_upload_data	\DocSpring\Model\CreateTemplateFromUploadData

Return type

\DocSpring\Model\PendingTemplate

Authorization

api_token_basic

HTTP request headers

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

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

deleteFolder

\DocSpring\Model\Folder deleteFolder($folder_id)

Delete a folder

Example

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

// Configure HTTP basic authorization: api_token_basic
$config = DocSpring\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new DocSpring\Api\PDFApi(
    // 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
);
$folder_id = fld_000000000000000001; // string | 

try {
    $result = $apiInstance->deleteFolder($folder_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PDFApi->deleteFolder: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
folder_id	string

Return type

\DocSpring\Model\Folder

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

expireCombinedSubmission

\DocSpring\Model\CombinedSubmission expireCombinedSubmission($combined_submission_id)

Expire a combined submission

Example

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

// Configure HTTP basic authorization: api_token_basic
$config = DocSpring\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new DocSpring\Api\PDFApi(
    // 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
);
$combined_submission_id = com_000000000000000001; // string | 

try {
    $result = $apiInstance->expireCombinedSubmission($combined_submission_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PDFApi->expireCombinedSubmission: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
combined_submission_id	string

Return type

\DocSpring\Model\CombinedSubmission

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

expireSubmission

\DocSpring\Model\Submission expireSubmission($submission_id)

Expire a PDF submission

Example

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

// Configure HTTP basic authorization: api_token_basic
$config = DocSpring\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new DocSpring\Api\PDFApi(
    // 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
);
$submission_id = sub_000000000000000001; // string | 

try {
    $result = $apiInstance->expireSubmission($submission_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PDFApi->expireSubmission: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
submission_id	string

Return type

\DocSpring\Model\Submission

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

generatePDF

\DocSpring\Model\CreateSubmissionResponse generatePDF($template_id, $submission_data)

Generates a new PDF

Example

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

// Configure HTTP basic authorization: api_token_basic
$config = DocSpring\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new DocSpring\Api\PDFApi(
    // 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
);
$template_id = tpl_000000000000000001; // string | 
$submission_data = new \DocSpring\Model\SubmissionData(); // \DocSpring\Model\SubmissionData | 

try {
    $result = $apiInstance->generatePDF($template_id, $submission_data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PDFApi->generatePDF: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
template_id	string
submission_data	\DocSpring\Model\SubmissionData

Return type

\DocSpring\Model\CreateSubmissionResponse

Authorization

api_token_basic

HTTP request headers

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

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

getCombinedSubmission

\DocSpring\Model\CombinedSubmission getCombinedSubmission($combined_submission_id)

Check the status of a combined submission (merged PDFs)

Example

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

// Configure HTTP basic authorization: api_token_basic
$config = DocSpring\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new DocSpring\Api\PDFApi(
    // 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
);
$combined_submission_id = com_000000000000000001; // string | 

try {
    $result = $apiInstance->getCombinedSubmission($combined_submission_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PDFApi->getCombinedSubmission: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
combined_submission_id	string

Return type

\DocSpring\Model\CombinedSubmission

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

getDataRequest

\DocSpring\Model\SubmissionDataRequest getDataRequest($data_request_id)

Look up a submission data request

Example

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

// Configure HTTP basic authorization: api_token_basic
$config = DocSpring\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new DocSpring\Api\PDFApi(
    // 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_request_id = drq_000000000000000001; // string | 

try {
    $result = $apiInstance->getDataRequest($data_request_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PDFApi->getDataRequest: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
data_request_id	string

Return type

\DocSpring\Model\SubmissionDataRequest

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

getFullTemplate

\DocSpring\Model\Template1 getFullTemplate($template_id)

Fetch the full template attributes

Example

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

// Configure HTTP basic authorization: api_token_basic
$config = DocSpring\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new DocSpring\Api\PDFApi(
    // 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
);
$template_id = tpl_000000000000000001; // string | 

try {
    $result = $apiInstance->getFullTemplate($template_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PDFApi->getFullTemplate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
template_id	string

Return type

\DocSpring\Model\Template1

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

getPresignUrl

map[string,object] getPresignUrl()

Get a presigned URL so that you can upload a file to our AWS S3 bucket

Example

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

// Configure HTTP basic authorization: api_token_basic
$config = DocSpring\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new DocSpring\Api\PDFApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

map[string,object]

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

getSubmission

\DocSpring\Model\Submission getSubmission($submission_id, $include_data)

Check the status of a PDF

Example

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

// Configure HTTP basic authorization: api_token_basic
$config = DocSpring\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new DocSpring\Api\PDFApi(
    // 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
);
$submission_id = sub_000000000000000001; // string | 
$include_data = true; // bool | 

try {
    $result = $apiInstance->getSubmission($submission_id, $include_data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PDFApi->getSubmission: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
submission_id	string
include_data	bool		[optional]

Return type

\DocSpring\Model\Submission

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

getSubmissionBatch

\DocSpring\Model\SubmissionBatch getSubmissionBatch($submission_batch_id, $include_submissions)

Check the status of a submission batch job

Example

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

// Configure HTTP basic authorization: api_token_basic
$config = DocSpring\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new DocSpring\Api\PDFApi(
    // 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
);
$submission_batch_id = sbb_000000000000000001; // string | 
$include_submissions = true; // bool | 

try {
    $result = $apiInstance->getSubmissionBatch($submission_batch_id, $include_submissions);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PDFApi->getSubmissionBatch: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
submission_batch_id	string
include_submissions	bool		[optional]

Return type

\DocSpring\Model\SubmissionBatch

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

getTemplate

\DocSpring\Model\Template getTemplate($template_id)

Check the status of an uploaded template

Example

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

// Configure HTTP basic authorization: api_token_basic
$config = DocSpring\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new DocSpring\Api\PDFApi(
    // 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
);
$template_id = tpl_000000000000000001; // string | 

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

Parameters

Name	Type	Description	Notes
template_id	string

Return type

\DocSpring\Model\Template

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

getTemplateSchema

map[string,object] getTemplateSchema($template_id)

Fetch the JSON schema for a template

Example

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

// Configure HTTP basic authorization: api_token_basic
$config = DocSpring\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new DocSpring\Api\PDFApi(
    // 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
);
$template_id = tpl_000000000000000001; // string | 

try {
    $result = $apiInstance->getTemplateSchema($template_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PDFApi->getTemplateSchema: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
template_id	string

Return type

map[string,object]

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

listFolders

\DocSpring\Model\Folder[] listFolders($parent_folder_id)

Get a list of all folders

Example

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

// Configure HTTP basic authorization: api_token_basic
$config = DocSpring\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new DocSpring\Api\PDFApi(
    // 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
);
$parent_folder_id = fld_000000000000000002; // string | Filter By Folder Id

try {
    $result = $apiInstance->listFolders($parent_folder_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PDFApi->listFolders: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
parent_folder_id	string	Filter By Folder Id	[optional]

Return type

\DocSpring\Model\Folder[]

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

listSubmissions

\DocSpring\Model\ListSubmissionsResponse listSubmissions($cursor, $limit, $created_after, $created_before, $type, $include_data)

List all submissions

Example

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

// Configure HTTP basic authorization: api_token_basic
$config = DocSpring\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new DocSpring\Api\PDFApi(
    // 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
);
$cursor = sub_list_000012; // string | 
$limit = 3; // float | 
$created_after = 2019-01-01T09:00:00-05:00; // string | 
$created_before = 2020-01-01T09:00:00-05:00; // string | 
$type = test; // string | 
$include_data = true; // bool | 

try {
    $result = $apiInstance->listSubmissions($cursor, $limit, $created_after, $created_before, $type, $include_data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PDFApi->listSubmissions: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Notes
cursor	string	[optional]
limit	float	[optional]
created_after	string	[optional]
created_before	string	[optional]
type	string	[optional]
include_data	bool	[optional]

Return type

\DocSpring\Model\ListSubmissionsResponse

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

listSubmissions_0

\DocSpring\Model\ListSubmissionsResponse listSubmissions_0($template_id, $cursor, $limit, $created_after, $created_before, $type, $include_data)

List all submissions for a given template

Example

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

// Configure HTTP basic authorization: api_token_basic
$config = DocSpring\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new DocSpring\Api\PDFApi(
    // 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
);
$template_id = tpl_000000000000000002; // string | 
$cursor = 'cursor_example'; // string | 
$limit = 3.4; // float | 
$created_after = 'created_after_example'; // string | 
$created_before = 'created_before_example'; // string | 
$type = 'type_example'; // string | 
$include_data = true; // bool | 

try {
    $result = $apiInstance->listSubmissions_0($template_id, $cursor, $limit, $created_after, $created_before, $type, $include_data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PDFApi->listSubmissions_0: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Notes
template_id	string
cursor	string	[optional]
limit	float	[optional]
created_after	string	[optional]
created_before	string	[optional]
type	string	[optional]
include_data	bool	[optional]

Return type

\DocSpring\Model\ListSubmissionsResponse

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

listTemplates

\DocSpring\Model\Template[] listTemplates($query, $parent_folder_id, $page, $per_page)

Get a list of all templates

Example

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

// Configure HTTP basic authorization: api_token_basic
$config = DocSpring\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new DocSpring\Api\PDFApi(
    // 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
);
$query = 2; // string | Search By Name
$parent_folder_id = fld_000000000000000001; // string | Filter By Folder Id
$page = 2; // int | Default: 1
$per_page = 1; // int | Default: 50

try {
    $result = $apiInstance->listTemplates($query, $parent_folder_id, $page, $per_page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PDFApi->listTemplates: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
query	string	Search By Name	[optional]
parent_folder_id	string	Filter By Folder Id	[optional]
page	int	Default: 1	[optional]
per_page	int	Default: 50	[optional]

Return type

\DocSpring\Model\Template[]

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

moveFolderToFolder

\DocSpring\Model\Folder moveFolderToFolder($folder_id, $move_folder_data)

Move a folder

Example

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

// Configure HTTP basic authorization: api_token_basic
$config = DocSpring\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new DocSpring\Api\PDFApi(
    // 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
);
$folder_id = fld_000000000000000001; // string | 
$move_folder_data = new \DocSpring\Model\MoveFolderData(); // \DocSpring\Model\MoveFolderData | 

try {
    $result = $apiInstance->moveFolderToFolder($folder_id, $move_folder_data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PDFApi->moveFolderToFolder: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
folder_id	string
move_folder_data	\DocSpring\Model\MoveFolderData

Return type

\DocSpring\Model\Folder

Authorization

api_token_basic

HTTP request headers

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

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

moveTemplateToFolder

\DocSpring\Model\Template moveTemplateToFolder($template_id, $move_template_data)

Move Template to folder

Example

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

// Configure HTTP basic authorization: api_token_basic
$config = DocSpring\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new DocSpring\Api\PDFApi(
    // 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
);
$template_id = tpl_000000000000000001; // string | 
$move_template_data = new \DocSpring\Model\MoveTemplateData(); // \DocSpring\Model\MoveTemplateData | 

try {
    $result = $apiInstance->moveTemplateToFolder($template_id, $move_template_data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PDFApi->moveTemplateToFolder: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
template_id	string
move_template_data	\DocSpring\Model\MoveTemplateData

Return type

\DocSpring\Model\Template

Authorization

api_token_basic

HTTP request headers

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

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

renameFolder

renameFolder($folder_id, $rename_folder_data)

Rename a folder

Example

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

// Configure HTTP basic authorization: api_token_basic
$config = DocSpring\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new DocSpring\Api\PDFApi(
    // 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
);
$folder_id = fld_000000000000000001; // string | 
$rename_folder_data = new \DocSpring\Model\RenameFolderData(); // \DocSpring\Model\RenameFolderData | 

try {
    $apiInstance->renameFolder($folder_id, $rename_folder_data);
} catch (Exception $e) {
    echo 'Exception when calling PDFApi->renameFolder: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
folder_id	string
rename_folder_data	\DocSpring\Model\RenameFolderData

Return type

void (empty response body)

Authorization

api_token_basic

HTTP request headers

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

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

testAuthentication

\DocSpring\Model\AuthenticationSuccessResponse testAuthentication()

Test Authentication

Example

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

// Configure HTTP basic authorization: api_token_basic
$config = DocSpring\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new DocSpring\Api\PDFApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

\DocSpring\Model\AuthenticationSuccessResponse

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

updateDataRequest

\DocSpring\Model\UpdateDataRequestResponse updateDataRequest($data_request_id, $update_submission_data_request_data)

Update a submission data request

Example

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

// Configure HTTP basic authorization: api_token_basic
$config = DocSpring\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new DocSpring\Api\PDFApi(
    // 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_request_id = drq_000000000000000001; // string | 
$update_submission_data_request_data = new \DocSpring\Model\UpdateSubmissionDataRequestData(); // \DocSpring\Model\UpdateSubmissionDataRequestData | 

try {
    $result = $apiInstance->updateDataRequest($data_request_id, $update_submission_data_request_data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PDFApi->updateDataRequest: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
data_request_id	string
update_submission_data_request_data	\DocSpring\Model\UpdateSubmissionDataRequestData

Return type

\DocSpring\Model\UpdateDataRequestResponse

Authorization

api_token_basic

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

\DocSpring\Model\UpdateTemplateResponse updateTemplate($template_id, $update_template_data)

Update a Template

Example

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

// Configure HTTP basic authorization: api_token_basic
$config = DocSpring\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new DocSpring\Api\PDFApi(
    // 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
);
$template_id = tpl_000000000000000003; // string | 
$update_template_data = new \DocSpring\Model\UpdateTemplateData(); // \DocSpring\Model\UpdateTemplateData | 

try {
    $result = $apiInstance->updateTemplate($template_id, $update_template_data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PDFApi->updateTemplate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
template_id	string
update_template_data	\DocSpring\Model\UpdateTemplateData

Return type

\DocSpring\Model\UpdateTemplateResponse

Authorization

api_token_basic

HTTP request headers

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

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

Files

PDFApi.md

Latest commit

History

PDFApi.md

File metadata and controls

DocSpring\PDFApi

addFieldsToTemplate

Example

Parameters

Return type

Authorization

HTTP request headers

batchGeneratePdfV1

Example

Parameters

Return type

Authorization

HTTP request headers

batchGeneratePdfs

Example

Parameters

Return type

Authorization

HTTP request headers

combinePdfs

Example

Parameters

Return type

Authorization

HTTP request headers

combineSubmissions

Example

Parameters

Return type

Authorization

HTTP request headers

copyTemplate

Example

Parameters

Return type

Authorization

HTTP request headers

createCustomFileFromUpload

Example

Parameters

Return type

Authorization

HTTP request headers

createDataRequestToken

Example

Parameters

Return type

Authorization

HTTP request headers

createFolder

Example

Parameters

Return type

Authorization

HTTP request headers

createHTMLTemplate

Example

Parameters

Return type

Authorization

HTTP request headers

createPDFTemplate

Example

Parameters

Return type

Authorization

HTTP request headers

createPDFTemplateFromUpload

Example

Parameters

Return type

Authorization

HTTP request headers

deleteFolder