docspring 2.0.0 → 3.0.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/README.md +53 -46
- package/dist/ApiClient.js +3 -3
- package/dist/api/{PDFApi.js → Client.js} +534 -372
- package/dist/index.js +52 -17
- package/dist/model/AddFieldsData.js +2 -2
- package/dist/model/BatchGeneratePdfs201Response.js +7 -7
- package/dist/model/CombinePdfsData.js +7 -7
- package/dist/model/CombinedSubmission.js +21 -21
- package/dist/model/CombinedSubmissionAction.js +13 -13
- package/dist/model/CopyTemplateOptions.js +7 -7
- package/dist/model/CreateCombinedSubmissionResponse.js +7 -7
- package/dist/model/CreateCustomFileData.js +7 -7
- package/dist/model/CreateCustomFileResponse.js +7 -7
- package/dist/model/CreateFolderData.js +2 -2
- package/dist/model/CreateHtmlTemplate.js +2 -2
- package/dist/model/CreatePdfSubmissionData.js +14 -2
- package/dist/model/CreatePdfTemplate.js +2 -2
- package/dist/model/CreateSubmissionDataRequestData.js +106 -2
- package/dist/model/CreateSubmissionDataRequestEventRequest.js +31 -7
- package/dist/model/CreateSubmissionDataRequestEventResponse.js +2 -2
- package/dist/model/CreateSubmissionDataRequestResponse.js +7 -7
- package/dist/model/CreateSubmissionDataRequestTokenResponse.js +2 -2
- package/dist/model/CreateSubmissionResponse.js +2 -2
- package/dist/model/CustomFile.js +2 -2
- package/dist/model/ErrorOrMultipleErrorsResponse.js +151 -0
- package/dist/model/ErrorResponse.js +2 -2
- package/dist/model/Folder.js +7 -7
- package/dist/model/JsonSchema.js +2 -2
- package/dist/model/ListSubmissionsResponse.js +7 -7
- package/dist/model/MoveFolderData.js +2 -2
- package/dist/model/MoveTemplateData.js +7 -7
- package/dist/model/MultipleErrorsResponse.js +2 -2
- package/dist/model/PublishVersionData.js +124 -0
- package/dist/model/RenameFolderData.js +2 -2
- package/dist/model/RestoreVersionData.js +112 -0
- package/dist/model/Submission.js +78 -32
- package/dist/model/Submission422Response.js +165 -0
- package/dist/model/SubmissionAction.js +13 -13
- package/dist/model/SubmissionBatch.js +15 -15
- package/dist/model/SubmissionBatchData.js +26 -2
- package/dist/model/SubmissionBatchWithSubmissions.js +15 -15
- package/dist/model/SubmissionDataRequest.js +31 -31
- package/dist/model/SubmissionDataRequestEvent.js +17 -17
- package/dist/model/SubmissionDataRequestShow.js +33 -33
- package/dist/model/SubmissionDataRequestToken.js +9 -9
- package/dist/model/SubmissionPreview.js +78 -32
- package/dist/model/SuccessErrorResponse.js +2 -2
- package/dist/model/SuccessMultipleErrorsResponse.js +2 -2
- package/dist/model/Template.js +194 -78
- package/dist/model/TemplateAddFieldsResponse.js +2 -2
- package/dist/model/TemplateDeleteResponse.js +166 -0
- package/dist/model/TemplatePreview.js +168 -66
- package/dist/model/{CombinedSubmissionData.js → TemplatePublishVersionResponse.js} +56 -52
- package/dist/model/UpdateHtmlTemplate.js +2 -2
- package/dist/model/UpdatePdfTemplate.js +108 -0
- package/dist/model/UpdateSubmissionDataRequestData.js +153 -2
- package/dist/model/UploadPresignResponse.js +2 -2
- package/package.json +1 -1
- package/dist/model/CreateHtmlSubmissionData.js +0 -161
package/README.md
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
# docspring
|
|
2
2
|
|
|
3
3
|
DocSpring - JavaScript client for docspring
|
|
4
|
-
DocSpring
|
|
4
|
+
Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
|
|
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:
|
|
9
|
-
- Generator version: 7.
|
|
8
|
+
- Package version: 3.0.0
|
|
9
|
+
- Generator version: 7.16.0-DOCSPRING
|
|
10
10
|
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
|
|
11
11
|
|
|
12
12
|
## Installation
|
|
@@ -107,8 +107,8 @@ var api_token_basic = defaultClient.authentications['api_token_basic'];
|
|
|
107
107
|
api_token_basic.username = 'YOUR USERNAME'
|
|
108
108
|
api_token_basic.password = 'YOUR PASSWORD'
|
|
109
109
|
|
|
110
|
-
var api = new DocSpring.
|
|
111
|
-
var
|
|
110
|
+
var api = new DocSpring.Client()
|
|
111
|
+
var template_id = "tpl_1234567890abcdef02"; // {String}
|
|
112
112
|
var data = new DocSpring.AddFieldsData(); // {AddFieldsData}
|
|
113
113
|
var callback = function(error, data, response) {
|
|
114
114
|
if (error) {
|
|
@@ -117,7 +117,7 @@ var callback = function(error, data, response) {
|
|
|
117
117
|
console.log('API called successfully. Returned data: ' + data);
|
|
118
118
|
}
|
|
119
119
|
};
|
|
120
|
-
api.addFieldsToTemplate(
|
|
120
|
+
api.addFieldsToTemplate(template_id, data, callback);
|
|
121
121
|
|
|
122
122
|
```
|
|
123
123
|
|
|
@@ -127,44 +127,46 @@ All URIs are relative to *https://sync.api.docspring.com/api/v1*
|
|
|
127
127
|
|
|
128
128
|
Class | Method | HTTP request | Description
|
|
129
129
|
------------ | ------------- | ------------- | -------------
|
|
130
|
-
*DocSpring.
|
|
131
|
-
*DocSpring.
|
|
132
|
-
*DocSpring.
|
|
133
|
-
*DocSpring.
|
|
134
|
-
*DocSpring.
|
|
135
|
-
*DocSpring.
|
|
136
|
-
*DocSpring.
|
|
137
|
-
*DocSpring.
|
|
138
|
-
*DocSpring.
|
|
139
|
-
*DocSpring.
|
|
140
|
-
*DocSpring.
|
|
141
|
-
*DocSpring.
|
|
142
|
-
*DocSpring.
|
|
143
|
-
*DocSpring.
|
|
144
|
-
*DocSpring.
|
|
145
|
-
*DocSpring.
|
|
146
|
-
*DocSpring.
|
|
147
|
-
*DocSpring.
|
|
148
|
-
*DocSpring.
|
|
149
|
-
*DocSpring.
|
|
150
|
-
*DocSpring.
|
|
151
|
-
*DocSpring.
|
|
152
|
-
*DocSpring.
|
|
153
|
-
*DocSpring.
|
|
154
|
-
*DocSpring.
|
|
155
|
-
*DocSpring.
|
|
156
|
-
*DocSpring.
|
|
157
|
-
*DocSpring.
|
|
158
|
-
*DocSpring.
|
|
159
|
-
*DocSpring.
|
|
160
|
-
*DocSpring.
|
|
161
|
-
*DocSpring.
|
|
162
|
-
*DocSpring.
|
|
163
|
-
*DocSpring.
|
|
164
|
-
*DocSpring.
|
|
165
|
-
*DocSpring.
|
|
166
|
-
*DocSpring.
|
|
167
|
-
*DocSpring.
|
|
130
|
+
*DocSpring.Client* | [**addFieldsToTemplate**](docs/Client.md#addFieldsToTemplate) | **PUT** /templates/{template_id}/add_fields | Add new fields to a Template
|
|
131
|
+
*DocSpring.Client* | [**batchGeneratePdfs**](docs/Client.md#batchGeneratePdfs) | **POST** /submissions/batches | Generate multiple PDFs
|
|
132
|
+
*DocSpring.Client* | [**combinePdfs**](docs/Client.md#combinePdfs) | **POST** /combined_submissions | Merge submission PDFs, template PDFs, or custom files
|
|
133
|
+
*DocSpring.Client* | [**copyTemplate**](docs/Client.md#copyTemplate) | **POST** /templates/{template_id}/copy | Copy a template
|
|
134
|
+
*DocSpring.Client* | [**createCustomFileFromUpload**](docs/Client.md#createCustomFileFromUpload) | **POST** /custom_files | Create a new custom file from a cached S3 upload
|
|
135
|
+
*DocSpring.Client* | [**createDataRequestEvent**](docs/Client.md#createDataRequestEvent) | **POST** /data_requests/{data_request_id}/events | Create a new event for emailing a signee a request for signature
|
|
136
|
+
*DocSpring.Client* | [**createDataRequestToken**](docs/Client.md#createDataRequestToken) | **POST** /data_requests/{data_request_id}/tokens | Create a new data request token for form authentication
|
|
137
|
+
*DocSpring.Client* | [**createFolder**](docs/Client.md#createFolder) | **POST** /folders/ | Create a folder
|
|
138
|
+
*DocSpring.Client* | [**createHtmlTemplate**](docs/Client.md#createHtmlTemplate) | **POST** /templates?endpoint_variant=create_html_template | Create a new HTML template
|
|
139
|
+
*DocSpring.Client* | [**createPdfTemplate**](docs/Client.md#createPdfTemplate) | **POST** /templates | Create a new PDF template with a form POST file upload
|
|
140
|
+
*DocSpring.Client* | [**createPdfTemplateFromUpload**](docs/Client.md#createPdfTemplateFromUpload) | **POST** /templates?endpoint_variant=create_template_from_cached_upload | Create a new PDF template from a cached S3 file upload
|
|
141
|
+
*DocSpring.Client* | [**deleteFolder**](docs/Client.md#deleteFolder) | **DELETE** /folders/{folder_id} | Delete a folder
|
|
142
|
+
*DocSpring.Client* | [**deleteTemplate**](docs/Client.md#deleteTemplate) | **DELETE** /templates/{template_id} | Delete a template
|
|
143
|
+
*DocSpring.Client* | [**expireCombinedSubmission**](docs/Client.md#expireCombinedSubmission) | **DELETE** /combined_submissions/{combined_submission_id} | Expire a combined submission
|
|
144
|
+
*DocSpring.Client* | [**expireSubmission**](docs/Client.md#expireSubmission) | **DELETE** /submissions/{submission_id} | Expire a PDF submission
|
|
145
|
+
*DocSpring.Client* | [**generatePdf**](docs/Client.md#generatePdf) | **POST** /templates/{template_id}/submissions | Generate a PDF
|
|
146
|
+
*DocSpring.Client* | [**generatePreview**](docs/Client.md#generatePreview) | **POST** /submissions/{submission_id}/generate_preview | Generate a preview PDF for partially completed data requests
|
|
147
|
+
*DocSpring.Client* | [**getCombinedSubmission**](docs/Client.md#getCombinedSubmission) | **GET** /combined_submissions/{combined_submission_id} | Check the status of a combined submission (merged PDFs)
|
|
148
|
+
*DocSpring.Client* | [**getDataRequest**](docs/Client.md#getDataRequest) | **GET** /data_requests/{data_request_id} | Look up a submission data request
|
|
149
|
+
*DocSpring.Client* | [**getFullTemplate**](docs/Client.md#getFullTemplate) | **GET** /templates/{template_id}?full=true | Fetch the full attributes for a PDF template
|
|
150
|
+
*DocSpring.Client* | [**getPresignUrl**](docs/Client.md#getPresignUrl) | **GET** /uploads/presign | Get a presigned S3 URL for direct file upload
|
|
151
|
+
*DocSpring.Client* | [**getSubmission**](docs/Client.md#getSubmission) | **GET** /submissions/{submission_id} | Check the status of a PDF
|
|
152
|
+
*DocSpring.Client* | [**getSubmissionBatch**](docs/Client.md#getSubmissionBatch) | **GET** /submissions/batches/{submission_batch_id} | Check the status of a submission batch job
|
|
153
|
+
*DocSpring.Client* | [**getTemplate**](docs/Client.md#getTemplate) | **GET** /templates/{template_id} | Check the status of an uploaded template
|
|
154
|
+
*DocSpring.Client* | [**getTemplateSchema**](docs/Client.md#getTemplateSchema) | **GET** /templates/{template_id}/schema | Fetch the JSON schema for a template
|
|
155
|
+
*DocSpring.Client* | [**listCombinedSubmissions**](docs/Client.md#listCombinedSubmissions) | **GET** /combined_submissions | Get a list of all combined submissions
|
|
156
|
+
*DocSpring.Client* | [**listFolders**](docs/Client.md#listFolders) | **GET** /folders/ | Get a list of all folders
|
|
157
|
+
*DocSpring.Client* | [**listSubmissions**](docs/Client.md#listSubmissions) | **GET** /submissions | List all submissions
|
|
158
|
+
*DocSpring.Client* | [**listTemplateSubmissions**](docs/Client.md#listTemplateSubmissions) | **GET** /templates/{template_id}/submissions | List all submissions for a given template
|
|
159
|
+
*DocSpring.Client* | [**listTemplates**](docs/Client.md#listTemplates) | **GET** /templates | Get a list of all templates
|
|
160
|
+
*DocSpring.Client* | [**moveFolderToFolder**](docs/Client.md#moveFolderToFolder) | **POST** /folders/{folder_id}/move | Move a folder
|
|
161
|
+
*DocSpring.Client* | [**moveTemplateToFolder**](docs/Client.md#moveTemplateToFolder) | **POST** /templates/{template_id}/move | Move Template to folder
|
|
162
|
+
*DocSpring.Client* | [**publishTemplateVersion**](docs/Client.md#publishTemplateVersion) | **POST** /templates/{template_id}/publish_version | Publish a template version
|
|
163
|
+
*DocSpring.Client* | [**renameFolder**](docs/Client.md#renameFolder) | **POST** /folders/{folder_id}/rename | Rename a folder
|
|
164
|
+
*DocSpring.Client* | [**restoreTemplateVersion**](docs/Client.md#restoreTemplateVersion) | **POST** /templates/{template_id}/restore_version | Restore a template version
|
|
165
|
+
*DocSpring.Client* | [**testAuthentication**](docs/Client.md#testAuthentication) | **GET** /authentication | Test authentication
|
|
166
|
+
*DocSpring.Client* | [**updateDataRequest**](docs/Client.md#updateDataRequest) | **PUT** /data_requests/{data_request_id} | Update a submission data request
|
|
167
|
+
*DocSpring.Client* | [**updateTemplate**](docs/Client.md#updateTemplate) | **PUT** /templates/{template_id} | Update a Template
|
|
168
|
+
*DocSpring.Client* | [**updateTemplateDocument**](docs/Client.md#updateTemplateDocument) | **PUT** /templates/{template_id}?endpoint_variant=update_template_pdf_with_form_post | Update a template's document with a form POST file upload
|
|
169
|
+
*DocSpring.Client* | [**updateTemplateDocumentFromUpload**](docs/Client.md#updateTemplateDocumentFromUpload) | **PUT** /templates/{template_id}?endpoint_variant=update_template_pdf_with_cached_upload | Update a template's document with a cached S3 file upload
|
|
168
170
|
|
|
169
171
|
|
|
170
172
|
## Documentation for Models
|
|
@@ -174,13 +176,11 @@ Class | Method | HTTP request | Description
|
|
|
174
176
|
- [DocSpring.CombinePdfsData](docs/CombinePdfsData.md)
|
|
175
177
|
- [DocSpring.CombinedSubmission](docs/CombinedSubmission.md)
|
|
176
178
|
- [DocSpring.CombinedSubmissionAction](docs/CombinedSubmissionAction.md)
|
|
177
|
-
- [DocSpring.CombinedSubmissionData](docs/CombinedSubmissionData.md)
|
|
178
179
|
- [DocSpring.CopyTemplateOptions](docs/CopyTemplateOptions.md)
|
|
179
180
|
- [DocSpring.CreateCombinedSubmissionResponse](docs/CreateCombinedSubmissionResponse.md)
|
|
180
181
|
- [DocSpring.CreateCustomFileData](docs/CreateCustomFileData.md)
|
|
181
182
|
- [DocSpring.CreateCustomFileResponse](docs/CreateCustomFileResponse.md)
|
|
182
183
|
- [DocSpring.CreateFolderData](docs/CreateFolderData.md)
|
|
183
|
-
- [DocSpring.CreateHtmlSubmissionData](docs/CreateHtmlSubmissionData.md)
|
|
184
184
|
- [DocSpring.CreateHtmlTemplate](docs/CreateHtmlTemplate.md)
|
|
185
185
|
- [DocSpring.CreatePdfSubmissionData](docs/CreatePdfSubmissionData.md)
|
|
186
186
|
- [DocSpring.CreatePdfTemplate](docs/CreatePdfTemplate.md)
|
|
@@ -191,6 +191,7 @@ Class | Method | HTTP request | Description
|
|
|
191
191
|
- [DocSpring.CreateSubmissionDataRequestTokenResponse](docs/CreateSubmissionDataRequestTokenResponse.md)
|
|
192
192
|
- [DocSpring.CreateSubmissionResponse](docs/CreateSubmissionResponse.md)
|
|
193
193
|
- [DocSpring.CustomFile](docs/CustomFile.md)
|
|
194
|
+
- [DocSpring.ErrorOrMultipleErrorsResponse](docs/ErrorOrMultipleErrorsResponse.md)
|
|
194
195
|
- [DocSpring.ErrorResponse](docs/ErrorResponse.md)
|
|
195
196
|
- [DocSpring.Folder](docs/Folder.md)
|
|
196
197
|
- [DocSpring.JsonSchema](docs/JsonSchema.md)
|
|
@@ -198,8 +199,11 @@ Class | Method | HTTP request | Description
|
|
|
198
199
|
- [DocSpring.MoveFolderData](docs/MoveFolderData.md)
|
|
199
200
|
- [DocSpring.MoveTemplateData](docs/MoveTemplateData.md)
|
|
200
201
|
- [DocSpring.MultipleErrorsResponse](docs/MultipleErrorsResponse.md)
|
|
202
|
+
- [DocSpring.PublishVersionData](docs/PublishVersionData.md)
|
|
201
203
|
- [DocSpring.RenameFolderData](docs/RenameFolderData.md)
|
|
204
|
+
- [DocSpring.RestoreVersionData](docs/RestoreVersionData.md)
|
|
202
205
|
- [DocSpring.Submission](docs/Submission.md)
|
|
206
|
+
- [DocSpring.Submission422Response](docs/Submission422Response.md)
|
|
203
207
|
- [DocSpring.SubmissionAction](docs/SubmissionAction.md)
|
|
204
208
|
- [DocSpring.SubmissionBatch](docs/SubmissionBatch.md)
|
|
205
209
|
- [DocSpring.SubmissionBatchData](docs/SubmissionBatchData.md)
|
|
@@ -213,8 +217,11 @@ Class | Method | HTTP request | Description
|
|
|
213
217
|
- [DocSpring.SuccessMultipleErrorsResponse](docs/SuccessMultipleErrorsResponse.md)
|
|
214
218
|
- [DocSpring.Template](docs/Template.md)
|
|
215
219
|
- [DocSpring.TemplateAddFieldsResponse](docs/TemplateAddFieldsResponse.md)
|
|
220
|
+
- [DocSpring.TemplateDeleteResponse](docs/TemplateDeleteResponse.md)
|
|
216
221
|
- [DocSpring.TemplatePreview](docs/TemplatePreview.md)
|
|
222
|
+
- [DocSpring.TemplatePublishVersionResponse](docs/TemplatePublishVersionResponse.md)
|
|
217
223
|
- [DocSpring.UpdateHtmlTemplate](docs/UpdateHtmlTemplate.md)
|
|
224
|
+
- [DocSpring.UpdatePdfTemplate](docs/UpdatePdfTemplate.md)
|
|
218
225
|
- [DocSpring.UpdateSubmissionDataRequestData](docs/UpdateSubmissionDataRequestData.md)
|
|
219
226
|
- [DocSpring.UploadPresignResponse](docs/UploadPresignResponse.md)
|
|
220
227
|
|
package/dist/ApiClient.js
CHANGED
|
@@ -13,7 +13,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
|
|
|
13
13
|
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
14
14
|
function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
|
|
15
15
|
* DocSpring API
|
|
16
|
-
* DocSpring
|
|
16
|
+
* Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
|
|
17
17
|
*
|
|
18
18
|
* The version of the OpenAPI document: v1
|
|
19
19
|
*
|
|
@@ -25,7 +25,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
|
|
|
25
25
|
*/
|
|
26
26
|
/**
|
|
27
27
|
* @module ApiClient
|
|
28
|
-
* @version
|
|
28
|
+
* @version 3.0.0
|
|
29
29
|
*/
|
|
30
30
|
/**
|
|
31
31
|
* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
|
|
@@ -66,7 +66,7 @@ var ApiClient = /*#__PURE__*/function () {
|
|
|
66
66
|
* @default {}
|
|
67
67
|
*/
|
|
68
68
|
this.defaultHeaders = {
|
|
69
|
-
'User-Agent': 'docspring-javascript-
|
|
69
|
+
'User-Agent': 'docspring-javascript-3.0.0'
|
|
70
70
|
};
|
|
71
71
|
|
|
72
72
|
/**
|