PDFApi.md

DocSpring\PDFApi

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

Method	HTTP request	Description
addFieldsToTemplate()	PUT /templates/{template_id}/add_fields	Add new fields to a Template
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
createDataRequestEvent()	POST /data_requests/{data_request_id}/events	Creates a new event for emailing a signee a request for signature
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?endpoint_description=html	Create a new HTML template
createPDFTemplate()	POST /templates	Create a new PDF template with a form POST file upload
createPDFTemplateFromUpload()	POST /templates?endpoint_description=cached_upload	Create a new PDF template from a cached presign upload
deleteFolder()	DELETE /folders/{folder_id}	Delete a folder
deleteTemplate()	DELETE /templates/{template_id}	Delete a template
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
generatePdfForHtmlTemplate()	POST /templates/{template_id}/submissions?endpoint_description=html_templates	Generates a new PDF for an HTML template
generatePreview()	POST /submissions/{submission_id}/generate_preview	Generated a preview PDF for partially completed data requests
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
listCombinedSubmissions()	GET /combined_submissions	Get a list of all combined submissions
listFolders()	GET /folders/	Get a list of all folders
listSubmissions()	GET /submissions	List all submissions
listTemplateSubmissions()	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()

addFieldsToTemplate($template_id, $data): \DocSpring\Model\TemplateAddFieldsResponse

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_1234567890abcdef02; // string
$data = new \DocSpring\Model\AddFieldsData(); // \DocSpring\Model\AddFieldsData

try {
    $result = $apiInstance->addFieldsToTemplate($template_id, $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
data	\DocSpring\Model\AddFieldsData

Return type

\DocSpring\Model\TemplateAddFieldsResponse

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()

batchGeneratePdfs($data, $wait): \DocSpring\Model\BatchGeneratePdfs201Response

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
);
$data = new \DocSpring\Model\SubmissionBatchData(); // \DocSpring\Model\SubmissionBatchData
$wait = true; // bool | Wait for submission batch to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain)

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

Parameters

Name	Type	Description	Notes
data	\DocSpring\Model\SubmissionBatchData
wait	bool	Wait for submission batch to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain)	[optional] [default to true]

Return type

\DocSpring\Model\BatchGeneratePdfs201Response

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()

combinePdfs($data): \DocSpring\Model\CreateCombinedSubmissionResponse

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
);
$data = new \DocSpring\Model\CombinePdfsData(); // \DocSpring\Model\CombinePdfsData

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

Parameters

Name	Type	Description	Notes
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()

combineSubmissions($data, $wait): \DocSpring\Model\CreateCombinedSubmissionResponse

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
);
$data = new \DocSpring\Model\CombinedSubmissionData(); // \DocSpring\Model\CombinedSubmissionData
$wait = true; // bool | Wait for combined submission to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain)

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

Parameters

Name	Type	Description	Notes
data	\DocSpring\Model\CombinedSubmissionData
wait	bool	Wait for combined submission to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain)	[optional] [default to true]

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()

copyTemplate($template_id, $options): \DocSpring\Model\TemplatePreview

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_1234567890abcdef01; // string
$options = new \DocSpring\Model\CopyTemplateOptions(); // \DocSpring\Model\CopyTemplateOptions

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

Parameters

Name	Type	Description	Notes
template_id	string
options	\DocSpring\Model\CopyTemplateOptions		[optional]

Return type

\DocSpring\Model\TemplatePreview

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()

createCustomFileFromUpload($data): \DocSpring\Model\CreateCustomFileResponse

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
);
$data = new \DocSpring\Model\CreateCustomFileData(); // \DocSpring\Model\CreateCustomFileData

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

Parameters

Name	Type	Description	Notes
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]

createDataRequestEvent()

createDataRequestEvent($data_request_id, $event): \DocSpring\Model\CreateSubmissionDataRequestEventResponse

Creates a new event for emailing a signee a request for signature

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_1234567890abcdef01; // string
$event = new \DocSpring\Model\CreateSubmissionDataRequestEventRequest(); // \DocSpring\Model\CreateSubmissionDataRequestEventRequest

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

Parameters

Name	Type	Description	Notes
data_request_id	string
event	\DocSpring\Model\CreateSubmissionDataRequestEventRequest

Return type

