Updated on 2020-09-12 21:56:57. Version: 1.1.0

Author: ndbroadbent

CHANGELOG.md

@@ -1,49 +1,9 @@
-### 1.13.0 [October 10, 2019]
+### 1.1.0 [September 12, 2020]
 
-- Add permanent_download_url attribute to Submission model
+- **BREAKING CHANGE**: Renamed createTemplate operation to createPDFTemplate
+- Added createHTMLTemplate operation. (This uses the same API endpoint as createPDFTemplate, but the example shows how to set html, scss, etc. fields)
+- Added updateTemplate operation, to update a PDF or HTML template
 
-### 1.12.0 [October 9, 2019]
+### 1.0.0 [May 20, 2019]
 
-- Add parent folder ID and path params to GET template response
-- Add parent folder ID param when creating a new template, so you can upload a template into a folder
-
-### 1.11.0 [July 31, 2019]
-* Added Create Folder, List Folder, Move to Folder endpoints
-* **BREAKING CHANGE** Added parent_folder_id query parameter to "List Templates".
-
-### 1.10.1 [July 3, 2019]
-
-- Fixed combineSubmissions and combinePdfs helpers when "strict mode" is enabled by setting error_reporting
-
-### 1.10.0 [July 3, 2019]
-
-- Added combinePdfs wrapper that handles polling and doesn't return a pending combined submission job
-
-### 1.9.0 [June 22, 2019]
-
-- **BREAKING CHANGE** Renamed "Get Templates" endpoint to "List Templates". Added a search query parameter.
-
-### 1.8.0 [April 11, 2019]
-
-- Added support for editable PDFS (editable: true)
-
-### 1.7.0 [December 23, 2018]
-
-- Added CustomFiles, and combinePdf call to support many different types of source PDFs. Renamed a few models
-
-### 1.6.0 [December 18, 2018]
-
-- Updated API host to api.formapi.io
-
-### 1.5.0 [December 13, 2018]
-
-- Fix model name for newly created Templates (PendingTemplate)
-- Added "actions" to submission and combined_submission responses. Includes information about custom S3 uploads
-
-### 1.4.0 [December 1, 2018]
-
-- Added Create Template, Get Template, and Get Template Schema endpoints
-
-### 1.3.1 [November 4, 2018]
-
-- Initial changelog
+- Renamed FormAPI to DocSpring. (View the CHANGELOG in the original FormAPI API client for prior releases.)

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.0.0
+- Package version: 1.1.0
 - Build package: com.docspring.codegen.DocSpringPhpClientCodegen
 
 ## Requirements
