@openfilz-sdk/typescript 1.3.16 → 1.3.18

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.
Files changed (199) hide show
  1. package/.openapi-generator/FILES +50 -0
  2. package/.openapi-generator/openfilz-api-generate-typescript-sdk.sha256 +1 -1
  3. package/README.md +43 -3
  4. package/api/esign-api.ts +9 -9
  5. package/api/smart-filing-api.ts +75 -0
  6. package/api/workflows-api.ts +1234 -0
  7. package/api.ts +1 -0
  8. package/dist/api/esign-api.d.ts +4 -4
  9. package/dist/api/esign-api.js +9 -9
  10. package/dist/api/smart-filing-api.d.ts +33 -0
  11. package/dist/api/smart-filing-api.js +70 -0
  12. package/dist/api/workflows-api.d.ts +565 -0
  13. package/dist/api/workflows-api.js +1163 -0
  14. package/dist/api.d.ts +1 -0
  15. package/dist/api.js +1 -0
  16. package/dist/esm/api/esign-api.d.ts +4 -4
  17. package/dist/esm/api/esign-api.js +9 -9
  18. package/dist/esm/api/smart-filing-api.d.ts +33 -0
  19. package/dist/esm/api/smart-filing-api.js +70 -0
  20. package/dist/esm/api/workflows-api.d.ts +565 -0
  21. package/dist/esm/api/workflows-api.js +1156 -0
  22. package/dist/esm/api.d.ts +1 -0
  23. package/dist/esm/api.js +1 -0
  24. package/dist/esm/models/audit-log-details-one-of.d.ts +7 -1
  25. package/dist/esm/models/audit-log-details.d.ts +12 -0
  26. package/dist/esm/models/audit-log.d.ts +9 -0
  27. package/dist/esm/models/audit-log.js +9 -0
  28. package/dist/esm/models/auto-file-jobs-request.d.ts +14 -0
  29. package/dist/esm/models/auto-file-jobs-request.js +14 -0
  30. package/dist/esm/models/cancel-instance-request.d.ts +14 -0
  31. package/dist/esm/models/cancel-instance-request.js +14 -0
  32. package/dist/esm/models/complete-task-request.d.ts +15 -0
  33. package/dist/esm/models/complete-task-request.js +14 -0
  34. package/dist/esm/models/index.d.ts +24 -0
  35. package/dist/esm/models/index.js +24 -0
  36. package/dist/esm/models/my-tasks-count-dto.d.ts +15 -0
  37. package/dist/esm/models/my-tasks-count-dto.js +14 -0
  38. package/dist/esm/models/per-definition.d.ts +18 -0
  39. package/dist/esm/models/per-definition.js +14 -0
  40. package/dist/esm/models/reassign-task-request.d.ts +15 -0
  41. package/dist/esm/models/reassign-task-request.js +14 -0
  42. package/dist/esm/models/save-workflow-definition-request.d.ts +19 -0
  43. package/dist/esm/models/save-workflow-definition-request.js +14 -0
  44. package/dist/esm/models/search-by-audit-log-request.d.ts +9 -0
  45. package/dist/esm/models/search-by-audit-log-request.js +9 -0
  46. package/dist/esm/models/settings.d.ts +2 -0
  47. package/dist/esm/models/start-workflow-request.d.ts +20 -0
  48. package/dist/esm/models/start-workflow-request.js +14 -0
  49. package/dist/esm/models/workflow-action-failure-audit.d.ts +17 -0
  50. package/dist/esm/models/workflow-action-failure-audit.js +14 -0
  51. package/dist/esm/models/workflow-action.d.ts +25 -0
  52. package/dist/esm/models/workflow-action.js +18 -0
  53. package/dist/esm/models/workflow-assignment.d.ts +24 -0
  54. package/dist/esm/models/workflow-assignment.js +19 -0
  55. package/dist/esm/models/workflow-audit.d.ts +17 -0
  56. package/dist/esm/models/workflow-audit.js +14 -0
  57. package/dist/esm/models/workflow-definition-dto.d.ts +26 -0
  58. package/dist/esm/models/workflow-definition-dto.js +14 -0
  59. package/dist/esm/models/workflow-event-dto.d.ts +35 -0
  60. package/dist/esm/models/workflow-event-dto.js +23 -0
  61. package/dist/esm/models/workflow-instance-detail-dto.d.ts +23 -0
  62. package/dist/esm/models/workflow-instance-detail-dto.js +14 -0
  63. package/dist/esm/models/workflow-instance-dto.d.ts +35 -0
  64. package/dist/esm/models/workflow-instance-dto.js +18 -0
  65. package/dist/esm/models/workflow-instance-page.d.ts +18 -0
  66. package/dist/esm/models/workflow-instance-page.js +14 -0
  67. package/dist/esm/models/workflow-problem.d.ts +17 -0
  68. package/dist/esm/models/workflow-problem.js +14 -0
  69. package/dist/esm/models/workflow-spec.d.ts +15 -0
  70. package/dist/esm/models/workflow-spec.js +14 -0
  71. package/dist/esm/models/workflow-state.d.ts +31 -0
  72. package/dist/esm/models/workflow-state.js +18 -0
  73. package/dist/esm/models/workflow-summary-dto.d.ts +19 -0
  74. package/dist/esm/models/workflow-summary-dto.js +14 -0
  75. package/dist/esm/models/workflow-task-dto.d.ts +44 -0
  76. package/dist/esm/models/workflow-task-dto.js +18 -0
  77. package/dist/esm/models/workflow-transition.d.ts +25 -0
  78. package/dist/esm/models/workflow-transition.js +19 -0
  79. package/dist/esm/models/workflow-validation-result.d.ts +16 -0
  80. package/dist/esm/models/workflow-validation-result.js +14 -0
  81. package/dist/models/audit-log-details-one-of.d.ts +7 -1
  82. package/dist/models/audit-log-details.d.ts +12 -0
  83. package/dist/models/audit-log.d.ts +9 -0
  84. package/dist/models/audit-log.js +9 -0
  85. package/dist/models/auto-file-jobs-request.d.ts +14 -0
  86. package/dist/models/auto-file-jobs-request.js +15 -0
  87. package/dist/models/cancel-instance-request.d.ts +14 -0
  88. package/dist/models/cancel-instance-request.js +15 -0
  89. package/dist/models/complete-task-request.d.ts +15 -0
  90. package/dist/models/complete-task-request.js +15 -0
  91. package/dist/models/index.d.ts +24 -0
  92. package/dist/models/index.js +24 -0
  93. package/dist/models/my-tasks-count-dto.d.ts +15 -0
  94. package/dist/models/my-tasks-count-dto.js +15 -0
  95. package/dist/models/per-definition.d.ts +18 -0
  96. package/dist/models/per-definition.js +15 -0
  97. package/dist/models/reassign-task-request.d.ts +15 -0
  98. package/dist/models/reassign-task-request.js +15 -0
  99. package/dist/models/save-workflow-definition-request.d.ts +19 -0
  100. package/dist/models/save-workflow-definition-request.js +15 -0
  101. package/dist/models/search-by-audit-log-request.d.ts +9 -0
  102. package/dist/models/search-by-audit-log-request.js +9 -0
  103. package/dist/models/settings.d.ts +2 -0
  104. package/dist/models/start-workflow-request.d.ts +20 -0
  105. package/dist/models/start-workflow-request.js +15 -0
  106. package/dist/models/workflow-action-failure-audit.d.ts +17 -0
  107. package/dist/models/workflow-action-failure-audit.js +15 -0
  108. package/dist/models/workflow-action.d.ts +25 -0
  109. package/dist/models/workflow-action.js +21 -0
  110. package/dist/models/workflow-assignment.d.ts +24 -0
  111. package/dist/models/workflow-assignment.js +22 -0
  112. package/dist/models/workflow-audit.d.ts +17 -0
  113. package/dist/models/workflow-audit.js +15 -0
  114. package/dist/models/workflow-definition-dto.d.ts +26 -0
  115. package/dist/models/workflow-definition-dto.js +15 -0
  116. package/dist/models/workflow-event-dto.d.ts +35 -0
  117. package/dist/models/workflow-event-dto.js +26 -0
  118. package/dist/models/workflow-instance-detail-dto.d.ts +23 -0
  119. package/dist/models/workflow-instance-detail-dto.js +15 -0
  120. package/dist/models/workflow-instance-dto.d.ts +35 -0
  121. package/dist/models/workflow-instance-dto.js +21 -0
  122. package/dist/models/workflow-instance-page.d.ts +18 -0
  123. package/dist/models/workflow-instance-page.js +15 -0
  124. package/dist/models/workflow-problem.d.ts +17 -0
  125. package/dist/models/workflow-problem.js +15 -0
  126. package/dist/models/workflow-spec.d.ts +15 -0
  127. package/dist/models/workflow-spec.js +15 -0
  128. package/dist/models/workflow-state.d.ts +31 -0
  129. package/dist/models/workflow-state.js +21 -0
  130. package/dist/models/workflow-summary-dto.d.ts +19 -0
  131. package/dist/models/workflow-summary-dto.js +15 -0
  132. package/dist/models/workflow-task-dto.d.ts +44 -0
  133. package/dist/models/workflow-task-dto.js +21 -0
  134. package/dist/models/workflow-transition.d.ts +25 -0
  135. package/dist/models/workflow-transition.js +22 -0
  136. package/dist/models/workflow-validation-result.d.ts +16 -0
  137. package/dist/models/workflow-validation-result.js +15 -0
  138. package/docs/AuditLogDetails.md +6 -0
  139. package/docs/AuditLogDetailsOneOf.md +22 -0
  140. package/docs/AutoFileJobsRequest.md +20 -0
  141. package/docs/CancelInstanceRequest.md +20 -0
  142. package/docs/CompleteTaskRequest.md +22 -0
  143. package/docs/ESignApi.md +4 -4
  144. package/docs/MyTasksCountDTO.md +22 -0
  145. package/docs/PerDefinition.md +28 -0
  146. package/docs/ReassignTaskRequest.md +22 -0
  147. package/docs/SaveWorkflowDefinitionRequest.md +28 -0
  148. package/docs/Settings.md +4 -0
  149. package/docs/SmartFilingApi.md +53 -0
  150. package/docs/StartWorkflowRequest.md +28 -0
  151. package/docs/WorkflowAction.md +26 -0
  152. package/docs/WorkflowActionFailureAudit.md +25 -0
  153. package/docs/WorkflowAssignment.md +26 -0
  154. package/docs/WorkflowAudit.md +31 -0
  155. package/docs/WorkflowDefinitionDTO.md +42 -0
  156. package/docs/WorkflowEventDTO.md +36 -0
  157. package/docs/WorkflowInstanceDTO.md +48 -0
  158. package/docs/WorkflowInstanceDetailDTO.md +28 -0
  159. package/docs/WorkflowInstancePage.md +26 -0
  160. package/docs/WorkflowProblem.md +26 -0
  161. package/docs/WorkflowSpec.md +20 -0
  162. package/docs/WorkflowState.md +36 -0
  163. package/docs/WorkflowSummaryDTO.md +28 -0
  164. package/docs/WorkflowTaskDTO.md +66 -0
  165. package/docs/WorkflowTransition.md +28 -0
  166. package/docs/WorkflowValidationResult.md +22 -0
  167. package/docs/WorkflowsApi.md +791 -0
  168. package/graphql/document.graphqls +2 -0
  169. package/models/audit-log-details-one-of.ts +7 -1
  170. package/models/audit-log-details.ts +12 -0
  171. package/models/audit-log.ts +9 -0
  172. package/models/auto-file-jobs-request.ts +20 -0
  173. package/models/cancel-instance-request.ts +20 -0
  174. package/models/complete-task-request.ts +21 -0
  175. package/models/index.ts +24 -0
  176. package/models/my-tasks-count-dto.ts +21 -0
  177. package/models/per-definition.ts +24 -0
  178. package/models/reassign-task-request.ts +21 -0
  179. package/models/save-workflow-definition-request.ts +27 -0
  180. package/models/search-by-audit-log-request.ts +9 -0
  181. package/models/settings.ts +2 -0
  182. package/models/start-workflow-request.ts +24 -0
  183. package/models/workflow-action-failure-audit.ts +26 -0
  184. package/models/workflow-action.ts +32 -0
  185. package/models/workflow-assignment.ts +33 -0
  186. package/models/workflow-audit.ts +26 -0
  187. package/models/workflow-definition-dto.ts +34 -0
  188. package/models/workflow-event-dto.ts +42 -0
  189. package/models/workflow-instance-detail-dto.ts +33 -0
  190. package/models/workflow-instance-dto.ts +46 -0
  191. package/models/workflow-instance-page.ts +26 -0
  192. package/models/workflow-problem.ts +23 -0
  193. package/models/workflow-spec.ts +23 -0
  194. package/models/workflow-state.ts +46 -0
  195. package/models/workflow-summary-dto.ts +27 -0
  196. package/models/workflow-task-dto.ts +55 -0
  197. package/models/workflow-transition.ts +34 -0
  198. package/models/workflow-validation-result.ts +24 -0
  199. package/package.json +1 -1