\DocSpring\Model\CreateSubmissionDataRequestEventResponse

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()

createDataRequestToken($data_request_id, $type): \DocSpring\Model\CreateSubmissionDataRequestTokenResponse

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_1234567890abcdef01; // string
$type = api; // string

try {
    $result = $apiInstance->createDataRequestToken($data_request_id, $type);
    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
type	string		[optional]

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()

createFolder($data): \DocSpring\Model\Folder

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
);
$data = new \DocSpring\Model\CreateFolderData(); // \DocSpring\Model\CreateFolderData

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

Parameters

Name	Type	Description	Notes
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()

createHTMLTemplate($data): \DocSpring\Model\TemplatePreview

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
);
$data = new \DocSpring\Model\CreateHtmlTemplate(); // \DocSpring\Model\CreateHtmlTemplate

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

Parameters

Name	Type	Description	Notes
data	\DocSpring\Model\CreateHtmlTemplate

Return type

\DocSpring\Model\TemplatePreview

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()

createPDFTemplate($template_document, $template_name, $wait, $template_description, $template_parent_folder_id): \DocSpring\Model\TemplatePreview

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
$wait = true; // bool | Wait for template document to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain)
$template_description = 'template_description_example'; // string
$template_parent_folder_id = 'template_parent_folder_id_example'; // string

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

Parameters

Name	Type	Description	Notes
template_document	\SplFileObject**\SplFileObject**
template_name	string
wait	bool	Wait for template document to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain)	[optional] [default to true]
template_description	string		[optional]
template_parent_folder_id	string		[optional]

Return type

\DocSpring\Model\TemplatePreview

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()

createPDFTemplateFromUpload($data): \DocSpring\Model\TemplatePreview

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
);
$data = new \DocSpring\Model\CreatePdfTemplate(); // \DocSpring\Model\CreatePdfTemplate

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

Parameters

Name	Type	Description	Notes
data	\DocSpring\Model\CreatePdfTemplate

Return type

\DocSpring\Model\TemplatePreview

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()

deleteFolder($folder_id): \DocSpring\Model\Folder

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_1234567890abcdef01; // 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]

deleteTemplate()

deleteTemplate($template_id): \DocSpring\Model\SuccessMultipleErrorsResponse

Delete 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_1234567890abcdef01; // string

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

Parameters

Name	Type	Description	Notes
template_id	string

Return type

\DocSpring\Model\SuccessMultipleErrorsResponse

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()

expireCombinedSubmission($combined_submission_id): \DocSpring\Model\CombinedSubmission

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_1234567890abcdef01; // 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()

expireSubmission($submission_id): \DocSpring\Model\SubmissionPreview

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_1234567890abcdef01; // 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\SubmissionPreview

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()

generatePdf($template_id, $submission, $wait): \DocSpring\Model\CreateSubmissionResponse

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_1234567890abcdef01; // string
$submission = new \DocSpring\Model\CreatePdfSubmissionData(); // \DocSpring\Model\CreatePdfSubmissionData
$wait = true; // bool | Wait for submission to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain)

try {
    $result = $apiInstance->generatePdf($template_id, $submission, $wait);
    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	\DocSpring\Model\CreatePdfSubmissionData
wait	bool	Wait for submission to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain)	[optional] [default to true]

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]

generatePdfForHtmlTemplate()

generatePdfForHtmlTemplate($template_id, $submission, $wait): \DocSpring\Model\CreateSubmissionResponse

Generates a new PDF for an 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
);
$template_id = tpl_HTML567890abcdef01; // string
$submission = new \DocSpring\Model\CreateHtmlSubmissionData(); // \DocSpring\Model\CreateHtmlSubmissionData
$wait = true; // bool | Wait for submission to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain)

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

Parameters

Name	Type	Description	Notes
template_id	string
submission	\DocSpring\Model\CreateHtmlSubmissionData
wait	bool	Wait for submission to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain)	[optional] [default to true]

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]

generatePreview()

generatePreview($submission_id): \DocSpring\Model\SuccessErrorResponse

Generated a preview PDF for partially completed data requests

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_1234567890abcdef01; // string

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

Parameters

Name	Type	Description	Notes
submission_id	string

Return type

\DocSpring\Model\SuccessErrorResponse

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]

