Skip to content

Commit b1fa7da

Browse files
ndbroadbentndbroadbent
committed
Updated on 2020-11-19 00:08:35. Version: 1.3.1
1 parent 2fa74ba commit b1fa7da

62 files changed

Lines changed: 377 additions & 64 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎CHANGELOG.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
### 1.3.1 [November 19, 2020]
2+
3+
- Added "sort_order" property for Submission Data Requests
4+
15
### 1.3.0 [September 26, 2020]
26

37
- Updated OpenAPI Generator to v3.3.0

‎LICENSE‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Copyright © 2018 Form Applications Inc.
1+
Copyright © 2018-2020 DocSpring, Inc.
22

33
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
44

‎README.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ DocSpring is a service that helps you fill out and sign PDF templates.
55
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
66

77
- API version: v1
8-
- Package version: 1.3.0
8+
- Package version: 1.3.1
99
- Build package: com.docspring.codegen.DocSpringJavascriptClientCodegen
1010

1111
## Installation
@@ -128,6 +128,7 @@ Class | Method | HTTP request | Description
128128
*DocSpring.PDFApi* | [**batchGeneratePdfs**](docs/PDFApi.md#batchGeneratePdfs) | **POST** /submissions/batches | Generates multiple PDFs
129129
*DocSpring.PDFApi* | [**combinePdfs**](docs/PDFApi.md#combinePdfs) | **POST** /combined_submissions?v=2 | Merge submission PDFs, template PDFs, or custom files
130130
*DocSpring.PDFApi* | [**combineSubmissions**](docs/PDFApi.md#combineSubmissions) | **POST** /combined_submissions | Merge generated PDFs together
131+
*DocSpring.PDFApi* | [**copyTemplate**](docs/PDFApi.md#copyTemplate) | **POST** /templates/{template_id}/copy | Copy a Template
131132
*DocSpring.PDFApi* | [**createCustomFileFromUpload**](docs/PDFApi.md#createCustomFileFromUpload) | **POST** /custom_files | Create a new custom file from a cached presign upload
132133
*DocSpring.PDFApi* | [**createDataRequestToken**](docs/PDFApi.md#createDataRequestToken) | **POST** /data_requests/{data_request_id}/tokens | Creates a new data request token for form authentication
133134
*DocSpring.PDFApi* | [**createFolder**](docs/PDFApi.md#createFolder) | **POST** /folders/ | Create a folder
@@ -165,6 +166,7 @@ Class | Method | HTTP request | Description
165166
- [DocSpring.CombinedSubmission](docs/CombinedSubmission.md)
166167
- [DocSpring.CombinedSubmissionAction](docs/CombinedSubmissionAction.md)
167168
- [DocSpring.CombinedSubmissionData](docs/CombinedSubmissionData.md)
169+
- [DocSpring.CopyTemplateData](docs/CopyTemplateData.md)
168170
- [DocSpring.CreateCombinedSubmissionResponse](docs/CreateCombinedSubmissionResponse.md)
169171
- [DocSpring.CreateCustomFileData](docs/CreateCustomFileData.md)
170172
- [DocSpring.CreateCustomFileResponse](docs/CreateCustomFileResponse.md)

‎docs/CopyTemplateData.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# DocSpring.CopyTemplateData
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**name** | **String** | | [optional]
7+
**parentFolderId** | **String** | |
8+
9+

‎docs/MoveTemplateData.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**parentFolderId** | **String** | | [optional]
6+
**parentFolderId** | **String** | |
77

88

‎docs/PDFApi.md‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Method | HTTP request | Description
99
[**batchGeneratePdfs**](PDFApi.md#batchGeneratePdfs) | **POST** /submissions/batches | Generates multiple PDFs
1010
[**combinePdfs**](PDFApi.md#combinePdfs) | **POST** /combined_submissions?v=2 | Merge submission PDFs, template PDFs, or custom files
1111
[**combineSubmissions**](PDFApi.md#combineSubmissions) | **POST** /combined_submissions | Merge generated PDFs together
12+
[**copyTemplate**](PDFApi.md#copyTemplate) | **POST** /templates/{template_id}/copy | Copy a Template
1213
[**createCustomFileFromUpload**](PDFApi.md#createCustomFileFromUpload) | **POST** /custom_files | Create a new custom file from a cached presign upload
1314
[**createDataRequestToken**](PDFApi.md#createDataRequestToken) | **POST** /data_requests/{data_request_id}/tokens | Creates a new data request token for form authentication
1415
[**createFolder**](PDFApi.md#createFolder) | **POST** /folders/ | Create a folder
@@ -270,6 +271,55 @@ Name | Type | Description | Notes
270271

271272
[api_token_basic](../README.md#api_token_basic)
272273

274+
### HTTP request headers
275+
276+
- **Content-Type**: application/json
277+
- **Accept**: application/json
278+
279+
<a name="copyTemplate"></a>
280+
# **copyTemplate**
281+
> Template copyTemplate(templateId, copyTemplateData)
282+
283+
Copy a Template
284+
285+
### Example
286+
```javascript
287+
var DocSpring = require('docspring');
288+
var defaultClient = DocSpring.ApiClient.instance;
289+
290+
// Configure HTTP basic authorization: api_token_basic
291+
var api_token_basic = defaultClient.authentications['api_token_basic'];
292+
api_token_basic.username = 'YOUR USERNAME';
293+
api_token_basic.password = 'YOUR PASSWORD';
294+
295+
var apiInstance = new DocSpring.PDFApi();
296+
var templateId = tpl_000000000000000001; // String |
297+
var copyTemplateData = new DocSpring.CopyTemplateData(); // CopyTemplateData |
298+
var callback = function(error, data, response) {
299+
if (error) {
300+
console.error(error);
301+
} else {
302+
console.log('API called successfully. Returned data: ' + data);
303+
}
304+
};
305+
apiInstance.copyTemplate(templateId, copyTemplateData, callback);
306+
```
307+
308+
### Parameters
309+
310+
Name | Type | Description | Notes
311+
------------- | ------------- | ------------- | -------------
312+
**templateId** | **String**| |
313+
**copyTemplateData** | [**CopyTemplateData**](CopyTemplateData.md)| |
314+
315+
### Return type
316+
317+
[**Template**](Template.md)
318+
319+
### Authorization
320+
321+
[api_token_basic](../README.md#api_token_basic)
322+
273323
### HTTP request headers
274324

275325
- **Content-Type**: application/json

‎docs/SubmissionDataRequest.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
77
**name** | **String** | |
88
**email** | **String** | |
99
**order** | **Number** | |
10+
**sortOrder** | **Number** | |
1011
**fields** | **[String]** | |
1112
**metadata** | **Object** | |
1213
**state** | **String** | |

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "docspring",
3-
"version": "1.3.0",
3+
"version": "1.3.1",
44
"description": "An API client for the DocSpring PDF generation service",
55
"license": "Unlicense",
66
"main": "src/index.js",

‎src/ApiClient.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232

3333
/**
3434
* @module ApiClient
35-
* @version 1.3.0
35+
* @version 1.3.1
3636
*/
3737

3838
/**

‎src/api/PDFApi.js‎

Lines changed: 58 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,24 +16,24 @@
1616
(function(root, factory) {
1717
if (typeof define === 'function' && define.amd) {
1818
// AMD. Register as an anonymous module.
19-
define(['../ApiClient', '../model/AddFieldsData', '../model/AddFieldsTemplateResponse', '../model/AuthenticationError', '../model/AuthenticationSuccessResponse', '../model/CombinePdfsData', '../model/CombinedSubmission', '../model/CombinedSubmissionData', '../model/CreateCombinedSubmissionResponse', '../model/CreateCustomFileData', '../model/CreateCustomFileResponse', '../model/CreateFolderData', '../model/CreateHtmlTemplateData', '../model/CreateSubmissionBatchResponse', '../model/CreateSubmissionDataRequestTokenResponse', '../model/CreateSubmissionResponse', '../model/CreateTemplateFromUploadData', '../model/Error', '../model/Folder', '../model/InvalidRequest', '../model/MoveFolderData', '../model/MoveTemplateData', '../model/PendingTemplate', '../model/RenameFolderData', '../model/Submission', '../model/SubmissionBatch', '../model/SubmissionBatchData', '../model/SubmissionData', '../model/SubmissionDataRequest', '../model/Template', '../model/UpdateDataRequestResponse', '../model/UpdateSubmissionDataRequestData', '../model/UpdateTemplateData', '../model/UpdateTemplateResponse'], factory);
19+
define(['../ApiClient', '../model/AddFieldsData', '../model/AddFieldsTemplateResponse', '../model/AuthenticationError', '../model/AuthenticationSuccessResponse', '../model/CombinePdfsData', '../model/CombinedSubmission', '../model/CombinedSubmissionData', '../model/CopyTemplateData', '../model/CreateCombinedSubmissionResponse', '../model/CreateCustomFileData', '../model/CreateCustomFileResponse', '../model/CreateFolderData', '../model/CreateHtmlTemplateData', '../model/CreateSubmissionBatchResponse', '../model/CreateSubmissionDataRequestTokenResponse', '../model/CreateSubmissionResponse', '../model/CreateTemplateFromUploadData', '../model/Error', '../model/Folder', '../model/InvalidRequest', '../model/MoveFolderData', '../model/MoveTemplateData', '../model/PendingTemplate', '../model/RenameFolderData', '../model/Submission', '../model/SubmissionBatch', '../model/SubmissionBatchData', '../model/SubmissionData', '../model/SubmissionDataRequest', '../model/Template', '../model/UpdateDataRequestResponse', '../model/UpdateSubmissionDataRequestData', '../model/UpdateTemplateData', '../model/UpdateTemplateResponse'], factory);
2020
} else if (typeof module === 'object' && module.exports) {
2121
// CommonJS-like environments that support module.exports, like Node.
22-
module.exports = factory(require('../ApiClient'), require('../model/AddFieldsData'), require('../model/AddFieldsTemplateResponse'), require('../model/AuthenticationError'), require('../model/AuthenticationSuccessResponse'), require('../model/CombinePdfsData'), require('../model/CombinedSubmission'), require('../model/CombinedSubmissionData'), require('../model/CreateCombinedSubmissionResponse'), require('../model/CreateCustomFileData'), require('../model/CreateCustomFileResponse'), require('../model/CreateFolderData'), require('../model/CreateHtmlTemplateData'), require('../model/CreateSubmissionBatchResponse'), require('../model/CreateSubmissionDataRequestTokenResponse'), require('../model/CreateSubmissionResponse'), require('../model/CreateTemplateFromUploadData'), require('../model/Error'), require('../model/Folder'), require('../model/InvalidRequest'), require('../model/MoveFolderData'), require('../model/MoveTemplateData'), require('../model/PendingTemplate'), require('../model/RenameFolderData'), require('../model/Submission'), require('../model/SubmissionBatch'), require('../model/SubmissionBatchData'), require('../model/SubmissionData'), require('../model/SubmissionDataRequest'), require('../model/Template'), require('../model/UpdateDataRequestResponse'), require('../model/UpdateSubmissionDataRequestData'), require('../model/UpdateTemplateData'), require('../model/UpdateTemplateResponse'));
22+
module.exports = factory(require('../ApiClient'), require('../model/AddFieldsData'), require('../model/AddFieldsTemplateResponse'), require('../model/AuthenticationError'), require('../model/AuthenticationSuccessResponse'), require('../model/CombinePdfsData'), require('../model/CombinedSubmission'), require('../model/CombinedSubmissionData'), require('../model/CopyTemplateData'), require('../model/CreateCombinedSubmissionResponse'), require('../model/CreateCustomFileData'), require('../model/CreateCustomFileResponse'), require('../model/CreateFolderData'), require('../model/CreateHtmlTemplateData'), require('../model/CreateSubmissionBatchResponse'), require('../model/CreateSubmissionDataRequestTokenResponse'), require('../model/CreateSubmissionResponse'), require('../model/CreateTemplateFromUploadData'), require('../model/Error'), require('../model/Folder'), require('../model/InvalidRequest'), require('../model/MoveFolderData'), require('../model/MoveTemplateData'), require('../model/PendingTemplate'), require('../model/RenameFolderData'), require('../model/Submission'), require('../model/SubmissionBatch'), require('../model/SubmissionBatchData'), require('../model/SubmissionData'), require('../model/SubmissionDataRequest'), require('../model/Template'), require('../model/UpdateDataRequestResponse'), require('../model/UpdateSubmissionDataRequestData'), require('../model/UpdateTemplateData'), require('../model/UpdateTemplateResponse'));
2323
} else {
2424
// Browser globals (root is window)
2525
if (!root.DocSpring) {
2626
root.DocSpring = {};
2727
}
28-
root.DocSpring.PDFApi = factory(root.DocSpring.ApiClient, root.DocSpring.AddFieldsData, root.DocSpring.AddFieldsTemplateResponse, root.DocSpring.AuthenticationError, root.DocSpring.AuthenticationSuccessResponse, root.DocSpring.CombinePdfsData, root.DocSpring.CombinedSubmission, root.DocSpring.CombinedSubmissionData, root.DocSpring.CreateCombinedSubmissionResponse, root.DocSpring.CreateCustomFileData, root.DocSpring.CreateCustomFileResponse, root.DocSpring.CreateFolderData, root.DocSpring.CreateHtmlTemplateData, root.DocSpring.CreateSubmissionBatchResponse, root.DocSpring.CreateSubmissionDataRequestTokenResponse, root.DocSpring.CreateSubmissionResponse, root.DocSpring.CreateTemplateFromUploadData, root.DocSpring.Error, root.DocSpring.Folder, root.DocSpring.InvalidRequest, root.DocSpring.MoveFolderData, root.DocSpring.MoveTemplateData, root.DocSpring.PendingTemplate, root.DocSpring.RenameFolderData, root.DocSpring.Submission, root.DocSpring.SubmissionBatch, root.DocSpring.SubmissionBatchData, root.DocSpring.SubmissionData, root.DocSpring.SubmissionDataRequest, root.DocSpring.Template, root.DocSpring.UpdateDataRequestResponse, root.DocSpring.UpdateSubmissionDataRequestData, root.DocSpring.UpdateTemplateData, root.DocSpring.UpdateTemplateResponse);
28+
root.DocSpring.PDFApi = factory(root.DocSpring.ApiClient, root.DocSpring.AddFieldsData, root.DocSpring.AddFieldsTemplateResponse, root.DocSpring.AuthenticationError, root.DocSpring.AuthenticationSuccessResponse, root.DocSpring.CombinePdfsData, root.DocSpring.CombinedSubmission, root.DocSpring.CombinedSubmissionData, root.DocSpring.CopyTemplateData, root.DocSpring.CreateCombinedSubmissionResponse, root.DocSpring.CreateCustomFileData, root.DocSpring.CreateCustomFileResponse, root.DocSpring.CreateFolderData, root.DocSpring.CreateHtmlTemplateData, root.DocSpring.CreateSubmissionBatchResponse, root.DocSpring.CreateSubmissionDataRequestTokenResponse, root.DocSpring.CreateSubmissionResponse, root.DocSpring.CreateTemplateFromUploadData, root.DocSpring.Error, root.DocSpring.Folder, root.DocSpring.InvalidRequest, root.DocSpring.MoveFolderData, root.DocSpring.MoveTemplateData, root.DocSpring.PendingTemplate, root.DocSpring.RenameFolderData, root.DocSpring.Submission, root.DocSpring.SubmissionBatch, root.DocSpring.SubmissionBatchData, root.DocSpring.SubmissionData, root.DocSpring.SubmissionDataRequest, root.DocSpring.Template, root.DocSpring.UpdateDataRequestResponse, root.DocSpring.UpdateSubmissionDataRequestData, root.DocSpring.UpdateTemplateData, root.DocSpring.UpdateTemplateResponse);
2929
}
30-
}(this, function(ApiClient, AddFieldsData, AddFieldsTemplateResponse, AuthenticationError, AuthenticationSuccessResponse, CombinePdfsData, CombinedSubmission, CombinedSubmissionData, CreateCombinedSubmissionResponse, CreateCustomFileData, CreateCustomFileResponse, CreateFolderData, CreateHtmlTemplateData, CreateSubmissionBatchResponse, CreateSubmissionDataRequestTokenResponse, CreateSubmissionResponse, CreateTemplateFromUploadData, Error, Folder, InvalidRequest, MoveFolderData, MoveTemplateData, PendingTemplate, RenameFolderData, Submission, SubmissionBatch, SubmissionBatchData, SubmissionData, SubmissionDataRequest, Template, UpdateDataRequestResponse, UpdateSubmissionDataRequestData, UpdateTemplateData, UpdateTemplateResponse) {
30+
}(this, function(ApiClient, AddFieldsData, AddFieldsTemplateResponse, AuthenticationError, AuthenticationSuccessResponse, CombinePdfsData, CombinedSubmission, CombinedSubmissionData, CopyTemplateData, CreateCombinedSubmissionResponse, CreateCustomFileData, CreateCustomFileResponse, CreateFolderData, CreateHtmlTemplateData, CreateSubmissionBatchResponse, CreateSubmissionDataRequestTokenResponse, CreateSubmissionResponse, CreateTemplateFromUploadData, Error, Folder, InvalidRequest, MoveFolderData, MoveTemplateData, PendingTemplate, RenameFolderData, Submission, SubmissionBatch, SubmissionBatchData, SubmissionData, SubmissionDataRequest, Template, UpdateDataRequestResponse, UpdateSubmissionDataRequestData, UpdateTemplateData, UpdateTemplateResponse) {
3131
'use strict';
3232

3333
/**
3434
* PDF service.
3535
* @module api/PDFApi
36-
* @version 1.3.0
36+
* @version 1.3.1
3737
*/
3838

3939
/**
@@ -291,6 +291,59 @@
291291
);
292292
}
293293

294+
/**
295+
* Callback function to receive the result of the copyTemplate operation.
296+
* @callback module:api/PDFApi~copyTemplateCallback
297+
* @param {String} error Error message, if any.
298+
* @param {module:model/Template} data The data returned by the service call.
299+
* @param {String} response The complete HTTP response.
300+
*/
301+
302+
/**
303+
* Copy a Template
304+
* @param {String} templateId
305+
* @param {module:model/CopyTemplateData} copyTemplateData
306+
* @param {module:api/PDFApi~copyTemplateCallback} callback The callback function, accepting three arguments: error, data, response
307+
* data is of type: {@link module:model/Template}
308+
*/
309+
this.copyTemplate = function(templateId, copyTemplateData, callback) {
310+
var postBody = copyTemplateData;
311+
312+
// verify the required parameter 'templateId' is set
313+
if (templateId === undefined || templateId === null) {
314+
throw new Error("Missing the required parameter 'templateId' when calling copyTemplate");
315+
}
316+
317+
// verify the required parameter 'copyTemplateData' is set
318+
if (copyTemplateData === undefined || copyTemplateData === null) {
319+
throw new Error("Missing the required parameter 'copyTemplateData' when calling copyTemplate");
320+
}
321+
322+
323+
var pathParams = {
324+
'template_id': templateId
325+
};
326+
var queryParams = {
327+
};
328+
var collectionQueryParams = {
329+
};
330+
var headerParams = {
331+
};
332+
var formParams = {
333+
};
334+
335+
var authNames = ['api_token_basic'];
336+
var contentTypes = ['application/json'];
337+
var accepts = ['application/json'];
338+
var returnType = Template;
339+
340+
return this.apiClient.callApi(
341+
'/templates/{template_id}/copy', 'POST',
342+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
343+
authNames, contentTypes, accepts, returnType, callback
344+
);
345+
}
346+
294347
/**
295348
* Callback function to receive the result of the createCustomFileFromUpload operation.
296349
* @callback module:api/PDFApi~createCustomFileFromUploadCallback

0 commit comments

Comments
 (0)