@openfilz-sdk/typescript 1.3.15 → 1.3.17

package/.openapi-generator/FILES

@@ -23,6 +23,7 @@ api/pdftools-api.ts
 api/settings-api.ts
 api/smart-filing-api.ts
 api/tus-controller-api.ts
+api/workflows-api.ts
 base.ts
 common.ts
 configuration.ts
@@ -47,7 +48,9 @@ docs/AutoFileJobView.md
 docs/AutoFileRequest.md
 docs/AutoFileTicket.md
 docs/BrokenLink.md
+docs/CancelInstanceRequest.md
 docs/CloudSignatureSubscription.md
+docs/CompleteTaskRequest.md
 docs/CopyAudit.md
 docs/CopyRequest.md
 docs/CopyResponse.md
@@ -96,6 +99,7 @@ docs/MergeRequest.md
 docs/MergeSource.md
 docs/MoveAudit.md
 docs/MoveRequest.md
+docs/MyTasksCountDTO.md
 docs/OrganizeRequest.md
 docs/OutputTarget.md
 docs/PDFToolsApi.md
@@ -106,7 +110,9 @@ docs/PdfOutlineEntry.md
 docs/PdfOutputInfo.md
 docs/PdfPageInfo.md
 docs/PdfTransformAudit.md
+docs/PerDefinition.md
 docs/PublicSignatureView.md
+docs/ReassignTaskRequest.md
 docs/RenameAudit.md
 docs/RenameRequest.md
 docs/ReorganizationApplyRequest.md
@@ -120,6 +126,7 @@ docs/RoleBinding.md
 docs/RotateRequest.md
 docs/SaveAiPreferencesRequest.md
 docs/SaveAiSettingsRequest.md
+docs/SaveWorkflowDefinitionRequest.md
 docs/SearchByAuditLogRequest.md
 docs/SearchByMetadataRequest.md
 docs/SearchMetadataRequest.md
@@ -141,6 +148,7 @@ docs/SmartFilingApi.md
 docs/SortInput.md
 docs/SplitOutput.md
 docs/SplitRequest.md
+docs/StartWorkflowRequest.md
 docs/StorageBreakdown.md
 docs/Suggest.md
 docs/TusConfigResponse.md
@@ -152,6 +160,23 @@ docs/UpdateMetadataRequest.md
 docs/UploadAudit.md
 docs/UploadResponse.md
 docs/VerifyOtpRequest.md
+docs/WorkflowAction.md
+docs/WorkflowActionFailureAudit.md
+docs/WorkflowAssignment.md
+docs/WorkflowAudit.md
+docs/WorkflowDefinitionDTO.md
+docs/WorkflowEventDTO.md
+docs/WorkflowInstanceDTO.md
+docs/WorkflowInstanceDetailDTO.md
+docs/WorkflowInstancePage.md
+docs/WorkflowProblem.md
+docs/WorkflowSpec.md
+docs/WorkflowState.md
+docs/WorkflowSummaryDTO.md
+docs/WorkflowTaskDTO.md
+docs/WorkflowTransition.md
+docs/WorkflowValidationResult.md
+docs/WorkflowsApi.md
 git_push.sh
 index.ts
 models/ai-chat-conversation.ts
@@ -171,7 +196,9 @@ models/auto-file-job-view.ts
 models/auto-file-request.ts
 models/auto-file-ticket.ts
 models/broken-link.ts
+models/cancel-instance-request.ts
 models/cloud-signature-subscription.ts
+models/complete-task-request.ts
 models/copy-audit.ts
 models/copy-request.ts
 models/copy-response.ts
@@ -209,6 +236,7 @@ models/merge-request.ts
 models/merge-source.ts
 models/move-audit.ts
 models/move-request.ts
+models/my-tasks-count-dto.ts
 models/organize-request.ts
 models/output-target.ts
 models/page-instruction.ts
@@ -218,7 +246,9 @@ models/pdf-outline-entry.ts
 models/pdf-output-info.ts
 models/pdf-page-info.ts
 models/pdf-transform-audit.ts
+models/per-definition.ts
 models/public-signature-view.ts
+models/reassign-task-request.ts
 models/rename-audit.ts
 models/rename-request.ts
 models/reorganization-apply-request.ts
@@ -232,6 +262,7 @@ models/role-binding.ts
 models/rotate-request.ts
 models/save-ai-preferences-request.ts
 models/save-ai-settings-request.ts