@@ -23,6 +23,7 @@ api/pdftools-api.ts
23
23
  api/settings-api.ts
24
24
  api/smart-filing-api.ts
25
25
  api/tus-controller-api.ts
26
+ api/workflows-api.ts
26
27
  base.ts
27
28
  common.ts
28
29
  configuration.ts
@@ -44,10 +45,13 @@ docs/AuditLogDetails.md
44
45
  docs/AuditLogDetailsOneOf.md
45
46
  docs/AuditVerificationResult.md
46
47
  docs/AutoFileJobView.md
48
+ docs/AutoFileJobsRequest.md
47
49
  docs/AutoFileRequest.md
48
50
  docs/AutoFileTicket.md
49
51
  docs/BrokenLink.md
52
+ docs/CancelInstanceRequest.md
50
53
  docs/CloudSignatureSubscription.md
54
+ docs/CompleteTaskRequest.md
51
55
  docs/CopyAudit.md
52
56
  docs/CopyRequest.md
53
57
  docs/CopyResponse.md
@@ -96,6 +100,7 @@ docs/MergeRequest.md
96
100
  docs/MergeSource.md
97
101
  docs/MoveAudit.md
98
102
  docs/MoveRequest.md
103
+ docs/MyTasksCountDTO.md
99
104
  docs/OrganizeRequest.md
