@openfilz-sdk/typescript 1.3.15 → 1.3.17

package/graphql/document.graphqls

@@ -77,6 +77,8 @@ input ListFolderRequest {
     active : Boolean = true
     "When true and id is set, search recursively in all subfolders of the given folder"
     recursive : Boolean
+    "Keep only the folders the caller may write into (Enterprise: owned, or shared in editor mode). Ignored by the Community Edition, which has no per-document permissions."
+    writableOnly : Boolean
 }
 
 input FavoriteRequest {

package/models/audit-log-details-one-of.ts

@@ -67,10 +67,16 @@ import type { UpdateMetadataAudit } from './update-metadata-audit';
 // May contain unused imports in some cases
 // @ts-ignore
 import type { UploadAudit } from './upload-audit';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { WorkflowActionFailureAudit } from './workflow-action-failure-audit';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { WorkflowAudit } from './workflow-audit';
 
 /**
  * @type AuditLogDetailsOneOf
  */
-export type AuditLogDetailsOneOf = { type: 'copy' } & CopyAudit | { type: 'createFolder' } & CreateFolderAudit | { type: 'delete' } & DeleteAudit | { type: 'deleteMetadata' } & DeleteMetadataAudit | { type: 'move' } & MoveAudit | { type: 'pdfTransform' } & PdfTransformAudit | { type: 'rename' } & RenameAudit | { type: 'replace' } & ReplaceAudit | { type: 'restoreVersion' } & RestoreVersionAudit | { type: 'updateMetadata' } & UpdateMetadataAudit | { type: 'upload' } & UploadAudit;
+export type AuditLogDetailsOneOf = { type: 'copy' } & CopyAudit | { type: 'createFolder' } & CreateFolderAudit | { type: 'delete' } & DeleteAudit | { type: 'deleteMetadata' } & DeleteMetadataAudit | { type: 'move' } & MoveAudit | { type: 'pdfTransform' } & PdfTransformAudit | { type: 'rename' } & RenameAudit | { type: 'replace' } & ReplaceAudit | { type: 'restoreVersion' } & RestoreVersionAudit | { type: 'updateMetadata' } & UpdateMetadataAudit | { type: 'upload' } & UploadAudit | { type: 'workflow' } & WorkflowAudit | { type: 'workflowActionFailure' } & WorkflowActionFailureAudit;
 
 

package/models/audit-log-details.ts

@@ -15,6 +15,18 @@
 
 
 export interface AuditLogDetails {
+    /**
+     * Workflow instance this action was part of, when a workflow caused it
+     */
+    'workflowInstanceId'?: string;
+    /**
+     * Name of the workflow that caused this action
+     */
+    'workflow'?: string;
+    /**
+     * Label of the workflow status whose entry caused this action
+     */
+    'workflowState'?: string;
     'type': string;
 }
 

package/models/audit-log.ts

@@ -66,6 +66,15 @@ export const AuditLogActionEnum = {
     SignatureTemplateCreated: 'SIGNATURE_TEMPLATE_CREATED',
     SignatureTemplateDeleted: 'SIGNATURE_TEMPLATE_DELETED',
     PdfTransform: 'PDF_TRANSFORM',
+    WorkflowStarted: 'WORKFLOW_STARTED',
+    WorkflowTransitioned: 'WORKFLOW_TRANSITIONED',
+    WorkflowCompleted: 'WORKFLOW_COMPLETED',
+    WorkflowCancelled: 'WORKFLOW_CANCELLED',
+    WorkflowTaskReassigned: 'WORKFLOW_TASK_REASSIGNED',
+    WorkflowActionFailed: 'WORKFLOW_ACTION_FAILED',
+    WorkflowDefinitionCreated: 'WORKFLOW_DEFINITION_CREATED',
+    WorkflowDefinitionUpdated: 'WORKFLOW_DEFINITION_UPDATED',
+    WorkflowDefinitionDeleted: 'WORKFLOW_DEFINITION_DELETED',
     ChainGenesis: 'CHAIN_GENESIS',
 } as const;
 

package/models/cancel-instance-request.ts

@@ -0,0 +1,20 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+export interface CancelInstanceRequest {
+    'comment'?: string;
+}
+

package/models/complete-task-request.ts

@@ -0,0 +1,21 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+export interface CompleteTaskRequest {
+    'transitionKey': string;
+    'comment'?: string;
+}
+

package/models/index.ts

@@ -15,7 +15,9 @@ export * from './auto-file-job-view';
 export * from './auto-file-request';
 export * from './auto-file-ticket';
 export * from './broken-link';
+export * from './cancel-instance-request';
 export * from './cloud-signature-subscription';
+export * from './complete-task-request';
 export * from './copy-audit';
 export * from './copy-request';
 export * from './copy-response';
@@ -52,6 +54,7 @@ export * from './merge-request';
 export * from './merge-source';
 export * from './move-audit';
 export * from './move-request';
+export * from './my-tasks-count-dto';
 export * from './organize-request';
 export * from './output-target';
 export * from './page-instruction';
@@ -61,7 +64,9 @@ export * from './pdf-outline-entry';
 export * from './pdf-output-info';
 export * from './pdf-page-info';
 export * from './pdf-transform-audit';
+export * from './per-definition';
 export * from './public-signature-view';
+export * from './reassign-task-request';
 export * from './rename-audit';
 export * from './rename-request';
 export * from './reorganization-apply-request';
@@ -75,6 +80,7 @@ export * from './role-binding';
 export * from './rotate-request';
 export * from './save-ai-preferences-request';
 export * from './save-ai-settings-request';
+export * from './save-workflow-definition-request';
 export * from './search-by-audit-log-request';
 export * from './search-by-metadata-request';
 export * from './search-metadata-request';
@@ -94,6 +100,7 @@ export * from './signature-template-role';
 export * from './sort-input';
 export * from './split-output';
 export * from './split-request';
+export * from './start-workflow-request';
 export * from './storage-breakdown';
 export * from './suggest';
 export * from './tus-config-response';
@@ -104,3 +111,19 @@ export * from './update-metadata-request';
 export * from './upload-audit';
 export * from './upload-response';
 export * from './verify-otp-request';
+export * from './workflow-action';
+export * from './workflow-action-failure-audit';
+export * from './workflow-assignment';
+export * from './workflow-audit';
+export * from './workflow-definition-dto';
+export * from './workflow-event-dto';
+export * from './workflow-instance-dto';
+export * from './workflow-instance-detail-dto';
+export * from './workflow-instance-page';
+export * from './workflow-problem';
+export * from './workflow-spec';
+export * from './workflow-state';
+export * from './workflow-summary-dto';
+export * from './workflow-task-dto';
+export * from './workflow-transition';
+export * from './workflow-validation-result';

package/models/my-tasks-count-dto.ts

@@ -0,0 +1,21 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+export interface MyTasksCountDTO {
+    'count'?: number;
+    'overdue'?: number;
+}
+

package/models/per-definition.ts

@@ -0,0 +1,24 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+export interface PerDefinition {
+    'definitionId'?: string;
+    'definitionName'?: string;
+    'running'?: number;
+    'completed'?: number;
+    'cancelled'?: number;
+}
+

package/models/reassign-task-request.ts

@@ -0,0 +1,21 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+export interface ReassignTaskRequest {
+    'emails': Array<string>;
+    'comment'?: string;
+}
+

package/models/save-workflow-definition-request.ts

@@ -0,0 +1,27 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { WorkflowSpec } from './workflow-spec';
+
+export interface SaveWorkflowDefinitionRequest {
+    'name': string;
+    'description'?: string;
+    'active'?: boolean;
+    'spec': WorkflowSpec;
+    'triggerFolderIds'?: Array<string>;
+}
+

package/models/search-by-audit-log-request.ts

@@ -81,6 +81,15 @@ export const SearchByAuditLogRequestActionEnum = {
     SignatureTemplateCreated: 'SIGNATURE_TEMPLATE_CREATED',
     SignatureTemplateDeleted: 'SIGNATURE_TEMPLATE_DELETED',
     PdfTransform: 'PDF_TRANSFORM',
+    WorkflowStarted: 'WORKFLOW_STARTED',
+    WorkflowTransitioned: 'WORKFLOW_TRANSITIONED',
+    WorkflowCompleted: 'WORKFLOW_COMPLETED',
+    WorkflowCancelled: 'WORKFLOW_CANCELLED',
+    WorkflowTaskReassigned: 'WORKFLOW_TASK_REASSIGNED',
+    WorkflowActionFailed: 'WORKFLOW_ACTION_FAILED',
+    WorkflowDefinitionCreated: 'WORKFLOW_DEFINITION_CREATED',
+    WorkflowDefinitionUpdated: 'WORKFLOW_DEFINITION_UPDATED',
+    WorkflowDefinitionDeleted: 'WORKFLOW_DEFINITION_DELETED',
     ChainGenesis: 'CHAIN_GENESIS',
 } as const;
 

package/models/settings.ts

@@ -22,6 +22,7 @@ export interface Settings {
     'theme'?: string;
     'thumbnailsActive'?: boolean;
     'aiActive'?: boolean;
+    'aiChatActive'?: boolean;
     'aiUserSettingsEnabled'?: boolean;
     'aiInsightsActive'?: boolean;
     'aiInsightsCategories'?: Array<string>;
@@ -32,6 +33,8 @@ export interface Settings {
     'signatureAuthMethods'?: Array<string>;
     'signatureRemindersActive'?: boolean;
     'signatureCloudActive'?: boolean;
+    'workflowsActive'?: boolean;
+    'workflowDesignerRoleRequired'?: boolean;
     'demoMode'?: boolean;
     'sealProvider'?: string;
     'mcpActive'?: boolean;

package/models/start-workflow-request.ts

@@ -0,0 +1,24 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+export interface StartWorkflowRequest {
+    'definitionId': string;
+    'documentId': string;
+    'assignments'?: { [key: string]: Array<string>; };
+    'transitionKey'?: string;
+    'comment'?: string;
+}
+

package/models/workflow-action-failure-audit.ts

@@ -0,0 +1,26 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { AuditLogDetails } from './audit-log-details';
+
+/**
+ * @type WorkflowActionFailureAudit
+ * type=workflowActionFailure
+ */
+export type WorkflowActionFailureAudit = AuditLogDetails;
+
+

package/models/workflow-action.ts

@@ -0,0 +1,32 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+export interface WorkflowAction {
+    'type'?: WorkflowActionTypeEnum;
+    'folderId'?: string;
+    'entries'?: { [key: string]: any; };
+    'emails'?: Array<string>;
+}
+
+export const WorkflowActionTypeEnum = {
+    MoveToFolder: 'MOVE_TO_FOLDER',
+    SetMetadata: 'SET_METADATA',
+    Notify: 'NOTIFY',
+} as const;
+
+export type WorkflowActionTypeEnum = typeof WorkflowActionTypeEnum[keyof typeof WorkflowActionTypeEnum];
+
+

package/models/workflow-assignment.ts

@@ -0,0 +1,33 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+export interface WorkflowAssignment {
+    'type'?: WorkflowAssignmentTypeEnum;
+    'emails'?: Array<string>;
+    'role'?: string;
+    'label'?: string;
+}
+
+export const WorkflowAssignmentTypeEnum = {
+    Initiator: 'INITIATOR',
+    Users: 'USERS',
+    Role: 'ROLE',
+    ChosenAtStart: 'CHOSEN_AT_START',
+} as const;
+
+export type WorkflowAssignmentTypeEnum = typeof WorkflowAssignmentTypeEnum[keyof typeof WorkflowAssignmentTypeEnum];
+
+

package/models/workflow-audit.ts

@@ -0,0 +1,26 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { AuditLogDetails } from './audit-log-details';
+
+/**
+ * @type WorkflowAudit
+ * type=workflow
+ */
+export type WorkflowAudit = AuditLogDetails;
+
+

package/models/workflow-definition-dto.ts

@@ -0,0 +1,34 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { WorkflowSpec } from './workflow-spec';
+
+export interface WorkflowDefinitionDTO {
+    'id'?: string;
+    'name'?: string;
+    'description'?: string;
+    'active'?: boolean;
+    'spec'?: WorkflowSpec;
+    'triggerFolderIds'?: Array<string>;
+    'version'?: number;
+    'createdBy'?: string;
+    'createdAt'?: string;
+    'updatedAt'?: string;
+    'runningCount'?: number;
+    'canEdit'?: boolean;
+}
+

package/models/workflow-event-dto.ts

@@ -0,0 +1,42 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+export interface WorkflowEventDTO {
+    'id'?: string;
+    'type'?: WorkflowEventDTOTypeEnum;
+    'fromState'?: string;
+    'toState'?: string;
+    'transitionKey'?: string;
+    'actor'?: string;
+    'comment'?: string;
+    'details'?: { [key: string]: any; };
+    'createdAt'?: string;
+}
+
+export const WorkflowEventDTOTypeEnum = {
+    Started: 'STARTED',
+    Transitioned: 'TRANSITIONED',
+    ActionApplied: 'ACTION_APPLIED',
+    ActionFailed: 'ACTION_FAILED',
+    Reassigned: 'REASSIGNED',
+    Reminded: 'REMINDED',
+    Completed: 'COMPLETED',
+    Cancelled: 'CANCELLED',
+} as const;
+
+export type WorkflowEventDTOTypeEnum = typeof WorkflowEventDTOTypeEnum[keyof typeof WorkflowEventDTOTypeEnum];
+
+

package/models/workflow-instance-detail-dto.ts

@@ -0,0 +1,33 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { WorkflowEventDTO } from './workflow-event-dto';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { WorkflowInstanceDTO } from './workflow-instance-dto';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { WorkflowSpec } from './workflow-spec';
+
+export interface WorkflowInstanceDetailDTO {
+    'instance'?: WorkflowInstanceDTO;
+    'spec'?: WorkflowSpec;
+    'assignments'?: { [key: string]: Array<string>; };
+    'history'?: Array<WorkflowEventDTO>;
+    'canManage'?: boolean;
+}
+

package/models/workflow-instance-dto.ts

@@ -0,0 +1,46 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { WorkflowTaskDTO } from './workflow-task-dto';
+
+export interface WorkflowInstanceDTO {
+    'id'?: string;
+    'definitionId'?: string;
+    'definitionName'?: string;
+    'definitionVersion'?: number;
+    'documentId'?: string;
+    'documentName'?: string;
+    'status'?: WorkflowInstanceDTOStatusEnum;
+    'currentStateKey'?: string;
+    'currentStateLabel'?: string;
+    'currentStateColor'?: string;
+    'startedBy'?: string;
+    'startedAt'?: string;
+    'updatedAt'?: string;
+    'completedAt'?: string;
+    'currentTask'?: WorkflowTaskDTO;
+}
+
+export const WorkflowInstanceDTOStatusEnum = {
+    Running: 'RUNNING',
+    Completed: 'COMPLETED',
+    Cancelled: 'CANCELLED',
+} as const;
+
+export type WorkflowInstanceDTOStatusEnum = typeof WorkflowInstanceDTOStatusEnum[keyof typeof WorkflowInstanceDTOStatusEnum];
+
+

package/models/workflow-instance-page.ts

@@ -0,0 +1,26 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { WorkflowInstanceDTO } from './workflow-instance-dto';
+
+export interface WorkflowInstancePage {
+    'items'?: Array<WorkflowInstanceDTO>;
+    'total'?: number;
+    'page'?: number;
+    'size'?: number;
+}
+

package/models/workflow-problem.ts

@@ -0,0 +1,23 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+export interface WorkflowProblem {
+    'path'?: string;
+    'code'?: string;
+    'message'?: string;
+    'args'?: Array<string>;
+}
+