+models/save-workflow-definition-request.ts
 models/search-by-audit-log-request.ts
 models/search-by-metadata-request.ts
 models/search-metadata-request.ts
@@ -251,6 +282,7 @@ models/signature-template-role.ts
 models/sort-input.ts
 models/split-output.ts
 models/split-request.ts
+models/start-workflow-request.ts
 models/storage-breakdown.ts
 models/suggest.ts
 models/tus-config-response.ts
@@ -261,6 +293,22 @@ models/update-metadata-request.ts
 models/upload-audit.ts
 models/upload-response.ts
 models/verify-otp-request.ts
+models/workflow-action-failure-audit.ts
+models/workflow-action.ts
+models/workflow-assignment.ts
+models/workflow-audit.ts
+models/workflow-definition-dto.ts
+models/workflow-event-dto.ts
+models/workflow-instance-detail-dto.ts
+models/workflow-instance-dto.ts
+models/workflow-instance-page.ts
+models/workflow-problem.ts
+models/workflow-spec.ts
+models/workflow-state.ts
+models/workflow-summary-dto.ts
+models/workflow-task-dto.ts
+models/workflow-transition.ts
+models/workflow-validation-result.ts
 package.json
 tsconfig.esm.json
 tsconfig.json

package/.openapi-generator/openfilz-api-generate-typescript-sdk.sha256

@@ -1 +1 @@
-716a5450e012c1ba185a73478997a9ec9c4ef2923804bd719ebda6636c634717
+96e084dc672b86a48223f845e1bb84d091fe5e9061c47495184a8745c9bedc29

package/README.md

@@ -1,4 +1,4 @@
-## @openfilz-sdk/typescript@1.3.15
+## @openfilz-sdk/typescript@1.3.17
 
 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:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @openfilz-sdk/typescript@1.3.15 --save
