@openfilz-sdk/typescript-ee 1.9.9 → 1.9.11

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 (204) 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.d.ts +12 -0
  25. package/dist/esm/models/auto-file-jobs-request.d.ts +14 -0
  26. package/dist/esm/models/auto-file-jobs-request.js +14 -0
  27. package/dist/esm/models/cancel-instance-request.d.ts +14 -0
  28. package/dist/esm/models/cancel-instance-request.js +14 -0
  29. package/dist/esm/models/complete-task-request.d.ts +15 -0
  30. package/dist/esm/models/complete-task-request.js +14 -0
  31. package/dist/esm/models/enriched-audit-log-details.d.ts +7 -1
  32. package/dist/esm/models/enriched-audit-log.d.ts +9 -0
  33. package/dist/esm/models/enriched-audit-log.js +9 -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/notification-dto.d.ts +4 -0
  39. package/dist/esm/models/notification-dto.js +4 -0
  40. package/dist/esm/models/per-definition.d.ts +18 -0
  41. package/dist/esm/models/per-definition.js +14 -0
  42. package/dist/esm/models/reassign-task-request.d.ts +15 -0
  43. package/dist/esm/models/reassign-task-request.js +14 -0
  44. package/dist/esm/models/save-workflow-definition-request.d.ts +19 -0
  45. package/dist/esm/models/save-workflow-definition-request.js +14 -0
  46. package/dist/esm/models/search-by-audit-log-request.d.ts +9 -0
  47. package/dist/esm/models/search-by-audit-log-request.js +9 -0
  48. package/dist/esm/models/settings.d.ts +3 -0
  49. package/dist/esm/models/start-workflow-request.d.ts +20 -0
  50. package/dist/esm/models/start-workflow-request.js +14 -0
  51. package/dist/esm/models/workflow-action-failure-audit.d.ts +17 -0
  52. package/dist/esm/models/workflow-action-failure-audit.js +14 -0
  53. package/dist/esm/models/workflow-action.d.ts +25 -0
  54. package/dist/esm/models/workflow-action.js +18 -0
  55. package/dist/esm/models/workflow-assignment.d.ts +24 -0
  56. package/dist/esm/models/workflow-assignment.js +19 -0
  57. package/dist/esm/models/workflow-audit.d.ts +17 -0
  58. package/dist/esm/models/workflow-audit.js +14 -0
  59. package/dist/esm/models/workflow-definition-dto.d.ts +26 -0
  60. package/dist/esm/models/workflow-definition-dto.js +14 -0
  61. package/dist/esm/models/workflow-event-dto.d.ts +35 -0
  62. package/dist/esm/models/workflow-event-dto.js +23 -0
  63. package/dist/esm/models/workflow-instance-detail-dto.d.ts +23 -0
  64. package/dist/esm/models/workflow-instance-detail-dto.js +14 -0
  65. package/dist/esm/models/workflow-instance-dto.d.ts +35 -0
  66. package/dist/esm/models/workflow-instance-dto.js +18 -0
  67. package/dist/esm/models/workflow-instance-page.d.ts +18 -0
  68. package/dist/esm/models/workflow-instance-page.js +14 -0
  69. package/dist/esm/models/workflow-problem.d.ts +17 -0
  70. package/dist/esm/models/workflow-problem.js +14 -0
  71. package/dist/esm/models/workflow-spec.d.ts +15 -0
  72. package/dist/esm/models/workflow-spec.js +14 -0
  73. package/dist/esm/models/workflow-state.d.ts +31 -0
  74. package/dist/esm/models/workflow-state.js +18 -0
  75. package/dist/esm/models/workflow-summary-dto.d.ts +19 -0
  76. package/dist/esm/models/workflow-summary-dto.js +14 -0
  77. package/dist/esm/models/workflow-task-dto.d.ts +44 -0
  78. package/dist/esm/models/workflow-task-dto.js +18 -0
  79. package/dist/esm/models/workflow-transition.d.ts +25 -0
  80. package/dist/esm/models/workflow-transition.js +19 -0
  81. package/dist/esm/models/workflow-validation-result.d.ts +16 -0
  82. package/dist/esm/models/workflow-validation-result.js +14 -0
  83. package/dist/models/audit-log-details.d.ts +12 -0
  84. package/dist/models/auto-file-jobs-request.d.ts +14 -0
  85. package/dist/models/auto-file-jobs-request.js +15 -0
  86. package/dist/models/cancel-instance-request.d.ts +14 -0
  87. package/dist/models/cancel-instance-request.js +15 -0
  88. package/dist/models/complete-task-request.d.ts +15 -0
  89. package/dist/models/complete-task-request.js +15 -0
  90. package/dist/models/enriched-audit-log-details.d.ts +7 -1
  91. package/dist/models/enriched-audit-log.d.ts +9 -0
  92. package/dist/models/enriched-audit-log.js +9 -0
  93. package/dist/models/index.d.ts +24 -0
  94. package/dist/models/index.js +24 -0
  95. package/dist/models/my-tasks-count-dto.d.ts +15 -0
  96. package/dist/models/my-tasks-count-dto.js +15 -0
  97. package/dist/models/notification-dto.d.ts +4 -0
  98. package/dist/models/notification-dto.js +4 -0
  99. package/dist/models/per-definition.d.ts +18 -0
  100. package/dist/models/per-definition.js +15 -0
  101. package/dist/models/reassign-task-request.d.ts +15 -0
  102. package/dist/models/reassign-task-request.js +15 -0
  103. package/dist/models/save-workflow-definition-request.d.ts +19 -0
  104. package/dist/models/save-workflow-definition-request.js +15 -0
  105. package/dist/models/search-by-audit-log-request.d.ts +9 -0
  106. package/dist/models/search-by-audit-log-request.js +9 -0
  107. package/dist/models/settings.d.ts +3 -0
  108. package/dist/models/start-workflow-request.d.ts +20 -0
  109. package/dist/models/start-workflow-request.js +15 -0
  110. package/dist/models/workflow-action-failure-audit.d.ts +17 -0
  111. package/dist/models/workflow-action-failure-audit.js +15 -0
  112. package/dist/models/workflow-action.d.ts +25 -0
  113. package/dist/models/workflow-action.js +21 -0
  114. package/dist/models/workflow-assignment.d.ts +24 -0
  115. package/dist/models/workflow-assignment.js +22 -0
  116. package/dist/models/workflow-audit.d.ts +17 -0
  117. package/dist/models/workflow-audit.js +15 -0
  118. package/dist/models/workflow-definition-dto.d.ts +26 -0
  119. package/dist/models/workflow-definition-dto.js +15 -0
  120. package/dist/models/workflow-event-dto.d.ts +35 -0
  121. package/dist/models/workflow-event-dto.js +26 -0
  122. package/dist/models/workflow-instance-detail-dto.d.ts +23 -0
  123. package/dist/models/workflow-instance-detail-dto.js +15 -0
  124. package/dist/models/workflow-instance-dto.d.ts +35 -0
  125. package/dist/models/workflow-instance-dto.js +21 -0
  126. package/dist/models/workflow-instance-page.d.ts +18 -0
  127. package/dist/models/workflow-instance-page.js +15 -0
  128. package/dist/models/workflow-problem.d.ts +17 -0
  129. package/dist/models/workflow-problem.js +15 -0
  130. package/dist/models/workflow-spec.d.ts +15 -0
  131. package/dist/models/workflow-spec.js +15 -0
  132. package/dist/models/workflow-state.d.ts +31 -0
  133. package/dist/models/workflow-state.js +21 -0
  134. package/dist/models/workflow-summary-dto.d.ts +19 -0
  135. package/dist/models/workflow-summary-dto.js +15 -0
  136. package/dist/models/workflow-task-dto.d.ts +44 -0
  137. package/dist/models/workflow-task-dto.js +21 -0
  138. package/dist/models/workflow-transition.d.ts +25 -0
  139. package/dist/models/workflow-transition.js +22 -0
  140. package/dist/models/workflow-validation-result.d.ts +16 -0
  141. package/dist/models/workflow-validation-result.js +15 -0
  142. package/docs/AuditLogDetails.md +6 -0
  143. package/docs/AutoFileJobsRequest.md +20 -0
  144. package/docs/CancelInstanceRequest.md +20 -0
  145. package/docs/CompleteTaskRequest.md +22 -0
  146. package/docs/ESignApi.md +4 -4
  147. package/docs/EnrichedAuditLogDetails.md +22 -0
  148. package/docs/MyTasksCountDTO.md +22 -0
  149. package/docs/PerDefinition.md +28 -0
  150. package/docs/ReassignTaskRequest.md +22 -0
  151. package/docs/SaveWorkflowDefinitionRequest.md +28 -0
  152. package/docs/Settings.md +6 -0
  153. package/docs/SmartFilingApi.md +53 -0
  154. package/docs/StartWorkflowRequest.md +28 -0
  155. package/docs/WorkflowAction.md +26 -0
  156. package/docs/WorkflowActionFailureAudit.md +25 -0
  157. package/docs/WorkflowAssignment.md +26 -0
  158. package/docs/WorkflowAudit.md +31 -0
  159. package/docs/WorkflowDefinitionDTO.md +42 -0
  160. package/docs/WorkflowEventDTO.md +36 -0
  161. package/docs/WorkflowInstanceDTO.md +48 -0
  162. package/docs/WorkflowInstanceDetailDTO.md +28 -0
  163. package/docs/WorkflowInstancePage.md +26 -0
  164. package/docs/WorkflowProblem.md +26 -0
  165. package/docs/WorkflowSpec.md +20 -0
  166. package/docs/WorkflowState.md +36 -0
  167. package/docs/WorkflowSummaryDTO.md +28 -0
  168. package/docs/WorkflowTaskDTO.md +66 -0
  169. package/docs/WorkflowTransition.md +28 -0
  170. package/docs/WorkflowValidationResult.md +22 -0
  171. package/docs/WorkflowsApi.md +791 -0
  172. package/graphql/document.graphqls +2 -0
  173. package/models/audit-log-details.ts +12 -0
  174. package/models/auto-file-jobs-request.ts +20 -0
  175. package/models/cancel-instance-request.ts +20 -0
  176. package/models/complete-task-request.ts +21 -0
  177. package/models/enriched-audit-log-details.ts +7 -1
  178. package/models/enriched-audit-log.ts +9 -0
  179. package/models/index.ts +24 -0
  180. package/models/my-tasks-count-dto.ts +21 -0
  181. package/models/notification-dto.ts +4 -0
  182. package/models/per-definition.ts +24 -0
  183. package/models/reassign-task-request.ts +21 -0
  184. package/models/save-workflow-definition-request.ts +27 -0
  185. package/models/search-by-audit-log-request.ts +9 -0
  186. package/models/settings.ts +3 -0
  187. package/models/start-workflow-request.ts +24 -0
  188. package/models/workflow-action-failure-audit.ts +26 -0
  189. package/models/workflow-action.ts +32 -0
  190. package/models/workflow-assignment.ts +33 -0
  191. package/models/workflow-audit.ts +26 -0
  192. package/models/workflow-definition-dto.ts +34 -0
  193. package/models/workflow-event-dto.ts +42 -0
  194. package/models/workflow-instance-detail-dto.ts +33 -0
  195. package/models/workflow-instance-dto.ts +46 -0
  196. package/models/workflow-instance-page.ts +26 -0
  197. package/models/workflow-problem.ts +23 -0
  198. package/models/workflow-spec.ts +23 -0
  199. package/models/workflow-state.ts +46 -0
  200. package/models/workflow-summary-dto.ts +27 -0
  201. package/models/workflow-task-dto.ts +55 -0
  202. package/models/workflow-transition.ts +34 -0
  203. package/models/workflow-validation-result.ts +24 -0
  204. package/package.json +1 -1
