@openfilz-sdk/typescript-ee 1.12.17 → 1.12.19

package/docs/OwnedDocument.md

@@ -0,0 +1,32 @@
+# OwnedDocument
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**type** | **string** |  | [optional] [default to undefined]
+**parentId** | **string** |  | [optional] [default to undefined]
+**size** | **number** |  | [optional] [default to undefined]
+**updatedAt** | **string** |  | [optional] [default to undefined]
+**active** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OwnedDocument } from '@openfilz-sdk/typescript-ee';
+
+const instance: OwnedDocument = {
+    id,
+    name,
+    type,
+    parentId,
+    size,
+    updatedAt,
+    active,
+};
+```
+
+[[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/OwnedDocumentsFilter.md

@@ -0,0 +1,31 @@
+# OwnedDocumentsFilter
+
+Filter on the documents owned by a user
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**parentId** | **string** | Children of this folder (owned by the user) | [optional] [default to undefined]
+**recursive** | **boolean** | With parentId: every descendant; without: every owned document | [optional] [default to undefined]
+**type** | **string** | FILE or FOLDER | [optional] [default to undefined]
+**name** | **string** | Case-insensitive part of the name | [optional] [default to undefined]
+**updatedAfter** | **string** | Last modified at or after | [optional] [default to undefined]
+**updatedBefore** | **string** | Last modified at or before | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OwnedDocumentsFilter } from '@openfilz-sdk/typescript-ee';
+
+const instance: OwnedDocumentsFilter = {
+    parentId,
+    recursive,
+    type,
+    name,
+    updatedAfter,
+    updatedBefore,
+};
+```
+
+[[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/OwnershipApi.md

@@ -0,0 +1,621 @@
+# OwnershipApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**adminCountOwnedDocuments**](#admincountowneddocuments) | **GET** /api/v1/admin/ownership/users/{userId}/documents/count | Count the documents a user owns (same filter as the listing)|
+|[**adminGetOwnershipTransfer**](#admingetownershiptransfer) | **GET** /api/v1/admin/ownership/transfers/{jobId} | A transfer\'s progress and outcome|
+|[**adminListOwnedDocuments**](#adminlistowneddocuments) | **GET** /api/v1/admin/ownership/users/{userId}/documents | List the documents a user owns|
+|[**adminListOwnershipTransfers**](#adminlistownershiptransfers) | **GET** /api/v1/admin/ownership/transfers | The last 50 transfers from or to a user|
+|[**adminTransferOwnership**](#admintransferownership) | **POST** /api/v1/admin/ownership/transfers | Transfer documents to another user|
+|[**countOwnedDocuments**](#countowneddocuments) | **GET** /api/v1/users/ownership/users/{userId}/documents/count | Count the documents a user owns (same filter as the listing)|
+|[**getOwnershipTransfer**](#getownershiptransfer) | **GET** /api/v1/users/ownership/transfers/{jobId} | A transfer\'s progress and outcome|
+|[**listOwnedDocuments**](#listowneddocuments) | **GET** /api/v1/users/ownership/users/{userId}/documents | List the documents a user owns|
+|[**listOwnershipTransfers**](#listownershiptransfers) | **GET** /api/v1/users/ownership/transfers | The last 50 transfers from or to a user|
+|[**transferOwnership**](#transferownership) | **POST** /api/v1/users/ownership/transfers | Transfer documents to another user|
+
+# **adminCountOwnedDocuments**
+> number adminCountOwnedDocuments()
+
+
+### Example
+
+```typescript
+import {
+    OwnershipApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new OwnershipApi(configuration);
+
+let userId: string; // (default to undefined)
+let parentId: string; // (optional) (default to undefined)
+let recursive: boolean; // (optional) (default to undefined)
+let type: 'FILE' | 'FOLDER'; // (optional) (default to undefined)
+let name: string; // (optional) (default to undefined)
+let updatedAfter: string; // (optional) (default to undefined)
+let updatedBefore: string; // (optional) (default to undefined)
+let xOpenFilzReason: string; //Why the administrator looks at this user\'s documents — required when the consent bypass applies; percent-encode (UTF-8) a non-ASCII reason (optional) (default to undefined)
+
+const { status, data } = await apiInstance.adminCountOwnedDocuments(
+    userId,
+    parentId,
+    recursive,
+    type,
+    name,
+    updatedAfter,
+    updatedBefore,
+    xOpenFilzReason
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **userId** | [**string**] |  | defaults to undefined|
+| **parentId** | [**string**] |  | (optional) defaults to undefined|
+| **recursive** | [**boolean**] |  | (optional) defaults to undefined|
+| **type** | [**&#39;FILE&#39; | &#39;FOLDER&#39;**]**Array<&#39;FILE&#39; &#124; &#39;FOLDER&#39;>** |  | (optional) defaults to undefined|
+| **name** | [**string**] |  | (optional) defaults to undefined|
+| **updatedAfter** | [**string**] |  | (optional) defaults to undefined|
+| **updatedBefore** | [**string**] |  | (optional) defaults to undefined|
+| **xOpenFilzReason** | [**string**] | Why the administrator looks at this user\&#39;s documents — required when the consent bypass applies; percent-encode (UTF-8) a non-ASCII reason | (optional) defaults to undefined|
+
+
+### Return type
+
+**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)
+
+# **adminGetOwnershipTransfer**
+> OwnershipTransferReport adminGetOwnershipTransfer()
+
+
+### Example
+
+```typescript
+import {
+    OwnershipApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new OwnershipApi(configuration);
+
+let jobId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.adminGetOwnershipTransfer(
+    jobId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **jobId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**OwnershipTransferReport**
+
+### 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)
+
+# **adminListOwnedDocuments**
+> Array<OwnedDocument> adminListOwnedDocuments()
+
+Without parentId and recursive: the user\'s top level (no parent, or a parent they do not own). Subject to the consent-bypass setting (except type=FOLDER, used to pick a transfer\'s destination): send the reason in the X-OpenFilz-Reason header, percent-encoded (UTF-8) if not ASCII.
+
+### Example
+
+```typescript
+import {
+    OwnershipApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new OwnershipApi(configuration);
+
+let userId: string; // (default to undefined)
+let parentId: string; // (optional) (default to undefined)
+let recursive: boolean; // (optional) (default to undefined)
+let type: 'FILE' | 'FOLDER'; // (optional) (default to undefined)
+let name: string; // (optional) (default to undefined)
+let updatedAfter: string; // (optional) (default to undefined)
+let updatedBefore: string; // (optional) (default to undefined)
+let page: number; // (optional) (default to 0)
+let size: number; // (optional) (default to 50)
+let xOpenFilzReason: string; //Why the administrator looks at this user\'s documents — required when the consent bypass applies; percent-encode (UTF-8) a non-ASCII reason (optional) (default to undefined)
+
+const { status, data } = await apiInstance.adminListOwnedDocuments(
+    userId,
+    parentId,
+    recursive,
+    type,
+    name,
+    updatedAfter,
+    updatedBefore,
+    page,
+    size,
+    xOpenFilzReason
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **userId** | [**string**] |  | defaults to undefined|
+| **parentId** | [**string**] |  | (optional) defaults to undefined|
+| **recursive** | [**boolean**] |  | (optional) defaults to undefined|
+| **type** | [**&#39;FILE&#39; | &#39;FOLDER&#39;**]**Array<&#39;FILE&#39; &#124; &#39;FOLDER&#39;>** |  | (optional) defaults to undefined|
+| **name** | [**string**] |  | (optional) defaults to undefined|
+| **updatedAfter** | [**string**] |  | (optional) defaults to undefined|
+| **updatedBefore** | [**string**] |  | (optional) defaults to undefined|
+| **page** | [**number**] |  | (optional) defaults to 0|
+| **size** | [**number**] |  | (optional) defaults to 50|
+| **xOpenFilzReason** | [**string**] | Why the administrator looks at this user\&#39;s documents — required when the consent bypass applies; percent-encode (UTF-8) a non-ASCII reason | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<OwnedDocument>**
+
+### 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)
+
+# **adminListOwnershipTransfers**
+> Array<OwnershipTransferReport> adminListOwnershipTransfers()
+
+
+### Example
+
+```typescript
+import {
+    OwnershipApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new OwnershipApi(configuration);
+
+let userId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.adminListOwnershipTransfers(
+    userId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **userId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**Array<OwnershipTransferReport>**
+
+### 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)
+
+# **adminTransferOwnership**
+> OwnershipTransferReport adminTransferOwnership(ownershipTransferRequest)
+
+dryRun=true reports what would happen. Otherwise 200 with status DONE, or 202 with status RUNNING for a large scope (poll GET …/transfers/{jobId}). 409 QUOTA_EXCEEDED carries usedBytes, transferBytes, limitBytes.
+
+### Example
+
+```typescript
+import {
+    OwnershipApi,
+    Configuration,
+    OwnershipTransferRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new OwnershipApi(configuration);
+
+let ownershipTransferRequest: OwnershipTransferRequest; //
+
+const { status, data } = await apiInstance.adminTransferOwnership(
+    ownershipTransferRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **ownershipTransferRequest** | **OwnershipTransferRequest**|  | |
+
+
+### Return type
+
+**OwnershipTransferReport**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Done (status DONE), or the dry run\&#39;s report |  -  |
+|**202** | Large scope: running in the background (status RUNNING) |  -  |
+
+[[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)
+
+# **countOwnedDocuments**
+> number countOwnedDocuments()
+
+
+### Example
+
+```typescript
+import {
+    OwnershipApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new OwnershipApi(configuration);
+
+let userId: string; // (default to undefined)
+let parentId: string; // (optional) (default to undefined)
+let recursive: boolean; // (optional) (default to undefined)
+let type: 'FILE' | 'FOLDER'; // (optional) (default to undefined)
+let name: string; // (optional) (default to undefined)
+let updatedAfter: string; // (optional) (default to undefined)
+let updatedBefore: string; // (optional) (default to undefined)
+let xOpenFilzReason: string; //Why the administrator looks at this user\'s documents — required when the consent bypass applies; percent-encode (UTF-8) a non-ASCII reason (optional) (default to undefined)
+
+const { status, data } = await apiInstance.countOwnedDocuments(
+    userId,
+    parentId,
+    recursive,
+    type,
+    name,
+    updatedAfter,
+    updatedBefore,
+    xOpenFilzReason
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **userId** | [**string**] |  | defaults to undefined|
+| **parentId** | [**string**] |  | (optional) defaults to undefined|
+| **recursive** | [**boolean**] |  | (optional) defaults to undefined|
+| **type** | [**&#39;FILE&#39; | &#39;FOLDER&#39;**]**Array<&#39;FILE&#39; &#124; &#39;FOLDER&#39;>** |  | (optional) defaults to undefined|
+| **name** | [**string**] |  | (optional) defaults to undefined|
+| **updatedAfter** | [**string**] |  | (optional) defaults to undefined|
+| **updatedBefore** | [**string**] |  | (optional) defaults to undefined|
+| **xOpenFilzReason** | [**string**] | Why the administrator looks at this user\&#39;s documents — required when the consent bypass applies; percent-encode (UTF-8) a non-ASCII reason | (optional) defaults to undefined|
+
+
+### Return type
+
+**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)
+
+# **getOwnershipTransfer**
+> OwnershipTransferReport getOwnershipTransfer()
+
+
+### Example
+
+```typescript
+import {
+    OwnershipApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new OwnershipApi(configuration);
+
+let jobId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getOwnershipTransfer(
+    jobId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **jobId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**OwnershipTransferReport**
+
+### 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)
+
+# **listOwnedDocuments**
+> Array<OwnedDocument> listOwnedDocuments()
+
+Without parentId and recursive: the user\'s top level (no parent, or a parent they do not own). Subject to the consent-bypass setting (except type=FOLDER, used to pick a transfer\'s destination): send the reason in the X-OpenFilz-Reason header, percent-encoded (UTF-8) if not ASCII.
+
+### Example
+
+```typescript
+import {
+    OwnershipApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new OwnershipApi(configuration);
+
+let userId: string; // (default to undefined)
+let parentId: string; // (optional) (default to undefined)
+let recursive: boolean; // (optional) (default to undefined)
+let type: 'FILE' | 'FOLDER'; // (optional) (default to undefined)
+let name: string; // (optional) (default to undefined)
+let updatedAfter: string; // (optional) (default to undefined)
+let updatedBefore: string; // (optional) (default to undefined)
+let page: number; // (optional) (default to 0)
+let size: number; // (optional) (default to 50)
+let xOpenFilzReason: string; //Why the administrator looks at this user\'s documents — required when the consent bypass applies; percent-encode (UTF-8) a non-ASCII reason (optional) (default to undefined)
+
+const { status, data } = await apiInstance.listOwnedDocuments(
+    userId,
+    parentId,
+    recursive,
+    type,
+    name,
+    updatedAfter,
+    updatedBefore,
+    page,
+    size,
+    xOpenFilzReason
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **userId** | [**string**] |  | defaults to undefined|
+| **parentId** | [**string**] |  | (optional) defaults to undefined|
+| **recursive** | [**boolean**] |  | (optional) defaults to undefined|
+| **type** | [**&#39;FILE&#39; | &#39;FOLDER&#39;**]**Array<&#39;FILE&#39; &#124; &#39;FOLDER&#39;>** |  | (optional) defaults to undefined|
+| **name** | [**string**] |  | (optional) defaults to undefined|
+| **updatedAfter** | [**string**] |  | (optional) defaults to undefined|
+| **updatedBefore** | [**string**] |  | (optional) defaults to undefined|
+| **page** | [**number**] |  | (optional) defaults to 0|
+| **size** | [**number**] |  | (optional) defaults to 50|
+| **xOpenFilzReason** | [**string**] | Why the administrator looks at this user\&#39;s documents — required when the consent bypass applies; percent-encode (UTF-8) a non-ASCII reason | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<OwnedDocument>**
+
+### 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)
+
+# **listOwnershipTransfers**
+> Array<OwnershipTransferReport> listOwnershipTransfers()
+
+
+### Example
+
+```typescript
+import {
+    OwnershipApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new OwnershipApi(configuration);
+
+let userId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.listOwnershipTransfers(
+    userId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **userId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**Array<OwnershipTransferReport>**
+
+### 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)
+
+# **transferOwnership**
+> OwnershipTransferReport transferOwnership(ownershipTransferRequest)
+
+dryRun=true reports what would happen. Otherwise 200 with status DONE, or 202 with status RUNNING for a large scope (poll GET …/transfers/{jobId}). 409 QUOTA_EXCEEDED carries usedBytes, transferBytes, limitBytes.
+
+### Example
+
+```typescript
+import {
+    OwnershipApi,
+    Configuration,
+    OwnershipTransferRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new OwnershipApi(configuration);
+
+let ownershipTransferRequest: OwnershipTransferRequest; //
+
+const { status, data } = await apiInstance.transferOwnership(
+    ownershipTransferRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **ownershipTransferRequest** | **OwnershipTransferRequest**|  | |
+
+
+### Return type
+
+**OwnershipTransferReport**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Done (status DONE), or the dry run\&#39;s report |  -  |
+|**202** | Large scope: running in the background (status RUNNING) |  -  |
+
+[[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)
+