@openfilz-sdk/typescript-ee 1.10.1 → 1.10.3

package/dist/models/workflow-review.d.ts

@@ -0,0 +1,22 @@
+/**
+ * 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 WorkflowReview {
+    'rule'?: WorkflowReviewRuleEnum;
+    'quorum'?: number;
+    'approveTransition'?: string;
+}
+export declare const WorkflowReviewRuleEnum: {
+    readonly All: "ALL";
+    readonly FirstRejection: "FIRST_REJECTION";
+    readonly Quorum: "QUORUM";
+};
+export type WorkflowReviewRuleEnum = typeof WorkflowReviewRuleEnum[keyof typeof WorkflowReviewRuleEnum];

package/dist/models/workflow-review.js

@@ -0,0 +1,21 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkflowReviewRuleEnum = void 0;
+exports.WorkflowReviewRuleEnum = {
+    All: 'ALL',
+    FirstRejection: 'FIRST_REJECTION',
+    Quorum: 'QUORUM',
+};

package/dist/models/workflow-state.d.ts

@@ -11,6 +11,7 @@
  */
 import type { WorkflowAction } from './workflow-action';
 import type { WorkflowAssignment } from './workflow-assignment';
+import type { WorkflowReview } from './workflow-review';
 import type { WorkflowTransition } from './workflow-transition';
 export interface WorkflowState {
     'key'?: string;
@@ -21,6 +22,7 @@ export interface WorkflowState {
     'dueInDays'?: number;
     'transitions'?: Array<WorkflowTransition>;
     'onEnter'?: Array<WorkflowAction>;
+    'review'?: WorkflowReview;
     'end'?: boolean;
 }
 export declare const WorkflowStateKindEnum: {

package/dist/models/workflow-task-dto.d.ts

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { WorkflowReviewProgressDTO } from './workflow-review-progress-dto';
 import type { WorkflowTransition } from './workflow-transition';
 export interface WorkflowTaskDTO {
     'id'?: string;
@@ -35,6 +36,7 @@ export interface WorkflowTaskDTO {
     'previousComment'?: string;
     'previousActor'?: string;
     'mine'?: boolean;
+    'review'?: WorkflowReviewProgressDTO;
 }
 export declare const WorkflowTaskDTOStatusEnum: {
     readonly Open: "OPEN";

package/docs/AiTaxonomyCategory.md

@@ -6,7 +6,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **key** | **string** |  | [optional] [default to undefined]
-**label** | **string** |  | [optional] [default to undefined]
+**labels** | **{ [key: string]: string; }** |  | [optional] [default to undefined]
 **description** | **string** |  | [optional] [default to undefined]
 **examples** | **Array<string>** |  | [optional] [default to undefined]
 **position** | **number** |  | [optional] [default to undefined]
@@ -19,7 +19,7 @@ import { AiTaxonomyCategory } from '@openfilz-sdk/typescript-ee';
 
 const instance: AiTaxonomyCategory = {
     key,
-    label,
+    labels,
     description,
     examples,
     position,

package/docs/AiTaxonomyView.md

@@ -7,6 +7,8 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **source** | **string** |  | [optional] [default to undefined]
 **categories** | [**Array<AiTaxonomyCategory>**](AiTaxonomyCategory.md) |  | [optional] [default to undefined]
+**languages** | **Array<string>** |  | [optional] [default to undefined]
+**builtInLabels** | **{ [key: string]: { [key: string]: string; }; }** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -16,6 +18,8 @@ import { AiTaxonomyView } from '@openfilz-sdk/typescript-ee';
 const instance: AiTaxonomyView = {
     source,
     categories,
+    languages,
+    builtInLabels,
 };
 ```
 

package/docs/Settings.md

@@ -17,6 +17,7 @@ Name | Type | Description | Notes
 **aiUserSettingsEnabled** | **boolean** |  | [optional] [default to undefined]
 **aiInsightsActive** | **boolean** |  | [optional] [default to undefined]
 **aiInsightsCategories** | **Array<string>** |  | [optional] [default to undefined]
+**aiInsightsCategoryLabels** | **{ [key: string]: string; }** |  | [optional] [default to undefined]
 **aiAutoFileActive** | **boolean** |  | [optional] [default to undefined]
 **signatureActive** | **boolean** |  | [optional] [default to undefined]
 **pdfToolsActive** | **boolean** |  | [optional] [default to undefined]
@@ -52,6 +53,7 @@ const instance: Settings = {
     aiUserSettingsEnabled,
     aiInsightsActive,
     aiInsightsCategories,
+    aiInsightsCategoryLabels,
     aiAutoFileActive,
     signatureActive,
     pdfToolsActive,

package/docs/SettingsApi.md

@@ -100,7 +100,7 @@ This endpoint does not have any parameters.
 # **getSettings**
 > Settings getSettings()
 
-Retrieve user\'s settings : global settings and user\'s preferences
+Retrieve user\'s settings : global settings and user\'s preferences. The category labels (aiInsightsCategoryLabels) are in the Accept-Language language, English when it is not supported.
 
 ### Example
 
@@ -113,11 +113,18 @@ import {
 const configuration = new Configuration();
 const apiInstance = new SettingsApi(configuration);
 
-const { status, data } = await apiInstance.getSettings();
+let acceptLanguage: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getSettings(
+    acceptLanguage
+);
 ```
 
 ### Parameters
-This endpoint does not have any parameters.
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
 
 
 ### Return type
@@ -214,9 +221,11 @@ const configuration = new Configuration();
 const apiInstance = new SettingsApi(configuration);
 
 let userPreferencesRequest: UserPreferencesRequest; //
+let acceptLanguage: string; // (optional) (default to undefined)
 
 const { status, data } = await apiInstance.saveSettings(
-    userPreferencesRequest
+    userPreferencesRequest,
+    acceptLanguage
 );
 ```
 
@@ -225,6 +234,7 @@ const { status, data } = await apiInstance.saveSettings(
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
 | **userPreferencesRequest** | **UserPreferencesRequest**|  | |
+| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
 
 
 ### Return type

package/docs/Vote.md

@@ -0,0 +1,26 @@
+# Vote
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**reviewer** | **string** |  | [optional] [default to undefined]
+**transitionKey** | **string** |  | [optional] [default to undefined]
+**comment** | **string** |  | [optional] [default to undefined]
+**at** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Vote } from '@openfilz-sdk/typescript-ee';
+
+const instance: Vote = {
+    reviewer,
+    transitionKey,
+    comment,
+    at,
+};
+```
+
+[[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/WorkflowReview.md

@@ -0,0 +1,24 @@
+# WorkflowReview
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**rule** | **string** |  | [optional] [default to undefined]
+**quorum** | **number** |  | [optional] [default to undefined]
+**approveTransition** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { WorkflowReview } from '@openfilz-sdk/typescript-ee';
+
+const instance: WorkflowReview = {
+    rule,
+    quorum,
+    approveTransition,
+};
+```
+
+[[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/WorkflowReviewProgressDTO.md

@@ -0,0 +1,32 @@
+# WorkflowReviewProgressDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**rule** | **string** |  | [optional] [default to undefined]
+**quorum** | **number** |  | [optional] [default to undefined]
+**approveTransition** | **string** |  | [optional] [default to undefined]
+**total** | **number** |  | [optional] [default to undefined]
+**approvals** | **number** |  | [optional] [default to undefined]
+**votes** | [**Array<Vote>**](Vote.md) |  | [optional] [default to undefined]
+**pending** | **Array<string>** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { WorkflowReviewProgressDTO } from '@openfilz-sdk/typescript-ee';
+
+const instance: WorkflowReviewProgressDTO = {
+    rule,
+    quorum,
+    approveTransition,
+    total,
+    approvals,
+    votes,
+    pending,
+};
+```
+
+[[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/WorkflowState.md

@@ -13,6 +13,7 @@ Name | Type | Description | Notes
 **dueInDays** | **number** |  | [optional] [default to undefined]
 **transitions** | [**Array<WorkflowTransition>**](WorkflowTransition.md) |  | [optional] [default to undefined]
 **onEnter** | [**Array<WorkflowAction>**](WorkflowAction.md) |  | [optional] [default to undefined]
+**review** | [**WorkflowReview**](WorkflowReview.md) |  | [optional] [default to undefined]
 **end** | **boolean** |  | [optional] [default to undefined]
 
 ## Example
@@ -29,6 +30,7 @@ const instance: WorkflowState = {
     dueInDays,
     transitions,
     onEnter,
+    review,
     end,
 };
 ```

package/docs/WorkflowTaskDTO.md

@@ -29,6 +29,7 @@ Name | Type | Description | Notes
 **previousComment** | **string** |  | [optional] [default to undefined]
 **previousActor** | **string** |  | [optional] [default to undefined]
 **mine** | **boolean** |  | [optional] [default to undefined]
+**review** | [**WorkflowReviewProgressDTO**](WorkflowReviewProgressDTO.md) |  | [optional] [default to undefined]
 
 ## Example
 
@@ -60,6 +61,7 @@ const instance: WorkflowTaskDTO = {
     previousComment,
     previousActor,
     mine,
+    review,
 };
 ```
 

package/models/ai-taxonomy-category.ts

@@ -16,7 +16,7 @@
 
 export interface AiTaxonomyCategory {
     'key'?: string;
-    'label'?: string;
+    'labels'?: { [key: string]: string; };
     'description'?: string;
     'examples'?: Array<string>;
     'position'?: number;

package/models/ai-taxonomy-view.ts

@@ -20,5 +20,7 @@ import type { AiTaxonomyCategory } from './ai-taxonomy-category';
 export interface AiTaxonomyView {
     'source'?: string;
     'categories'?: Array<AiTaxonomyCategory>;
+    'languages'?: Array<string>;
+    'builtInLabels'?: { [key: string]: { [key: string]: string; }; };
 }
 

package/models/enriched-audit-log.ts

@@ -60,6 +60,7 @@ export const EnrichedAuditLogActionEnum = {
     PdfTransform: 'PDF_TRANSFORM',
     WorkflowStarted: 'WORKFLOW_STARTED',
     WorkflowTransitioned: 'WORKFLOW_TRANSITIONED',
+    WorkflowReviewed: 'WORKFLOW_REVIEWED',
     WorkflowCompleted: 'WORKFLOW_COMPLETED',
     WorkflowCancelled: 'WORKFLOW_CANCELLED',
     WorkflowTaskReassigned: 'WORKFLOW_TASK_REASSIGNED',

package/models/index.ts

@@ -183,6 +183,7 @@ export * from './user-preferences-request';
 export * from './user-privacy-dto';
 export * from './user-registration-request';
 export * from './verify-otp-request';
+export * from './vote';
 export * from './workflow-action';
 export * from './workflow-action-failure-audit';
 export * from './workflow-assignment';
@@ -193,6 +194,8 @@ export * from './workflow-instance-dto';
 export * from './workflow-instance-detail-dto';
 export * from './workflow-instance-page';
 export * from './workflow-problem';
+export * from './workflow-review';
+export * from './workflow-review-progress-dto';
 export * from './workflow-spec';
 export * from './workflow-state';
 export * from './workflow-summary-dto';

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

@@ -73,6 +73,7 @@ export const SearchByAuditLogRequestActionEnum = {
     PdfTransform: 'PDF_TRANSFORM',
     WorkflowStarted: 'WORKFLOW_STARTED',
     WorkflowTransitioned: 'WORKFLOW_TRANSITIONED',
+    WorkflowReviewed: 'WORKFLOW_REVIEWED',
     WorkflowCompleted: 'WORKFLOW_COMPLETED',
     WorkflowCancelled: 'WORKFLOW_CANCELLED',
     WorkflowTaskReassigned: 'WORKFLOW_TASK_REASSIGNED',

package/models/settings.ts

@@ -27,6 +27,7 @@ export interface Settings {
     'aiUserSettingsEnabled'?: boolean;
     'aiInsightsActive'?: boolean;
     'aiInsightsCategories'?: Array<string>;
+    'aiInsightsCategoryLabels'?: { [key: string]: string; };
     'aiAutoFileActive'?: boolean;
     'signatureActive'?: boolean;
     'pdfToolsActive'?: boolean;

package/models/vote.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 Vote {
+    'reviewer'?: string;
+    'transitionKey'?: string;
+    'comment'?: string;
+    'at'?: string;
+}
+

package/models/workflow-event-dto.ts

@@ -29,6 +29,7 @@ export interface WorkflowEventDTO {
 export const WorkflowEventDTOTypeEnum = {
     Started: 'STARTED',
     Transitioned: 'TRANSITIONED',
+    Reviewed: 'REVIEWED',
     ActionApplied: 'ACTION_APPLIED',
     ActionFailed: 'ACTION_FAILED',
     Reassigned: 'REASSIGNED',

package/models/workflow-review-progress-dto.ts

@@ -0,0 +1,38 @@
+/* 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 { Vote } from './vote';
+
+export interface WorkflowReviewProgressDTO {
+    'rule'?: WorkflowReviewProgressDTORuleEnum;
+    'quorum'?: number;
+    'approveTransition'?: string;
+    'total'?: number;
+    'approvals'?: number;
+    'votes'?: Array<Vote>;
+    'pending'?: Array<string>;
+}
+
+export const WorkflowReviewProgressDTORuleEnum = {
+    All: 'ALL',
+    FirstRejection: 'FIRST_REJECTION',
+    Quorum: 'QUORUM',
+} as const;
+
+export type WorkflowReviewProgressDTORuleEnum = typeof WorkflowReviewProgressDTORuleEnum[keyof typeof WorkflowReviewProgressDTORuleEnum];
+
+

package/models/workflow-review.ts

@@ -0,0 +1,31 @@
+/* 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 WorkflowReview {
+    'rule'?: WorkflowReviewRuleEnum;
+    'quorum'?: number;
+    'approveTransition'?: string;
+}
+
+export const WorkflowReviewRuleEnum = {
+    All: 'ALL',
+    FirstRejection: 'FIRST_REJECTION',
+    Quorum: 'QUORUM',
+} as const;
+
+export type WorkflowReviewRuleEnum = typeof WorkflowReviewRuleEnum[keyof typeof WorkflowReviewRuleEnum];
+
+

package/models/workflow-state.ts

@@ -21,6 +21,9 @@ import type { WorkflowAction } from './workflow-action';
 import type { WorkflowAssignment } from './workflow-assignment';
 // May contain unused imports in some cases
 // @ts-ignore
+import type { WorkflowReview } from './workflow-review';
+// May contain unused imports in some cases
+// @ts-ignore
 import type { WorkflowTransition } from './workflow-transition';
 
 export interface WorkflowState {
@@ -32,6 +35,7 @@ export interface WorkflowState {
     'dueInDays'?: number;
     'transitions'?: Array<WorkflowTransition>;
     'onEnter'?: Array<WorkflowAction>;
+    'review'?: WorkflowReview;
     'end'?: boolean;
 }
 

package/models/workflow-task-dto.ts

@@ -13,6 +13,9 @@
  */
 
 
+// May contain unused imports in some cases
+// @ts-ignore
+import type { WorkflowReviewProgressDTO } from './workflow-review-progress-dto';
 // May contain unused imports in some cases
 // @ts-ignore
 import type { WorkflowTransition } from './workflow-transition';
@@ -42,6 +45,7 @@ export interface WorkflowTaskDTO {
     'previousComment'?: string;
     'previousActor'?: string;
     'mine'?: boolean;
+    'review'?: WorkflowReviewProgressDTO;
 }
 
 export const WorkflowTaskDTOStatusEnum = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfilz-sdk/typescript-ee",
-  "version": "1.10.1",
+  "version": "1.10.3",
   "description": "OpenAPI client for @openfilz-sdk/typescript-ee",
   "author": "OpenAPI-Generator Contributors",
   "repository": {