docspring 2.1.0 → 3.1.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 +59 -48
- package/dist/ApiClient.js +4 -4
- package/dist/api/{PDFApi.js → Client.js} +698 -384
- package/dist/index.js +56 -21
- package/dist/model/AddFieldsData.js +3 -3
- package/dist/model/BatchGeneratePdfs201Response.js +8 -8
- package/dist/model/CombinePdfsData.js +10 -8
- package/dist/model/CombinedSubmission.js +22 -22
- package/dist/model/CombinedSubmissionAction.js +29 -15
- package/dist/model/CopyTemplateOptions.js +19 -30
- package/dist/model/CreateCombinedSubmissionResponse.js +8 -8
- package/dist/model/CreateCustomFileData.js +8 -8
- package/dist/model/CreateCustomFileResponse.js +8 -8
- package/dist/model/CreateFolderData.js +3 -3
- package/dist/model/CreateHtmlTemplate.js +3 -3
- package/dist/model/CreatePdfSubmissionData.js +3 -3
- package/dist/model/CreatePdfTemplate.js +3 -3
- package/dist/model/CreateSubmissionDataRequestData.js +107 -3
- package/dist/model/CreateSubmissionDataRequestEventRequest.js +32 -8
- package/dist/model/CreateSubmissionDataRequestEventResponse.js +3 -3
- package/dist/model/CreateSubmissionDataRequestResponse.js +8 -8
- package/dist/model/CreateSubmissionDataRequestTokenResponse.js +3 -3
- package/dist/model/CreateSubmissionResponse.js +3 -3
- package/dist/model/{CombinedSubmissionData.js → CreateWebhookData.js} +28 -68
- package/dist/model/CustomFile.js +3 -3
- package/dist/model/ErrorOrMultipleErrorsResponse.js +151 -0
- package/dist/model/ErrorResponse.js +3 -3
- package/dist/model/Folder.js +8 -8
- package/dist/model/JsonSchema.js +35 -3
- package/dist/model/ListSubmissionsResponse.js +8 -8
- package/dist/model/MoveFolderData.js +3 -3
- package/dist/model/MoveTemplateData.js +20 -8
- package/dist/model/MultipleErrorsResponse.js +3 -3
- package/dist/model/PublishVersionData.js +8 -8
- package/dist/model/RenameFolderData.js +3 -3
- package/dist/model/RestoreVersionData.js +3 -3
- package/dist/model/Submission.js +57 -44
- package/dist/model/Submission422Response.js +165 -0
- package/dist/model/SubmissionAction.js +29 -15
- package/dist/model/SubmissionBatch.js +16 -16
- package/dist/model/SubmissionBatchData.js +27 -3
- package/dist/model/SubmissionBatchWithSubmissions.js +16 -16
- package/dist/model/SubmissionDataRequest.js +53 -34
- package/dist/model/SubmissionDataRequestEvent.js +18 -18
- package/dist/model/SubmissionDataRequestShow.js +55 -36
- package/dist/model/SubmissionDataRequestToken.js +10 -10
- package/dist/model/SubmissionPreview.js +57 -38
- package/dist/model/SuccessErrorResponse.js +3 -3
- package/dist/model/SuccessMultipleErrorsResponse.js +3 -3
- package/dist/model/Template.js +203 -90
- package/dist/model/TemplateAddFieldsResponse.js +3 -3
- package/dist/model/TemplateDeleteResponse.js +3 -3
- package/dist/model/TemplateModelCodeResponse.js +193 -0
- package/dist/model/TemplatePreview.js +167 -78
- package/dist/model/TemplatePublishVersionResponse.js +3 -3
- package/dist/model/UpdateHtmlTemplate.js +3 -3
- package/dist/model/UpdatePdfTemplate.js +108 -0
- package/dist/model/UpdateSubmissionDataRequestData.js +154 -3
- package/dist/model/UpdateWebhookData.js +108 -0
- package/dist/model/UploadPresignResponse.js +3 -3
- package/dist/model/Webhook.js +378 -0
- package/package.json +2 -2
- package/dist/model/CreateHtmlSubmissionData.js +0 -173
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.1.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,46 +127,52 @@ 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.
|
|
168
|
-
*DocSpring.
|
|
169
|
-
*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* | [**createWebhook**](docs/Client.md#createWebhook) | **POST** /webhooks | Create a webhook
|
|
142
|
+
*DocSpring.Client* | [**deleteFolder**](docs/Client.md#deleteFolder) | **DELETE** /folders/{folder_id} | Delete a folder
|
|
143
|
+
*DocSpring.Client* | [**deleteTemplate**](docs/Client.md#deleteTemplate) | **DELETE** /templates/{template_id} | Delete a template
|
|
144
|
+
*DocSpring.Client* | [**deleteWebhook**](docs/Client.md#deleteWebhook) | **DELETE** /webhooks/{webhook_id} | Delete a webhook
|
|
145
|
+
*DocSpring.Client* | [**expireCombinedSubmission**](docs/Client.md#expireCombinedSubmission) | **DELETE** /combined_submissions/{combined_submission_id} | Expire a combined submission
|
|
146
|
+
*DocSpring.Client* | [**expireSubmission**](docs/Client.md#expireSubmission) | **DELETE** /submissions/{submission_id} | Expire a PDF submission
|
|
147
|
+
*DocSpring.Client* | [**generatePdf**](docs/Client.md#generatePdf) | **POST** /templates/{template_id}/submissions | Generate a PDF
|
|
148
|
+
*DocSpring.Client* | [**generatePreview**](docs/Client.md#generatePreview) | **POST** /submissions/{submission_id}/generate_preview | Generate a preview PDF for partially completed data requests
|
|
149
|
+
*DocSpring.Client* | [**getCombinedSubmission**](docs/Client.md#getCombinedSubmission) | **GET** /combined_submissions/{combined_submission_id} | Check the status of a combined submission (merged PDFs)
|
|
150
|
+
*DocSpring.Client* | [**getDataRequest**](docs/Client.md#getDataRequest) | **GET** /data_requests/{data_request_id} | Look up a submission data request
|
|
151
|
+
*DocSpring.Client* | [**getFullTemplate**](docs/Client.md#getFullTemplate) | **GET** /templates/{template_id}?full=true | Fetch the full attributes for a PDF template
|
|
152
|
+
*DocSpring.Client* | [**getPresignUrl**](docs/Client.md#getPresignUrl) | **GET** /uploads/presign | Get a presigned S3 URL for direct file upload
|
|
153
|
+
*DocSpring.Client* | [**getSubmission**](docs/Client.md#getSubmission) | **GET** /submissions/{submission_id} | Check the status of a PDF
|
|
154
|
+
*DocSpring.Client* | [**getSubmissionBatch**](docs/Client.md#getSubmissionBatch) | **GET** /submissions/batches/{submission_batch_id} | Check the status of a submission batch job
|
|
155
|
+
*DocSpring.Client* | [**getTemplate**](docs/Client.md#getTemplate) | **GET** /templates/{template_id} | Check the status of an uploaded template
|
|
156
|
+
*DocSpring.Client* | [**getTemplateModelCode**](docs/Client.md#getTemplateModelCode) | **GET** /templates/{template_id}/model_code | Generate typed model code for a template
|
|
157
|
+
*DocSpring.Client* | [**getTemplateSchema**](docs/Client.md#getTemplateSchema) | **GET** /templates/{template_id}/schema | Fetch the JSON schema for a template
|
|
158
|
+
*DocSpring.Client* | [**getWebhook**](docs/Client.md#getWebhook) | **GET** /webhooks/{webhook_id} | Get a webhook
|
|
159
|
+
*DocSpring.Client* | [**listCombinedSubmissions**](docs/Client.md#listCombinedSubmissions) | **GET** /combined_submissions | Get a list of all combined submissions
|
|
160
|
+
*DocSpring.Client* | [**listFolders**](docs/Client.md#listFolders) | **GET** /folders/ | Get a list of all folders
|
|
161
|
+
*DocSpring.Client* | [**listSubmissions**](docs/Client.md#listSubmissions) | **GET** /submissions | List all submissions
|
|
162
|
+
*DocSpring.Client* | [**listTemplateSubmissions**](docs/Client.md#listTemplateSubmissions) | **GET** /templates/{template_id}/submissions | List all submissions for a given template
|
|
163
|
+
*DocSpring.Client* | [**listTemplates**](docs/Client.md#listTemplates) | **GET** /templates | Get a list of all templates
|
|
164
|
+
*DocSpring.Client* | [**listWebhooks**](docs/Client.md#listWebhooks) | **GET** /webhooks | Get a list of all webhooks
|
|
165
|
+
*DocSpring.Client* | [**moveFolderToFolder**](docs/Client.md#moveFolderToFolder) | **POST** /folders/{folder_id}/move | Move a folder
|
|
166
|
+
*DocSpring.Client* | [**moveTemplateToFolder**](docs/Client.md#moveTemplateToFolder) | **POST** /templates/{template_id}/move | Move Template to folder
|
|
167
|
+
*DocSpring.Client* | [**publishTemplateVersion**](docs/Client.md#publishTemplateVersion) | **POST** /templates/{template_id}/publish_version | Publish a template version
|
|
168
|
+
*DocSpring.Client* | [**renameFolder**](docs/Client.md#renameFolder) | **POST** /folders/{folder_id}/rename | Rename a folder
|
|
169
|
+
*DocSpring.Client* | [**restoreTemplateVersion**](docs/Client.md#restoreTemplateVersion) | **POST** /templates/{template_id}/restore_version | Restore a template version
|
|
170
|
+
*DocSpring.Client* | [**testAuthentication**](docs/Client.md#testAuthentication) | **GET** /authentication | Test authentication
|
|
171
|
+
*DocSpring.Client* | [**updateDataRequest**](docs/Client.md#updateDataRequest) | **PUT** /data_requests/{data_request_id} | Update a submission data request
|
|
172
|
+
*DocSpring.Client* | [**updateTemplate**](docs/Client.md#updateTemplate) | **PUT** /templates/{template_id} | Update a Template
|
|
173
|
+
*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
|
|
174
|
+
*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
|
|
175
|
+
*DocSpring.Client* | [**updateWebhook**](docs/Client.md#updateWebhook) | **PUT** /webhooks/{webhook_id} | Update a webhook
|
|
170
176
|
|
|
171
177
|
|
|
172
178
|
## Documentation for Models
|
|
@@ -176,13 +182,11 @@ Class | Method | HTTP request | Description
|
|
|
176
182
|
- [DocSpring.CombinePdfsData](docs/CombinePdfsData.md)
|
|
177
183
|
- [DocSpring.CombinedSubmission](docs/CombinedSubmission.md)
|
|
178
184
|
- [DocSpring.CombinedSubmissionAction](docs/CombinedSubmissionAction.md)
|
|
179
|
-
- [DocSpring.CombinedSubmissionData](docs/CombinedSubmissionData.md)
|
|
180
185
|
- [DocSpring.CopyTemplateOptions](docs/CopyTemplateOptions.md)
|
|
181
186
|
- [DocSpring.CreateCombinedSubmissionResponse](docs/CreateCombinedSubmissionResponse.md)
|
|
182
187
|
- [DocSpring.CreateCustomFileData](docs/CreateCustomFileData.md)
|
|
183
188
|
- [DocSpring.CreateCustomFileResponse](docs/CreateCustomFileResponse.md)
|
|
184
189
|
- [DocSpring.CreateFolderData](docs/CreateFolderData.md)
|
|
185
|
-
- [DocSpring.CreateHtmlSubmissionData](docs/CreateHtmlSubmissionData.md)
|
|
186
190
|
- [DocSpring.CreateHtmlTemplate](docs/CreateHtmlTemplate.md)
|
|
187
191
|
- [DocSpring.CreatePdfSubmissionData](docs/CreatePdfSubmissionData.md)
|
|
188
192
|
- [DocSpring.CreatePdfTemplate](docs/CreatePdfTemplate.md)
|
|
@@ -192,7 +196,9 @@ Class | Method | HTTP request | Description
|
|
|
192
196
|
- [DocSpring.CreateSubmissionDataRequestResponse](docs/CreateSubmissionDataRequestResponse.md)
|
|
193
197
|
- [DocSpring.CreateSubmissionDataRequestTokenResponse](docs/CreateSubmissionDataRequestTokenResponse.md)
|
|
194
198
|
- [DocSpring.CreateSubmissionResponse](docs/CreateSubmissionResponse.md)
|
|
199
|
+
- [DocSpring.CreateWebhookData](docs/CreateWebhookData.md)
|
|
195
200
|
- [DocSpring.CustomFile](docs/CustomFile.md)
|
|
201
|
+
- [DocSpring.ErrorOrMultipleErrorsResponse](docs/ErrorOrMultipleErrorsResponse.md)
|
|
196
202
|
- [DocSpring.ErrorResponse](docs/ErrorResponse.md)
|
|
197
203
|
- [DocSpring.Folder](docs/Folder.md)
|
|
198
204
|
- [DocSpring.JsonSchema](docs/JsonSchema.md)
|
|
@@ -204,6 +210,7 @@ Class | Method | HTTP request | Description
|
|
|
204
210
|
- [DocSpring.RenameFolderData](docs/RenameFolderData.md)
|
|
205
211
|
- [DocSpring.RestoreVersionData](docs/RestoreVersionData.md)
|
|
206
212
|
- [DocSpring.Submission](docs/Submission.md)
|
|
213
|
+
- [DocSpring.Submission422Response](docs/Submission422Response.md)
|
|
207
214
|
- [DocSpring.SubmissionAction](docs/SubmissionAction.md)
|
|
208
215
|
- [DocSpring.SubmissionBatch](docs/SubmissionBatch.md)
|
|
209
216
|
- [DocSpring.SubmissionBatchData](docs/SubmissionBatchData.md)
|
|
@@ -218,11 +225,15 @@ Class | Method | HTTP request | Description
|
|
|
218
225
|
- [DocSpring.Template](docs/Template.md)
|
|
219
226
|
- [DocSpring.TemplateAddFieldsResponse](docs/TemplateAddFieldsResponse.md)
|
|
220
227
|
- [DocSpring.TemplateDeleteResponse](docs/TemplateDeleteResponse.md)
|
|
228
|
+
- [DocSpring.TemplateModelCodeResponse](docs/TemplateModelCodeResponse.md)
|
|
221
229
|
- [DocSpring.TemplatePreview](docs/TemplatePreview.md)
|
|
222
230
|
- [DocSpring.TemplatePublishVersionResponse](docs/TemplatePublishVersionResponse.md)
|
|
223
231
|
- [DocSpring.UpdateHtmlTemplate](docs/UpdateHtmlTemplate.md)
|
|
232
|
+
- [DocSpring.UpdatePdfTemplate](docs/UpdatePdfTemplate.md)
|
|
224
233
|
- [DocSpring.UpdateSubmissionDataRequestData](docs/UpdateSubmissionDataRequestData.md)
|
|
234
|
+
- [DocSpring.UpdateWebhookData](docs/UpdateWebhookData.md)
|
|
225
235
|
- [DocSpring.UploadPresignResponse](docs/UploadPresignResponse.md)
|
|
236
|
+
- [DocSpring.Webhook](docs/Webhook.md)
|
|
226
237
|
|
|
227
238
|
|
|
228
239
|
## Documentation for Authorization
|
package/dist/ApiClient.js
CHANGED
|
@@ -11,9 +11,9 @@ function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Can
|
|
|
11
11
|
function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
|
|
12
12
|
function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
|
|
13
13
|
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
14
|
-
function _toPrimitive(t,
|
|
14
|
+
function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? 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.1.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.1.0'
|
|
70
70
|
};
|
|
71
71
|
|
|
72
72
|
/**
|