100
105
  docs/OutputTarget.md
101
106
  docs/PDFToolsApi.md
@@ -106,7 +111,9 @@ docs/PdfOutlineEntry.md
106
111
  docs/PdfOutputInfo.md
107
112
  docs/PdfPageInfo.md
108
113
  docs/PdfTransformAudit.md
114
+ docs/PerDefinition.md
109
115
  docs/PublicSignatureView.md
116
+ docs/ReassignTaskRequest.md
110
117
  docs/RenameAudit.md
111
118
  docs/RenameRequest.md
112
119
  docs/ReorganizationApplyRequest.md
@@ -120,6 +127,7 @@ docs/RoleBinding.md
120
127
  docs/RotateRequest.md
121
128
  docs/SaveAiPreferencesRequest.md
122
129
  docs/SaveAiSettingsRequest.md
130
+ docs/SaveWorkflowDefinitionRequest.md
123
131
  docs/SearchByAuditLogRequest.md
124
132
  docs/SearchByMetadataRequest.md
125
133
  docs/SearchMetadataRequest.md
@@ -141,6 +149,7 @@ docs/SmartFilingApi.md
141
149
  docs/SortInput.md
142
150
  docs/SplitOutput.md
143
151
  docs/SplitRequest.md
152
+ docs/StartWorkflowRequest.md
144
153
  docs/StorageBreakdown.md
