Updated on 2020-09-12 20:43:00. Version: 1.2.0

Author: ndbroadbent

CHANGELOG.md

@@ -1,50 +1,13 @@
-### 1.1.0 [July 7, 2020]
-
-- Update to use latest API schema
-
-### 1.13.0 [October 10, 2019]
-
-- Add permanent_download_url attribute to Submission model
-
-### 1.12.0 [October 9, 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.0 [June 22, 2019]
-
-- **BREAKING CHANGE** Renamed "Get Templates" endpoint to "List Templates". Added a search query parameter.
+### 1.2.0 [September 12, 2020]
 
-### 1.9.0 [April 11, 2019]
+- **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
 
-- Added support for editable PDFS (editable: true)
-
-### 1.8.0 [December 23, 2018]
-
-- Added CustomFiles, and combinePdf call to support many different types of source PDFs. Renamed a few models
-
-### 1.7.0 [December 18, 2018]
-
-- Updated API host to api.formapi.io
-
-### 1.6.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.5.0 [December 1, 2018]
-
-- Added Get Template Schema endpoint
-
-### 1.4.0 [November 22, 2018]
+### 1.1.0 [July 7, 2020]
 
-- Added getTemplate(id) and createTemplate endpoints
+- Update to use latest API schema
 
-### 1.3.0 [November 4, 2018]
+### 1.0.0 [May 20, 2019]
 
-- Initial changelog
+- Renamed FormAPI to DocSpring. (View the CHANGELOG in the original FormAPI API client for prior releases.)

DocSpring.Client.sln

@@ -2,7 +2,7 @@ Microsoft Visual Studio Solution File, Format Version 12.00
 # Visual Studio 2012
 VisualStudioVersion = 12.0.0.0
 MinimumVisualStudioVersion = 10.0.0.1
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "DocSpring.Client", "src\DocSpring.Client\DocSpring.Client.csproj", "{90AFFF8C-76CA-4AC1-BC3C-063C100DED67}"
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "DocSpring.Client", "src\DocSpring.Client\DocSpring.Client.csproj", "{DB132E15-0167-42BE-A528-C751A746A03A}"
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "DocSpring.Client.Test", "src\DocSpring.Client.Test\DocSpring.Client.Test.csproj", "{19F1DEBC-DE5E-4517-8062-F000CD499087}"
 EndProject
@@ -12,10 +12,10 @@ Global
 		Release|Any CPU = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(ProjectConfigurationPlatforms) = postSolution
-		{90AFFF8C-76CA-4AC1-BC3C-063C100DED67}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{90AFFF8C-76CA-4AC1-BC3C-063C100DED67}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{90AFFF8C-76CA-4AC1-BC3C-063C100DED67}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{90AFFF8C-76CA-4AC1-BC3C-063C100DED67}.Release|Any CPU.Build.0 = Release|Any CPU
+		{DB132E15-0167-42BE-A528-C751A746A03A}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{DB132E15-0167-42BE-A528-C751A746A03A}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{DB132E15-0167-42BE-A528-C751A746A03A}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{DB132E15-0167-42BE-A528-C751A746A03A}.Release|Any CPU.Build.0 = Release|Any CPU
 		{19F1DEBC-DE5E-4517-8062-F000CD499087}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{19F1DEBC-DE5E-4517-8062-F000CD499087}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{19F1DEBC-DE5E-4517-8062-F000CD499087}.Release|Any CPU.ActiveCfg = Release|Any CPU

README.md

@@ -5,7 +5,7 @@ DocSpring is a service that helps you fill out and sign PDF templates.
 This C# SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: v1
-- SDK version: 1.1.0
+- SDK version: 1.2.0
 - Build package: com.docspring.codegen.DocSpringCSharpClientCodegen
 
 <a name="frameworks-supported"></a>
