Updated on 2021-11-28 11:44:20. Version: 1.3.2

DocSpring · Nov 27, 2021 · 45a62e7 · 45a62e7
1 parent 001e1f2
commit 45a62e7
Show file tree

Hide file tree

Showing 28 changed files with 4,470 additions and 251 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+### 1.3.2 [November 28, 2021]
+
+- Added 'password' parameter to Generate PDF and Combine PDF API endpoints. You can now encrypt each generated PDF with a unique password.
+
 ### 1.3.1 [November 19, 2020]
 
 - Added "sort_order" property for Submission Data Requests

diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@ DocSpring is a service that helps you fill out and sign PDF templates.
 This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: v1
-- Package version: 1.3.1
+- Package version: 1.3.2
 - Build package: com.docspring.codegen.DocSpringPhpClientCodegen
 
 ## Requirements
@@ -105,12 +105,15 @@ Class | Method | HTTP request | Description
 *PDFApi* | [**generatePDF**](docs/Api/PDFApi.md#generatepdf) | **POST** /templates/{template_id}/submissions | Generates a new PDF
 *PDFApi* | [**getCombinedSubmission**](docs/Api/PDFApi.md#getcombinedsubmission) | **GET** /combined_submissions/{combined_submission_id} | Check the status of a combined submission (merged PDFs)
 *PDFApi* | [**getDataRequest**](docs/Api/PDFApi.md#getdatarequest) | **GET** /data_requests/{data_request_id} | Look up a submission data request
+*PDFApi* | [**getFullTemplate**](docs/Api/PDFApi.md#getfulltemplate) | **GET** /templates/{template_id}?full&#x3D;true | Fetch the full template attributes
 *PDFApi* | [**getPresignUrl**](docs/Api/PDFApi.md#getpresignurl) | **GET** /uploads/presign | Get a presigned URL so that you can upload a file to our AWS S3 bucket
 *PDFApi* | [**getSubmission**](docs/Api/PDFApi.md#getsubmission) | **GET** /submissions/{submission_id} | Check the status of a PDF
 *PDFApi* | [**getSubmissionBatch**](docs/Api/PDFApi.md#getsubmissionbatch) | **GET** /submissions/batches/{submission_batch_id} | Check the status of a submission batch job
-*PDFApi* | [**getTemplate**](docs/Api/PDFApi.md#gettemplate) | **GET** /templates/{template_id} | Get a single template
+*PDFApi* | [**getTemplate**](docs/Api/PDFApi.md#gettemplate) | **GET** /templates/{template_id} | Check the status of an uploaded template
 *PDFApi* | [**getTemplateSchema**](docs/Api/PDFApi.md#gettemplateschema) | **GET** /templates/{template_id}/schema | Fetch the JSON schema for a template
 *PDFApi* | [**listFolders**](docs/Api/PDFApi.md#listfolders) | **GET** /folders/ | Get a list of all folders
+*PDFApi* | [**listSubmissions**](docs/Api/PDFApi.md#listsubmissions) | **GET** /submissions | List all submissions
+*PDFApi* | [**listSubmissions_0**](docs/Api/PDFApi.md#listsubmissions_0) | **GET** /templates/{template_id}/submissions | List all submissions for a given template
 *PDFApi* | [**listTemplates**](docs/Api/PDFApi.md#listtemplates) | **GET** /templates | Get a list of all templates
 *PDFApi* | [**moveFolderToFolder**](docs/Api/PDFApi.md#movefoldertofolder) | **POST** /folders/{folder_id}/move | Move a folder
 *PDFApi* | [**moveTemplateToFolder**](docs/Api/PDFApi.md#movetemplatetofolder) | **POST** /templates/{template_id}/move | Move Template to folder
@@ -149,6 +152,7 @@ Class | Method | HTTP request | Description
  - [FoldersFolder](docs/Model/FoldersFolder.md)
  - [HtmlTemplateData](docs/Model/HtmlTemplateData.md)
  - [InvalidRequest](docs/Model/InvalidRequest.md)
+ - [ListSubmissionsResponse](docs/Model/ListSubmissionsResponse.md)
  - [MoveFolderData](docs/Model/MoveFolderData.md)
  - [MoveTemplateData](docs/Model/MoveTemplateData.md)
  - [PendingTemplate](docs/Model/PendingTemplate.md)
@@ -161,6 +165,8 @@ Class | Method | HTTP request | Description
  - [SubmissionDataBatchRequest](docs/Model/SubmissionDataBatchRequest.md)
  - [SubmissionDataRequest](docs/Model/SubmissionDataRequest.md)
  - [Template](docs/Model/Template.md)
+ - [Template1](docs/Model/Template1.md)
+ - [Template1Defaults](docs/Model/Template1Defaults.md)
  - [TemplateData](docs/Model/TemplateData.md)
  - [TemplatestemplateIdaddFieldsFields](docs/Model/TemplatestemplateIdaddFieldsFields.md)
  - [UpdateDataRequestResponse](docs/Model/UpdateDataRequestResponse.md)

diff --git a/composer.json b/composer.json
@@ -1,6 +1,6 @@
 {
     "name": "docspring/docspring",
-    "version": "1.3.1",
+    "version": "1.3.2",
     "description": "",
     "keywords": [
         "openapitools",

diff --git a/docs/Api/PDFApi.md b/docs/Api/PDFApi.md
@@ -22,12 +22,15 @@ Method | HTTP request | Description
 [**generatePDF**](PDFApi.md#generatePDF) | **POST** /templates/{template_id}/submissions | Generates a new PDF
 [**getCombinedSubmission**](PDFApi.md#getCombinedSubmission) | **GET** /combined_submissions/{combined_submission_id} | Check the status of a combined submission (merged PDFs)
 [**getDataRequest**](PDFApi.md#getDataRequest) | **GET** /data_requests/{data_request_id} | Look up a submission data request
+[**getFullTemplate**](PDFApi.md#getFullTemplate) | **GET** /templates/{template_id}?full&#x3D;true | Fetch the full template attributes
 [**getPresignUrl**](PDFApi.md#getPresignUrl) | **GET** /uploads/presign | Get a presigned URL so that you can upload a file to our AWS S3 bucket
 [**getSubmission**](PDFApi.md#getSubmission) | **GET** /submissions/{submission_id} | Check the status of a PDF
 [**getSubmissionBatch**](PDFApi.md#getSubmissionBatch) | **GET** /submissions/batches/{submission_batch_id} | Check the status of a submission batch job
-[**getTemplate**](PDFApi.md#getTemplate) | **GET** /templates/{template_id} | Get a single template
+[**getTemplate**](PDFApi.md#getTemplate) | **GET** /templates/{template_id} | Check the status of an uploaded template
 [**getTemplateSchema**](PDFApi.md#getTemplateSchema) | **GET** /templates/{template_id}/schema | Fetch the JSON schema for a template
 [**listFolders**](PDFApi.md#listFolders) | **GET** /folders/ | Get a list of all folders
+[**listSubmissions**](PDFApi.md#listSubmissions) | **GET** /submissions | List all submissions
+[**listSubmissions_0**](PDFApi.md#listSubmissions_0) | **GET** /templates/{template_id}/submissions | List all submissions for a given template
 [**listTemplates**](PDFApi.md#listTemplates) | **GET** /templates | Get a list of all templates
 [**moveFolderToFolder**](PDFApi.md#moveFolderToFolder) | **POST** /folders/{folder_id}/move | Move a folder
 [**moveTemplateToFolder**](PDFApi.md#moveTemplateToFolder) | **POST** /templates/{template_id}/move | Move Template to folder
@@ -1021,6 +1024,60 @@ Name | Type | Description  | Notes
 
 [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
 
+# **getFullTemplate**
+> \DocSpring\Model\Template1 getFullTemplate($template_id)
+
+Fetch the full template attributes
+
+### Example
+```php
+<?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**](../Model/Template1.md)
+
+### Authorization
+
+[api_token_basic](../../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
+
 # **getPresignUrl**
 > map[string,object] getPresignUrl()
 
@@ -1186,7 +1243,7 @@ Name | Type | Description  | Notes
 # **getTemplate**
 > \DocSpring\Model\Template getTemplate($template_id)
 
-Get a single template
+Check the status of an uploaded template
 
 ### Example
 ```php
@@ -1205,7 +1262,7 @@ $apiInstance = new DocSpring\Api\PDFApi(
     new GuzzleHttp\Client(),
     $config
 );
-$template_id = tpl_000000000000000011; // string | 
+$template_id = tpl_000000000000000001; // string | 
 
 try {
     $result = $apiInstance->getTemplate($template_id);
@@ -1345,6 +1402,136 @@ Name | Type | Description  | Notes
 
 [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
 
+# **listSubmissions**
+> \DocSpring\Model\ListSubmissionsResponse listSubmissions($cursor, $limit, $created_after, $created_before, $type, $include_data)
+
+List all submissions
+
+### Example
+```php
+<?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 | 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**](../Model/ListSubmissionsResponse.md)
+
+### Authorization
+
+[api_token_basic](../../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
+
+# **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
+<?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 | 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**](../Model/ListSubmissionsResponse.md)
+
+### Authorization
+
+[api_token_basic](../../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
+
 # **listTemplates**
 > \DocSpring\Model\Template[] listTemplates($query, $parent_folder_id, $page, $per_page)
 

diff --git a/docs/Model/CombinePdfsData.md b/docs/Model/CombinePdfsData.md
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
 **delete_custom_files** | **bool** |  | [optional] 
 **expires_in** | **int** |  | [optional] 
 **metadata** | **object** |  | [optional] 
+**password** | **string** |  | [optional] 
 **source_pdfs** | **object[]** |  | 
 **test** | **bool** |  | [optional] 
 

diff --git a/docs/Model/CombinedSubmission.md b/docs/Model/CombinedSubmission.md
@@ -4,6 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **metadata** | **object** |  | [optional] 
+**password** | **string** |  | [optional] 
 **expired** | **bool** |  | [optional] 
 **expires_at** | **string** |  | [optional] 
 **source_pdfs** | **object[]** |  | [optional] 

diff --git a/docs/Model/CombinedSubmissionData.md b/docs/Model/CombinedSubmissionData.md
@@ -5,6 +5,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **expires_in** | **int** |  | [optional] 
 **metadata** | **object** |  | [optional] 
+**password** | **string** |  | [optional] 
 **submission_ids** | **string[]** |  | 
 **test** | **bool** |  | [optional] 
 

diff --git a/docs/Model/ListSubmissionsResponse.md b/docs/Model/ListSubmissionsResponse.md
@@ -0,0 +1,12 @@
+# ListSubmissionsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**next_cursor** | **string** |  | [optional] 
+**submissions** | [**\DocSpring\Model\Submission[]**](Submission.md) |  | [optional] 
+**limit** | **float** |  | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/Model/SubmissionData.md b/docs/Model/SubmissionData.md
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **field_overrides** | **object** |  | [optional] 
 **html** | **string** |  | [optional] 
 **metadata** | **object** |  | [optional] 
+**password** | **string** |  | [optional] 
 **test** | **bool** |  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

diff --git a/docs/Model/Template1.md b/docs/Model/Template1.md
@@ -0,0 +1,48 @@
+# Template1
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**document_processed** | **bool** |  | [optional] 
+**expiration_interval** | **string** |  | [optional] 
+**scss** | **string** |  | [optional] 
+**document_state** | **string** |  | [optional] 
+**expire_after** | **float** |  | [optional] 
+**description** | **string** |  | [optional] 
+**slack_webhook_url** | **string** |  | [optional] 
+**demo** | **bool** |  | [optional] 
+**path** | **string** |  | [optional] 
+**header_html** | **string** |  | [optional] 
+**public_web_form** | **bool** |  | [optional] 
+**field_order** | [**float[][]**](array.md) |  | [optional] 
+**permanent_document_url** | **string** |  | [optional] 
+**html** | **string** |  | [optional] 
+**template_type** | **string** |  | [optional] 
+**id** | **string** |  | [optional] 
+**page_dimensions** | [**float[][]**](array.md) |  | [optional] 
+**locked** | **bool** |  | [optional] 
+**page_count** | **float** |  | [optional] 
+**encrypt_pdfs** | **bool** |  | [optional] 
+**webhook_url** | **string** |  | [optional] 
+**embed_domains** | **string[]** |  | [optional] 
+**parent_folder_id** | **string** |  | [optional] 
+**allow_additional_properties** | **bool** |  | [optional] 
+**encrypt_pdfs_password** | **string** |  | [optional] 
+**public_submissions** | **bool** |  | [optional] 
+**shared_field_data** | **object** |  | [optional] 
+**document_md5** | **string** |  | [optional] 
+**first_template** | **bool** |  | [optional] 
+**defaults** | [**\DocSpring\Model\Template1Defaults**](Template1Defaults.md) |  | [optional] 
+**editable_submissions** | **bool** |  | [optional] 
+**expire_submissions** | **bool** |  | [optional] 
+**name** | **string** |  | [optional] 
+**footer_html** | **string** |  | [optional] 
+**document_parse_error** | **bool** |  | [optional] 
+**fields** | **object** |  | [optional] 
+**document_filename** | **string** |  | [optional] 
+**redirect_url** | **string** |  | [optional] 
+**document_url** | **string** |  | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/Model/Template1Defaults.md b/docs/Model/Template1Defaults.md
@@ -0,0 +1,12 @@
+# Template1Defaults
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**color** | **string** |  | [optional] 
+**font_size** | **float** |  | [optional] 
+**typeface** | **string** |  | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+