145
154
  docs/Suggest.md
146
155
  docs/TusConfigResponse.md
@@ -152,6 +161,23 @@ docs/UpdateMetadataRequest.md
152
161
  docs/UploadAudit.md
153
162
  docs/UploadResponse.md
154
163
  docs/VerifyOtpRequest.md
164
+ docs/WorkflowAction.md
165
+ docs/WorkflowActionFailureAudit.md
166
+ docs/WorkflowAssignment.md
167
+ docs/WorkflowAudit.md
168
+ docs/WorkflowDefinitionDTO.md
169
+ docs/WorkflowEventDTO.md
170
+ docs/WorkflowInstanceDTO.md
171
+ docs/WorkflowInstanceDetailDTO.md
172
+ docs/WorkflowInstancePage.md
173
+ docs/WorkflowProblem.md
174
+ docs/WorkflowSpec.md
175
+ docs/WorkflowState.md
176
+ docs/WorkflowSummaryDTO.md
177
+ docs/WorkflowTaskDTO.md
178
+ docs/WorkflowTransition.md
179
+ docs/WorkflowValidationResult.md
180
+ docs/WorkflowsApi.md
155
181
  git_push.sh
156
182
  index.ts
157
183
  models/ai-chat-conversation.ts
@@ -168,10 +194,13 @@ models/audit-log-details.ts
168
194
  models/audit-log.ts
169
195
  models/audit-verification-result.ts
170
196
  models/auto-file-job-view.ts
197
+ models/auto-file-jobs-request.ts
171
198
  models/auto-file-request.ts
172
199
  models/auto-file-ticket.ts
173
200
  models/broken-link.ts
201
+ models/cancel-instance-request.ts
174
202
  models/cloud-signature-subscription.ts
203
+ models/complete-task-request.ts
175
204
  models/copy-audit.ts
176
205
  models/copy-request.ts
177
206
  models/copy-response.ts
@@ -209,6 +238,7 @@ models/merge-request.ts
209
238
  models/merge-source.ts
210
239
  models/move-audit.ts
211
240
  models/move-request.ts
241
+ models/my-tasks-count-dto.ts
212
242
  models/organize-request.ts
213
243
  models/output-target.ts
214
244
  models/page-instruction.ts
@@ -218,7 +248,9 @@ models/pdf-outline-entry.ts
218
248
  models/pdf-output-info.ts
219
249
  models/pdf-page-info.ts
220
250
  models/pdf-transform-audit.ts
251
+ models/per-definition.ts
221
252
  models/public-signature-view.ts
253
+ models/reassign-task-request.ts
222
254
  models/rename-audit.ts
223
255
  models/rename-request.ts
224
256
  models/reorganization-apply-request.ts
@@ -232,6 +264,7 @@ models/role-binding.ts
232
264
  models/rotate-request.ts
233
265
  models/save-ai-preferences-request.ts
234
266
  models/save-ai-settings-request.ts
267
+ models/save-workflow-definition-request.ts
235
268
  models/search-by-audit-log-request.ts
236
269
  models/search-by-metadata-request.ts
237
270
  models/search-metadata-request.ts
@@ -251,6 +284,7 @@ models/signature-template-role.ts
251
284
  models/sort-input.ts
252
285
  models/split-output.ts
253
286
  models/split-request.ts
287
+ models/start-workflow-request.ts
254
288
  models/storage-breakdown.ts
255
289
  models/suggest.ts
256
290
  models/tus-config-response.ts
@@ -261,6 +295,22 @@ models/update-metadata-request.ts
261
295
  models/upload-audit.ts
262
296
  models/upload-response.ts
263
297
  models/verify-otp-request.ts
298
+ models/workflow-action-failure-audit.ts
299
+ models/workflow-action.ts
300
+ models/workflow-assignment.ts
301
+ models/workflow-audit.ts
302
+ models/workflow-definition-dto.ts
303
+ models/workflow-event-dto.ts
304
+ models/workflow-instance-detail-dto.ts
305
+ models/workflow-instance-dto.ts
306
+ models/workflow-instance-page.ts
307
+ models/workflow-problem.ts
308
+ models/workflow-spec.ts
309
+ models/workflow-state.ts
310
+ models/workflow-summary-dto.ts
311
+ models/workflow-task-dto.ts
312
+ models/workflow-transition.ts
313
+ models/workflow-validation-result.ts
264
314
  package.json
265
315
  tsconfig.esm.json
266
316
  tsconfig.json