@@ -108,8 +108,9 @@ Class | Method | HTTP request | Description
 *PDFApi* | [**CreateCustomFileFromUpload**](docs/PDFApi.md#createcustomfilefromupload) | **POST** /custom_files | Create a new custom file from a cached presign upload
 *PDFApi* | [**CreateDataRequestToken**](docs/PDFApi.md#createdatarequesttoken) | **POST** /data_requests/{data_request_id}/tokens | Creates a new data request token for form authentication
 *PDFApi* | [**CreateFolder**](docs/PDFApi.md#createfolder) | **POST** /folders/ | Create a folder
-*PDFApi* | [**CreateTemplate**](docs/PDFApi.md#createtemplate) | **POST** /templates | Upload a new PDF template with a file upload
-*PDFApi* | [**CreateTemplateFromUpload**](docs/PDFApi.md#createtemplatefromupload) | **POST** /templates?v&#x3D;2 | Create a new PDF template from a cached presign upload
+*PDFApi* | [**CreateHTMLTemplate**](docs/PDFApi.md#createhtmltemplate) | **POST** /templates?desc&#x3D;html | Create a new HTML template
+*PDFApi* | [**CreatePDFTemplate**](docs/PDFApi.md#createpdftemplate) | **POST** /templates | Create a new PDF template with a form POST file upload
+*PDFApi* | [**CreatePDFTemplateFromUpload**](docs/PDFApi.md#createpdftemplatefromupload) | **POST** /templates?desc&#x3D;cached_upload | Create a new PDF template from a cached presign upload
 *PDFApi* | [**DeleteFolder**](docs/PDFApi.md#deletefolder) | **DELETE** /folders/{folder_id} | Delete a folder
 *PDFApi* | [**ExpireCombinedSubmission**](docs/PDFApi.md#expirecombinedsubmission) | **DELETE** /combined_submissions/{combined_submission_id} | Expire a combined submission
 *PDFApi* | [**ExpireSubmission**](docs/PDFApi.md#expiresubmission) | **DELETE** /submissions/{submission_id} | Expire a PDF submission
@@ -128,6 +129,7 @@ Class | Method | HTTP request | Description
 *PDFApi* | [**RenameFolder**](docs/PDFApi.md#renamefolder) | **POST** /folders/{folder_id}/rename | Rename a folder
 *PDFApi* | [**TestAuthentication**](docs/PDFApi.md#testauthentication) | **GET** /authentication | Test Authentication
 *PDFApi* | [**UpdateDataRequest**](docs/PDFApi.md#updatedatarequest) | **PUT** /data_requests/{data_request_id} | Update a submission data request
+*PDFApi* | [**UpdateTemplate**](docs/PDFApi.md#updatetemplate) | **PUT** /templates/{template_id} | Update a Template
 
 
 <a name="documentation-for-models"></a>
@@ -150,6 +152,7 @@ Class | Method | HTTP request | Description
  - [Model.CreateSubmissionDataRequestTokenResponseToken](docs/CreateSubmissionDataRequestTokenResponseToken.md)
  - [Model.CreateSubmissionResponse](docs/CreateSubmissionResponse.md)
  - [Model.CreateTemplateData](docs/CreateTemplateData.md)
+ - [Model.CreateTemplateData1](docs/CreateTemplateData1.md)
  - [Model.CustomFile](docs/CustomFile.md)
  - [Model.Error](docs/Error.md)
  - [Model.Folder](docs/Folder.md)
@@ -167,11 +170,14 @@ Class | Method | HTTP request | Description
  - [Model.SubmissionDataBatchRequest](docs/SubmissionDataBatchRequest.md)
  - [Model.SubmissionDataRequest](docs/SubmissionDataRequest.md)
  - [Model.Template](docs/Template.md)
- - [Model.Templatesv2Template](docs/Templatesv2Template.md)
- - [Model.Templatesv2TemplateDocument](docs/Templatesv2TemplateDocument.md)
- - [Model.Templatesv2TemplateDocumentMetadata](docs/Templatesv2TemplateDocumentMetadata.md)
+ - [Model.TemplatesdesccachedUploadTemplate](docs/TemplatesdesccachedUploadTemplate.md)
+ - [Model.TemplatesdesccachedUploadTemplateDocument](docs/TemplatesdesccachedUploadTemplateDocument.md)
+ - [Model.TemplatesdesccachedUploadTemplateDocumentMetadata](docs/TemplatesdesccachedUploadTemplateDocumentMetadata.md)
+ - [Model.TemplatestemplateIdTemplate](docs/TemplatestemplateIdTemplate.md)
  - [Model.UpdateDataRequestResponse](docs/UpdateDataRequestResponse.md)
  - [Model.UpdateSubmissionDataRequestData](docs/UpdateSubmissionDataRequestData.md)
+ - [Model.UpdateTemplateData](docs/UpdateTemplateData.md)
+ - [Model.UpdateTemplateResponse](docs/UpdateTemplateResponse.md)
 
 
 <a name="documentation-for-authorization"></a>

docs/CreateTemplateData.md

@@ -3,7 +3,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**Template** | [**Templatesv2Template**](Templatesv2Template.md) |  | 
+**Template** | [**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/CreateTemplateData1.md

@@ -0,0 +1,9 @@
+# DocSpring.Client.Model.CreateTemplateData1
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Template** | [**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/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>
@@ -476,11 +478,11 @@ 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)
 
-<a name="createtemplate"></a>
-# **CreateTemplate**
-> PendingTemplate CreateTemplate (System.IO.Stream templateDocument, string templateName, string templateParentFolderId = null)
+<a name="createhtmltemplate"></a>
+# **CreateHTMLTemplate**
+> PendingTemplate CreateHTMLTemplate (CreateTemplateData1 createTemplateData1)
 
-Upload a new PDF template with a file upload
+Create a new HTML template
 
 ### Example
 ```csharp
@@ -492,7 +494,70 @@ using DocSpring.Client.Model;
 
 namespace Example
 {
-    public class CreateTemplateExample
+    public class CreateHTMLTemplateExample
+    {
+        public void main()
+        {
+            // Configure HTTP basic authorization: api_token_basic
+            Configuration.Default.Username = "YOUR_USERNAME";
+            Configuration.Default.Password = "YOUR_PASSWORD";
+
+            var apiInstance = new PDFApi();
+            var createTemplateData1 = new CreateTemplateData1(); // CreateTemplateData1 | 
+
+            try
+            {
+                // Create a new HTML template
+                PendingTemplate result = apiInstance.CreateHTMLTemplate(createTemplateData1);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling PDFApi.CreateHTMLTemplate: " + e.Message );
+            }
+        }
+    }
+}
+```
+
+### 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
+
+[[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)
+
+<a name="createpdftemplate"></a>
+# **CreatePDFTemplate**
+> PendingTemplate CreatePDFTemplate (System.IO.Stream templateDocument, string templateName, string templateParentFolderId = null)
+
+Create a new PDF template with a form POST file upload
+
+### Example
+```csharp
+using System;
+using System.Diagnostics;
+using DocSpring.Client.Api;
+using DocSpring.Client.Client;
+using DocSpring.Client.Model;
+
+namespace Example
+{
+    public class CreatePDFTemplateExample
     {
         public void main()
         {
@@ -507,13 +572,13 @@ namespace Example
 
             try
             {
-                // Upload a new PDF template with a file upload
-                PendingTemplate result = apiInstance.CreateTemplate(templateDocument, templateName, templateParentFolderId);
+                // Create a new PDF template with a form POST file upload
+                PendingTemplate result = apiInstance.CreatePDFTemplate(templateDocument, templateName, templateParentFolderId);
                 Debug.WriteLine(result);
             }
             catch (Exception e)
             {
-                Debug.Print("Exception when calling PDFApi.CreateTemplate: " + e.Message );
+                Debug.Print("Exception when calling PDFApi.CreatePDFTemplate: " + e.Message );
             }
         }
     }
@@ -543,9 +608,9 @@ 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)
 
-<a name="createtemplatefromupload"></a>
-# **CreateTemplateFromUpload**
-> PendingTemplate CreateTemplateFromUpload (CreateTemplateData createTemplateData)
+<a name="createpdftemplatefromupload"></a>
+# **CreatePDFTemplateFromUpload**
+> PendingTemplate CreatePDFTemplateFromUpload (CreateTemplateData createTemplateData)
 
 Create a new PDF template from a cached presign upload
 
@@ -559,7 +624,7 @@ using DocSpring.Client.Model;
 
 namespace Example
 {
-    public class CreateTemplateFromUploadExample
+    public class CreatePDFTemplateFromUploadExample
     {
         public void main()
         {
@@ -573,12 +638,12 @@ namespace Example
             try
             {
                 // Create a new PDF template from a cached presign upload
-                PendingTemplate result = apiInstance.CreateTemplateFromUpload(createTemplateData);
+                PendingTemplate result = apiInstance.CreatePDFTemplateFromUpload(createTemplateData);
                 Debug.WriteLine(result);
             }
             catch (Exception e)
             {
-                Debug.Print("Exception when calling PDFApi.CreateTemplateFromUpload: " + e.Message );
+                Debug.Print("Exception when calling PDFApi.CreatePDFTemplateFromUpload: " + e.Message );
             }
         }
     }
@@ -1751,3 +1816,68 @@ 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)
 
+<a name="updatetemplate"></a>
+# **UpdateTemplate**
+> UpdateTemplateResponse UpdateTemplate (string templateId, UpdateTemplateData updateTemplateData)
+
+Update a Template
+
+### Example
+```csharp
+using System;
+using System.Diagnostics;
+using DocSpring.Client.Api;
+using DocSpring.Client.Client;
+using DocSpring.Client.Model;
+
+namespace Example
+{
+    public class UpdateTemplateExample
+    {
+        public void main()
+        {
+            // Configure HTTP basic authorization: api_token_basic
+            Configuration.Default.Username = "YOUR_USERNAME";
+            Configuration.Default.Password = "YOUR_PASSWORD";
+
+            var apiInstance = new PDFApi();
+            var templateId = tpl_000000000000000003;  // string | 
+            var updateTemplateData = new UpdateTemplateData(); // UpdateTemplateData | 
+
+            try
+            {
+                // Update a Template
+                UpdateTemplateResponse result = apiInstance.UpdateTemplate(templateId, updateTemplateData);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling PDFApi.UpdateTemplate: " + e.Message );
+            }
+        }
+    }
+}
+```
+
+### 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
+
+[[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/PendingTemplate.md

@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 **ParentFolderId** | **string** |  | [optional] 
 **ExpireAfter** | **decimal?** |  | [optional] 
 **AllowAdditionalProperties** | **bool?** |  | [optional] 
+**Description** | **string** |  | [optional] 
 **PublicSubmissions** | **bool?** |  | [optional] 
 **SlackWebhookUrl** | **string** |  | [optional] 
 **Path** | **string** |  | [optional]