@openfilz-sdk/typescript 1.3.28 → 1.3.30

package/dist/models/user-quota-request.js

@@ -0,0 +1,15 @@
+"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 });

package/docs/ErrorResponse.md

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

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

@@ -0,0 +1,275 @@
+# QuotaAdministrationApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**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|
+|[**listUsers**](#listusers) | **GET** /api/v1/admin/quotas/users | List users\' storage|
+|[**overview**](#overview) | **GET** /api/v1/admin/quotas | Quota overview|
+|[**setUserQuota**](#setuserquota) | **PUT** /api/v1/admin/quotas/users/{username} | Set one user\'s own limit|
+
+# **clearUserQuota**
+> QuotaUsage clearUserQuota()
+
+The group or default limit applies again.
+
+### Example
+
+```typescript
+import {
+    QuotaAdministrationApi,
+    Configuration
+} from '@openfilz-sdk/typescript';
+
+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';
+
+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)
+
+# **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';
+
+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';
+
+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)
+
+# **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';
+
+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';
+
+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';
+
+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';
+
+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';
+
+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/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,
 };
 ```
 

package/docs/TusControllerApi.md

@@ -111,7 +111,7 @@ void (empty response body)
 [[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)
 
 # **createUpload**
-> createUpload()
+> object createUpload()
 
 Creates a new TUS upload session. Client must provide Upload-Length header. Upload-Metadata header should contain base64-encoded values for: filename (required), parentFolderId (optional), allowDuplicateFileNames (optional, default false).
 
@@ -145,7 +145,7 @@ const { status, data } = await apiInstance.createUpload(
 
 ### Return type
 
-void (empty response body)
+**object**
 
 ### Authorization
 
@@ -154,7 +154,7 @@ void (empty response body)
 ### HTTP request headers
 
  - **Content-Type**: Not defined
- - **Accept**: Not defined
+ - **Accept**: */*
 
 
 ### HTTP response details
@@ -162,7 +162,7 @@ void (empty response body)
 |-------------|-------------|------------------|
 |**201** | Upload created |  * Tus-Resumable - TUS protocol version <br>  * Location - URL to upload chunks to <br>  |
 |**413** | Upload size exceeds maximum allowed or file quota exceeded |  -  |
-|**507** | User storage quota exceeded |  -  |
+|**507** | User or instance storage quota exceeded (error UserQuotaExceeded / InstanceQuotaExceeded) |  -  |
 |**404** | Parent folder not found |  -  |
 |**409** | Duplicate filename in target folder |  -  |
 |**400** | Missing required headers or filename |  -  |
@@ -430,7 +430,7 @@ const { status, data } = await apiInstance.isUploadComplete(
 [[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)
 
 # **uploadChunk**
-> uploadChunk(requestBody)
+> object uploadChunk(requestBody)
 
 Uploads a chunk of data. Client must send Upload-Offset header matching current offset.
 
@@ -470,7 +470,7 @@ const { status, data } = await apiInstance.uploadChunk(
 
 ### Return type
 
-void (empty response body)
+**object**
 
 ### Authorization
 
@@ -479,7 +479,7 @@ void (empty response body)
 ### HTTP request headers
 
  - **Content-Type**: application/offset+octet-stream
- - **Accept**: Not defined
+ - **Accept**: */*
 
 
 ### HTTP response details
@@ -487,6 +487,7 @@ void (empty response body)
 |-------------|-------------|------------------|
 |**204** | Chunk received successfully |  * Tus-Resumable - TUS protocol version <br>  * Upload-Offset - New offset after this chunk <br>  |
 |**409** | Offset mismatch - resume from HEAD request |  -  |
+|**413** | The chunk would go past the declared Upload-Length |  -  |
 |**404** | Upload not found |  -  |
 
 [[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/UserQuotaRequest.md

@@ -0,0 +1,20 @@
+# UserQuotaRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**quotaMb** | **number** | Limit in MB; 0 = no limit for this user | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UserQuotaRequest } from '@openfilz-sdk/typescript';
+
+const instance: UserQuotaRequest = {
+    quotaMb,
+};
+```
+
+[[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/models/error-response.ts

@@ -0,0 +1,22 @@
+/* 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 ErrorResponse {
+    'status'?: number;
+    'message'?: string;
+    'error'?: string;
+}
+

package/models/index.ts

@@ -42,6 +42,7 @@ export * from './document-version-info';
 export * from './element-info';
 export * from './embedding-backfill-request';
 export * from './embedding-backfill-status';
+export * from './error-response';
 export * from './facet';
 export * from './file-type-stats';
 export * from './filing-outcome';
@@ -60,6 +61,7 @@ export * from './merge-request';
 export * from './merge-source';
 export * from './move-audit';
 export * from './move-request';
+export * from './my-storage-quota';
 export * from './my-tasks-count-dto';
 export * from './organize-request';
 export * from './output-target';
@@ -72,6 +74,9 @@ export * from './pdf-page-info';
 export * from './pdf-transform-audit';
 export * from './per-definition';
 export * from './public-signature-view';
+export * from './quota-overview';
+export * from './quota-usage';
+export * from './quota-user-page';
 export * from './reassign-task-request';
 export * from './rename-audit';
 export * from './rename-request';
@@ -119,6 +124,7 @@ export * from './update-metadata-audit';
 export * from './update-metadata-request';
 export * from './upload-audit';
 export * from './upload-response';
+export * from './user-quota-request';
 export * from './verify-otp-request';
 export * from './vote';
 export * from './workflow-action';

package/models/my-storage-quota.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 MyStorageQuota {
+    'usedBytes'?: number;
+    'limitBytes'?: number;
+    'source'?: MyStorageQuotaSourceEnum;
+    'sourceName'?: string;
+    'maxFileSizeBytes'?: number;
+}
+
+export const MyStorageQuotaSourceEnum = {
+    User: 'USER',
+    Group: 'GROUP',
+    Default: 'DEFAULT',
+} as const;
+
+export type MyStorageQuotaSourceEnum = typeof MyStorageQuotaSourceEnum[keyof typeof MyStorageQuotaSourceEnum];
+
+