@@ -1 +1 @@
1
- 11ec9ffb2c0767774ce69e73b5e34619f25a628c42f99ef8e4471278508fc605
1
+ 8672580c6c5002cb918a847b9f10e8dd17d4fb82174d95aee6d855cadfbb0aa8
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @openfilz-sdk/typescript@1.3.16
1
+ ## @openfilz-sdk/typescript@1.3.18
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@1.3.16 --save
39
+ npm install @openfilz-sdk/typescript@1.3.18 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -93,7 +93,7 @@ Class | Method | HTTP request | Description
93
93
  *DocumentVersionControllerApi* | [**downloadVersion**](docs/DocumentVersionControllerApi.md#downloadversion) | **GET** /api/v1/documents/{documentId}/versions/{versionId}/download | Download a specific document version
94
94
  *DocumentVersionControllerApi* | [**listVersions**](docs/DocumentVersionControllerApi.md#listversions) | **GET** /api/v1/documents/{documentId}/versions | List document versions
95
95
  *DocumentVersionControllerApi* | [**restoreVersion**](docs/DocumentVersionControllerApi.md#restoreversion) | **POST** /api/v1/documents/{documentId}/versions/{versionId}/restore | Restore a previous document version
96
- *ESignApi* | [**cancel**](docs/ESignApi.md#cancel) | **POST** /api/v1/signatures/{id}/cancel | Cancel a non-terminal envelope
96
+ *ESignApi* | [**cancel1**](docs/ESignApi.md#cancel1) | **POST** /api/v1/signatures/{id}/cancel | Cancel a non-terminal envelope
97
97
  *ESignApi* | [**cloudSubscription**](docs/ESignApi.md#cloudsubscription) | **GET** /api/v1/signatures/cloud-subscription | Cloud Signing subscription and month-to-date usage (openfilz-cloud seal provider only)
98
98
  *ESignApi* | [**create**](docs/ESignApi.md#create) | **POST** /api/v1/signatures | Create an envelope (sent immediately unless send=false)
99
99
  *ESignApi* | [**events**](docs/ESignApi.md#events) | **GET** /api/v1/signatures/{id}/events | Audit trail of one of my envelopes
@@ -143,6 +143,7 @@ Class | Method | HTTP request | Description
143
143
  *SettingsApi* | [**save**](docs/SettingsApi.md#save) | **PUT** /api/v1/settings/ai/preferences | Save the caller\'s smart-filing preferences
144
144
  *SmartFilingApi* | [**file**](docs/SmartFilingApi.md#file) | **POST** /api/v1/ai/auto-file | File existing documents on demand
145
145
  *SmartFilingApi* | [**job**](docs/SmartFilingApi.md#job) | **GET** /api/v1/ai/auto-file/{jobId} | Progress and outcome of a filing job
146
+ *SmartFilingApi* | [**jobs**](docs/SmartFilingApi.md#jobs) | **POST** /api/v1/ai/auto-file/jobs | Progress and outcome of several filing jobs
146
147
  *SmartFilingApi* | [**lastFiling**](docs/SmartFilingApi.md#lastfiling) | **GET** /api/v1/ai/auto-file/document/{documentId} | The latest filing record of a document (the \"Filed by OpenFilz\" chip)
147
148
  *SmartFilingApi* | [**undo**](docs/SmartFilingApi.md#undo) | **POST** /api/v1/ai/auto-file/{jobId}/undo | Move every document the job filed back where it came from
148
149
  *SmartFilingApi* | [**undoFiling**](docs/SmartFilingApi.md#undofiling) | **POST** /api/v1/ai/auto-file/filing/{planId}/undo | Move one filed document back (the chip\'s \"Move back\")
@@ -155,6 +156,21 @@ Class | Method | HTTP request | Description
155
156
  *TusControllerApi* | [**getUploadOffset**](docs/TusControllerApi.md#getuploadoffset) | **HEAD** /api/v1/tus/{uploadId} | Get upload progress
156
157
  *TusControllerApi* | [**isUploadComplete**](docs/TusControllerApi.md#isuploadcomplete) | **GET** /api/v1/tus/{uploadId}/complete | Check upload completion
157
158
  *TusControllerApi* | [**uploadChunk**](docs/TusControllerApi.md#uploadchunk) | **PATCH** /api/v1/tus/{uploadId} | Upload chunk
159
+ *WorkflowsApi* | [**cancel**](docs/WorkflowsApi.md#cancel) | **POST** /api/v1/workflows/instances/{id}/cancel | Cancel a running instance (initiator)
160
+ *WorkflowsApi* | [**complete**](docs/WorkflowsApi.md#complete) | **POST** /api/v1/workflows/tasks/{id}/complete | Take a transition on a task I am a candidate of
161
+ *WorkflowsApi* | [**createDefinition**](docs/WorkflowsApi.md#createdefinition) | **POST** /api/v1/workflows/definitions | Create a workflow definition (400 with the problem list when invalid)
162
+ *WorkflowsApi* | [**deleteDefinition**](docs/WorkflowsApi.md#deletedefinition) | **DELETE** /api/v1/workflows/definitions/{id} | Delete a workflow definition (409 while instances are running)
163
+ *WorkflowsApi* | [**getDefinition**](docs/WorkflowsApi.md#getdefinition) | **GET** /api/v1/workflows/definitions/{id} | Get a workflow definition
164
+ *WorkflowsApi* | [**getInstance**](docs/WorkflowsApi.md#getinstance) | **GET** /api/v1/workflows/instances/{id} | One instance with its snapshot spec, open task and history
165
+ *WorkflowsApi* | [**listDefinitions**](docs/WorkflowsApi.md#listdefinitions) | **GET** /api/v1/workflows/definitions | List workflow definitions
166
+ *WorkflowsApi* | [**listInstances**](docs/WorkflowsApi.md#listinstances) | **GET** /api/v1/workflows/instances | List instances (monitor), newest first
167
+ *WorkflowsApi* | [**myTasks**](docs/WorkflowsApi.md#mytasks) | **GET** /api/v1/workflows/tasks/mine | Open tasks I can act on (by e-mail or role)
168
+ *WorkflowsApi* | [**myTasksCount**](docs/WorkflowsApi.md#mytaskscount) | **GET** /api/v1/workflows/tasks/mine/count | Number of open tasks I can act on (sidebar badge)
169
+ *WorkflowsApi* | [**reassign**](docs/WorkflowsApi.md#reassign) | **POST** /api/v1/workflows/tasks/{id}/reassign | Hand a task to other people (initiator or current candidate)
170
+ *WorkflowsApi* | [**start**](docs/WorkflowsApi.md#start) | **POST** /api/v1/workflows/instances | Start a workflow on a document (409 when one is already running)
171
+ *WorkflowsApi* | [**summary**](docs/WorkflowsApi.md#summary) | **GET** /api/v1/workflows/instances/summary | Counts for the monitor header
172
+ *WorkflowsApi* | [**updateDefinition**](docs/WorkflowsApi.md#updatedefinition) | **PUT** /api/v1/workflows/definitions/{id} | Update a workflow definition (running instances keep their snapshot)
173
+ *WorkflowsApi* | [**validateDefinition**](docs/WorkflowsApi.md#validatedefinition) | **POST** /api/v1/workflows/definitions/validate | Validate a definition without saving it
158
174
 
159
175
 
160
176
  ### Documentation For Models
@@ -173,10 +189,13 @@ Class | Method | HTTP request | Description
173
189
  - [AuditLogDetailsOneOf](docs/AuditLogDetailsOneOf.md)
174
190
  - [AuditVerificationResult](docs/AuditVerificationResult.md)
175
191
  - [AutoFileJobView](docs/AutoFileJobView.md)
192
+ - [AutoFileJobsRequest](docs/AutoFileJobsRequest.md)
176
193
  - [AutoFileRequest](docs/AutoFileRequest.md)
177
194
  - [AutoFileTicket](docs/AutoFileTicket.md)
178
195
  - [BrokenLink](docs/BrokenLink.md)
196
+ - [CancelInstanceRequest](docs/CancelInstanceRequest.md)
179
197
  - [CloudSignatureSubscription](docs/CloudSignatureSubscription.md)
198
+ - [CompleteTaskRequest](docs/CompleteTaskRequest.md)
180
199
  - [CopyAudit](docs/CopyAudit.md)
181
200
  - [CopyRequest](docs/CopyRequest.md)
182
201
  - [CopyResponse](docs/CopyResponse.md)
@@ -213,6 +232,7 @@ Class | Method | HTTP request | Description
213
232
  - [MergeSource](docs/MergeSource.md)
214
233
  - [MoveAudit](docs/MoveAudit.md)
215
234
  - [MoveRequest](docs/MoveRequest.md)
235
+ - [MyTasksCountDTO](docs/MyTasksCountDTO.md)
216
236
  - [OrganizeRequest](docs/OrganizeRequest.md)
217
237
  - [OutputTarget](docs/OutputTarget.md)
218
238
  - [PageInstruction](docs/PageInstruction.md)
@@ -222,7 +242,9 @@ Class | Method | HTTP request | Description
222
242
  - [PdfOutputInfo](docs/PdfOutputInfo.md)
223
243
  - [PdfPageInfo](docs/PdfPageInfo.md)
224
244
  - [PdfTransformAudit](docs/PdfTransformAudit.md)
245
+ - [PerDefinition](docs/PerDefinition.md)
225
246
  - [PublicSignatureView](docs/PublicSignatureView.md)
247
+ - [ReassignTaskRequest](docs/ReassignTaskRequest.md)
226
248
  - [RenameAudit](docs/RenameAudit.md)
227
249
  - [RenameRequest](docs/RenameRequest.md)
228
250
  - [ReorganizationApplyRequest](docs/ReorganizationApplyRequest.md)
@@ -236,6 +258,7 @@ Class | Method | HTTP request | Description
236
258
  - [RotateRequest](docs/RotateRequest.md)
237
259
  - [SaveAiPreferencesRequest](docs/SaveAiPreferencesRequest.md)
238
260
  - [SaveAiSettingsRequest](docs/SaveAiSettingsRequest.md)
261
+ - [SaveWorkflowDefinitionRequest](docs/SaveWorkflowDefinitionRequest.md)
239
262
  - [SearchByAuditLogRequest](docs/SearchByAuditLogRequest.md)
240
263
  - [SearchByMetadataRequest](docs/SearchByMetadataRequest.md)
241
264
  - [SearchMetadataRequest](docs/SearchMetadataRequest.md)
@@ -255,6 +278,7 @@ Class | Method | HTTP request | Description
255
278
  - [SortInput](docs/SortInput.md)
256
279
  - [SplitOutput](docs/SplitOutput.md)
257
280
  - [SplitRequest](docs/SplitRequest.md)
281
+ - [StartWorkflowRequest](docs/StartWorkflowRequest.md)
258
282
  - [StorageBreakdown](docs/StorageBreakdown.md)
259
283
  - [Suggest](docs/Suggest.md)
260
284
  - [TusConfigResponse](docs/TusConfigResponse.md)
@@ -265,6 +289,22 @@ Class | Method | HTTP request | Description
265
289
  - [UploadAudit](docs/UploadAudit.md)
266
290
  - [UploadResponse](docs/UploadResponse.md)
267
291
  - [VerifyOtpRequest](docs/VerifyOtpRequest.md)
292
+ - [WorkflowAction](docs/WorkflowAction.md)
293
+ - [WorkflowActionFailureAudit](docs/WorkflowActionFailureAudit.md)
294
+ - [WorkflowAssignment](docs/WorkflowAssignment.md)
295
+ - [WorkflowAudit](docs/WorkflowAudit.md)
296
+ - [WorkflowDefinitionDTO](docs/WorkflowDefinitionDTO.md)
297
+ - [WorkflowEventDTO](docs/WorkflowEventDTO.md)
298
+ - [WorkflowInstanceDTO](docs/WorkflowInstanceDTO.md)
299
+ - [WorkflowInstanceDetailDTO](docs/WorkflowInstanceDetailDTO.md)
300
+ - [WorkflowInstancePage](docs/WorkflowInstancePage.md)
301
+ - [WorkflowProblem](docs/WorkflowProblem.md)
302
+ - [WorkflowSpec](docs/WorkflowSpec.md)
303
+ - [WorkflowState](docs/WorkflowState.md)
304
+ - [WorkflowSummaryDTO](docs/WorkflowSummaryDTO.md)
305
+ - [WorkflowTaskDTO](docs/WorkflowTaskDTO.md)
306
+ - [WorkflowTransition](docs/WorkflowTransition.md)
307
+ - [WorkflowValidationResult](docs/WorkflowValidationResult.md)
268
308
 
269
309
 
270
310
  <a id="documentation-for-authorization"></a>
package/api/esign-api.ts CHANGED
@@ -41,9 +41,9 @@ export const ESignApiAxiosParamCreator = function (configuration?: Configuration
41
41
  * @param {*} [options] Override http request option.
42
42
  * @throws {RequiredError}
43
43
  */
44
- cancel: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
44
+ cancel1: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
45
45
  // verify required parameter 'id' is not null or undefined
46
- assertParamExists('cancel', 'id', id)
46
+ assertParamExists('cancel1', 'id', id)
47
47
  const localVarPath = `/api/v1/signatures/{id}/cancel`
48
48
  .replace('{id}', encodeURIComponent(String(id)));
49
49
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -428,10 +428,10 @@ export const ESignApiFp = function(configuration?: Configuration) {
428
428
  * @param {*} [options] Override http request option.
429
429
  * @throws {RequiredError}
430
430
  */
431
- async cancel(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SignatureEnvelopeDTO>> {
432
- const localVarAxiosArgs = await localVarAxiosParamCreator.cancel(id, options);
431
+ async cancel1(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SignatureEnvelopeDTO>> {
432
+ const localVarAxiosArgs = await localVarAxiosParamCreator.cancel1(id, options);
433
433
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
434
- const localVarOperationServerBasePath = operationServerMap['ESignApi.cancel']?.[localVarOperationServerIndex]?.url;
434
+ const localVarOperationServerBasePath = operationServerMap['ESignApi.cancel1']?.[localVarOperationServerIndex]?.url;
435
435
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
436
436
  },
437
437
  /**
@@ -566,8 +566,8 @@ export const ESignApiFactory = function (configuration?: Configuration, basePath
566
566
  * @param {*} [options] Override http request option.
567
567
  * @throws {RequiredError}
568
568
  */
569
- cancel(id: string, options?: RawAxiosRequestConfig): AxiosPromise<SignatureEnvelopeDTO> {
570
- return localVarFp.cancel(id, options).then((request) => request(axios, basePath));
569
+ cancel1(id: string, options?: RawAxiosRequestConfig): AxiosPromise<SignatureEnvelopeDTO> {
570
+ return localVarFp.cancel1(id, options).then((request) => request(axios, basePath));
571
571
  },
572
572
  /**
573
573
  *
@@ -672,8 +672,8 @@ export class ESignApi extends BaseAPI {
672
672
  * @param {*} [options] Override http request option.
673
673
  * @throws {RequiredError}
674
674
  */
675
- public cancel(id: string, options?: RawAxiosRequestConfig) {
676
- return ESignApiFp(this.configuration).cancel(id, options).then((request) => request(this.axios, this.basePath));
675
+ public cancel1(id: string, options?: RawAxiosRequestConfig) {
676
+ return ESignApiFp(this.configuration).cancel1(id, options).then((request) => request(this.axios, this.basePath));
677
677
  }
678
678
 
679
679
  /**
@@ -24,6 +24,8 @@ import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError
24
24
  // @ts-ignore
25
25
  import type { AutoFileJobView } from '../models';
26
26
  // @ts-ignore
27
+ import type { AutoFileJobsRequest } from '../models';
28
+ // @ts-ignore
27
29
  import type { AutoFileRequest } from '../models';
28
30
  // @ts-ignore
29
31
  import type { FilingOutcome } from '../models';
@@ -109,6 +111,45 @@ export const SmartFilingApiAxiosParamCreator = function (configuration?: Configu
109
111
  options: localVarRequestOptions,
110
112
  };
111
113
  },
114
+ /**
115
+ * Follows a whole upload batch in one call: the browser sends one upload request per file, so a batch leaves as many jobs to poll. Jobs that do not exist, or belong to somebody else, are left out of the answer rather than failing it. A POST because a batch of ids does not fit in a query string.
116
+ * @summary Progress and outcome of several filing jobs
117
+ * @param {AutoFileJobsRequest} autoFileJobsRequest
118
+ * @param {*} [options] Override http request option.
119
+ * @throws {RequiredError}
120
+ */
121
+ jobs: async (autoFileJobsRequest: AutoFileJobsRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
122
+ // verify required parameter 'autoFileJobsRequest' is not null or undefined
123
+ assertParamExists('jobs', 'autoFileJobsRequest', autoFileJobsRequest)
124
+ const localVarPath = `/api/v1/ai/auto-file/jobs`;
125
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
126
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
127
+ let baseOptions;
128
+ if (configuration) {
129
+ baseOptions = configuration.baseOptions;
130
+ }
131
+
132
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
133
+ const localVarHeaderParameter = {} as any;
134
+ const localVarQueryParameter = {} as any;
135
+
136
+ // authentication keycloak_auth required
137
+ // http bearer authentication required
138
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
139
+
140
+ localVarHeaderParameter['Content-Type'] = 'application/json';
141
+ localVarHeaderParameter['Accept'] = 'application/json';
142
+
143
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
144
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
145
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
146
+ localVarRequestOptions.data = serializeDataIfNeeded(autoFileJobsRequest, localVarRequestOptions, configuration)
147
+
148
+ return {
149
+ url: toPathString(localVarUrlObj),
150
+ options: localVarRequestOptions,
151
+ };
152
+ },
112
153
  /**
113
154
  *
114
155
  * @summary The latest filing record of a document (the \"Filed by OpenFilz\" chip)
@@ -258,6 +299,19 @@ export const SmartFilingApiFp = function(configuration?: Configuration) {
258
299
  const localVarOperationServerBasePath = operationServerMap['SmartFilingApi.job']?.[localVarOperationServerIndex]?.url;
259
300
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
260
301
  },
302
+ /**
303
+ * Follows a whole upload batch in one call: the browser sends one upload request per file, so a batch leaves as many jobs to poll. Jobs that do not exist, or belong to somebody else, are left out of the answer rather than failing it. A POST because a batch of ids does not fit in a query string.
304
+ * @summary Progress and outcome of several filing jobs
305
+ * @param {AutoFileJobsRequest} autoFileJobsRequest
306
+ * @param {*} [options] Override http request option.
307
+ * @throws {RequiredError}
308
+ */
309
+ async jobs(autoFileJobsRequest: AutoFileJobsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AutoFileJobView>>> {
310
+ const localVarAxiosArgs = await localVarAxiosParamCreator.jobs(autoFileJobsRequest, options);
311
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
312
+ const localVarOperationServerBasePath = operationServerMap['SmartFilingApi.jobs']?.[localVarOperationServerIndex]?.url;
313
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
314
+ },
261
315
  /**
262
316
  *
263
317
  * @summary The latest filing record of a document (the \"Filed by OpenFilz\" chip)
@@ -326,6 +380,16 @@ export const SmartFilingApiFactory = function (configuration?: Configuration, ba
326
380
  job(jobId: string, options?: RawAxiosRequestConfig): AxiosPromise<AutoFileJobView> {
327
381
  return localVarFp.job(jobId, options).then((request) => request(axios, basePath));
328
382
  },
383
+ /**
384
+ * Follows a whole upload batch in one call: the browser sends one upload request per file, so a batch leaves as many jobs to poll. Jobs that do not exist, or belong to somebody else, are left out of the answer rather than failing it. A POST because a batch of ids does not fit in a query string.
385
+ * @summary Progress and outcome of several filing jobs
386
+ * @param {AutoFileJobsRequest} autoFileJobsRequest
387
+ * @param {*} [options] Override http request option.
388
+ * @throws {RequiredError}
389
+ */
390
+ jobs(autoFileJobsRequest: AutoFileJobsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<AutoFileJobView>> {
391
+ return localVarFp.jobs(autoFileJobsRequest, options).then((request) => request(axios, basePath));
392
+ },
329
393
  /**
330
394
  *
331
395
  * @summary The latest filing record of a document (the \"Filed by OpenFilz\" chip)
@@ -385,6 +449,17 @@ export class SmartFilingApi extends BaseAPI {
385
449
  return SmartFilingApiFp(this.configuration).job(jobId, options).then((request) => request(this.axios, this.basePath));
386
450
  }
387
451
 
452
+ /**
453
+ * Follows a whole upload batch in one call: the browser sends one upload request per file, so a batch leaves as many jobs to poll. Jobs that do not exist, or belong to somebody else, are left out of the answer rather than failing it. A POST because a batch of ids does not fit in a query string.
454
+ * @summary Progress and outcome of several filing jobs
455
+ * @param {AutoFileJobsRequest} autoFileJobsRequest
456
+ * @param {*} [options] Override http request option.
457
+ * @throws {RequiredError}
458
+ */
459
+ public jobs(autoFileJobsRequest: AutoFileJobsRequest, options?: RawAxiosRequestConfig) {
460
+ return SmartFilingApiFp(this.configuration).jobs(autoFileJobsRequest, options).then((request) => request(this.axios, this.basePath));
461
+ }
462
+
388
463
  /**
389
464
  *
390
465
  * @summary The latest filing record of a document (the \"Filed by OpenFilz\" chip)