@openfilz-sdk/typescript-ee 1.8.1 → 1.8.3
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/.openapi-generator/FILES +40 -4
- package/.openapi-generator/openfilz-api-generate-typescript-sdk.sha256 +1 -1
- package/README.md +43 -13
- package/api/esign-api.ts +719 -0
- package/api/esign-enterprise-api.ts +286 -0
- package/api/{digital-signature-public-api.ts → esign-public-api.ts} +183 -24
- package/api/{digital-signature-api.ts → esign-templates-api.ts} +137 -113
- package/api.ts +4 -2
- package/dist/api/esign-api.d.ts +334 -0
- package/dist/api/esign-api.js +693 -0
- package/dist/api/esign-enterprise-api.d.ts +138 -0
- package/dist/api/esign-enterprise-api.js +278 -0
- package/dist/{esm/api/digital-signature-public-api.d.ts → api/esign-public-api.d.ts} +81 -12
- package/dist/api/{digital-signature-public-api.js → esign-public-api.js} +178 -29
- package/dist/api/esign-templates-api.d.ts +234 -0
- package/dist/api/{digital-signature-api.js → esign-templates-api.js} +137 -115
- package/dist/api.d.ts +4 -2
- package/dist/api.js +4 -2
- package/dist/esm/api/esign-api.d.ts +334 -0
- package/dist/esm/api/esign-api.js +686 -0
- package/dist/esm/api/esign-enterprise-api.d.ts +138 -0
- package/dist/esm/api/esign-enterprise-api.js +271 -0
- package/dist/{api/digital-signature-public-api.d.ts → esm/api/esign-public-api.d.ts} +81 -12
- package/dist/esm/api/{digital-signature-public-api.js → esign-public-api.js} +173 -24
- package/dist/esm/api/esign-templates-api.d.ts +234 -0
- package/dist/esm/api/{digital-signature-api.js → esign-templates-api.js} +132 -110
- package/dist/esm/api.d.ts +4 -2
- package/dist/esm/api.js +4 -2
- package/dist/esm/models/apply-signature-request.d.ts +3 -0
- package/dist/esm/models/bulk-row-result.d.ts +17 -0
- package/dist/esm/models/bulk-row-result.js +14 -0
- package/dist/esm/models/bulk-row.d.ts +19 -0
- package/dist/esm/models/bulk-row.js +14 -0
- package/dist/esm/models/bulk-send-request.d.ts +19 -0
- package/dist/esm/models/bulk-send-request.js +14 -0
- package/dist/esm/models/bulk-send-response.d.ts +18 -0
- package/dist/esm/models/bulk-send-response.js +14 -0
- package/dist/esm/models/create-signature-envelope-request.d.ts +5 -0
- package/dist/esm/models/embed-url-response.d.ts +16 -0
- package/dist/esm/models/embed-url-response.js +14 -0
- package/dist/esm/models/enriched-audit-log.d.ts +3 -0
- package/dist/esm/models/enriched-audit-log.js +3 -0
- package/dist/esm/models/index.d.ts +16 -0
- package/dist/esm/models/index.js +16 -0
- package/dist/esm/models/instantiate-template-request.d.ts +22 -0
- package/dist/esm/models/instantiate-template-request.js +14 -0
- package/dist/esm/models/public-signature-view.d.ts +13 -0
- package/dist/esm/models/public-signature-view.js +5 -0
- package/dist/esm/models/role-binding.d.ts +19 -0
- package/dist/esm/models/role-binding.js +14 -0
- package/dist/esm/models/search-by-audit-log-request.d.ts +3 -0
- package/dist/esm/models/search-by-audit-log-request.js +3 -0
- package/dist/esm/models/settings.d.ts +3 -0
- package/dist/esm/models/signature-envelope-dto.d.ts +6 -0
- package/dist/esm/models/signature-event-dto.d.ts +33 -0
- package/dist/esm/models/signature-event-dto.js +26 -0
- package/dist/esm/models/signature-field-dto.d.ts +44 -0
- package/dist/esm/models/signature-field-dto.js +27 -0
- package/dist/esm/models/signature-field-input.d.ts +39 -0
- package/dist/esm/models/signature-field-input.js +27 -0
- package/dist/esm/models/signature-field-value.d.ts +16 -0
- package/dist/esm/models/signature-field-value.js +14 -0
- package/dist/esm/models/signature-recipient-dto.d.ts +16 -0
- package/dist/esm/models/signature-recipient-dto.js +9 -0
- package/dist/esm/models/signature-recipient-input.d.ts +19 -1
- package/dist/esm/models/signature-recipient-input.js +9 -1
- package/dist/esm/models/signature-template-dto.d.ts +27 -0
- package/dist/esm/models/signature-template-dto.js +14 -0
- package/dist/esm/models/signature-template-field.d.ts +40 -0
- package/dist/esm/models/signature-template-field.js +27 -0
- package/dist/esm/models/signature-template-request.d.ts +23 -0
- package/dist/esm/models/signature-template-request.js +14 -0
- package/dist/esm/models/signature-template-role.d.ts +28 -0
- package/dist/esm/models/signature-template-role.js +22 -0
- package/dist/esm/models/verify-otp-request.d.ts +14 -0
- package/dist/esm/models/verify-otp-request.js +14 -0
- package/dist/models/apply-signature-request.d.ts +3 -0
- package/dist/models/bulk-row-result.d.ts +17 -0
- package/dist/models/bulk-row-result.js +15 -0
- package/dist/models/bulk-row.d.ts +19 -0
- package/dist/models/bulk-row.js +15 -0
- package/dist/models/bulk-send-request.d.ts +19 -0
- package/dist/models/bulk-send-request.js +15 -0
- package/dist/models/bulk-send-response.d.ts +18 -0
- package/dist/models/bulk-send-response.js +15 -0
- package/dist/models/create-signature-envelope-request.d.ts +5 -0
- package/dist/models/embed-url-response.d.ts +16 -0
- package/dist/models/embed-url-response.js +15 -0
- package/dist/models/enriched-audit-log.d.ts +3 -0
- package/dist/models/enriched-audit-log.js +3 -0
- package/dist/models/index.d.ts +16 -0
- package/dist/models/index.js +16 -0
- package/dist/models/instantiate-template-request.d.ts +22 -0
- package/dist/models/instantiate-template-request.js +15 -0
- package/dist/models/public-signature-view.d.ts +13 -0
- package/dist/models/public-signature-view.js +6 -1
- package/dist/models/role-binding.d.ts +19 -0
- package/dist/models/role-binding.js +15 -0
- package/dist/models/search-by-audit-log-request.d.ts +3 -0
- package/dist/models/search-by-audit-log-request.js +3 -0
- package/dist/models/settings.d.ts +3 -0
- package/dist/models/signature-envelope-dto.d.ts +6 -0
- package/dist/models/signature-event-dto.d.ts +33 -0
- package/dist/models/signature-event-dto.js +29 -0
- package/dist/models/signature-field-dto.d.ts +44 -0
- package/dist/models/signature-field-dto.js +30 -0
- package/dist/models/signature-field-input.d.ts +39 -0
- package/dist/models/signature-field-input.js +30 -0
- package/dist/models/signature-field-value.d.ts +16 -0
- package/dist/models/signature-field-value.js +15 -0
- package/dist/models/signature-recipient-dto.d.ts +16 -0
- package/dist/models/signature-recipient-dto.js +10 -1
- package/dist/models/signature-recipient-input.d.ts +19 -1
- package/dist/models/signature-recipient-input.js +10 -0
- package/dist/models/signature-template-dto.d.ts +27 -0
- package/dist/models/signature-template-dto.js +15 -0
- package/dist/models/signature-template-field.d.ts +40 -0
- package/dist/models/signature-template-field.js +30 -0
- package/dist/models/signature-template-request.d.ts +23 -0
- package/dist/models/signature-template-request.js +15 -0
- package/dist/models/signature-template-role.d.ts +28 -0
- package/dist/models/signature-template-role.js +25 -0
- package/dist/models/verify-otp-request.d.ts +14 -0
- package/dist/models/verify-otp-request.js +15 -0
- package/docs/ApplySignatureRequest.md +4 -0
- package/docs/BulkRow.md +28 -0
- package/docs/BulkRowResult.md +26 -0
- package/docs/BulkSendRequest.md +28 -0
- package/docs/BulkSendResponse.md +26 -0
- package/docs/CreateSignatureEnvelopeRequest.md +10 -0
- package/docs/ESignApi.md +463 -0
- package/docs/ESignEnterpriseApi.md +164 -0
- package/docs/{DigitalSignaturePublicApi.md → ESignPublicApi.md} +118 -12
- package/docs/{DigitalSignatureApi.md → ESignTemplatesApi.md} +76 -61
- package/docs/EmbedUrlResponse.md +24 -0
- package/docs/InstantiateTemplateRequest.md +34 -0
- package/docs/PublicSignatureView.md +12 -0
- package/docs/RoleBinding.md +30 -0
- package/docs/Settings.md +6 -0
- package/docs/SignatureEnvelopeDTO.md +12 -0
- package/docs/SignatureEventDTO.md +30 -0
- package/docs/SignatureFieldDTO.md +46 -0
- package/docs/SignatureFieldInput.md +36 -0
- package/docs/SignatureFieldValue.md +24 -0
- package/docs/SignatureRecipientDTO.md +8 -0
- package/docs/SignatureRecipientInput.md +13 -1
- package/docs/SignatureTemplateDTO.md +42 -0
- package/docs/SignatureTemplateField.md +38 -0
- package/docs/SignatureTemplateRequest.md +34 -0
- package/docs/SignatureTemplateRole.md +26 -0
- package/docs/VerifyOtpRequest.md +20 -0
- package/models/apply-signature-request.ts +5 -0
- package/models/bulk-row-result.ts +23 -0
- package/models/bulk-row.ts +27 -0
- package/models/bulk-send-request.ts +27 -0
- package/models/bulk-send-response.ts +26 -0
- package/models/create-signature-envelope-request.ts +5 -0
- package/models/embed-url-response.ts +22 -0
- package/models/enriched-audit-log.ts +3 -0
- package/models/index.ts +16 -0
- package/models/instantiate-template-request.ts +30 -0
- package/models/public-signature-view.ts +16 -0
- package/models/role-binding.ts +25 -0
- package/models/search-by-audit-log-request.ts +3 -0
- package/models/settings.ts +3 -0
- package/models/signature-envelope-dto.ts +6 -0
- package/models/signature-event-dto.ts +42 -0
- package/models/signature-field-dto.ts +51 -0
- package/models/signature-field-input.ts +46 -0
- package/models/signature-field-value.ts +22 -0
- package/models/signature-recipient-dto.ts +20 -0
- package/models/signature-recipient-input.ts +25 -1
- package/models/signature-template-dto.ts +37 -0
- package/models/signature-template-field.ts +47 -0
- package/models/signature-template-request.ts +33 -0
- package/models/signature-template-role.ts +38 -0
- package/models/verify-otp-request.ts +20 -0
- package/package.json +1 -1
- package/dist/api/digital-signature-api.d.ts +0 -221
- package/dist/esm/api/digital-signature-api.d.ts +0 -221
package/.openapi-generator/FILES
CHANGED
|
@@ -11,11 +11,13 @@ api/comments-api.ts
|
|
|
11
11
|
api/dashboard-api.ts
|
|
12
12
|
api/delegated-browse-grants-admin-api.ts
|
|
13
13
|
api/delegated-browse-grants-end-user-api.ts
|
|
14
|
-
api/digital-signature-api.ts
|
|
15
|
-
api/digital-signature-public-api.ts
|
|
16
14
|
api/document-controller-api.ts
|
|
17
15
|
api/document-suggestion-controller-api.ts
|
|
18
16
|
api/document-version-controller-api.ts
|
|
17
|
+
api/esign-api.ts
|
|
18
|
+
api/esign-enterprise-api.ts
|
|
19
|
+
api/esign-public-api.ts
|
|
20
|
+
api/esign-templates-api.ts
|
|
19
21
|
api/favorites-api.ts
|
|
20
22
|
api/file-controller-api.ts
|
|
21
23
|
api/folder-controller-api.ts
|
|
@@ -44,6 +46,10 @@ docs/ApplySignatureRequest.md
|
|
|
44
46
|
docs/AuditLogDetails.md
|
|
45
47
|
docs/AuditVerificationResult.md
|
|
46
48
|
docs/BrokenLink.md
|
|
49
|
+
docs/BulkRow.md
|
|
50
|
+
docs/BulkRowResult.md
|
|
51
|
+
docs/BulkSendRequest.md
|
|
52
|
+
docs/BulkSendResponse.md
|
|
47
53
|
docs/CollaborationAuditControllerApi.md
|
|
48
54
|
docs/CollaborationControllerApi.md
|
|
49
55
|
docs/CommentDTO.md
|
|
@@ -71,15 +77,18 @@ docs/DeleteMetadataAudit.md
|
|
|
71
77
|
docs/DeleteMetadataRequest.md
|
|
72
78
|
docs/DeleteRequest.md
|
|
73
79
|
docs/DeleteShareRequest.md
|
|
74
|
-
docs/DigitalSignatureApi.md
|
|
75
|
-
docs/DigitalSignaturePublicApi.md
|
|
76
80
|
docs/DocumentControllerApi.md
|
|
77
81
|
docs/DocumentInfo.md
|
|
78
82
|
docs/DocumentPosition.md
|
|
79
83
|
docs/DocumentSuggestionControllerApi.md
|
|
80
84
|
docs/DocumentVersionControllerApi.md
|
|
81
85
|
docs/DocumentVersionInfo.md
|
|
86
|
+
docs/ESignApi.md
|
|
87
|
+
docs/ESignEnterpriseApi.md
|
|
88
|
+
docs/ESignPublicApi.md
|
|
89
|
+
docs/ESignTemplatesApi.md
|
|
82
90
|
docs/ElementInfo.md
|
|
91
|
+
docs/EmbedUrlResponse.md
|
|
83
92
|
docs/EnrichedAuditLog.md
|
|
84
93
|
docs/EnrichedAuditLogDetails.md
|
|
85
94
|
docs/FavoritesApi.md
|
|
@@ -90,6 +99,7 @@ docs/FolderControllerApi.md
|
|
|
90
99
|
docs/FolderElementInfo.md
|
|
91
100
|
docs/FolderResponse.md
|
|
92
101
|
docs/IngestionStatusDto.md
|
|
102
|
+
docs/InstantiateTemplateRequest.md
|
|
93
103
|
docs/ListAiModelsRequest.md
|
|
94
104
|
docs/MintUploadTokenRequest.md
|
|
95
105
|
docs/MoveAudit.md
|
|
@@ -102,6 +112,7 @@ docs/RenameRequest.md
|
|
|
102
112
|
docs/ReplaceAudit.md
|
|
103
113
|
docs/RestoreVersionAudit.md
|
|
104
114
|
docs/RestoreVersionResponse.md
|
|
115
|
+
docs/RoleBinding.md
|
|
105
116
|
docs/SaveAiSettingsRequest.md
|
|
106
117
|
docs/ScanAgentApi.md
|
|
107
118
|
docs/ScanJobStatusDto.md
|
|
@@ -120,9 +131,17 @@ docs/ShareResultItem.md
|
|
|
120
131
|
docs/ShareResultResponse.md
|
|
121
132
|
docs/SignatureArchiveDTO.md
|
|
122
133
|
docs/SignatureEnvelopeDTO.md
|
|
134
|
+
docs/SignatureEventDTO.md
|
|
135
|
+
docs/SignatureFieldDTO.md
|
|
136
|
+
docs/SignatureFieldInput.md
|
|
123
137
|
docs/SignatureFieldPlacement.md
|
|
138
|
+
docs/SignatureFieldValue.md
|
|
124
139
|
docs/SignatureRecipientDTO.md
|
|
125
140
|
docs/SignatureRecipientInput.md
|
|
141
|
+
docs/SignatureTemplateDTO.md
|
|
142
|
+
docs/SignatureTemplateField.md
|
|
143
|
+
docs/SignatureTemplateRequest.md
|
|
144
|
+
docs/SignatureTemplateRole.md
|
|
126
145
|
docs/SortInput.md
|
|
127
146
|
docs/StorageBreakdown.md
|
|
128
147
|
docs/Suggest.md
|
|
@@ -145,6 +164,7 @@ docs/UserPreferencesRequest.md
|
|
|
145
164
|
docs/UserPrivacyApi.md
|
|
146
165
|
docs/UserPrivacyDTO.md
|
|
147
166
|
docs/UserRegistrationRequest.md
|
|
167
|
+
docs/VerifyOtpRequest.md
|
|
148
168
|
docs/WebhookProxyControllerApi.md
|
|
149
169
|
git_push.sh
|
|
150
170
|
index.ts
|
|
@@ -159,6 +179,10 @@ models/apply-signature-request.ts
|
|
|
159
179
|
models/audit-log-details.ts
|
|
160
180
|
models/audit-verification-result.ts
|
|
161
181
|
models/broken-link.ts
|
|
182
|
+
models/bulk-row-result.ts
|
|
183
|
+
models/bulk-row.ts
|
|
184
|
+
models/bulk-send-request.ts
|
|
185
|
+
models/bulk-send-response.ts
|
|
162
186
|
models/comment-dto.ts
|
|
163
187
|
models/consume-delegated-grant-request.ts
|
|
164
188
|
models/copy-audit.ts
|
|
@@ -184,6 +208,7 @@ models/document-info.ts
|
|
|
184
208
|
models/document-position.ts
|
|
185
209
|
models/document-version-info.ts
|
|
186
210
|
models/element-info.ts
|
|
211
|
+
models/embed-url-response.ts
|
|
187
212
|
models/enriched-audit-log-details.ts
|
|
188
213
|
models/enriched-audit-log.ts
|
|
189
214
|
models/file-type-stats.ts
|
|
@@ -192,6 +217,7 @@ models/folder-element-info.ts
|
|
|
192
217
|
models/folder-response.ts
|
|
193
218
|
models/index.ts
|
|
194
219
|
models/ingestion-status-dto.ts
|
|
220
|
+
models/instantiate-template-request.ts
|
|
195
221
|
models/list-ai-models-request.ts
|
|
196
222
|
models/mint-upload-token-request.ts
|
|
197
223
|
models/move-audit.ts
|
|
@@ -203,6 +229,7 @@ models/rename-request.ts
|
|
|
203
229
|
models/replace-audit.ts
|
|
204
230
|
models/restore-version-audit.ts
|
|
205
231
|
models/restore-version-response.ts
|
|
232
|
+
models/role-binding.ts
|
|
206
233
|
models/save-ai-settings-request.ts
|
|
207
234
|
models/scan-job-status-dto.ts
|
|
208
235
|
models/scan-request-dto.ts
|
|
@@ -217,9 +244,17 @@ models/share-result-item.ts
|
|
|
217
244
|
models/share-result-response.ts
|
|
218
245
|
models/signature-archive-dto.ts
|
|
219
246
|
models/signature-envelope-dto.ts
|
|
247
|
+
models/signature-event-dto.ts
|
|
248
|
+
models/signature-field-dto.ts
|
|
249
|
+
models/signature-field-input.ts
|
|
220
250
|
models/signature-field-placement.ts
|
|
251
|
+
models/signature-field-value.ts
|
|
221
252
|
models/signature-recipient-dto.ts
|
|
222
253
|
models/signature-recipient-input.ts
|
|
254
|
+
models/signature-template-dto.ts
|
|
255
|
+
models/signature-template-field.ts
|
|
256
|
+
models/signature-template-request.ts
|
|
257
|
+
models/signature-template-role.ts
|
|
223
258
|
models/sort-input.ts
|
|
224
259
|
models/storage-breakdown.ts
|
|
225
260
|
models/suggest.ts
|
|
@@ -239,6 +274,7 @@ models/upload-token-response.ts
|
|
|
239
274
|
models/user-preferences-request.ts
|
|
240
275
|
models/user-privacy-dto.ts
|
|
241
276
|
models/user-registration-request.ts
|
|
277
|
+
models/verify-otp-request.ts
|
|
242
278
|
package.json
|
|
243
279
|
tsconfig.esm.json
|
|
244
280
|
tsconfig.json
|
|
@@ -1 +1 @@
|
|
|
1
|
-
|
|
1
|
+
4ab2ed4c0ba88058cd1a0128113a639445da90c263d1f825c71122d767b2458f
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @openfilz-sdk/typescript-ee@1.8.
|
|
1
|
+
## @openfilz-sdk/typescript-ee@1.8.3
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @openfilz-sdk/typescript-ee@1.8.
|
|
39
|
+
npm install @openfilz-sdk/typescript-ee@1.8.3 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -92,17 +92,6 @@ Class | Method | HTTP request | Description
|
|
|
92
92
|
*DelegatedBrowseGrantsEndUserApi* | [**disableLinkedWebhook**](docs/DelegatedBrowseGrantsEndUserApi.md#disablelinkedwebhook) | **POST** /api/v1/users/me/delegated/grants/{id}/disable-webhook | Disable the webhook created from this grant
|
|
93
93
|
*DelegatedBrowseGrantsEndUserApi* | [**listIncoming**](docs/DelegatedBrowseGrantsEndUserApi.md#listincoming) | **GET** /api/v1/users/me/delegated/grants | List grants addressed to me
|
|
94
94
|
*DelegatedBrowseGrantsEndUserApi* | [**revoke**](docs/DelegatedBrowseGrantsEndUserApi.md#revoke) | **POST** /api/v1/users/me/delegated/grants/{id}/revoke | Revoke an accepted grant
|
|
95
|
-
*DigitalSignatureApi* | [**archive**](docs/DigitalSignatureApi.md#archive) | **GET** /api/v1/signatures/{id}/archive | Get the PDF/A archive + veraPDF compliance for a completed envelope
|
|
96
|
-
*DigitalSignatureApi* | [**cancel**](docs/DigitalSignatureApi.md#cancel) | **POST** /api/v1/signatures/{id}/cancel | Cancel a non-terminal envelope
|
|
97
|
-
*DigitalSignatureApi* | [**create**](docs/DigitalSignatureApi.md#create) | **POST** /api/v1/signatures | Create and send a signature envelope
|
|
98
|
-
*DigitalSignatureApi* | [**get1**](docs/DigitalSignatureApi.md#get1) | **GET** /api/v1/signatures/{id} | Get a single envelope I sent
|
|
99
|
-
*DigitalSignatureApi* | [**listSent**](docs/DigitalSignatureApi.md#listsent) | **GET** /api/v1/signatures | List envelopes I sent for signature
|
|
100
|
-
*DigitalSignatureApi* | [**listToSign**](docs/DigitalSignatureApi.md#listtosign) | **GET** /api/v1/signatures/to-sign | List documents waiting for my signature
|
|
101
|
-
*DigitalSignaturePublicApi* | [**decline1**](docs/DigitalSignaturePublicApi.md#decline1) | **POST** /api/v1/public/signatures/decline | Decline to sign (voids the envelope)
|
|
102
|
-
*DigitalSignaturePublicApi* | [**document**](docs/DigitalSignaturePublicApi.md#document) | **GET** /api/v1/public/signatures/document | Stream the source PDF for signing
|
|
103
|
-
*DigitalSignaturePublicApi* | [**markViewed**](docs/DigitalSignaturePublicApi.md#markviewed) | **POST** /api/v1/public/signatures/viewed | Record that the recipient opened the document
|
|
104
|
-
*DigitalSignaturePublicApi* | [**sign**](docs/DigitalSignaturePublicApi.md#sign) | **POST** /api/v1/public/signatures/sign | Apply the recipient\'s signature
|
|
105
|
-
*DigitalSignaturePublicApi* | [**view**](docs/DigitalSignaturePublicApi.md#view) | **GET** /api/v1/public/signatures | Resolve a signing token to its envelope view
|
|
106
95
|
*DocumentControllerApi* | [**createBlankDocument**](docs/DocumentControllerApi.md#createblankdocument) | **POST** /api/v1/documents/create-blank | Create a blank document from template
|
|
107
96
|
*DocumentControllerApi* | [**deleteDocumentMetadata**](docs/DocumentControllerApi.md#deletedocumentmetadata) | **DELETE** /api/v1/documents/{documentId}/metadata | Delete specific metadata keys
|
|
108
97
|
*DocumentControllerApi* | [**downloadDocument**](docs/DocumentControllerApi.md#downloaddocument) | **GET** /api/v1/documents/{documentId}/download | Download a document
|
|
@@ -122,6 +111,31 @@ Class | Method | HTTP request | Description
|
|
|
122
111
|
*DocumentVersionControllerApi* | [**downloadVersion**](docs/DocumentVersionControllerApi.md#downloadversion) | **GET** /api/v1/documents/{documentId}/versions/{versionId}/download | Download a specific document version
|
|
123
112
|
*DocumentVersionControllerApi* | [**listVersions**](docs/DocumentVersionControllerApi.md#listversions) | **GET** /api/v1/documents/{documentId}/versions | List document versions
|
|
124
113
|
*DocumentVersionControllerApi* | [**restoreVersion**](docs/DocumentVersionControllerApi.md#restoreversion) | **POST** /api/v1/documents/{documentId}/versions/{versionId}/restore | Restore a previous document version
|
|
114
|
+
*ESignApi* | [**cancel**](docs/ESignApi.md#cancel) | **POST** /api/v1/signatures/{id}/cancel | Cancel a non-terminal envelope
|
|
115
|
+
*ESignApi* | [**create**](docs/ESignApi.md#create) | **POST** /api/v1/signatures | Create an envelope (sent immediately unless send=false)
|
|
116
|
+
*ESignApi* | [**events**](docs/ESignApi.md#events) | **GET** /api/v1/signatures/{id}/events | Audit trail of one of my envelopes
|
|
117
|
+
*ESignApi* | [**get2**](docs/ESignApi.md#get2) | **GET** /api/v1/signatures/{id} | Get one of my envelopes (recipients + fields)
|
|
118
|
+
*ESignApi* | [**listSent**](docs/ESignApi.md#listsent) | **GET** /api/v1/signatures | List envelopes I sent for signature
|
|
119
|
+
*ESignApi* | [**listToSign**](docs/ESignApi.md#listtosign) | **GET** /api/v1/signatures/to-sign | List envelopes waiting for my signature
|
|
120
|
+
*ESignApi* | [**resend**](docs/ESignApi.md#resend) | **POST** /api/v1/signatures/{id}/recipients/{recipientId}/resend | Resend the signing link to a recipient (new token, previous one revoked)
|
|
121
|
+
*ESignApi* | [**send**](docs/ESignApi.md#send) | **POST** /api/v1/signatures/{id}/send | Send a DRAFT envelope
|
|
122
|
+
*ESignApi* | [**signedDocument**](docs/ESignApi.md#signeddocument) | **GET** /api/v1/signatures/{id}/signed-document | Download the sealed PDF of a completed envelope
|
|
123
|
+
*ESignEnterpriseApi* | [**archive**](docs/ESignEnterpriseApi.md#archive) | **GET** /api/v1/signatures/{id}/archive | PDF/A-2b archive + veraPDF compliance for a completed envelope
|
|
124
|
+
*ESignEnterpriseApi* | [**bulk**](docs/ESignEnterpriseApi.md#bulk) | **POST** /api/v1/signatures/bulk | Create (and send) one envelope per row from a template
|
|
125
|
+
*ESignEnterpriseApi* | [**embedUrl**](docs/ESignEnterpriseApi.md#embedurl) | **POST** /api/v1/signatures/{id}/recipients/{recipientId}/embed-url | Mint an embedded-signing URL for a recipient (rotates the token; no email is sent)
|
|
126
|
+
*ESignPublicApi* | [**decline1**](docs/ESignPublicApi.md#decline1) | **POST** /api/v1/public/signatures/decline | Decline to sign (voids the envelope)
|
|
127
|
+
*ESignPublicApi* | [**document**](docs/ESignPublicApi.md#document) | **GET** /api/v1/public/signatures/document | Stream the source PDF for signing
|
|
128
|
+
*ESignPublicApi* | [**markViewed**](docs/ESignPublicApi.md#markviewed) | **POST** /api/v1/public/signatures/viewed | Record that the recipient opened the document
|
|
129
|
+
*ESignPublicApi* | [**requestOtp**](docs/ESignPublicApi.md#requestotp) | **POST** /api/v1/public/signatures/otp/request | Send a one-time access code to the recipient (EMAIL_OTP / SMS_OTP)
|
|
130
|
+
*ESignPublicApi* | [**sign**](docs/ESignPublicApi.md#sign) | **POST** /api/v1/public/signatures/sign | Submit the recipient\'s fields and sign
|
|
131
|
+
*ESignPublicApi* | [**verifyOtp**](docs/ESignPublicApi.md#verifyotp) | **POST** /api/v1/public/signatures/otp/verify | Verify the one-time access code
|
|
132
|
+
*ESignPublicApi* | [**view**](docs/ESignPublicApi.md#view) | **GET** /api/v1/public/signatures | Resolve a signing token to its envelope view
|
|
133
|
+
*ESignTemplatesApi* | [**_delete**](docs/ESignTemplatesApi.md#_delete) | **DELETE** /api/v1/signature-templates/{id} | Delete a template
|
|
134
|
+
*ESignTemplatesApi* | [**create1**](docs/ESignTemplatesApi.md#create1) | **POST** /api/v1/signature-templates | Create a template
|
|
135
|
+
*ESignTemplatesApi* | [**get1**](docs/ESignTemplatesApi.md#get1) | **GET** /api/v1/signature-templates/{id} | Get a template
|
|
136
|
+
*ESignTemplatesApi* | [**instantiate**](docs/ESignTemplatesApi.md#instantiate) | **POST** /api/v1/signature-templates/{id}/envelopes | Create (and send) an envelope from a template
|
|
137
|
+
*ESignTemplatesApi* | [**list**](docs/ESignTemplatesApi.md#list) | **GET** /api/v1/signature-templates | List my templates
|
|
138
|
+
*ESignTemplatesApi* | [**update1**](docs/ESignTemplatesApi.md#update1) | **PUT** /api/v1/signature-templates/{id} | Update a template
|
|
125
139
|
*FavoritesApi* | [**addFavorite**](docs/FavoritesApi.md#addfavorite) | **POST** /api/v1/favorites/{documentId} | Add document to favorites
|
|
126
140
|
*FavoritesApi* | [**isFavorite**](docs/FavoritesApi.md#isfavorite) | **GET** /api/v1/favorites/{documentId}/is-favorite | Check favorite status
|
|
127
141
|
*FavoritesApi* | [**removeFavorite**](docs/FavoritesApi.md#removefavorite) | **DELETE** /api/v1/favorites/{documentId} | Remove document from favorites
|
|
@@ -190,6 +204,10 @@ Class | Method | HTTP request | Description
|
|
|
190
204
|
- [AuditLogDetails](docs/AuditLogDetails.md)
|
|
191
205
|
- [AuditVerificationResult](docs/AuditVerificationResult.md)
|
|
192
206
|
- [BrokenLink](docs/BrokenLink.md)
|
|
207
|
+
- [BulkRow](docs/BulkRow.md)
|
|
208
|
+
- [BulkRowResult](docs/BulkRowResult.md)
|
|
209
|
+
- [BulkSendRequest](docs/BulkSendRequest.md)
|
|
210
|
+
- [BulkSendResponse](docs/BulkSendResponse.md)
|
|
193
211
|
- [CommentDTO](docs/CommentDTO.md)
|
|
194
212
|
- [ConsumeDelegatedGrantRequest](docs/ConsumeDelegatedGrantRequest.md)
|
|
195
213
|
- [CopyAudit](docs/CopyAudit.md)
|
|
@@ -215,6 +233,7 @@ Class | Method | HTTP request | Description
|
|
|
215
233
|
- [DocumentPosition](docs/DocumentPosition.md)
|
|
216
234
|
- [DocumentVersionInfo](docs/DocumentVersionInfo.md)
|
|
217
235
|
- [ElementInfo](docs/ElementInfo.md)
|
|
236
|
+
- [EmbedUrlResponse](docs/EmbedUrlResponse.md)
|
|
218
237
|
- [EnrichedAuditLog](docs/EnrichedAuditLog.md)
|
|
219
238
|
- [EnrichedAuditLogDetails](docs/EnrichedAuditLogDetails.md)
|
|
220
239
|
- [FileTypeStats](docs/FileTypeStats.md)
|
|
@@ -222,6 +241,7 @@ Class | Method | HTTP request | Description
|
|
|
222
241
|
- [FolderElementInfo](docs/FolderElementInfo.md)
|
|
223
242
|
- [FolderResponse](docs/FolderResponse.md)
|
|
224
243
|
- [IngestionStatusDto](docs/IngestionStatusDto.md)
|
|
244
|
+
- [InstantiateTemplateRequest](docs/InstantiateTemplateRequest.md)
|
|
225
245
|
- [ListAiModelsRequest](docs/ListAiModelsRequest.md)
|
|
226
246
|
- [MintUploadTokenRequest](docs/MintUploadTokenRequest.md)
|
|
227
247
|
- [MoveAudit](docs/MoveAudit.md)
|
|
@@ -233,6 +253,7 @@ Class | Method | HTTP request | Description
|
|
|
233
253
|
- [ReplaceAudit](docs/ReplaceAudit.md)
|
|
234
254
|
- [RestoreVersionAudit](docs/RestoreVersionAudit.md)
|
|
235
255
|
- [RestoreVersionResponse](docs/RestoreVersionResponse.md)
|
|
256
|
+
- [RoleBinding](docs/RoleBinding.md)
|
|
236
257
|
- [SaveAiSettingsRequest](docs/SaveAiSettingsRequest.md)
|
|
237
258
|
- [ScanJobStatusDto](docs/ScanJobStatusDto.md)
|
|
238
259
|
- [ScanRequestDto](docs/ScanRequestDto.md)
|
|
@@ -247,9 +268,17 @@ Class | Method | HTTP request | Description
|
|
|
247
268
|
- [ShareResultResponse](docs/ShareResultResponse.md)
|
|
248
269
|
- [SignatureArchiveDTO](docs/SignatureArchiveDTO.md)
|
|
249
270
|
- [SignatureEnvelopeDTO](docs/SignatureEnvelopeDTO.md)
|
|
271
|
+
- [SignatureEventDTO](docs/SignatureEventDTO.md)
|
|
272
|
+
- [SignatureFieldDTO](docs/SignatureFieldDTO.md)
|
|
273
|
+
- [SignatureFieldInput](docs/SignatureFieldInput.md)
|
|
250
274
|
- [SignatureFieldPlacement](docs/SignatureFieldPlacement.md)
|
|
275
|
+
- [SignatureFieldValue](docs/SignatureFieldValue.md)
|
|
251
276
|
- [SignatureRecipientDTO](docs/SignatureRecipientDTO.md)
|
|
252
277
|
- [SignatureRecipientInput](docs/SignatureRecipientInput.md)
|
|
278
|
+
- [SignatureTemplateDTO](docs/SignatureTemplateDTO.md)
|
|
279
|
+
- [SignatureTemplateField](docs/SignatureTemplateField.md)
|
|
280
|
+
- [SignatureTemplateRequest](docs/SignatureTemplateRequest.md)
|
|
281
|
+
- [SignatureTemplateRole](docs/SignatureTemplateRole.md)
|
|
253
282
|
- [SortInput](docs/SortInput.md)
|
|
254
283
|
- [StorageBreakdown](docs/StorageBreakdown.md)
|
|
255
284
|
- [Suggest](docs/Suggest.md)
|
|
@@ -269,6 +298,7 @@ Class | Method | HTTP request | Description
|
|
|
269
298
|
- [UserPreferencesRequest](docs/UserPreferencesRequest.md)
|
|
270
299
|
- [UserPrivacyDTO](docs/UserPrivacyDTO.md)
|
|
271
300
|
- [UserRegistrationRequest](docs/UserRegistrationRequest.md)
|
|
301
|
+
- [VerifyOtpRequest](docs/VerifyOtpRequest.md)
|
|
272
302
|
|
|
273
303
|
|
|
274
304
|
<a id="documentation-for-authorization"></a>
|