Updated on 2020-09-12 20:46:40. Version: 1.1.0

Author: ndbroadbent

CHANGELOG.md

@@ -1,40 +1,9 @@
-### 1.9.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.8.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.7.0 [July 31, 2019]
-* Added Create Folder, List Folder, Move to Folder endpoints
-
-### 1.6.0 [June 22, 2019]
-
-- **BREAKING CHANGE** Renamed "Get Templates" endpoint to "List Templates". Added a search query parameter.
-
-### 1.5.0 [April 11, 2019]
-
-- Added support for editable PDFS (editable: true)
-
-### 1.4.0 [December 23, 2018]
-
-- Added CustomFiles, and combinePdf call to support many different types of source PDFs. Renamed a few models
-
-### 1.3.0 [December 18, 2018]
-
-- Updated API host to api.formapi.io
-
-### 1.2.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.1.0 [December 1, 2018]
-
-- Added Create Template, Get Template, and Get Template Schema endpoints
-
-### 1.0.0 [November 4, 2018]
-
-- Initial changelog
+- Renamed FormAPI to DocSpring. (View the CHANGELOG in the original FormAPI API client for prior releases.)

README.md

@@ -26,7 +26,7 @@ After the client library is installed/deployed, you can use it in your Maven pro
 <dependency>
     <groupId>com.docspring</groupId>
     <artifactId>DocSpring</artifactId>
-    <version>1.0.0</version>
+    <version>1.1.0</version>
     <scope>compile</scope>
 </dependency>
 

build.gradle

@@ -2,7 +2,7 @@ apply plugin: 'idea'
 apply plugin: 'eclipse'
 
 group = 'com.docspring'