@@ -94,8 +94,9 @@ Class | Method | HTTP request | Description
 *PDFApi* | [**createCustomFileFromUpload**](docs/Api/PDFApi.md#createcustomfilefromupload) | **POST** /custom_files | Create a new custom file from a cached presign upload
 *PDFApi* | [**createDataRequestToken**](docs/Api/PDFApi.md#createdatarequesttoken) | **POST** /data_requests/{data_request_id}/tokens | Creates a new data request token for form authentication
 *PDFApi* | [**createFolder**](docs/Api/PDFApi.md#createfolder) | **POST** /folders/ | Create a folder
-*PDFApi* | [**createTemplate**](docs/Api/PDFApi.md#createtemplate) | **POST** /templates | Upload a new PDF template with a file upload
-*PDFApi* | [**createTemplateFromUpload**](docs/Api/PDFApi.md#createtemplatefromupload) | **POST** /templates?v=2 | Create a new PDF template from a cached presign upload
+*PDFApi* | [**createHTMLTemplate**](docs/Api/PDFApi.md#createhtmltemplate) | **POST** /templates?desc=html | Create a new HTML template
+*PDFApi* | [**createPDFTemplate**](docs/Api/PDFApi.md#createpdftemplate) | **POST** /templates | Create a new PDF template with a form POST file upload
+*PDFApi* | [**createPDFTemplateFromUpload**](docs/Api/PDFApi.md#createpdftemplatefromupload) | **POST** /templates?desc=cached_upload | Create a new PDF template from a cached presign upload
 *PDFApi* | [**deleteFolder**](docs/Api/PDFApi.md#deletefolder) | **DELETE** /folders/{folder_id} | Delete a folder
 *PDFApi* | [**expireCombinedSubmission**](docs/Api/PDFApi.md#expirecombinedsubmission) | **DELETE** /combined_submissions/{combined_submission_id} | Expire a combined submission
 *PDFApi* | [**expireSubmission**](docs/Api/PDFApi.md#expiresubmission) | **DELETE** /submissions/{submission_id} | Expire a PDF submission
@@ -114,6 +115,7 @@ Class | Method | HTTP request | Description
 *PDFApi* | [**renameFolder**](docs/Api/PDFApi.md#renamefolder) | **POST** /folders/{folder_id}/rename | Rename a folder
 *PDFApi* | [**testAuthentication**](docs/Api/PDFApi.md#testauthentication) | **GET** /authentication | Test Authentication
 *PDFApi* | [**updateDataRequest**](docs/Api/PDFApi.md#updatedatarequest) | **PUT** /data_requests/{data_request_id} | Update a submission data request
+*PDFApi* | [**updateTemplate**](docs/Api/PDFApi.md#updatetemplate) | **PUT** /templates/{template_id} | Update a Template
 
 
 ## Documentation For Models
@@ -135,6 +137,7 @@ Class | Method | HTTP request | Description
  - [CreateSubmissionDataRequestTokenResponseToken](docs/Model/CreateSubmissionDataRequestTokenResponseToken.md)
  - [CreateSubmissionResponse](docs/Model/CreateSubmissionResponse.md)
  - [CreateTemplateData](docs/Model/CreateTemplateData.md)
+ - [CreateTemplateData1](docs/Model/CreateTemplateData1.md)
  - [CustomFile](docs/Model/CustomFile.md)
  - [Error](docs/Model/Error.md)
  - [Folder](docs/Model/Folder.md)
@@ -152,11 +155,14 @@ Class | Method | HTTP request | Description
  - [SubmissionDataBatchRequest](docs/Model/SubmissionDataBatchRequest.md)
  - [SubmissionDataRequest](docs/Model/SubmissionDataRequest.md)
  - [Template](docs/Model/Template.md)
- - [Templatesv2Template](docs/Model/Templatesv2Template.md)
- - [Templatesv2TemplateDocument](docs/Model/Templatesv2TemplateDocument.md)
- - [Templatesv2TemplateDocumentMetadata](docs/Model/Templatesv2TemplateDocumentMetadata.md)
+ - [TemplatesdesccachedUploadTemplate](docs/Model/TemplatesdesccachedUploadTemplate.md)
+ - [TemplatesdesccachedUploadTemplateDocument](docs/Model/TemplatesdesccachedUploadTemplateDocument.md)
+ - [TemplatesdesccachedUploadTemplateDocumentMetadata](docs/Model/TemplatesdesccachedUploadTemplateDocumentMetadata.md)
+ - [TemplatestemplateIdTemplate](docs/Model/TemplatestemplateIdTemplate.md)
  - [UpdateDataRequestResponse](docs/Model/UpdateDataRequestResponse.md)
  - [UpdateSubmissionDataRequestData](docs/Model/UpdateSubmissionDataRequestData.md)
+ - [UpdateTemplateData](docs/Model/UpdateTemplateData.md)
+ - [UpdateTemplateResponse](docs/Model/UpdateTemplateResponse.md)
 
 
 ## Documentation For Authorization

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "docspring/docspring",
-    "version": "1.0.0",
+    "version": "1.1.0",
     "description": "",
     "keywords": [
         "openapitools",

docs/Api/PDFApi.md

@@ -11,8 +11,9 @@ Method | HTTP request | Description
 [**createCustomFileFromUpload**](PDFApi.md#createCustomFileFromUpload) | **POST** /custom_files | Create a new custom file from a cached presign upload
 [**createDataRequestToken**](PDFApi.md#createDataRequestToken) | **POST** /data_requests/{data_request_id}/tokens | Creates a new data request token for form authentication
 [**createFolder**](PDFApi.md#createFolder) | **POST** /folders/ | Create a folder
-[**createTemplate**](PDFApi.md#createTemplate) | **POST** /templates | Upload a new PDF template with a file upload
-[**createTemplateFromUpload**](PDFApi.md#createTemplateFromUpload) | **POST** /templates?v=2 | Create a new PDF template from a cached presign upload
+[**createHTMLTemplate**](PDFApi.md#createHTMLTemplate) | **POST** /templates?desc=html | Create a new HTML template
+[**createPDFTemplate**](PDFApi.md#createPDFTemplate) | **POST** /templates | Create a new PDF template with a form POST file upload
+[**createPDFTemplateFromUpload**](PDFApi.md#createPDFTemplateFromUpload) | **POST** /templates?desc=cached_upload | Create a new PDF template from a cached presign upload
 [**deleteFolder**](PDFApi.md#deleteFolder) | **DELETE** /folders/{folder_id} | Delete a folder
 [**expireCombinedSubmission**](PDFApi.md#expireCombinedSubmission) | **DELETE** /combined_submissions/{combined_submission_id} | Expire a combined submission
 [**expireSubmission**](PDFApi.md#expireSubmission) | **DELETE** /submissions/{submission_id} | Expire a PDF submission
@@ -31,6 +32,7 @@ Method | HTTP request | Description
 [**renameFolder**](PDFApi.md#renameFolder) | **POST** /folders/{folder_id}/rename | Rename a folder
 [**testAuthentication**](PDFApi.md#testAuthentication) | **GET** /authentication | Test Authentication
 [**updateDataRequest**](PDFApi.md#updateDataRequest) | **PUT** /data_requests/{data_request_id} | Update a submission data request
+[**updateTemplate**](PDFApi.md#updateTemplate) | **PUT** /templates/{template_id} | Update a Template
 
 
 # **batchGeneratePdfV1**
@@ -413,10 +415,64 @@ 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)
 
-# **createTemplate**
-> \DocSpring\Model\PendingTemplate createTemplate($template_document, $template_name, $template_parent_folder_id)
+# **createHTMLTemplate**
+> \DocSpring\Model\PendingTemplate createHTMLTemplate($create_template_data1)
 
-Upload a new PDF template with a file upload
+Create a new HTML 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
+);
+$create_template_data1 = new \DocSpring\Model\CreateTemplateData1(); // \DocSpring\Model\CreateTemplateData1 | 
+
+try {
+    $result = $apiInstance->createHTMLTemplate($create_template_data1);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling PDFApi->createHTMLTemplate: ', $e->getMessage(), PHP_EOL;
+}
+?>
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **create_template_data1** | [**\DocSpring\Model\CreateTemplateData1**](../Model/CreateTemplateData1.md)|  |
+
+### Return type
+
+[**\DocSpring\Model\PendingTemplate**](../Model/PendingTemplate.md)
+
+### Authorization
+
+[api_token_basic](../../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **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)
+
+# **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
@@ -440,10 +496,10 @@ $template_name = 'template_name_example'; // string |
 $template_parent_folder_id = 'template_parent_folder_id_example'; // string | 
 
 try {
-    $result = $apiInstance->createTemplate($template_document, $template_name, $template_parent_folder_id);
+    $result = $apiInstance->createPDFTemplate($template_document, $template_name, $template_parent_folder_id);
     print_r($result);
 } catch (Exception $e) {
-    echo 'Exception when calling PDFApi->createTemplate: ', $e->getMessage(), PHP_EOL;
+    echo 'Exception when calling PDFApi->createPDFTemplate: ', $e->getMessage(), PHP_EOL;
 }
 ?>
 ```
@@ -471,8 +527,8 @@ 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)
 
-# **createTemplateFromUpload**
-> \DocSpring\Model\PendingTemplate createTemplateFromUpload($create_template_data)
+# **createPDFTemplateFromUpload**
+> \DocSpring\Model\PendingTemplate createPDFTemplateFromUpload($create_template_data)
 
 Create a new PDF template from a cached presign upload
 
@@ -496,10 +552,10 @@ $apiInstance = new DocSpring\Api\PDFApi(
 $create_template_data = new \DocSpring\Model\CreateTemplateData(); // \DocSpring\Model\CreateTemplateData | 
 
 try {
-    $result = $apiInstance->createTemplateFromUpload($create_template_data);
+    $result = $apiInstance->createPDFTemplateFromUpload($create_template_data);
     print_r($result);
 } catch (Exception $e) {
-    echo 'Exception when calling PDFApi->createTemplateFromUpload: ', $e->getMessage(), PHP_EOL;
+    echo 'Exception when calling PDFApi->createPDFTemplateFromUpload: ', $e->getMessage(), PHP_EOL;
 }
 ?>
 ```
@@ -1508,3 +1564,59 @@ 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)
 
+# **updateTemplate**
+> \DocSpring\Model\UpdateTemplateResponse updateTemplate($template_id, $update_template_data)
+
+Update a 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_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**](../Model/UpdateTemplateData.md)|  |
+
+### Return type
+
+[**\DocSpring\Model\UpdateTemplateResponse**](../Model/UpdateTemplateResponse.md)
+
+### Authorization
+
+[api_token_basic](../../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **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)
+

docs/Model/CombinedSubmission.md

@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 **expired** | **bool** |  | [optional] 
 **expires_at** | **string** |  | [optional] 
 **source_pdfs** | **object[]** |  | [optional] 
+**pdf_hash** | **string** |  | [optional] 
 **download_url** | **string** |  | [optional] 
 **submission_ids** | **string[]** |  | [optional] 
 **id** | **string** |  | [optional] 

docs/Model/CreateTemplateData.md

@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**template** | [**\DocSpring\Model\Templatesv2Template**](Templatesv2Template.md) |  | 
+**template** | [**\DocSpring\Model\TemplatesdesccachedUploadTemplate**](TemplatesdesccachedUploadTemplate.md) |  | 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

docs/Model/CreateTemplateData1.md

@@ -0,0 +1,10 @@
+# CreateTemplateData1
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**template** | [**\DocSpring\Model\TemplatesdesccachedUploadTemplate**](TemplatesdesccachedUploadTemplate.md) |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

docs/Model/PendingTemplate.md

@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 **parent_folder_id** | **string** |  | [optional] 
 **expire_after** | **float** |  | [optional] 
 **allow_additional_properties** | **bool** |  | [optional] 
+**description** | **string** |  | [optional] 
 **public_submissions** | **bool** |  | [optional] 
 **slack_webhook_url** | **string** |  | [optional] 
 **path** | **string** |  | [optional] 

docs/Model/Submission.md

@@ -12,6 +12,7 @@ Name | Type | Description | Notes
 **processed_at** | **string** |  | [optional] 
 **state** | **string** |  | 
 **metadata** | **object** |  | [optional] 
+**pdf_hash** | **string** |  | [optional] 
 **download_url** | **string** |  | [optional] 
 **permanent_download_url** | **string** |  | [optional] 
 **batch_id** | **string** |  | [optional] 

docs/Model/SubmissionData.md

@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 **html** | **string** |  | [optional] 
 **css** | **string** |  | [optional] 
 **metadata** | **object** |  | [optional] 
+**field_overrides** | **object** |  | [optional] 
 **data_requests** | [**\DocSpring\Model\CreateSubmissionDataRequestData[]**](CreateSubmissionDataRequestData.md) |  | [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)