+npm install @openfilz-sdk/typescript@1.3.17 --save
 ```
 
 _unPublished (not recommended):_
@@ -93,7 +93,7 @@ Class | Method | HTTP request | Description
 *DocumentVersionControllerApi* | [**downloadVersion**](docs/DocumentVersionControllerApi.md#downloadversion) | **GET** /api/v1/documents/{documentId}/versions/{versionId}/download | Download a specific document version
 *DocumentVersionControllerApi* | [**listVersions**](docs/DocumentVersionControllerApi.md#listversions) | **GET** /api/v1/documents/{documentId}/versions | List document versions
 *DocumentVersionControllerApi* | [**restoreVersion**](docs/DocumentVersionControllerApi.md#restoreversion) | **POST** /api/v1/documents/{documentId}/versions/{versionId}/restore | Restore a previous document version
-*ESignApi* | [**cancel**](docs/ESignApi.md#cancel) | **POST** /api/v1/signatures/{id}/cancel | Cancel a non-terminal envelope
+*ESignApi* | [**cancel1**](docs/ESignApi.md#cancel1) | **POST** /api/v1/signatures/{id}/cancel | Cancel a non-terminal envelope
 *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)
 *ESignApi* | [**create**](docs/ESignApi.md#create) | **POST** /api/v1/signatures | Create an envelope (sent immediately unless send=false)
 *ESignApi* | [**events**](docs/ESignApi.md#events) | **GET** /api/v1/signatures/{id}/events | Audit trail of one of my envelopes
@@ -155,6 +155,21 @@ Class | Method | HTTP request | Description
 *TusControllerApi* | [**getUploadOffset**](docs/TusControllerApi.md#getuploadoffset) | **HEAD** /api/v1/tus/{uploadId} | Get upload progress
 *TusControllerApi* | [**isUploadComplete**](docs/TusControllerApi.md#isuploadcomplete) | **GET** /api/v1/tus/{uploadId}/complete | Check upload completion
 *TusControllerApi* | [**uploadChunk**](docs/TusControllerApi.md#uploadchunk) | **PATCH** /api/v1/tus/{uploadId} | Upload chunk
+*WorkflowsApi* | [**cancel**](docs/WorkflowsApi.md#cancel) | **POST** /api/v1/workflows/instances/{id}/cancel | Cancel a running instance (initiator)
+*WorkflowsApi* | [**complete**](docs/WorkflowsApi.md#complete) | **POST** /api/v1/workflows/tasks/{id}/complete | Take a transition on a task I am a candidate of
+*WorkflowsApi* | [**createDefinition**](docs/WorkflowsApi.md#createdefinition) | **POST** /api/v1/workflows/definitions | Create a workflow definition (400 with the problem list when invalid)
+*WorkflowsApi* | [**deleteDefinition**](docs/WorkflowsApi.md#deletedefinition) | **DELETE** /api/v1/workflows/definitions/{id} | Delete a workflow definition (409 while instances are running)
+*WorkflowsApi* | [**getDefinition**](docs/WorkflowsApi.md#getdefinition) | **GET** /api/v1/workflows/definitions/{id} | Get a workflow definition
+*WorkflowsApi* | [**getInstance**](docs/WorkflowsApi.md#getinstance) | **GET** /api/v1/workflows/instances/{id} | One instance with its snapshot spec, open task and history
+*WorkflowsApi* | [**listDefinitions**](docs/WorkflowsApi.md#listdefinitions) | **GET** /api/v1/workflows/definitions | List workflow definitions
+*WorkflowsApi* | [**listInstances**](docs/WorkflowsApi.md#listinstances) | **GET** /api/v1/workflows/instances | List instances (monitor), newest first
+*WorkflowsApi* | [**myTasks**](docs/WorkflowsApi.md#mytasks) | **GET** /api/v1/workflows/tasks/mine | Open tasks I can act on (by e-mail or role)
+*WorkflowsApi* | [**myTasksCount**](docs/WorkflowsApi.md#mytaskscount) | **GET** /api/v1/workflows/tasks/mine/count | Number of open tasks I can act on (sidebar badge)
+*WorkflowsApi* | [**reassign**](docs/WorkflowsApi.md#reassign) | **POST** /api/v1/workflows/tasks/{id}/reassign | Hand a task to other people (initiator or current candidate)
+*WorkflowsApi* | [**start**](docs/WorkflowsApi.md#start) | **POST** /api/v1/workflows/instances | Start a workflow on a document (409 when one is already running)
+*WorkflowsApi* | [**summary**](docs/WorkflowsApi.md#summary) | **GET** /api/v1/workflows/instances/summary | Counts for the monitor header
+*WorkflowsApi* | [**updateDefinition**](docs/WorkflowsApi.md#updatedefinition) | **PUT** /api/v1/workflows/definitions/{id} | Update a workflow definition (running instances keep their snapshot)
+*WorkflowsApi* | [**validateDefinition**](docs/WorkflowsApi.md#validatedefinition) | **POST** /api/v1/workflows/definitions/validate | Validate a definition without saving it
 
 
 ### Documentation For Models
@@ -176,7 +191,9 @@ Class | Method | HTTP request | Description
  - [AutoFileRequest](docs/AutoFileRequest.md)
  - [AutoFileTicket](docs/AutoFileTicket.md)
  - [BrokenLink](docs/BrokenLink.md)
+ - [CancelInstanceRequest](docs/CancelInstanceRequest.md)
  - [CloudSignatureSubscription](docs/CloudSignatureSubscription.md)
+ - [CompleteTaskRequest](docs/CompleteTaskRequest.md)
  - [CopyAudit](docs/CopyAudit.md)
  - [CopyRequest](docs/CopyRequest.md)
  - [CopyResponse](docs/CopyResponse.md)
@@ -213,6 +230,7 @@ Class | Method | HTTP request | Description
  - [MergeSource](docs/MergeSource.md)
  - [MoveAudit](docs/MoveAudit.md)
  - [MoveRequest](docs/MoveRequest.md)
+ - [MyTasksCountDTO](docs/MyTasksCountDTO.md)
  - [OrganizeRequest](docs/OrganizeRequest.md)
  - [OutputTarget](docs/OutputTarget.md)
  - [PageInstruction](docs/PageInstruction.md)
@@ -222,7 +240,9 @@ Class | Method | HTTP request | Description
  - [PdfOutputInfo](docs/PdfOutputInfo.md)
  - [PdfPageInfo](docs/PdfPageInfo.md)
  - [PdfTransformAudit](docs/PdfTransformAudit.md)
+ - [PerDefinition](docs/PerDefinition.md)
  - [PublicSignatureView](docs/PublicSignatureView.md)
+ - [ReassignTaskRequest](docs/ReassignTaskRequest.md)
  - [RenameAudit](docs/RenameAudit.md)
  - [RenameRequest](docs/RenameRequest.md)
  - [ReorganizationApplyRequest](docs/ReorganizationApplyRequest.md)
@@ -236,6 +256,7 @@ Class | Method | HTTP request | Description
  - [RotateRequest](docs/RotateRequest.md)
  - [SaveAiPreferencesRequest](docs/SaveAiPreferencesRequest.md)
  - [SaveAiSettingsRequest](docs/SaveAiSettingsRequest.md)
+ - [SaveWorkflowDefinitionRequest](docs/SaveWorkflowDefinitionRequest.md)
  - [SearchByAuditLogRequest](docs/SearchByAuditLogRequest.md)
  - [SearchByMetadataRequest](docs/SearchByMetadataRequest.md)
  - [SearchMetadataRequest](docs/SearchMetadataRequest.md)
@@ -255,6 +276,7 @@ Class | Method | HTTP request | Description
  - [SortInput](docs/SortInput.md)
  - [SplitOutput](docs/SplitOutput.md)
  - [SplitRequest](docs/SplitRequest.md)
+ - [StartWorkflowRequest](docs/StartWorkflowRequest.md)
  - [StorageBreakdown](docs/StorageBreakdown.md)
  - [Suggest](docs/Suggest.md)
  - [TusConfigResponse](docs/TusConfigResponse.md)
@@ -265,6 +287,22 @@ Class | Method | HTTP request | Description
  - [UploadAudit](docs/UploadAudit.md)
  - [UploadResponse](docs/UploadResponse.md)
  - [VerifyOtpRequest](docs/VerifyOtpRequest.md)
+ - [WorkflowAction](docs/WorkflowAction.md)
+ - [WorkflowActionFailureAudit](docs/WorkflowActionFailureAudit.md)
+ - [WorkflowAssignment](docs/WorkflowAssignment.md)
+ - [WorkflowAudit](docs/WorkflowAudit.md)
+ - [WorkflowDefinitionDTO](docs/WorkflowDefinitionDTO.md)
+ - [WorkflowEventDTO](docs/WorkflowEventDTO.md)
+ - [WorkflowInstanceDTO](docs/WorkflowInstanceDTO.md)
+ - [WorkflowInstanceDetailDTO](docs/WorkflowInstanceDetailDTO.md)
+ - [WorkflowInstancePage](docs/WorkflowInstancePage.md)
+ - [WorkflowProblem](docs/WorkflowProblem.md)
+ - [WorkflowSpec](docs/WorkflowSpec.md)
+ - [WorkflowState](docs/WorkflowState.md)
+ - [WorkflowSummaryDTO](docs/WorkflowSummaryDTO.md)
+ - [WorkflowTaskDTO](docs/WorkflowTaskDTO.md)
+ - [WorkflowTransition](docs/WorkflowTransition.md)
+ - [WorkflowValidationResult](docs/WorkflowValidationResult.md)
 
 
 <a id="documentation-for-authorization"></a>

package/api/esign-api.ts

@@ -41,9 +41,9 @@ export const ESignApiAxiosParamCreator = function (configuration?: Configuration
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        cancel: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+        cancel1: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'id' is not null or undefined
-            assertParamExists('cancel', 'id', id)
+            assertParamExists('cancel1', 'id', id)
             const localVarPath = `/api/v1/signatures/{id}/cancel`
                 .replace('{id}', encodeURIComponent(String(id)));
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -428,10 +428,10 @@ export const ESignApiFp = function(configuration?: Configuration) {
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async cancel(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SignatureEnvelopeDTO>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.cancel(id, options);
+        async cancel1(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SignatureEnvelopeDTO>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.cancel1(id, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
-            const localVarOperationServerBasePath = operationServerMap['ESignApi.cancel']?.[localVarOperationServerIndex]?.url;
+            const localVarOperationServerBasePath = operationServerMap['ESignApi.cancel1']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
@@ -566,8 +566,8 @@ export const ESignApiFactory = function (configuration?: Configuration, basePath
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        cancel(id: string, options?: RawAxiosRequestConfig): AxiosPromise<SignatureEnvelopeDTO> {
-            return localVarFp.cancel(id, options).then((request) => request(axios, basePath));
+        cancel1(id: string, options?: RawAxiosRequestConfig): AxiosPromise<SignatureEnvelopeDTO> {
+            return localVarFp.cancel1(id, options).then((request) => request(axios, basePath));
         },
         /**
          * 
@@ -672,8 +672,8 @@ export class ESignApi extends BaseAPI {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    public cancel(id: string, options?: RawAxiosRequestConfig) {
-        return ESignApiFp(this.configuration).cancel(id, options).then((request) => request(this.axios, this.basePath));
+    public cancel1(id: string, options?: RawAxiosRequestConfig) {
+        return ESignApiFp(this.configuration).cancel1(id, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**