-version = '1.0.0'
+version = '1.1.0'
 
 buildscript {
     repositories {
@@ -100,6 +100,7 @@ ext {
     junit_version = "4.12"
     threetenbp_version = "1.3.5"
     json_fire_version = "1.8.0"
+    javax_annotation_api_version = "1.3.2"
 }
 
 dependencies {
@@ -112,6 +113,7 @@ dependencies {
     }
     compile "io.gsonfire:gson-fire:$json_fire_version"
     compile "org.threeten:threetenbp:$threetenbp_version"
+    compile "javax.annotation:javax.$javax_annotation_api_version"
 
     testCompile "junit:junit:$junit_version"
     testCompile "org.hamcrest:hamcrest-all:1.3"

build.sbt

@@ -2,7 +2,7 @@ lazy val root = (project in file(".")).
   settings(
     organization := "com.docspring",
     name := "DocSpring",
-    version := "1.0.0",
+    version := "1.1.0",
     scalaVersion := "2.11.4",
     scalacOptions ++= Seq("-feature"),
     javacOptions in compile ++= Seq("-Xlint:deprecation"),

docs/CombinedSubmission.md

@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 **expired** | **Boolean** |  |  [optional]
 **expiresAt** | **String** |  |  [optional]
 **sourcePdfs** | **List<Object>** |  |  [optional]
+**pdfHash** | **String** |  |  [optional]
 **downloadUrl** | **String** |  |  [optional]
 **submissionIds** | **List<String>** |  |  [optional]
 **id** | **String** |  |  [optional]

docs/CreateTemplateData.md

@@ -4,7 +4,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**template** | [**Templatesv2Template**](Templatesv2Template.md) |  | 
+**template** | [**TemplatesdesccachedUploadTemplate**](TemplatesdesccachedUploadTemplate.md) |  | 
 
 
 

docs/CreateTemplateData1.md

@@ -0,0 +1,10 @@
+
+# CreateTemplateData1
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**template** | [**TemplatesdesccachedUploadTemplate**](TemplatesdesccachedUploadTemplate.md) |  | 
+
+
+

docs/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
 
 
 <a name="batchGeneratePdfV1"></a>
@@ -399,11 +401,63 @@ Name | Type | Description  | Notes
  - **Content-Type**: application/json
  - **Accept**: application/json
 
-<a name="createTemplate"></a>
-# **createTemplate**
-> PendingTemplate createTemplate(templateDocument, templateName, templateParentFolderId)
+<a name="createHTMLTemplate"></a>
+# **createHTMLTemplate**
+> PendingTemplate createHTMLTemplate(createTemplateData1)
 
-Upload a new PDF template with a file upload
+Create a new HTML template
+
+### Example
+```java
+// Import classes:
+//import com.docspring.ApiClient;
+//import com.docspring.ApiException;
+//import com.docspring.Configuration;
+//import com.docspring.auth.*;
+//import com.docspring.PdfApi;
+
+ApiClient defaultClient = Configuration.getDefaultApiClient();
+
+// Configure HTTP basic authorization: api_token_basic
+HttpBasicAuth api_token_basic = (HttpBasicAuth) defaultClient.getAuthentication("api_token_basic");
+api_token_basic.setUsername("YOUR USERNAME");
+api_token_basic.setPassword("YOUR PASSWORD");
+
+PdfApi apiInstance = new PdfApi();
+CreateTemplateData1 createTemplateData1 = new CreateTemplateData1(); // CreateTemplateData1 | 
+try {
+    PendingTemplate result = apiInstance.createHTMLTemplate(createTemplateData1);
+    System.out.println(result);
+} catch (ApiException e) {
+    System.err.println("Exception when calling PdfApi#createHTMLTemplate");
+    e.printStackTrace();
+}
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **createTemplateData1** | [**CreateTemplateData1**](CreateTemplateData1.md)|  |
+
+### Return type
+
+[**PendingTemplate**](PendingTemplate.md)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+<a name="createPDFTemplate"></a>
+# **createPDFTemplate**
+> PendingTemplate createPDFTemplate(templateDocument, templateName, templateParentFolderId)
+
+Create a new PDF template with a form POST file upload
 
 ### Example
 ```java
@@ -426,10 +480,10 @@ File templateDocument = new File("null"); // File |
 String templateName = "null"; // String | 
 String templateParentFolderId = "null"; // String | 
 try {
-    PendingTemplate result = apiInstance.createTemplate(templateDocument, templateName, templateParentFolderId);
+    PendingTemplate result = apiInstance.createPDFTemplate(templateDocument, templateName, templateParentFolderId);
     System.out.println(result);
 } catch (ApiException e) {
-    System.err.println("Exception when calling PdfApi#createTemplate");
+    System.err.println("Exception when calling PdfApi#createPDFTemplate");
     e.printStackTrace();
 }
 ```
@@ -455,9 +509,9 @@ Name | Type | Description  | Notes
  - **Content-Type**: multipart/form-data
  - **Accept**: application/json
 
-<a name="createTemplateFromUpload"></a>
-# **createTemplateFromUpload**
-> PendingTemplate createTemplateFromUpload(createTemplateData)
+<a name="createPDFTemplateFromUpload"></a>
+# **createPDFTemplateFromUpload**
+> PendingTemplate createPDFTemplateFromUpload(createTemplateData)
 
 Create a new PDF template from a cached presign upload
 
@@ -480,10 +534,10 @@ api_token_basic.setPassword("YOUR PASSWORD");
 PdfApi apiInstance = new PdfApi();
 CreateTemplateData createTemplateData = new CreateTemplateData(); // CreateTemplateData | 
 try {
-    PendingTemplate result = apiInstance.createTemplateFromUpload(createTemplateData);
+    PendingTemplate result = apiInstance.createPDFTemplateFromUpload(createTemplateData);
     System.out.println(result);
 } catch (ApiException e) {
-    System.err.println("Exception when calling PdfApi#createTemplateFromUpload");
+    System.err.println("Exception when calling PdfApi#createPDFTemplateFromUpload");
     e.printStackTrace();
 }
 ```
@@ -1454,3 +1508,57 @@ Name | Type | Description  | Notes
  - **Content-Type**: application/json
  - **Accept**: application/json
 
+<a name="updateTemplate"></a>
+# **updateTemplate**
+> UpdateTemplateResponse updateTemplate(templateId, updateTemplateData)
+
+Update a Template
+
+### Example
+```java
+// Import classes:
+//import com.docspring.ApiClient;
+//import com.docspring.ApiException;
+//import com.docspring.Configuration;
+//import com.docspring.auth.*;
+//import com.docspring.PdfApi;
+
+ApiClient defaultClient = Configuration.getDefaultApiClient();
+
+// Configure HTTP basic authorization: api_token_basic
+HttpBasicAuth api_token_basic = (HttpBasicAuth) defaultClient.getAuthentication("api_token_basic");
+api_token_basic.setUsername("YOUR USERNAME");
+api_token_basic.setPassword("YOUR PASSWORD");
+
+PdfApi apiInstance = new PdfApi();
+String templateId = tpl_000000000000000003; // String | 
+UpdateTemplateData updateTemplateData = new UpdateTemplateData(); // UpdateTemplateData | 
+try {
+    UpdateTemplateResponse result = apiInstance.updateTemplate(templateId, updateTemplateData);
+    System.out.println(result);
+} catch (ApiException e) {
+    System.err.println("Exception when calling PdfApi#updateTemplate");
+    e.printStackTrace();
+}
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **templateId** | **String**|  |
+ **updateTemplateData** | [**UpdateTemplateData**](UpdateTemplateData.md)|  |
+
+### Return type
+
+[**UpdateTemplateResponse**](UpdateTemplateResponse.md)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+

docs/PendingTemplate.md

@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **parentFolderId** | **String** |  |  [optional]
 **expireAfter** | [**BigDecimal**](BigDecimal.md) |  |  [optional]
 **allowAdditionalProperties** | **Boolean** |  |  [optional]
+**description** | **String** |  |  [optional]
 **publicSubmissions** | **Boolean** |  |  [optional]
 **slackWebhookUrl** | **String** |  |  [optional]
 **path** | **String** |  |  [optional]

docs/Submission.md

@@ -13,6 +13,7 @@ Name | Type | Description | Notes
 **processedAt** | **String** |  |  [optional]
 **state** | [**StateEnum**](#StateEnum) |  | 
 **metadata** | **Object** |  |  [optional]
+**pdfHash** | **String** |  |  [optional]
 **downloadUrl** | **String** |  |  [optional]
 **permanentDownloadUrl** | **String** |  |  [optional]
 **batchId** | **String** |  |  [optional]
@@ -34,6 +35,7 @@ WAITING_FOR_DATA_REQUESTS | "waiting_for_data_requests"
 SYNTAX_ERROR | "syntax_error"
 ACCOUNT_SUSPENDED | "account_suspended"
 LICENSE_REVOKED | "license_revoked"
+ACCIDENTAL | "accidental"