docspring 1.3.0 → 1.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +12 -0
- package/LICENSE +1 -1
- package/README.md +10 -2
- package/docs/CombinePdfsData.md +1 -0
- package/docs/CombinedSubmission.md +1 -0
- package/docs/CombinedSubmissionData.md +1 -0
- package/docs/CopyTemplateData.md +9 -0
- package/docs/FullTemplate.md +59 -0
- package/docs/FullTemplateDefaults.md +10 -0
- package/docs/ListSubmissionsResponse.md +10 -0
- package/docs/MoveTemplateData.md +1 -1
- package/docs/PDFApi.md +223 -3
- package/docs/SubmissionData.md +1 -0
- package/docs/SubmissionDataRequest.md +1 -0
- package/docs/TemplatestemplateIdaddFieldsFields.md +1 -0
- package/package.json +1 -1
- package/src/ApiClient.js +1 -1
- package/src/api/PDFApi.js +221 -6
- package/src/index.js +24 -4
- package/src/model/AddFieldsData.js +1 -1
- package/src/model/AddFieldsTemplateResponse.js +1 -1
- package/src/model/AuthenticationError.js +1 -1
- package/src/model/AuthenticationSuccessResponse.js +1 -1
- package/src/model/CombinePdfsData.js +9 -1
- package/src/model/CombinedSubmission.js +9 -1
- package/src/model/CombinedSubmissionAction.js +1 -1
- package/src/model/CombinedSubmissionData.js +9 -1
- package/src/model/CopyTemplateData.js +90 -0
- package/src/model/CreateCombinedSubmissionResponse.js +1 -1
- package/src/model/CreateCustomFileData.js +1 -1
- package/src/model/CreateCustomFileResponse.js +1 -1
- package/src/model/CreateFolderData.js +1 -1
- package/src/model/CreateHtmlTemplateData.js +1 -1
- package/src/model/CreateSubmissionBatchResponse.js +1 -1
- package/src/model/CreateSubmissionBatchSubmissionsResponse.js +1 -1
- package/src/model/CreateSubmissionDataRequestData.js +1 -1
- package/src/model/CreateSubmissionDataRequestTokenResponse.js +1 -1
- package/src/model/CreateSubmissionDataRequestTokenResponseToken.js +1 -1
- package/src/model/CreateSubmissionResponse.js +1 -1
- package/src/model/CreateTemplateFromUploadData.js +1 -1
- package/src/model/CustomFile.js +1 -1
- package/src/model/Error.js +1 -1
- package/src/model/Folder.js +1 -1
- package/src/model/FoldersFolder.js +1 -1
- package/src/model/FullTemplate.js +407 -0
- package/src/model/FullTemplateDefaults.js +97 -0
- package/src/model/HtmlTemplateData.js +1 -1
- package/src/model/InvalidRequest.js +1 -1
- package/src/model/ListSubmissionsResponse.js +97 -0
- package/src/model/MoveFolderData.js +1 -1
- package/src/model/MoveTemplateData.js +4 -3
- package/src/model/PendingTemplate.js +1 -1
- package/src/model/RenameFolderData.js +1 -1
- package/src/model/Submission.js +1 -1
- package/src/model/SubmissionAction.js +1 -1
- package/src/model/SubmissionBatch.js +1 -1
- package/src/model/SubmissionBatchData.js +1 -1
- package/src/model/SubmissionData.js +9 -1
- package/src/model/SubmissionDataBatchRequest.js +1 -1
- package/src/model/SubmissionDataRequest.js +11 -2
- package/src/model/Template.js +1 -1
- package/src/model/TemplateData.js +1 -1
- package/src/model/TemplatestemplateIdaddFieldsFields.js +9 -1
- package/src/model/UpdateDataRequestResponse.js +1 -1
- package/src/model/UpdateSubmissionDataRequestData.js +1 -1
- package/src/model/UpdateTemplateData.js +1 -1
- package/src/model/UpdateTemplateResponse.js +1 -1
- package/src/model/UploadTemplateData.js +1 -1
- package/src/model/UploadTemplateDataDocument.js +1 -1
- package/src/model/UploadTemplateDataDocumentMetadata.js +1 -1
- package/test/api/ClientIntegration.spec.js +18 -2
- package/test/api/PDFApi.spec.js.original +40 -0
- package/test/model/CombinePdfsData.spec.js +6 -0
- package/test/model/CombinedSubmission.spec.js +6 -0
- package/test/model/CombinedSubmissionData.spec.js +6 -0
- package/test/model/CopyTemplateData.spec.js +73 -0
- package/test/model/FullTemplate.spec.js +295 -0
- package/test/model/FullTemplateDefaults.spec.js +79 -0
- package/test/model/ListSubmissionsResponse.spec.js +79 -0
- package/test/model/SubmissionData.spec.js +6 -0
- package/test/model/SubmissionDataRequest.spec.js +6 -0
- package/test/model/TemplatestemplateIdaddFieldsFields.spec.js +6 -0
- package/yarn.lock +263 -0
package/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,15 @@
|
|
|
1
|
+
### 1.4.0 [March 22, 2022]
|
|
2
|
+
|
|
3
|
+
- Renamed "Template1" model to "FullTemplate" since it includes all properties
|
|
4
|
+
|
|
5
|
+
### 1.3.2 [November 28, 2021]
|
|
6
|
+
|
|
7
|
+
- Added 'password' parameter to Generate PDF and Combine PDF API endpoints. You can now encrypt each generated PDF with a unique password.
|
|
8
|
+
|
|
9
|
+
### 1.3.1 [November 19, 2020]
|
|
10
|
+
|
|
11
|
+
- Added "sort_order" property for Submission Data Requests
|
|
12
|
+
|
|
1
13
|
### 1.3.0 [September 26, 2020]
|
|
2
14
|
|
|
3
15
|
- Updated OpenAPI Generator to v3.3.0
|
package/LICENSE
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
Copyright © 2018
|
|
1
|
+
Copyright © 2018-2020 DocSpring, Inc.
|
|
2
2
|
|
|
3
3
|
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:
|
|
4
4
|
|
package/README.md
CHANGED
|
@@ -5,7 +5,7 @@ DocSpring is a service that helps you fill out and sign PDF templates.
|
|
|
5
5
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
6
6
|
|
|
7
7
|
- API version: v1
|
|
8
|
-
- Package version: 1.
|
|
8
|
+
- Package version: 1.4.0
|
|
9
9
|
- Build package: com.docspring.codegen.DocSpringJavascriptClientCodegen
|
|
10
10
|
|
|
11
11
|
## Installation
|
|
@@ -128,6 +128,7 @@ Class | Method | HTTP request | Description
|
|
|
128
128
|
*DocSpring.PDFApi* | [**batchGeneratePdfs**](docs/PDFApi.md#batchGeneratePdfs) | **POST** /submissions/batches | Generates multiple PDFs
|
|
129
129
|
*DocSpring.PDFApi* | [**combinePdfs**](docs/PDFApi.md#combinePdfs) | **POST** /combined_submissions?v=2 | Merge submission PDFs, template PDFs, or custom files
|
|
130
130
|
*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
|
|
131
132
|
*DocSpring.PDFApi* | [**createCustomFileFromUpload**](docs/PDFApi.md#createCustomFileFromUpload) | **POST** /custom_files | Create a new custom file from a cached presign upload
|
|
132
133
|
*DocSpring.PDFApi* | [**createDataRequestToken**](docs/PDFApi.md#createDataRequestToken) | **POST** /data_requests/{data_request_id}/tokens | Creates a new data request token for form authentication
|
|
133
134
|
*DocSpring.PDFApi* | [**createFolder**](docs/PDFApi.md#createFolder) | **POST** /folders/ | Create a folder
|
|
@@ -140,12 +141,15 @@ Class | Method | HTTP request | Description
|
|
|
140
141
|
*DocSpring.PDFApi* | [**generatePDF**](docs/PDFApi.md#generatePDF) | **POST** /templates/{template_id}/submissions | Generates a new PDF
|
|
141
142
|
*DocSpring.PDFApi* | [**getCombinedSubmission**](docs/PDFApi.md#getCombinedSubmission) | **GET** /combined_submissions/{combined_submission_id} | Check the status of a combined submission (merged PDFs)
|
|
142
143
|
*DocSpring.PDFApi* | [**getDataRequest**](docs/PDFApi.md#getDataRequest) | **GET** /data_requests/{data_request_id} | Look up a submission data request
|
|
144
|
+
*DocSpring.PDFApi* | [**getFullTemplate**](docs/PDFApi.md#getFullTemplate) | **GET** /templates/{template_id}?full=true | Fetch the full template attributes
|
|
143
145
|
*DocSpring.PDFApi* | [**getPresignUrl**](docs/PDFApi.md#getPresignUrl) | **GET** /uploads/presign | Get a presigned URL so that you can upload a file to our AWS S3 bucket
|
|
144
146
|
*DocSpring.PDFApi* | [**getSubmission**](docs/PDFApi.md#getSubmission) | **GET** /submissions/{submission_id} | Check the status of a PDF
|
|
145
147
|
*DocSpring.PDFApi* | [**getSubmissionBatch**](docs/PDFApi.md#getSubmissionBatch) | **GET** /submissions/batches/{submission_batch_id} | Check the status of a submission batch job
|
|
146
|
-
*DocSpring.PDFApi* | [**getTemplate**](docs/PDFApi.md#getTemplate) | **GET** /templates/{template_id} |
|
|
148
|
+
*DocSpring.PDFApi* | [**getTemplate**](docs/PDFApi.md#getTemplate) | **GET** /templates/{template_id} | Check the status of an uploaded template
|
|
147
149
|
*DocSpring.PDFApi* | [**getTemplateSchema**](docs/PDFApi.md#getTemplateSchema) | **GET** /templates/{template_id}/schema | Fetch the JSON schema for a template
|
|
148
150
|
*DocSpring.PDFApi* | [**listFolders**](docs/PDFApi.md#listFolders) | **GET** /folders/ | Get a list of all folders
|
|
151
|
+
*DocSpring.PDFApi* | [**listSubmissions**](docs/PDFApi.md#listSubmissions) | **GET** /submissions | List all submissions
|
|
152
|
+
*DocSpring.PDFApi* | [**listSubmissions_0**](docs/PDFApi.md#listSubmissions_0) | **GET** /templates/{template_id}/submissions | List all submissions for a given template
|
|
149
153
|
*DocSpring.PDFApi* | [**listTemplates**](docs/PDFApi.md#listTemplates) | **GET** /templates | Get a list of all templates
|
|
150
154
|
*DocSpring.PDFApi* | [**moveFolderToFolder**](docs/PDFApi.md#moveFolderToFolder) | **POST** /folders/{folder_id}/move | Move a folder
|
|
151
155
|
*DocSpring.PDFApi* | [**moveTemplateToFolder**](docs/PDFApi.md#moveTemplateToFolder) | **POST** /templates/{template_id}/move | Move Template to folder
|
|
@@ -165,6 +169,7 @@ Class | Method | HTTP request | Description
|
|
|
165
169
|
- [DocSpring.CombinedSubmission](docs/CombinedSubmission.md)
|
|
166
170
|
- [DocSpring.CombinedSubmissionAction](docs/CombinedSubmissionAction.md)
|
|
167
171
|
- [DocSpring.CombinedSubmissionData](docs/CombinedSubmissionData.md)
|
|
172
|
+
- [DocSpring.CopyTemplateData](docs/CopyTemplateData.md)
|
|
168
173
|
- [DocSpring.CreateCombinedSubmissionResponse](docs/CreateCombinedSubmissionResponse.md)
|
|
169
174
|
- [DocSpring.CreateCustomFileData](docs/CreateCustomFileData.md)
|
|
170
175
|
- [DocSpring.CreateCustomFileResponse](docs/CreateCustomFileResponse.md)
|
|
@@ -181,8 +186,11 @@ Class | Method | HTTP request | Description
|
|
|
181
186
|
- [DocSpring.Error](docs/Error.md)
|
|
182
187
|
- [DocSpring.Folder](docs/Folder.md)
|
|
183
188
|
- [DocSpring.FoldersFolder](docs/FoldersFolder.md)
|
|
189
|
+
- [DocSpring.FullTemplate](docs/FullTemplate.md)
|
|
190
|
+
- [DocSpring.FullTemplateDefaults](docs/FullTemplateDefaults.md)
|
|
184
191
|
- [DocSpring.HtmlTemplateData](docs/HtmlTemplateData.md)
|
|
185
192
|
- [DocSpring.InvalidRequest](docs/InvalidRequest.md)
|
|
193
|
+
- [DocSpring.ListSubmissionsResponse](docs/ListSubmissionsResponse.md)
|
|
186
194
|
- [DocSpring.MoveFolderData](docs/MoveFolderData.md)
|
|
187
195
|
- [DocSpring.MoveTemplateData](docs/MoveTemplateData.md)
|
|
188
196
|
- [DocSpring.PendingTemplate](docs/PendingTemplate.md)
|
package/docs/CombinePdfsData.md
CHANGED
|
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
|
|
|
6
6
|
**deleteCustomFiles** | **Boolean** | | [optional]
|
|
7
7
|
**expiresIn** | **Number** | | [optional]
|
|
8
8
|
**metadata** | **Object** | | [optional]
|
|
9
|
+
**password** | **String** | | [optional]
|
|
9
10
|
**sourcePdfs** | **[Object]** | |
|
|
10
11
|
**test** | **Boolean** | | [optional]
|
|
11
12
|
|
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**metadata** | **Object** | | [optional]
|
|
7
|
+
**password** | **String** | | [optional]
|
|
7
8
|
**expired** | **Boolean** | | [optional]
|
|
8
9
|
**expiresAt** | **String** | | [optional]
|
|
9
10
|
**sourcePdfs** | **[Object]** | | [optional]
|
|
@@ -5,6 +5,7 @@ Name | Type | Description | Notes
|
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**expiresIn** | **Number** | | [optional]
|
|
7
7
|
**metadata** | **Object** | | [optional]
|
|
8
|
+
**password** | **String** | | [optional]
|
|
8
9
|
**submissionIds** | **[String]** | |
|
|
9
10
|
**test** | **Boolean** | | [optional]
|
|
10
11
|
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
# DocSpring.FullTemplate
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**documentProcessed** | **Boolean** | | [optional]
|
|
7
|
+
**expirationInterval** | **String** | | [optional]
|
|
8
|
+
**scss** | **String** | | [optional]
|
|
9
|
+
**documentState** | **String** | | [optional]
|
|
10
|
+
**expireAfter** | **Number** | | [optional]
|
|
11
|
+
**description** | **String** | | [optional]
|
|
12
|
+
**slackWebhookUrl** | **String** | | [optional]
|
|
13
|
+
**demo** | **Boolean** | | [optional]
|
|
14
|
+
**path** | **String** | | [optional]
|
|
15
|
+
**headerHtml** | **String** | | [optional]
|
|
16
|
+
**publicWebForm** | **Boolean** | | [optional]
|
|
17
|
+
**fieldOrder** | **[[Number]]** | | [optional]
|
|
18
|
+
**permanentDocumentUrl** | **String** | | [optional]
|
|
19
|
+
**html** | **String** | | [optional]
|
|
20
|
+
**templateType** | **String** | | [optional]
|
|
21
|
+
**id** | **String** | | [optional]
|
|
22
|
+
**pageDimensions** | **[[Number]]** | | [optional]
|
|
23
|
+
**locked** | **Boolean** | | [optional]
|
|
24
|
+
**pageCount** | **Number** | | [optional]
|
|
25
|
+
**encryptPdfs** | **Boolean** | | [optional]
|
|
26
|
+
**webhookUrl** | **String** | | [optional]
|
|
27
|
+
**embedDomains** | **[String]** | | [optional]
|
|
28
|
+
**parentFolderId** | **String** | | [optional]
|
|
29
|
+
**allowAdditionalProperties** | **Boolean** | | [optional]
|
|
30
|
+
**encryptPdfsPassword** | **String** | | [optional]
|
|
31
|
+
**publicSubmissions** | **Boolean** | | [optional]
|
|
32
|
+
**sharedFieldData** | **Object** | | [optional]
|
|
33
|
+
**documentMd5** | **String** | | [optional]
|
|
34
|
+
**firstTemplate** | **Boolean** | | [optional]
|
|
35
|
+
**defaults** | [**FullTemplateDefaults**](FullTemplateDefaults.md) | | [optional]
|
|
36
|
+
**editableSubmissions** | **Boolean** | | [optional]
|
|
37
|
+
**expireSubmissions** | **Boolean** | | [optional]
|
|
38
|
+
**name** | **String** | | [optional]
|
|
39
|
+
**footerHtml** | **String** | | [optional]
|
|
40
|
+
**documentParseError** | **Boolean** | | [optional]
|
|
41
|
+
**fields** | **Object** | | [optional]
|
|
42
|
+
**documentFilename** | **String** | | [optional]
|
|
43
|
+
**redirectUrl** | **String** | | [optional]
|
|
44
|
+
**documentUrl** | **String** | | [optional]
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
<a name="ExpirationIntervalEnum"></a>
|
|
48
|
+
## Enum: ExpirationIntervalEnum
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
* `minutes` (value: `"minutes"`)
|
|
52
|
+
|
|
53
|
+
* `hours` (value: `"hours"`)
|
|
54
|
+
|
|
55
|
+
* `days` (value: `"days"`)
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# DocSpring.FullTemplateDefaults
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**color** | **String** | | [optional]
|
|
7
|
+
**fontSize** | **Number** | | [optional]
|
|
8
|
+
**typeface** | **String** | | [optional]
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# DocSpring.ListSubmissionsResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**nextCursor** | **String** | | [optional]
|
|
7
|
+
**submissions** | [**[Submission]**](Submission.md) | | [optional]
|
|
8
|
+
**limit** | **Number** | | [optional]
|
|
9
|
+
|
|
10
|
+
|
package/docs/MoveTemplateData.md
CHANGED
package/docs/PDFApi.md
CHANGED
|
@@ -9,6 +9,7 @@ Method | HTTP request | Description
|
|
|
9
9
|
[**batchGeneratePdfs**](PDFApi.md#batchGeneratePdfs) | **POST** /submissions/batches | Generates multiple PDFs
|
|
10
10
|
[**combinePdfs**](PDFApi.md#combinePdfs) | **POST** /combined_submissions?v=2 | Merge submission PDFs, template PDFs, or custom files
|
|
11
11
|
[**combineSubmissions**](PDFApi.md#combineSubmissions) | **POST** /combined_submissions | Merge generated PDFs together
|
|
12
|
+
[**copyTemplate**](PDFApi.md#copyTemplate) | **POST** /templates/{template_id}/copy | Copy a Template
|
|
12
13
|
[**createCustomFileFromUpload**](PDFApi.md#createCustomFileFromUpload) | **POST** /custom_files | Create a new custom file from a cached presign upload
|
|
13
14
|
[**createDataRequestToken**](PDFApi.md#createDataRequestToken) | **POST** /data_requests/{data_request_id}/tokens | Creates a new data request token for form authentication
|
|
14
15
|
[**createFolder**](PDFApi.md#createFolder) | **POST** /folders/ | Create a folder
|
|
@@ -21,12 +22,15 @@ Method | HTTP request | Description
|
|
|
21
22
|
[**generatePDF**](PDFApi.md#generatePDF) | **POST** /templates/{template_id}/submissions | Generates a new PDF
|
|
22
23
|
[**getCombinedSubmission**](PDFApi.md#getCombinedSubmission) | **GET** /combined_submissions/{combined_submission_id} | Check the status of a combined submission (merged PDFs)
|
|
23
24
|
[**getDataRequest**](PDFApi.md#getDataRequest) | **GET** /data_requests/{data_request_id} | Look up a submission data request
|
|
25
|
+
[**getFullTemplate**](PDFApi.md#getFullTemplate) | **GET** /templates/{template_id}?full=true | Fetch the full template attributes
|
|
24
26
|
[**getPresignUrl**](PDFApi.md#getPresignUrl) | **GET** /uploads/presign | Get a presigned URL so that you can upload a file to our AWS S3 bucket
|
|
25
27
|
[**getSubmission**](PDFApi.md#getSubmission) | **GET** /submissions/{submission_id} | Check the status of a PDF
|
|
26
28
|
[**getSubmissionBatch**](PDFApi.md#getSubmissionBatch) | **GET** /submissions/batches/{submission_batch_id} | Check the status of a submission batch job
|
|
27
|
-
[**getTemplate**](PDFApi.md#getTemplate) | **GET** /templates/{template_id} |
|
|
29
|
+
[**getTemplate**](PDFApi.md#getTemplate) | **GET** /templates/{template_id} | Check the status of an uploaded template
|
|
28
30
|
[**getTemplateSchema**](PDFApi.md#getTemplateSchema) | **GET** /templates/{template_id}/schema | Fetch the JSON schema for a template
|
|
29
31
|
[**listFolders**](PDFApi.md#listFolders) | **GET** /folders/ | Get a list of all folders
|
|
32
|
+
[**listSubmissions**](PDFApi.md#listSubmissions) | **GET** /submissions | List all submissions
|
|
33
|
+
[**listSubmissions_0**](PDFApi.md#listSubmissions_0) | **GET** /templates/{template_id}/submissions | List all submissions for a given template
|
|
30
34
|
[**listTemplates**](PDFApi.md#listTemplates) | **GET** /templates | Get a list of all templates
|
|
31
35
|
[**moveFolderToFolder**](PDFApi.md#moveFolderToFolder) | **POST** /folders/{folder_id}/move | Move a folder
|
|
32
36
|
[**moveTemplateToFolder**](PDFApi.md#moveTemplateToFolder) | **POST** /templates/{template_id}/move | Move Template to folder
|
|
@@ -270,6 +274,55 @@ Name | Type | Description | Notes
|
|
|
270
274
|
|
|
271
275
|
[api_token_basic](../README.md#api_token_basic)
|
|
272
276
|
|
|
277
|
+
### HTTP request headers
|
|
278
|
+
|
|
279
|
+
- **Content-Type**: application/json
|
|
280
|
+
- **Accept**: application/json
|
|
281
|
+
|
|
282
|
+
<a name="copyTemplate"></a>
|
|
283
|
+
# **copyTemplate**
|
|
284
|
+
> Template copyTemplate(templateId, copyTemplateData)
|
|
285
|
+
|
|
286
|
+
Copy a Template
|
|
287
|
+
|
|
288
|
+
### Example
|
|
289
|
+
```javascript
|
|
290
|
+
var DocSpring = require('docspring');
|
|
291
|
+
var defaultClient = DocSpring.ApiClient.instance;
|
|
292
|
+
|
|
293
|
+
// Configure HTTP basic authorization: api_token_basic
|
|
294
|
+
var api_token_basic = defaultClient.authentications['api_token_basic'];
|
|
295
|
+
api_token_basic.username = 'YOUR USERNAME';
|
|
296
|
+
api_token_basic.password = 'YOUR PASSWORD';
|
|
297
|
+
|
|
298
|
+
var apiInstance = new DocSpring.PDFApi();
|
|
299
|
+
var templateId = tpl_000000000000000001; // String |
|
|
300
|
+
var copyTemplateData = new DocSpring.CopyTemplateData(); // CopyTemplateData |
|
|
301
|
+
var callback = function(error, data, response) {
|
|
302
|
+
if (error) {
|
|
303
|
+
console.error(error);
|
|
304
|
+
} else {
|
|
305
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
306
|
+
}
|
|
307
|
+
};
|
|
308
|
+
apiInstance.copyTemplate(templateId, copyTemplateData, callback);
|
|
309
|
+
```
|
|
310
|
+
|
|
311
|
+
### Parameters
|
|
312
|
+
|
|
313
|
+
Name | Type | Description | Notes
|
|
314
|
+
------------- | ------------- | ------------- | -------------
|
|
315
|
+
**templateId** | **String**| |
|
|
316
|
+
**copyTemplateData** | [**CopyTemplateData**](CopyTemplateData.md)| |
|
|
317
|
+
|
|
318
|
+
### Return type
|
|
319
|
+
|
|
320
|
+
[**Template**](Template.md)
|
|
321
|
+
|
|
322
|
+
### Authorization
|
|
323
|
+
|
|
324
|
+
[api_token_basic](../README.md#api_token_basic)
|
|
325
|
+
|
|
273
326
|
### HTTP request headers
|
|
274
327
|
|
|
275
328
|
- **Content-Type**: application/json
|
|
@@ -842,6 +895,53 @@ Name | Type | Description | Notes
|
|
|
842
895
|
|
|
843
896
|
[api_token_basic](../README.md#api_token_basic)
|
|
844
897
|
|
|
898
|
+
### HTTP request headers
|
|
899
|
+
|
|
900
|
+
- **Content-Type**: Not defined
|
|
901
|
+
- **Accept**: application/json
|
|
902
|
+
|
|
903
|
+
<a name="getFullTemplate"></a>
|
|
904
|
+
# **getFullTemplate**
|
|
905
|
+
> FullTemplate getFullTemplate(templateId)
|
|
906
|
+
|
|
907
|
+
Fetch the full template attributes
|
|
908
|
+
|
|
909
|
+
### Example
|
|
910
|
+
```javascript
|
|
911
|
+
var DocSpring = require('docspring');
|
|
912
|
+
var defaultClient = DocSpring.ApiClient.instance;
|
|
913
|
+
|
|
914
|
+
// Configure HTTP basic authorization: api_token_basic
|
|
915
|
+
var api_token_basic = defaultClient.authentications['api_token_basic'];
|
|
916
|
+
api_token_basic.username = 'YOUR USERNAME';
|
|
917
|
+
api_token_basic.password = 'YOUR PASSWORD';
|
|
918
|
+
|
|
919
|
+
var apiInstance = new DocSpring.PDFApi();
|
|
920
|
+
var templateId = tpl_000000000000000001; // String |
|
|
921
|
+
var callback = function(error, data, response) {
|
|
922
|
+
if (error) {
|
|
923
|
+
console.error(error);
|
|
924
|
+
} else {
|
|
925
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
926
|
+
}
|
|
927
|
+
};
|
|
928
|
+
apiInstance.getFullTemplate(templateId, callback);
|
|
929
|
+
```
|
|
930
|
+
|
|
931
|
+
### Parameters
|
|
932
|
+
|
|
933
|
+
Name | Type | Description | Notes
|
|
934
|
+
------------- | ------------- | ------------- | -------------
|
|
935
|
+
**templateId** | **String**| |
|
|
936
|
+
|
|
937
|
+
### Return type
|
|
938
|
+
|
|
939
|
+
[**FullTemplate**](FullTemplate.md)
|
|
940
|
+
|
|
941
|
+
### Authorization
|
|
942
|
+
|
|
943
|
+
[api_token_basic](../README.md#api_token_basic)
|
|
944
|
+
|
|
845
945
|
### HTTP request headers
|
|
846
946
|
|
|
847
947
|
- **Content-Type**: Not defined
|
|
@@ -996,7 +1096,7 @@ Name | Type | Description | Notes
|
|
|
996
1096
|
# **getTemplate**
|
|
997
1097
|
> Template getTemplate(templateId)
|
|
998
1098
|
|
|
999
|
-
|
|
1099
|
+
Check the status of an uploaded template
|
|
1000
1100
|
|
|
1001
1101
|
### Example
|
|
1002
1102
|
```javascript
|
|
@@ -1009,7 +1109,7 @@ api_token_basic.username = 'YOUR USERNAME';
|
|
|
1009
1109
|
api_token_basic.password = 'YOUR PASSWORD';
|
|
1010
1110
|
|
|
1011
1111
|
var apiInstance = new DocSpring.PDFApi();
|
|
1012
|
-
var templateId =
|
|
1112
|
+
var templateId = tpl_000000000000000001; // String |
|
|
1013
1113
|
var callback = function(error, data, response) {
|
|
1014
1114
|
if (error) {
|
|
1015
1115
|
console.error(error);
|
|
@@ -1130,6 +1230,126 @@ Name | Type | Description | Notes
|
|
|
1130
1230
|
|
|
1131
1231
|
[api_token_basic](../README.md#api_token_basic)
|
|
1132
1232
|
|
|
1233
|
+
### HTTP request headers
|
|
1234
|
+
|
|
1235
|
+
- **Content-Type**: Not defined
|
|
1236
|
+
- **Accept**: application/json
|
|
1237
|
+
|
|
1238
|
+
<a name="listSubmissions"></a>
|
|
1239
|
+
# **listSubmissions**
|
|
1240
|
+
> ListSubmissionsResponse listSubmissions(opts)
|
|
1241
|
+
|
|
1242
|
+
List all submissions
|
|
1243
|
+
|
|
1244
|
+
### Example
|
|
1245
|
+
```javascript
|
|
1246
|
+
var DocSpring = require('docspring');
|
|
1247
|
+
var defaultClient = DocSpring.ApiClient.instance;
|
|
1248
|
+
|
|
1249
|
+
// Configure HTTP basic authorization: api_token_basic
|
|
1250
|
+
var api_token_basic = defaultClient.authentications['api_token_basic'];
|
|
1251
|
+
api_token_basic.username = 'YOUR USERNAME';
|
|
1252
|
+
api_token_basic.password = 'YOUR PASSWORD';
|
|
1253
|
+
|
|
1254
|
+
var apiInstance = new DocSpring.PDFApi();
|
|
1255
|
+
var opts = {
|
|
1256
|
+
'cursor': sub_list_000012, // String |
|
|
1257
|
+
'limit': 3, // Number |
|
|
1258
|
+
'createdAfter': 2019-01-01T09:00:00-05:00, // String |
|
|
1259
|
+
'createdBefore': 2020-01-01T09:00:00-05:00, // String |
|
|
1260
|
+
'type': test, // String |
|
|
1261
|
+
'includeData': true // Boolean |
|
|
1262
|
+
};
|
|
1263
|
+
var callback = function(error, data, response) {
|
|
1264
|
+
if (error) {
|
|
1265
|
+
console.error(error);
|
|
1266
|
+
} else {
|
|
1267
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1268
|
+
}
|
|
1269
|
+
};
|
|
1270
|
+
apiInstance.listSubmissions(opts, callback);
|
|
1271
|
+
```
|
|
1272
|
+
|
|
1273
|
+
### Parameters
|
|
1274
|
+
|
|
1275
|
+
Name | Type | Description | Notes
|
|
1276
|
+
------------- | ------------- | ------------- | -------------
|
|
1277
|
+
**cursor** | **String**| | [optional]
|
|
1278
|
+
**limit** | **Number**| | [optional]
|
|
1279
|
+
**createdAfter** | **String**| | [optional]
|
|
1280
|
+
**createdBefore** | **String**| | [optional]
|
|
1281
|
+
**type** | **String**| | [optional]
|
|
1282
|
+
**includeData** | **Boolean**| | [optional]
|
|
1283
|
+
|
|
1284
|
+
### Return type
|
|
1285
|
+
|
|
1286
|
+
[**ListSubmissionsResponse**](ListSubmissionsResponse.md)
|
|
1287
|
+
|
|
1288
|
+
### Authorization
|
|
1289
|
+
|
|
1290
|
+
[api_token_basic](../README.md#api_token_basic)
|
|
1291
|
+
|
|
1292
|
+
### HTTP request headers
|
|
1293
|
+
|
|
1294
|
+
- **Content-Type**: Not defined
|
|
1295
|
+
- **Accept**: application/json
|
|
1296
|
+
|
|
1297
|
+
<a name="listSubmissions_0"></a>
|
|
1298
|
+
# **listSubmissions_0**
|
|
1299
|
+
> ListSubmissionsResponse listSubmissions_0(templateId, opts)
|
|
1300
|
+
|
|
1301
|
+
List all submissions for a given template
|
|
1302
|
+
|
|
1303
|
+
### Example
|
|
1304
|
+
```javascript
|
|
1305
|
+
var DocSpring = require('docspring');
|
|
1306
|
+
var defaultClient = DocSpring.ApiClient.instance;
|
|
1307
|
+
|
|
1308
|
+
// Configure HTTP basic authorization: api_token_basic
|
|
1309
|
+
var api_token_basic = defaultClient.authentications['api_token_basic'];
|
|
1310
|
+
api_token_basic.username = 'YOUR USERNAME';
|
|
1311
|
+
api_token_basic.password = 'YOUR PASSWORD';
|
|
1312
|
+
|
|
1313
|
+
var apiInstance = new DocSpring.PDFApi();
|
|
1314
|
+
var templateId = tpl_000000000000000002; // String |
|
|
1315
|
+
var opts = {
|
|
1316
|
+
'cursor': "cursor_example", // String |
|
|
1317
|
+
'limit': 3.4, // Number |
|
|
1318
|
+
'createdAfter': "createdAfter_example", // String |
|
|
1319
|
+
'createdBefore': "createdBefore_example", // String |
|
|
1320
|
+
'type': "type_example", // String |
|
|
1321
|
+
'includeData': true // Boolean |
|
|
1322
|
+
};
|
|
1323
|
+
var callback = function(error, data, response) {
|
|
1324
|
+
if (error) {
|
|
1325
|
+
console.error(error);
|
|
1326
|
+
} else {
|
|
1327
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1328
|
+
}
|
|
1329
|
+
};
|
|
1330
|
+
apiInstance.listSubmissions_0(templateId, opts, callback);
|
|
1331
|
+
```
|
|
1332
|
+
|
|
1333
|
+
### Parameters
|
|
1334
|
+
|
|
1335
|
+
Name | Type | Description | Notes
|
|
1336
|
+
------------- | ------------- | ------------- | -------------
|
|
1337
|
+
**templateId** | **String**| |
|
|
1338
|
+
**cursor** | **String**| | [optional]
|
|
1339
|
+
**limit** | **Number**| | [optional]
|
|
1340
|
+
**createdAfter** | **String**| | [optional]
|
|
1341
|
+
**createdBefore** | **String**| | [optional]
|
|
1342
|
+
**type** | **String**| | [optional]
|
|
1343
|
+
**includeData** | **Boolean**| | [optional]
|
|
1344
|
+
|
|
1345
|
+
### Return type
|
|
1346
|
+
|
|
1347
|
+
[**ListSubmissionsResponse**](ListSubmissionsResponse.md)
|
|
1348
|
+
|
|
1349
|
+
### Authorization
|
|
1350
|
+
|
|
1351
|
+
[api_token_basic](../README.md#api_token_basic)
|
|
1352
|
+
|
|
1133
1353
|
### HTTP request headers
|
|
1134
1354
|
|
|
1135
1355
|
- **Content-Type**: Not defined
|
package/docs/SubmissionData.md
CHANGED
|
@@ -66,6 +66,7 @@ Name | Type | Description | Notes
|
|
|
66
66
|
**qrcodeColorFieldRequired** | **Boolean** | | [optional]
|
|
67
67
|
**currency** | **Boolean** | | [optional]
|
|
68
68
|
**falseText** | **String** | | [optional]
|
|
69
|
+
**placeholder** | **String** | | [optional]
|
|
69
70
|
**strikethrough** | **Boolean** | | [optional]
|
|
70
71
|
**characterSpacing** | **Number** | | [optional]
|
|
71
72
|
**numberConditionRangeMax** | **Number** | | [optional]
|
package/package.json
CHANGED