@openfilz-sdk/typescript-ee 1.11.0 → 1.12.1

package/docs/QuotaAdministrationApi.md

@@ -0,0 +1,427 @@
+# QuotaAdministrationApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**clear**](#clear) | **DELETE** /api/v1/admin/quotas/teams/{teamId} | Remove a team\'s limit|
+|[**clearUserQuota**](#clearuserquota) | **DELETE** /api/v1/admin/quotas/users/{username} | Remove one user\'s own limit|
+|[**getUser**](#getuser) | **GET** /api/v1/admin/quotas/users/{username} | Get one user\'s storage|
+|[**list5**](#list5) | **GET** /api/v1/admin/quotas/teams | List teams with their per-member limit and their members\' usage|
+|[**listUsers**](#listusers) | **GET** /api/v1/admin/quotas/users | List users\' storage|
+|[**overview**](#overview) | **GET** /api/v1/admin/quotas | Quota overview|
+|[**set**](#set) | **PUT** /api/v1/admin/quotas/teams/{teamId} | Set a team\'s per-member limit|
+|[**setUserQuota**](#setuserquota) | **PUT** /api/v1/admin/quotas/users/{username} | Set one user\'s own limit|
+
+# **clear**
+> TeamQuotaView clear()
+
+Its members fall back to their other teams or the default.
+
+### Example
+
+```typescript
+import {
+    QuotaAdministrationApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new QuotaAdministrationApi(configuration);
+
+let teamId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.clear(
+    teamId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **teamId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**TeamQuotaView**
+
+### 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)
+
+# **clearUserQuota**
+> QuotaUsage clearUserQuota()
+
+The group or default limit applies again.
+
+### Example
+
+```typescript
+import {
+    QuotaAdministrationApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new QuotaAdministrationApi(configuration);
+
+let username: string; // (default to undefined)
+
+const { status, data } = await apiInstance.clearUserQuota(
+    username
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **username** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**QuotaUsage**
+
+### 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)
+
+# **getUser**
+> QuotaUsage getUser()
+
+
+### Example
+
+```typescript
+import {
+    QuotaAdministrationApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new QuotaAdministrationApi(configuration);
+
+let username: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getUser(
+    username
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **username** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**QuotaUsage**
+
+### 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)
+
+# **list5**
+> Array<TeamQuotaView> list5()
+
+
+### Example
+
+```typescript
+import {
+    QuotaAdministrationApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new QuotaAdministrationApi(configuration);
+
+const { status, data } = await apiInstance.list5();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<TeamQuotaView>**
+
+### 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)
+
+# **listUsers**
+> QuotaUserPage listUsers()
+
+Every user storage is charged to, with usage, effective limit and its source. Sort by usage (default), percent, limit or name.
+
+### Example
+
+```typescript
+import {
+    QuotaAdministrationApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new QuotaAdministrationApi(configuration);
+
+let search: string; //Case-insensitive filter on the user name (optional) (default to undefined)
+let sort: string; //usage | percent | limit | name (optional) (default to 'usage')
+let order: string; //asc | desc (optional) (default to 'desc')
+let page: number; // (optional) (default to 0)
+let size: number; // (optional) (default to 25)
+
+const { status, data } = await apiInstance.listUsers(
+    search,
+    sort,
+    order,
+    page,
+    size
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **search** | [**string**] | Case-insensitive filter on the user name | (optional) defaults to undefined|
+| **sort** | [**string**] | usage | percent | limit | name | (optional) defaults to 'usage'|
+| **order** | [**string**] | asc | desc | (optional) defaults to 'desc'|
+| **page** | [**number**] |  | (optional) defaults to 0|
+| **size** | [**number**] |  | (optional) defaults to 25|
+
+
+### Return type
+
+**QuotaUserPage**
+
+### 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)
+
+# **overview**
+> QuotaOverview overview()
+
+Deployment-wide limits (MB, 0 = no limit), instance usage and the number of user overrides.
+
+### Example
+
+```typescript
+import {
+    QuotaAdministrationApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new QuotaAdministrationApi(configuration);
+
+const { status, data } = await apiInstance.overview();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**QuotaOverview**
+
+### 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)
+
+# **set**
+> TeamQuotaView set(teamQuotaRequest)
+
+quotaMb > 0 = limit per member, 0 = members exempt.
+
+### Example
+
+```typescript
+import {
+    QuotaAdministrationApi,
+    Configuration,
+    TeamQuotaRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new QuotaAdministrationApi(configuration);
+
+let teamId: string; // (default to undefined)
+let teamQuotaRequest: TeamQuotaRequest; //
+
+const { status, data } = await apiInstance.set(
+    teamId,
+    teamQuotaRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **teamQuotaRequest** | **TeamQuotaRequest**|  | |
+| **teamId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**TeamQuotaView**
+
+### 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)
+
+# **setUserQuota**
+> QuotaUsage setUserQuota(userQuotaRequest)
+
+quotaMb > 0 = this user\'s limit, 0 = no limit for this user. Takes precedence over group and default limits.
+
+### Example
+
+```typescript
+import {
+    QuotaAdministrationApi,
+    Configuration,
+    UserQuotaRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new QuotaAdministrationApi(configuration);
+
+let username: string; // (default to undefined)
+let userQuotaRequest: UserQuotaRequest; //
+
+const { status, data } = await apiInstance.setUserQuota(
+    username,
+    userQuotaRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **userQuotaRequest** | **UserQuotaRequest**|  | |
+| **username** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**QuotaUsage**
+
+### 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)
+

package/docs/QuotaOverview.md

@@ -0,0 +1,30 @@
+# QuotaOverview
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**fileUploadMb** | **number** |  | [optional] [default to undefined]
+**defaultUserMb** | **number** |  | [optional] [default to undefined]
+**totalMb** | **number** |  | [optional] [default to undefined]
+**instanceUsedBytes** | **number** |  | [optional] [default to undefined]
+**instanceLimitBytes** | **number** |  | [optional] [default to undefined]
+**userOverrides** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { QuotaOverview } from '@openfilz-sdk/typescript-ee';
+
+const instance: QuotaOverview = {
+    fileUploadMb,
+    defaultUserMb,
+    totalMb,
+    instanceUsedBytes,
+    instanceLimitBytes,
+    userOverrides,
+};
+```
+
+[[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/QuotaUsage.md

@@ -0,0 +1,34 @@
+# QuotaUsage
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**username** | **string** |  | [optional] [default to undefined]
+**displayName** | **string** |  | [optional] [default to undefined]
+**usedBytes** | **number** |  | [optional] [default to undefined]
+**limitBytes** | **number** |  | [optional] [default to undefined]
+**source** | **string** |  | [optional] [default to undefined]
+**sourceName** | **string** |  | [optional] [default to undefined]
+**overrideMb** | **number** |  | [optional] [default to undefined]
+**usedPercent** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { QuotaUsage } from '@openfilz-sdk/typescript-ee';
+
+const instance: QuotaUsage = {
+    username,
+    displayName,
+    usedBytes,
+    limitBytes,
+    source,
+    sourceName,
+    overrideMb,
+    usedPercent,
+};
+```
+
+[[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/QuotaUserPage.md

@@ -0,0 +1,26 @@
+# QuotaUserPage
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | **number** |  | [optional] [default to undefined]
+**page** | **number** |  | [optional] [default to undefined]
+**size** | **number** |  | [optional] [default to undefined]
+**items** | [**Array<QuotaUsage>**](QuotaUsage.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { QuotaUserPage } from '@openfilz-sdk/typescript-ee';
+
+const instance: QuotaUserPage = {
+    total,
+    page,
+    size,
+    items,
+};
+```
+
+[[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/QuotasApi.md

@@ -0,0 +1,52 @@
+# QuotasApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**myQuota**](#myquota) | **GET** /api/v1/quotas/me | Get my storage quota|
+
+# **myQuota**
+> MyStorageQuota myQuota()
+
+The caller\'s used bytes, effective limit (null = unlimited) and where it comes from (USER override, GROUP, DEFAULT), plus the per-file upload limit.
+
+### Example
+
+```typescript
+import {
+    QuotasApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new QuotasApi(configuration);
+
+const { status, data } = await apiInstance.myQuota();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**MyStorageQuota**
+
+### 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/SearchAdministrationApi.md

@@ -7,6 +7,7 @@ All URIs are relative to *http://localhost:8081*
 |[**createIndex**](#createindex) | **POST** /api/v1/admin/search | Create search index|
 |[**deleteIndex**](#deleteindex) | **DELETE** /api/v1/admin/search | Delete search index|
 |[**getStatus**](#getstatus) | **GET** /api/v1/admin/search/status | Get reindexation status|
+|[**refreshMetadata**](#refreshmetadata) | **POST** /api/v1/admin/search/refresh-metadata | Refresh index metadata|
 |[**reindexAll**](#reindexall) | **POST** /api/v1/admin/search/reindex | Reindex all documents|
 
 # **createIndex**
@@ -120,6 +121,50 @@ const { status, data } = await apiInstance.getStatus();
 This endpoint does not have any parameters.
 
 
+### Return type
+
+**object**
+
+### 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)
+
+# **refreshMetadata**
+> object refreshMetadata()
+
+Rewrites the metadata fields of every indexed document from the database — no text extraction, no AI, no downtime. Runs asynchronously in the background.
+
+### Example
+
+```typescript
+import {
+    SearchAdministrationApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new SearchAdministrationApi(configuration);
+
+const { status, data } = await apiInstance.refreshMetadata();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
 ### Return type
 
 **object**

package/docs/SettingDto.md

@@ -0,0 +1,44 @@
+# SettingDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **string** |  | [optional] [default to undefined]
+**section** | **string** |  | [optional] [default to undefined]
+**type** | **string** |  | [optional] [default to undefined]
+**unit** | **string** |  | [optional] [default to undefined]
+**min** | **number** |  | [optional] [default to undefined]
+**max** | **number** |  | [optional] [default to undefined]
+**allowedValues** | **Array<string>** |  | [optional] [default to undefined]
+**value** | **string** |  | [optional] [default to undefined]
+**deploymentValue** | **string** |  | [optional] [default to undefined]
+**source** | **string** |  | [optional] [default to undefined]
+**locked** | **boolean** |  | [optional] [default to undefined]
+**updatedBy** | **string** |  | [optional] [default to undefined]
+**updatedAt** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SettingDto } from '@openfilz-sdk/typescript-ee';
+
+const instance: SettingDto = {
+    key,
+    section,
+    type,
+    unit,
+    min,
+    max,
+    allowedValues,
+    value,
+    deploymentValue,
+    source,
+    locked,
+    updatedBy,
+    updatedAt,
+};
+```
+
+[[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/StartRequest.md

@@ -0,0 +1,20 @@
+# StartRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**force** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { StartRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: StartRequest = {
+    force,
+};
+```
+
+[[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/StorageBreakdown.md

@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 **totalStorageUsed** | **number** |  | [optional] [default to undefined]
 **totalStorageAvailable** | **number** |  | [optional] [default to undefined]
 **fileTypeBreakdown** | [**Array<FileTypeStats>**](FileTypeStats.md) |  | [optional] [default to undefined]
+**quota** | [**MyStorageQuota**](MyStorageQuota.md) |  | [optional] [default to undefined]
 
 ## Example
 
@@ -18,6 +19,7 @@ const instance: StorageBreakdown = {
     totalStorageUsed,
     totalStorageAvailable,
     fileTypeBreakdown,
+    quota,
 };
 ```