@openfilz-sdk/typescript-ee 1.3.5

package/docs/CollaborationControllerApi.md

@@ -0,0 +1,802 @@
+# CollaborationControllerApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**acceptShareRequest**](#acceptsharerequest) | **POST** /api/v1/users/share-requests/{id}/accept | Accept a share request|
+|[**addTeamMembers**](#addteammembers) | **POST** /api/v1/users/teams/{teamId}/members | Add team members|
+|[**createSharedDocuments**](#createshareddocuments) | **POST** /api/v1/users/share | Create Share for document(s)|
+|[**createTeam**](#createteam) | **POST** /api/v1/users/teams | Create a team|
+|[**createUser**](#createuser) | **POST** /api/v1/users | Create a new user|
+|[**deactivateUser**](#deactivateuser) | **DELETE** /api/v1/users/{userId} | Deactivate a user|
+|[**deleteSharedDocuments**](#deleteshareddocuments) | **DELETE** /api/v1/users/share | Delete Share for document(s)|
+|[**deleteTeam**](#deleteteam) | **DELETE** /api/v1/users/teams/{teamId} | Delete a team|
+|[**getTeamMembers**](#getteammembers) | **GET** /api/v1/users/teams/{teamId}/members | Get team members|
+|[**getUserStatus**](#getuserstatus) | **GET** /api/v1/users/me/status | Check user status|
+|[**rejectShareRequest**](#rejectsharerequest) | **DELETE** /api/v1/users/share-requests/{id} | Reject a share request|
+|[**removeTeamMembers**](#removeteammembers) | **DELETE** /api/v1/users/teams/{teamId}/members | Remove team members|
+|[**updateSharedDocuments**](#updateshareddocuments) | **PUT** /api/v1/users/share | Update Share for document(s)|
+|[**updateTeam**](#updateteam) | **PUT** /api/v1/users/teams/{teamId} | Update a team|
+|[**updateUser**](#updateuser) | **PUT** /api/v1/users/{userId} | Update a user|
+
+# **acceptShareRequest**
+> number acceptShareRequest()
+
+Accepts a share request: creates the share and deletes the request. Accessible only by users with EDIT_SHARE role.
+
+### Example
+
+```typescript
+import {
+    CollaborationControllerApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new CollaborationControllerApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.acceptShareRequest(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | 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)
+
+# **addTeamMembers**
+> addTeamMembers(requestBody)
+
+Adds users to a team. Requires ADMIN_USERS role.
+
+### Example
+
+```typescript
+import {
+    CollaborationControllerApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new CollaborationControllerApi(configuration);
+
+let teamId: string; // (default to undefined)
+let requestBody: Array<string>; //
+
+const { status, data } = await apiInstance.addTeamMembers(
+    teamId,
+    requestBody
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **requestBody** | **Array<string>**|  | |
+| **teamId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+
+### 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)
+
+# **createSharedDocuments**
+> ShareResultResponse createSharedDocuments(shareRequest)
+
+Creates new Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors.  Error codes in response: - SHARE_ERR_USER_DEACTIVATED: Cannot share with a deactivated user in read-only mode - SHARE_ERR_USER_NOT_LICENSED: User must have a license to be shared with in editor or commenter mode - SHARE_ERR_PARENT_AND_CHILD: A folder and its children cannot both be in the share list - SHARE_ERR_ALREADY_EXISTS: A share already exists for this document and user 
+
+### Example
+
+```typescript
+import {
+    CollaborationControllerApi,
+    Configuration,
+    ShareRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new CollaborationControllerApi(configuration);
+
+let shareRequest: ShareRequest; //
+
+const { status, data } = await apiInstance.createSharedDocuments(
+    shareRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **shareRequest** | **ShareRequest**|  | |
+
+
+### Return type
+
+**ShareResultResponse**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | All shares created successfully |  -  |
+|**207** | Partial success: some shares created, some sent as requests, some failed |  -  |
+
+[[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)
+
+# **createTeam**
+> string createTeam(createTeamRequest)
+
+Creates a new team. Requires ADMIN_USERS role.
+
+### Example
+
+```typescript
+import {
+    CollaborationControllerApi,
+    Configuration,
+    CreateTeamRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new CollaborationControllerApi(configuration);
+
+let createTeamRequest: CreateTeamRequest; //
+
+const { status, data } = await apiInstance.createTeam(
+    createTeamRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createTeamRequest** | **CreateTeamRequest**|  | |
+
+
+### Return type
+
+**string**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Created |  -  |
+
+[[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)
+
+# **createUser**
+> string createUser(userRegistrationRequest)
+
+Create a new user to share documents with
+
+### Example
+
+```typescript
+import {
+    CollaborationControllerApi,
+    Configuration,
+    UserRegistrationRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new CollaborationControllerApi(configuration);
+
+let userRegistrationRequest: UserRegistrationRequest; //
+
+const { status, data } = await apiInstance.createUser(
+    userRegistrationRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **userRegistrationRequest** | **UserRegistrationRequest**|  | |
+
+
+### Return type
+
+**string**
+
+### 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)
+
+# **deactivateUser**
+> deactivateUser()
+
+Deactivates a user. Requires ADMIN_USERS role.
+
+### Example
+
+```typescript
+import {
+    CollaborationControllerApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new CollaborationControllerApi(configuration);
+
+let userId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.deactivateUser(
+    userId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **userId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### 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)
+
+# **deleteSharedDocuments**
+> ShareResultResponse deleteSharedDocuments(deleteShareRequest)
+
+Deletes existing Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors.  Error codes in response: - SHARE_ERR_NOT_ALREADY_SHARED: No existing share found for this document and user 
+
+### Example
+
+```typescript
+import {
+    CollaborationControllerApi,
+    Configuration,
+    DeleteShareRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new CollaborationControllerApi(configuration);
+
+let deleteShareRequest: DeleteShareRequest; //
+
+const { status, data } = await apiInstance.deleteSharedDocuments(
+    deleteShareRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **deleteShareRequest** | **DeleteShareRequest**|  | |
+
+
+### Return type
+
+**ShareResultResponse**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | All shares deleted successfully |  -  |
+|**207** | Partial success: some shares deleted, some sent as requests, some failed |  -  |
+
+[[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)
+
+# **deleteTeam**
+> deleteTeam()
+
+Deletes a team. Requires ADMIN_USERS role.
+
+### Example
+
+```typescript
+import {
+    CollaborationControllerApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new CollaborationControllerApi(configuration);
+
+let teamId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.deleteTeam(
+    teamId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **teamId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### 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)
+
+# **getTeamMembers**
+> Array<TeamMemberInfo> getTeamMembers()
+
+Lists all members of a team. Requires ADMIN_USERS role.
+
+### Example
+
+```typescript
+import {
+    CollaborationControllerApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new CollaborationControllerApi(configuration);
+
+let teamId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getTeamMembers(
+    teamId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **teamId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**Array<TeamMemberInfo>**
+
+### 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)
+
+# **getUserStatus**
+> getUserStatus()
+
+Confirms the current user exists in the local database. User sync happens during JWT authentication, so this endpoint simply confirms authentication was successful.
+
+### Example
+
+```typescript
+import {
+    CollaborationControllerApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new CollaborationControllerApi(configuration);
+
+const { status, data } = await apiInstance.getUserStatus();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### 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)
+
+# **rejectShareRequest**
+> rejectShareRequest()
+
+Rejects and deletes a share request. Accessible only by users with EDIT_SHARE role.
+
+### Example
+
+```typescript
+import {
+    CollaborationControllerApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new CollaborationControllerApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.rejectShareRequest(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### 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)
+
+# **removeTeamMembers**
+> removeTeamMembers(requestBody)
+
+Removes users from a team. Requires ADMIN_USERS role.
+
+### Example
+
+```typescript
+import {
+    CollaborationControllerApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new CollaborationControllerApi(configuration);
+
+let teamId: string; // (default to undefined)
+let requestBody: Array<string>; //
+
+const { status, data } = await apiInstance.removeTeamMembers(
+    teamId,
+    requestBody
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **requestBody** | **Array<string>**|  | |
+| **teamId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+
+### 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)
+
+# **updateSharedDocuments**
+> ShareResultResponse updateSharedDocuments(shareRequest)
+
+Updates existing Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors.  Error codes in response: - SHARE_ERR_USER_DEACTIVATED: Cannot share with a deactivated user in read-only mode - SHARE_ERR_USER_NOT_LICENSED: User must have a license to be shared with in editor or commenter mode - SHARE_ERR_PARENT_AND_CHILD: A folder and its children cannot both be in the share list - SHARE_ERR_NOT_ALREADY_SHARED: No existing share found for this document and user 
+
+### Example
+
+```typescript
+import {
+    CollaborationControllerApi,
+    Configuration,
+    ShareRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new CollaborationControllerApi(configuration);
+
+let shareRequest: ShareRequest; //
+
+const { status, data } = await apiInstance.updateSharedDocuments(
+    shareRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **shareRequest** | **ShareRequest**|  | |
+
+
+### Return type
+
+**ShareResultResponse**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | All shares updated successfully |  -  |
+|**207** | Partial success: some shares updated, some sent as requests, some failed |  -  |
+
+[[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)
+
+# **updateTeam**
+> updateTeam(updateTeamRequest)
+
+Updates team name and email. Requires ADMIN_USERS role.
+
+### Example
+
+```typescript
+import {
+    CollaborationControllerApi,
+    Configuration,
+    UpdateTeamRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new CollaborationControllerApi(configuration);
+
+let teamId: string; // (default to undefined)
+let updateTeamRequest: UpdateTeamRequest; //
+
+const { status, data } = await apiInstance.updateTeam(
+    teamId,
+    updateTeamRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateTeamRequest** | **UpdateTeamRequest**|  | |
+| **teamId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+
+### 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)
+
+# **updateUser**
+> updateUser(updateUserRequest)
+
+Updates user name, email and/or status. Requires ADMIN_USERS role. Status changes also require ASSIGN_LICENSES.
+
+### Example
+
+```typescript
+import {
+    CollaborationControllerApi,
+    Configuration,
+    UpdateUserRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new CollaborationControllerApi(configuration);
+
+let userId: string; // (default to undefined)
+let updateUserRequest: UpdateUserRequest; //
+
+const { status, data } = await apiInstance.updateUser(
+    userId,
+    updateUserRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateUserRequest** | **UpdateUserRequest**|  | |
+| **userId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+
+### 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)
+