package/docs/ESignApi.md CHANGED
@@ -4,7 +4,7 @@ All URIs are relative to *http://localhost:8081*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
- |[**cancel**](#cancel) | **POST** /api/v1/signatures/{id}/cancel | Cancel a non-terminal envelope|
7
+ |[**cancel1**](#cancel1) | **POST** /api/v1/signatures/{id}/cancel | Cancel a non-terminal envelope|
8
8
  |[**cloudSubscription**](#cloudsubscription) | **GET** /api/v1/signatures/cloud-subscription | Cloud Signing subscription and month-to-date usage (openfilz-cloud seal provider only)|
9
9
  |[**create**](#create) | **POST** /api/v1/signatures | Create an envelope (sent immediately unless send=false)|
10
10
  |[**events**](#events) | **GET** /api/v1/signatures/{id}/events | Audit trail of one of my envelopes|
@@ -15,8 +15,8 @@ All URIs are relative to *http://localhost:8081*
15
15
  |[**send**](#send) | **POST** /api/v1/signatures/{id}/send | Send a DRAFT envelope|
16
16
  |[**signedDocument**](#signeddocument) | **GET** /api/v1/signatures/{id}/signed-document | Download the sealed PDF of a completed envelope|
17
17
 
18
- # **cancel**
19
- > SignatureEnvelopeDTO cancel()
18
+ # **cancel1**
19
+ > SignatureEnvelopeDTO cancel1()
20
20
 
21
21
 
22
22
  ### Example
@@ -32,7 +32,7 @@ const apiInstance = new ESignApi(configuration);
32
32
 
33
33
  let id: string; // (default to undefined)
34
34
 
35
- const { status, data } = await apiInstance.cancel(
35
+ const { status, data } = await apiInstance.cancel1(
36
36
  id
37
37
  );
38
38
  ```
@@ -5,6 +5,9 @@
5
5
 
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
+ **workflowInstanceId** | **string** | Workflow instance this action was part of, when a workflow caused it | [optional] [default to undefined]
9
+ **workflow** | **string** | Workflow definition name | [optional] [default to undefined]
10
+ **workflowState** | **string** | Label of the workflow status whose entry caused this action | [optional] [default to undefined]
8
11
  **type** | **string** | | [default to undefined]
9
12
  **sourceFileId** | **string** | | [optional] [default to undefined]
10
13
  **targetFolderId** | **string** | | [optional] [default to undefined]
@@ -23,6 +26,14 @@ Name | Type | Description | Notes
23
26
  **restoredFromDate** | **string** | Creation date of the restored version | [optional] [default to undefined]
24
27
  **updatedMetadata** | **{ [key: string]: any; }** | Updated Metadata | [optional] [default to undefined]
25
28
  **parentFolderId** | **string** | | [optional] [default to undefined]
29
+ **action** | **string** | Action that failed (MOVE_TO_FOLDER, SET_METADATA, NOTIFY) | [optional] [default to undefined]
30
+ **target** | **string** | What it targeted: the destination folder, the metadata keys, the recipients | [optional] [default to undefined]
31
+ **error** | **string** | Why it failed | [optional] [default to undefined]
32
+ **instanceId** | **string** | Workflow instance | [optional] [default to undefined]
33
+ **fromState** | **string** | Status left (null on start) | [optional] [default to undefined]
34
+ **toState** | **string** | Status entered | [optional] [default to undefined]
35
+ **transition** | **string** | Transition taken | [optional] [default to undefined]
36
+ **comment** | **string** | Decision comment | [optional] [default to undefined]
26
37
 
27
38
  ## Example
28
39
 
@@ -30,6 +41,9 @@ Name | Type | Description | Notes
30
41
  import { EnrichedAuditLogDetails } from '@openfilz-sdk/typescript-ee';
31
42
 
32
43
  const instance: EnrichedAuditLogDetails = {
44
+ workflowInstanceId,
45
+ workflow,
46
+ workflowState,
33
47
  type,
34
48
  sourceFileId,
35
49
  targetFolderId,
@@ -48,6 +62,14 @@ const instance: EnrichedAuditLogDetails = {
48
62
  restoredFromDate,
49
63
  updatedMetadata,
50
64
  parentFolderId,
65
+ action,
66
+ target,
67
+ error,
68
+ instanceId,
69
+ fromState,
70
+ toState,
71
+ transition,
72
+ comment,
51
73
  };
52
74
  ```
53
75
 
@@ -0,0 +1,22 @@
1
+ # MyTasksCountDTO
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **count** | **number** | | [optional] [default to undefined]
9
+ **overdue** | **number** | | [optional] [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { MyTasksCountDTO } from '@openfilz-sdk/typescript-ee';
15
+
16
+ const instance: MyTasksCountDTO = {
17
+ count,
18
+ overdue,
19
+ };
20
+ ```
21
+
22
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,28 @@
1
+ # PerDefinition
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **definitionId** | **string** | | [optional] [default to undefined]
9
+ **definitionName** | **string** | | [optional] [default to undefined]
10
+ **running** | **number** | | [optional] [default to undefined]
11
+ **completed** | **number** | | [optional] [default to undefined]
12
+ **cancelled** | **number** | | [optional] [default to undefined]
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import { PerDefinition } from '@openfilz-sdk/typescript-ee';
18
+
19
+ const instance: PerDefinition = {
20
+ definitionId,
21
+ definitionName,
22
+ running,
23
+ completed,
24
+ cancelled,
25
+ };
26
+ ```
27
+
28
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,22 @@
1
+ # ReassignTaskRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **emails** | **Array<string>** | | [default to undefined]
9
+ **comment** | **string** | | [optional] [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { ReassignTaskRequest } from '@openfilz-sdk/typescript-ee';
15
+
16
+ const instance: ReassignTaskRequest = {
17
+ emails,
18
+ comment,
19
+ };
20
+ ```
21
+
22
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,28 @@
1
+ # SaveWorkflowDefinitionRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **name** | **string** | | [default to undefined]
9
+ **description** | **string** | | [optional] [default to undefined]
10
+ **active** | **boolean** | | [optional] [default to undefined]
11
+ **spec** | [**WorkflowSpec**](WorkflowSpec.md) | | [default to undefined]
12
+ **triggerFolderIds** | **Array<string>** | | [optional] [default to undefined]
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import { SaveWorkflowDefinitionRequest } from '@openfilz-sdk/typescript-ee';
18
+
19
+ const instance: SaveWorkflowDefinitionRequest = {
20
+ name,
21
+ description,
22
+ active,
23
+ spec,
24
+ triggerFolderIds,
25
+ };
26
+ ```
27
+
28
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
package/docs/Settings.md CHANGED
@@ -12,6 +12,7 @@ Name | Type | Description | Notes
12
12
  **theme** | **string** | | [optional] [default to undefined]
13
13
  **thumbnailsActive** | **boolean** | | [optional] [default to undefined]
14
14
  **aiActive** | **boolean** | | [optional] [default to undefined]
15
+ **aiChatActive** | **boolean** | | [optional] [default to undefined]
15
16
  **aiUserSettingsEnabled** | **boolean** | | [optional] [default to undefined]
16
17
  **aiInsightsActive** | **boolean** | | [optional] [default to undefined]
17
18
  **aiInsightsCategories** | **Array<string>** | | [optional] [default to undefined]
@@ -22,6 +23,8 @@ Name | Type | Description | Notes
22
23
  **signatureAuthMethods** | **Array<string>** | | [optional] [default to undefined]
23
24
  **signatureRemindersActive** | **boolean** | | [optional] [default to undefined]
24
25
  **signatureCloudActive** | **boolean** | | [optional] [default to undefined]
26
+ **workflowsActive** | **boolean** | | [optional] [default to undefined]
27
+ **workflowDesignerRoleRequired** | **boolean** | | [optional] [default to undefined]
25
28
  **demoMode** | **boolean** | | [optional] [default to undefined]
26
29
  **sealProvider** | **string** | | [optional] [default to undefined]
27
30
  **mcpActive** | **boolean** | | [optional] [default to undefined]
@@ -43,6 +46,7 @@ const instance: Settings = {
43
46
  theme,
44
47
  thumbnailsActive,
45
48
  aiActive,
49
+ aiChatActive,
46
50
  aiUserSettingsEnabled,
47
51
  aiInsightsActive,
48
52
  aiInsightsCategories,
@@ -53,6 +57,8 @@ const instance: Settings = {
53
57
  signatureAuthMethods,
54
58
  signatureRemindersActive,
55
59
  signatureCloudActive,
60
+ workflowsActive,
61
+ workflowDesignerRoleRequired,
56
62
  demoMode,
57
63
  sealProvider,
58
64
  mcpActive,
@@ -6,6 +6,7 @@ All URIs are relative to *http://localhost:8081*
6
6
  |------------- | ------------- | -------------|
7
7
  |[**file**](#file) | **POST** /api/v1/ai/auto-file | File existing documents on demand|
8
8
  |[**job**](#job) | **GET** /api/v1/ai/auto-file/{jobId} | Progress and outcome of a filing job|
9
+ |[**jobs**](#jobs) | **POST** /api/v1/ai/auto-file/jobs | Progress and outcome of several filing jobs|
9
10
  |[**lastFiling**](#lastfiling) | **GET** /api/v1/ai/auto-file/document/{documentId} | The latest filing record of a document (the \"Filed by OpenFilz\" chip)|
10
11
  |[**undo**](#undo) | **POST** /api/v1/ai/auto-file/{jobId}/undo | Move every document the job filed back where it came from|
11
12
  |[**undoFiling**](#undofiling) | **POST** /api/v1/ai/auto-file/filing/{planId}/undo | Move one filed document back (the chip\'s \"Move back\")|
@@ -105,6 +106,58 @@ const { status, data } = await apiInstance.job(
105
106
  - **Accept**: application/json
106
107
 
107
108
 
109
+ ### HTTP response details
110
+ | Status code | Description | Response headers |
111
+ |-------------|-------------|------------------|
112
+ |**200** | OK | - |
113
+
114
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
115
+
116
+ # **jobs**
117
+ > Array<AutoFileJobView> jobs(autoFileJobsRequest)
118
+
119
+ 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.
120
+
121
+ ### Example
122
+
123
+ ```typescript
124
+ import {
125
+ SmartFilingApi,
126
+ Configuration,
127
+ AutoFileJobsRequest
128
+ } from '@openfilz-sdk/typescript-ee';
129
+
130
+ const configuration = new Configuration();
131
+ const apiInstance = new SmartFilingApi(configuration);
132
+
133
+ let autoFileJobsRequest: AutoFileJobsRequest; //
134
+
135
+ const { status, data } = await apiInstance.jobs(
136
+ autoFileJobsRequest
137
+ );
138
+ ```
139
+
140
+ ### Parameters
141
+
142
+ |Name | Type | Description | Notes|
143
+ |------------- | ------------- | ------------- | -------------|
144
+ | **autoFileJobsRequest** | **AutoFileJobsRequest**| | |
145
+
146
+
147
+ ### Return type
148
+
149
+ **Array<AutoFileJobView>**
150
+
151
+ ### Authorization
152
+
153
+ [keycloak_auth](../README.md#keycloak_auth)
154
+
155
+ ### HTTP request headers
156
+
157
+ - **Content-Type**: application/json
158
+ - **Accept**: application/json
159
+
160
+
108
161
  ### HTTP response details
109
162
  | Status code | Description | Response headers |
110
163
  |-------------|-------------|------------------|
@@ -0,0 +1,28 @@
1
+ # StartWorkflowRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **definitionId** | **string** | | [default to undefined]
9
+ **documentId** | **string** | | [default to undefined]
10
+ **assignments** | **{ [key: string]: Array&lt;string&gt;; }** | | [optional] [default to undefined]
11
+ **transitionKey** | **string** | | [optional] [default to undefined]
12
+ **comment** | **string** | | [optional] [default to undefined]
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import { StartWorkflowRequest } from '@openfilz-sdk/typescript-ee';
18
+
19
+ const instance: StartWorkflowRequest = {
20
+ definitionId,
21
+ documentId,
22
+ assignments,
23
+ transitionKey,
24
+ comment,
25
+ };
26
+ ```
27
+
28
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,26 @@
1
+ # WorkflowAction
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **type** | **string** | | [optional] [default to undefined]
9
+ **folderId** | **string** | | [optional] [default to undefined]
10
+ **entries** | **{ [key: string]: any; }** | | [optional] [default to undefined]
11
+ **emails** | **Array&lt;string&gt;** | | [optional] [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { WorkflowAction } from '@openfilz-sdk/typescript-ee';
17
+
18
+ const instance: WorkflowAction = {
19
+ type,
20
+ folderId,
21
+ entries,
22
+ emails,
23
+ };
24
+ ```
25
+
26
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,25 @@
1
+ # WorkflowActionFailureAudit
2
+
3
+ type=workflowActionFailure
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **action** | **string** | Action that failed (MOVE_TO_FOLDER, SET_METADATA, NOTIFY) | [optional] [default to undefined]
10
+ **target** | **string** | What it targeted: the destination folder, the metadata keys, the recipients | [optional] [default to undefined]
11
+ **error** | **string** | Why it failed | [optional] [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { WorkflowActionFailureAudit } from '@openfilz-sdk/typescript-ee';
17
+
18
+ const instance: WorkflowActionFailureAudit = {
19
+ action,
20
+ target,
21
+ error,
22
+ };
23
+ ```
24
+
25
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,26 @@
1
+ # WorkflowAssignment
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **type** | **string** | | [optional] [default to undefined]
9
+ **emails** | **Array&lt;string&gt;** | | [optional] [default to undefined]
10
+ **role** | **string** | | [optional] [default to undefined]
11
+ **label** | **string** | | [optional] [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { WorkflowAssignment } from '@openfilz-sdk/typescript-ee';
17
+
18
+ const instance: WorkflowAssignment = {
19
+ type,
20
+ emails,
21
+ role,
22
+ label,
23
+ };
24
+ ```
25
+
26
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,31 @@
1
+ # WorkflowAudit
2
+
3
+ type=workflow
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **workflow** | **string** | Workflow definition name | [optional] [default to undefined]
10
+ **instanceId** | **string** | Workflow instance | [optional] [default to undefined]
11
+ **fromState** | **string** | Status left (null on start) | [optional] [default to undefined]
12
+ **toState** | **string** | Status entered | [optional] [default to undefined]
13
+ **transition** | **string** | Transition taken | [optional] [default to undefined]
14
+ **comment** | **string** | Decision comment | [optional] [default to undefined]
15
+
16
+ ## Example
17
+
18
+ ```typescript
19
+ import { WorkflowAudit } from '@openfilz-sdk/typescript-ee';
20
+
21
+ const instance: WorkflowAudit = {
22
+ workflow,
23
+ instanceId,
24
+ fromState,
25
+ toState,
26
+ transition,
27
+ comment,
28
+ };
29
+ ```
30
+
31
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,42 @@
1
+ # WorkflowDefinitionDTO
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **id** | **string** | | [optional] [default to undefined]
9
+ **name** | **string** | | [optional] [default to undefined]
10
+ **description** | **string** | | [optional] [default to undefined]
11
+ **active** | **boolean** | | [optional] [default to undefined]
12
+ **spec** | [**WorkflowSpec**](WorkflowSpec.md) | | [optional] [default to undefined]
13
+ **triggerFolderIds** | **Array&lt;string&gt;** | | [optional] [default to undefined]
14
+ **version** | **number** | | [optional] [default to undefined]
15
+ **createdBy** | **string** | | [optional] [default to undefined]
16
+ **createdAt** | **string** | | [optional] [default to undefined]
17
+ **updatedAt** | **string** | | [optional] [default to undefined]
18
+ **runningCount** | **number** | | [optional] [default to undefined]
19
+ **canEdit** | **boolean** | | [optional] [default to undefined]
20
+
21
+ ## Example
22
+
23
+ ```typescript
24
+ import { WorkflowDefinitionDTO } from '@openfilz-sdk/typescript-ee';
25
+
26
+ const instance: WorkflowDefinitionDTO = {
27
+ id,
28
+ name,
29
+ description,
30
+ active,
31
+ spec,
32
+ triggerFolderIds,
33
+ version,
34
+ createdBy,
35
+ createdAt,
36
+ updatedAt,
37
+ runningCount,
38
+ canEdit,
39
+ };
40
+ ```
41
+
42
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,36 @@
1
+ # WorkflowEventDTO
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **id** | **string** | | [optional] [default to undefined]
9
+ **type** | **string** | | [optional] [default to undefined]
10
+ **fromState** | **string** | | [optional] [default to undefined]
11
+ **toState** | **string** | | [optional] [default to undefined]
12
+ **transitionKey** | **string** | | [optional] [default to undefined]
13
+ **actor** | **string** | | [optional] [default to undefined]
14
+ **comment** | **string** | | [optional] [default to undefined]
15
+ **details** | **{ [key: string]: any; }** | | [optional] [default to undefined]
16
+ **createdAt** | **string** | | [optional] [default to undefined]
17
+
18
+ ## Example
19
+
20
+ ```typescript
21
+ import { WorkflowEventDTO } from '@openfilz-sdk/typescript-ee';
22
+
23
+ const instance: WorkflowEventDTO = {
24
+ id,
25
+ type,
26
+ fromState,
27
+ toState,
28
+ transitionKey,
29
+ actor,
30
+ comment,
31
+ details,
32
+ createdAt,
33
+ };
34
+ ```
35
+
36
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,48 @@
1
+ # WorkflowInstanceDTO
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **id** | **string** | | [optional] [default to undefined]
9
+ **definitionId** | **string** | | [optional] [default to undefined]
10
+ **definitionName** | **string** | | [optional] [default to undefined]
11
+ **definitionVersion** | **number** | | [optional] [default to undefined]
12
+ **documentId** | **string** | | [optional] [default to undefined]
13
+ **documentName** | **string** | | [optional] [default to undefined]
14
+ **status** | **string** | | [optional] [default to undefined]
15
+ **currentStateKey** | **string** | | [optional] [default to undefined]
16
+ **currentStateLabel** | **string** | | [optional] [default to undefined]
17
+ **currentStateColor** | **string** | | [optional] [default to undefined]
18
+ **startedBy** | **string** | | [optional] [default to undefined]
19
+ **startedAt** | **string** | | [optional] [default to undefined]
20
+ **updatedAt** | **string** | | [optional] [default to undefined]
21
+ **completedAt** | **string** | | [optional] [default to undefined]
22
+ **currentTask** | [**WorkflowTaskDTO**](WorkflowTaskDTO.md) | | [optional] [default to undefined]
23
+
24
+ ## Example
25
+
26
+ ```typescript
27
+ import { WorkflowInstanceDTO } from '@openfilz-sdk/typescript-ee';
28
+
29
+ const instance: WorkflowInstanceDTO = {
30
+ id,
31
+ definitionId,
32
+ definitionName,
33
+ definitionVersion,
34
+ documentId,
35
+ documentName,
36
+ status,
37
+ currentStateKey,
38
+ currentStateLabel,
39
+ currentStateColor,
40
+ startedBy,
41
+ startedAt,
42
+ updatedAt,
43
+ completedAt,
44
+ currentTask,
45
+ };
46
+ ```
47
+
48
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,28 @@
1
+ # WorkflowInstanceDetailDTO
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **instance** | [**WorkflowInstanceDTO**](WorkflowInstanceDTO.md) | | [optional] [default to undefined]
9
+ **spec** | [**WorkflowSpec**](WorkflowSpec.md) | | [optional] [default to undefined]
10
+ **assignments** | **{ [key: string]: Array&lt;string&gt;; }** | | [optional] [default to undefined]
11
+ **history** | [**Array&lt;WorkflowEventDTO&gt;**](WorkflowEventDTO.md) | | [optional] [default to undefined]
12
+ **canManage** | **boolean** | | [optional] [default to undefined]
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import { WorkflowInstanceDetailDTO } from '@openfilz-sdk/typescript-ee';
18
+
19
+ const instance: WorkflowInstanceDetailDTO = {
20
+ instance,
21
+ spec,
22
+ assignments,
23
+ history,
24
+ canManage,
25
+ };
26
+ ```
27
+
28
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,26 @@
1
+ # WorkflowInstancePage
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **items** | [**Array&lt;WorkflowInstanceDTO&gt;**](WorkflowInstanceDTO.md) | | [optional] [default to undefined]
9
+ **total** | **number** | | [optional] [default to undefined]
10
+ **page** | **number** | | [optional] [default to undefined]
11
+ **size** | **number** | | [optional] [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { WorkflowInstancePage } from '@openfilz-sdk/typescript-ee';
17
+
18
+ const instance: WorkflowInstancePage = {
19
+ items,
20
+ total,
21
+ page,
22
+ size,
23
+ };
24
+ ```
25
+
26
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,26 @@
1
+ # WorkflowProblem
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **path** | **string** | | [optional] [default to undefined]
9
+ **code** | **string** | | [optional] [default to undefined]
10
+ **message** | **string** | | [optional] [default to undefined]
11
+ **args** | **Array&lt;string&gt;** | | [optional] [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { WorkflowProblem } from '@openfilz-sdk/typescript-ee';
17
+
18
+ const instance: WorkflowProblem = {
19
+ path,
20
+ code,
21
+ message,
22
+ args,
23
+ };
24
+ ```
25
+
26
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,20 @@
1
+ # WorkflowSpec
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **states** | [**Array&lt;WorkflowState&gt;**](WorkflowState.md) | | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { WorkflowSpec } from '@openfilz-sdk/typescript-ee';
14
+
15
+ const instance: WorkflowSpec = {
16
+ states,
17
+ };
18
+ ```
19
+
20
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)