@openfilz-sdk/typescript-ee 1.10.5 → 1.11.0

package/docs/ReencryptRequest.md

@@ -0,0 +1,24 @@
+# ReencryptRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**mode** | **string** | LEGACY: plaintext objects only (after switching the feature on); MASTER_KEY: objects written under targetKeyId; ALL: everything | [default to undefined]
+**targetKeyId** | **string** | MASTER_KEY mode: the master key whose objects are rewritten under the active key | [optional] [default to undefined]
+**resume** | **boolean** | Continue an unfinished or failed pass of the same mode instead of starting over | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ReencryptRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: ReencryptRequest = {
+    mode,
+    targetKeyId,
+    resume,
+};
+```
+
+[[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/StorageEncryptionAdministrationApi.md

@@ -0,0 +1,239 @@
+# StorageEncryptionAdministrationApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**attest**](#attest) | **POST** /api/v1/admin/storage/encryption/attest | Prove the customer\'s KEK is usable right now|
+|[**reencrypt**](#reencrypt) | **POST** /api/v1/admin/storage/encryption/reencrypt | Run the re-encryption pass in the background|
+|[**rewrap**](#rewrap) | **POST** /api/v1/admin/storage/encryption/rewrap | Re-wrap every master key under the provider\'s current KEK|
+|[**rotateMasterKey**](#rotatemasterkey) | **POST** /api/v1/admin/storage/encryption/rotate-master-key | Create a new active master key|
+|[**status1**](#status1) | **GET** /api/v1/admin/storage/encryption/status | Configuration, master key ring state and re-encryption pass progress|
+
+# **attest**
+> { [key: string]: any; } attest()
+
+One unwrap through the provider. Unlocks a locked ring when it succeeds; locks it when the provider refuses.
+
+### Example
+
+```typescript
+import {
+    StorageEncryptionAdministrationApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new StorageEncryptionAdministrationApi(configuration);
+
+const { status, data } = await apiInstance.attest();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**{ [key: string]: any; }**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[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)
+
+# **reencrypt**
+> StorageEncryptionStatus reencrypt(reencryptRequest)
+
+202 with the status once started; 409 while a pass is in progress (or nothing to resume).
+
+### Example
+
+```typescript
+import {
+    StorageEncryptionAdministrationApi,
+    Configuration,
+    ReencryptRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new StorageEncryptionAdministrationApi(configuration);
+
+let reencryptRequest: ReencryptRequest; //
+
+const { status, data } = await apiInstance.reencrypt(
+    reencryptRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **reencryptRequest** | **ReencryptRequest**|  | |
+
+
+### Return type
+
+**StorageEncryptionStatus**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[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)
+
+# **rewrap**
+> { [key: string]: number; } rewrap()
+
+After the customer rotated the KEK in their KMS. One wrap per master key; no object is touched.
+
+### Example
+
+```typescript
+import {
+    StorageEncryptionAdministrationApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new StorageEncryptionAdministrationApi(configuration);
+
+const { status, data } = await apiInstance.rewrap();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**{ [key: string]: number; }**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[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)
+
+# **rotateMasterKey**
+> { [key: string]: string; } rotateMasterKey()
+
+New objects are wrapped with it; every older key stays readable. No object is rewritten.
+
+### Example
+
+```typescript
+import {
+    StorageEncryptionAdministrationApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new StorageEncryptionAdministrationApi(configuration);
+
+const { status, data } = await apiInstance.rotateMasterKey();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**{ [key: string]: string; }**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[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)
+
+# **status1**
+> StorageEncryptionStatus status1()
+
+
+### Example
+
+```typescript
+import {
+    StorageEncryptionAdministrationApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new StorageEncryptionAdministrationApi(configuration);
+
+const { status, data } = await apiInstance.status1();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**StorageEncryptionStatus**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[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)
+

package/docs/StorageEncryptionStatus.md

@@ -0,0 +1,45 @@
+# StorageEncryptionStatus
+
+Storage encryption: configuration, master key ring state and the re-encryption pass
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**enabled** | **boolean** |  | [optional] [default to undefined]
+**provider** | **string** | Key-wrap provider: local, vault-transit, aws-kms, azure-keyvault, scaleway-kms | [optional] [default to undefined]
+**chunkSize** | **number** |  | [optional] [default to undefined]
+**masterKeyTtl** | **string** |  | [optional] [default to undefined]
+**attestationInterval** | **string** |  | [optional] [default to undefined]
+**attestationGrace** | **string** |  | [optional] [default to undefined]
+**locked** | **boolean** | True while the customer\'s KEK is unavailable: content answers 423 Locked | [optional] [default to undefined]
+**lockReason** | **string** |  | [optional] [default to undefined]
+**lockedSince** | **string** |  | [optional] [default to undefined]
+**activeKeyId** | **string** |  | [optional] [default to undefined]
+**keysLoaded** | **number** |  | [optional] [default to undefined]
+**lastAttestation** | **string** |  | [optional] [default to undefined]
+**job** | [**JobStatus**](JobStatus.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { StorageEncryptionStatus } from '@openfilz-sdk/typescript-ee';
+
+const instance: StorageEncryptionStatus = {
+    enabled,
+    provider,
+    chunkSize,
+    masterKeyTtl,
+    attestationInterval,
+    attestationGrace,
+    locked,
+    lockReason,
+    lockedSince,
+    activeKeyId,
+    keysLoaded,
+    lastAttestation,
+    job,
+};
+```
+
+[[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/WorkflowsApi.md

@@ -10,13 +10,14 @@ All URIs are relative to *http://localhost:8081*
 |[**deleteDefinition**](#deletedefinition) | **DELETE** /api/v1/workflows/definitions/{id} | Delete a workflow definition (409 while instances are running)|
 |[**getDefinition**](#getdefinition) | **GET** /api/v1/workflows/definitions/{id} | Get a workflow definition|
 |[**getInstance**](#getinstance) | **GET** /api/v1/workflows/instances/{id} | One instance with its snapshot spec, open task and history|
-|[**listDefinitions**](#listdefinitions) | **GET** /api/v1/workflows/definitions | List workflow definitions|
+|[**listDefinitions**](#listdefinitions) | **GET** /api/v1/workflows/definitions | List the workflow definitions the caller may see (mine = created by the caller)|
 |[**listInstances**](#listinstances) | **GET** /api/v1/workflows/instances | List instances (monitor), newest first|
 |[**myTasks**](#mytasks) | **GET** /api/v1/workflows/tasks/mine | Open tasks I can act on (by e-mail or role)|
 |[**myTasksCount**](#mytaskscount) | **GET** /api/v1/workflows/tasks/mine/count | Number of open tasks I can act on (sidebar badge)|
 |[**reassign**](#reassign) | **POST** /api/v1/workflows/tasks/{id}/reassign | Hand a task to other people (initiator or current candidate)|
 |[**start**](#start) | **POST** /api/v1/workflows/instances | Start a workflow on a document (409 when one is already running)|
 |[**summary**](#summary) | **GET** /api/v1/workflows/instances/summary | Counts for the monitor header|
+|[**teamDefinitions**](#teamdefinitions) | **GET** /api/v1/workflows/team-definitions | Workflow definitions authored by the caller\'s teammates|
 |[**updateDefinition**](#updatedefinition) | **PUT** /api/v1/workflows/definitions/{id} | Update a workflow definition (running instances keep their snapshot)|
 |[**validateDefinition**](#validatedefinition) | **POST** /api/v1/workflows/definitions/validate | Validate a definition without saving it|
 
@@ -345,9 +346,11 @@ const configuration = new Configuration();
 const apiInstance = new WorkflowsApi(configuration);
 
 let active: boolean; // (optional) (default to undefined)
+let mine: boolean; // (optional) (default to false)
 
 const { status, data } = await apiInstance.listDefinitions(
-    active
+    active,
+    mine
 );
 ```
 
@@ -356,6 +359,7 @@ const { status, data } = await apiInstance.listDefinitions(
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
 | **active** | [**boolean**] |  | (optional) defaults to undefined|
+| **mine** | [**boolean**] |  | (optional) defaults to false|
 
 
 ### Return type
@@ -677,6 +681,60 @@ This endpoint does not have any parameters.
  - **Accept**: application/json
 
 
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[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)
+
+# **teamDefinitions**
+> Array<WorkflowDefinitionDTO> teamDefinitions()
+
+All of the caller\'s teams, or only teamId (404 when the caller is not a member of it). The caller\'s own definitions are not included — see GET /definitions?mine=true.
+
+### Example
+
+```typescript
+import {
+    WorkflowsApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new WorkflowsApi(configuration);
+
+let teamId: string; // (optional) (default to undefined)
+let active: boolean; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.teamDefinitions(
+    teamId,
+    active
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **teamId** | [**string**] |  | (optional) defaults to undefined|
+| **active** | [**boolean**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<WorkflowDefinitionDTO>**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|

package/graphql/document.graphqls

@@ -13,6 +13,12 @@ type Query {
     count(request: ListFolderRequest): Long
     listFavorites(request: FavoriteRequest!): [FolderElementInfo]
     countFavorites(request: FavoriteRequest): Long
+    "Count the documents across all folders (listAllFolder's filters; favorite: true counts the favorites)"
+    countAllFolder(request: ListFolderRequest): Long
+    "0-based index of a document in the listFolder listing the request describes (same filters and sort, paging ignored); null when the listing does not contain it"
+    listFolderPosition(request: ListFolderRequest!, documentId: UUID!): Long
+    "0-based index of a document in the listAllFolder listing the request describes (same filters and sort, paging ignored); null when the listing does not contain it"
+    listAllFolderPosition(request: ListFolderRequest!, documentId: UUID!): Long
 }
 
 type FolderElementInfo {

package/models/index.ts

@@ -93,6 +93,7 @@ export * from './insights';
 export * from './instantiate-template-request';
 export * from './item';
 export * from './item-result';
+export * from './job-status';
 export * from './key-count';
 export * from './license-info';
 export * from './list-ai-models-request';
@@ -118,6 +119,7 @@ export * from './pdf-transform-audit';
 export * from './per-definition';
 export * from './public-signature-view';
 export * from './reassign-task-request';
+export * from './reencrypt-request';
 export * from './rename-audit';
 export * from './rename-request';
 export * from './reorganization-apply-request';
@@ -162,6 +164,7 @@ export * from './split-output';
 export * from './split-request';
 export * from './start-workflow-request';
 export * from './storage-breakdown';
+export * from './storage-encryption-status';
 export * from './suggest';
 export * from './sync-backfill-status';
 export * from './sync-changes-response';

package/models/job-status.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.
+ */
+
+
+
+export interface JobStatus {
+    'status'?: string;
+    'mode'?: JobStatusModeEnum;
+    'targetKeyId'?: string;
+    'startedAt'?: string;
+    'finishedAt'?: string;
+    'files'?: number;
+    'reencrypted'?: number;
+    'skipped'?: number;
+    'failures'?: number;
+    'lastError'?: string;
+}
+
+export const JobStatusModeEnum = {
+    Legacy: 'LEGACY',
+    MasterKey: 'MASTER_KEY',
+    All: 'ALL',
+} as const;
+
+export type JobStatusModeEnum = typeof JobStatusModeEnum[keyof typeof JobStatusModeEnum];
+
+

package/models/reencrypt-request.ts

@@ -0,0 +1,40 @@
+/* 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 ReencryptRequest {
+    /**
+     * LEGACY: plaintext objects only (after switching the feature on); MASTER_KEY: objects written under targetKeyId; ALL: everything
+     */
+    'mode': ReencryptRequestModeEnum;
+    /**
+     * MASTER_KEY mode: the master key whose objects are rewritten under the active key
+     */
+    'targetKeyId'?: string;
+    /**
+     * Continue an unfinished or failed pass of the same mode instead of starting over
+     */
+    'resume'?: boolean;
+}
+
+export const ReencryptRequestModeEnum = {
+    Legacy: 'LEGACY',
+    MasterKey: 'MASTER_KEY',
+    All: 'ALL',
+} as const;
+
+export type ReencryptRequestModeEnum = typeof ReencryptRequestModeEnum[keyof typeof ReencryptRequestModeEnum];
+
+

package/models/storage-encryption-status.ts

@@ -0,0 +1,44 @@
+/* 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 { JobStatus } from './job-status';
+
+/**
+ * Storage encryption: configuration, master key ring state and the re-encryption pass
+ */
+export interface StorageEncryptionStatus {
+    'enabled'?: boolean;
+    /**
+     * Key-wrap provider: local, vault-transit, aws-kms, azure-keyvault, scaleway-kms
+     */
+    'provider'?: string;
+    'chunkSize'?: number;
+    'masterKeyTtl'?: string;
+    'attestationInterval'?: string;
+    'attestationGrace'?: string;
+    /**
+     * True while the customer\'s KEK is unavailable: content answers 423 Locked
+     */
+    'locked'?: boolean;
+    'lockReason'?: string;
+    'lockedSince'?: string;
+    'activeKeyId'?: string;
+    'keysLoaded'?: number;
+    'lastAttestation'?: string;
+    'job'?: JobStatus;
+}
+

package/package.json

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