getCombinedSubmission()

getCombinedSubmission($combined_submission_id): \DocSpring\Model\CombinedSubmission

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_1234567890abcdef01; // 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()

getDataRequest($data_request_id): \DocSpring\Model\SubmissionDataRequestShow

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_1234567890abcdef01; // 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\SubmissionDataRequestShow

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()

getFullTemplate($template_id): \DocSpring\Model\Template

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_1234567890abcdef01; // 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\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]

getPresignUrl()

getPresignUrl(): \DocSpring\Model\UploadPresignResponse

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

\DocSpring\Model\UploadPresignResponse

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()

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

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_1234567890abcdef01; // 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()

getSubmissionBatch($submission_batch_id, $include_submissions): \DocSpring\Model\SubmissionBatchWithSubmissions

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_1234567890abcdef01; // 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\SubmissionBatchWithSubmissions

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()

getTemplate($template_id): \DocSpring\Model\TemplatePreview

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_1234567890abcdef01; // 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\TemplatePreview

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()

getTemplateSchema($template_id): \DocSpring\Model\JsonSchema

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_1234567890abcdef01; // 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

\DocSpring\Model\JsonSchema

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]

listCombinedSubmissions()

listCombinedSubmissions($page, $per_page): \DocSpring\Model\CombinedSubmission[]

Get a list of all combined 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
);
$page = 2; // int | Default: 1
$per_page = 1; // int | Default: 50

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

Parameters

Name	Type	Description	Notes
page	int	Default: 1	[optional]
per_page	int	Default: 50	[optional]

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]

listFolders()

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

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_1234567890abcdef02; // 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()

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

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_1234567890abcdef12; // string
$limit = 3; // float
$created_after = 2019-01-01T09:00:00-05:00; // string
$created_before = 2020-01-01T09:00:00.000+0200; // 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	Description	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]

listTemplateSubmissions()

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

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_1234567890abcdef02; // 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->listTemplateSubmissions($template_id, $cursor, $limit, $created_after, $created_before, $type, $include_data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PDFApi->listTemplateSubmissions: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	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()

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

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_1234567890abcdef01; // 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\TemplatePreview[]

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()

moveFolderToFolder($folder_id, $data): \DocSpring\Model\Folder

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_1234567890abcdef01; // string
$data = new \DocSpring\Model\MoveFolderData(); // \DocSpring\Model\MoveFolderData

try {
    $result = $apiInstance->moveFolderToFolder($folder_id, $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
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()

moveTemplateToFolder($template_id, $data): \DocSpring\Model\TemplatePreview

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_1234567890abcdef01; // string
$data = new \DocSpring\Model\MoveTemplateData(); // \DocSpring\Model\MoveTemplateData

try {
    $result = $apiInstance->moveTemplateToFolder($template_id, $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
data	\DocSpring\Model\MoveTemplateData

Return type

\DocSpring\Model\TemplatePreview

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, $data): \DocSpring\Model\Folder

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_1234567890abcdef01; // string
$data = new \DocSpring\Model\RenameFolderData(); // \DocSpring\Model\RenameFolderData

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

Parameters

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

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]

testAuthentication()

testAuthentication(): \DocSpring\Model\SuccessErrorResponse

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\SuccessErrorResponse

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()

updateDataRequest($data_request_id, $data): \DocSpring\Model\CreateSubmissionDataRequestResponse

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_1234567890abcdef01; // string
$data = new \DocSpring\Model\UpdateSubmissionDataRequestData(); // \DocSpring\Model\UpdateSubmissionDataRequestData

try {
    $result = $apiInstance->updateDataRequest($data_request_id, $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
data	\DocSpring\Model\UpdateSubmissionDataRequestData

Return type

\DocSpring\Model\CreateSubmissionDataRequestResponse

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()

updateTemplate($template_id, $data): \DocSpring\Model\SuccessMultipleErrorsResponse

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_1234567890abcdef03; // string
$data = new \DocSpring\Model\UpdateHtmlTemplate(); // \DocSpring\Model\UpdateHtmlTemplate

try {
    $result = $apiInstance->updateTemplate($template_id, $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
data	\DocSpring\Model\UpdateHtmlTemplate

Return type

\DocSpring\Model\SuccessMultipleErrorsResponse

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]