@openfilz-sdk/typescript-ee 1.14.4 → 1.14.5

package/docs/TeamsApi.md

@@ -0,0 +1,724 @@
+# TeamsApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**acceptTeamInvitation**](#acceptteaminvitation) | **POST** /api/v1/users/me/team-invitations/{invitationId}/accept | Join the team|
+|[**addTeamOwner**](#addteamowner) | **POST** /api/v1/teams/{teamId}/owners | Make a licensed member a co-owner of a collaborative team|
+|[**cancelTeamInvitation**](#cancelteaminvitation) | **DELETE** /api/v1/teams/{teamId}/invitations/{invitationId} | Cancel a pending invitation|
+|[**createCollaborativeTeam**](#createcollaborativeteam) | **POST** /api/v1/teams | Create a collaborative team (I become its owner)|
+|[**declineTeamInvitation**](#declineteaminvitation) | **POST** /api/v1/users/me/team-invitations/{invitationId}/decline | Decline the invitation|
+|[**deleteCollaborativeTeam**](#deletecollaborativeteam) | **DELETE** /api/v1/teams/{teamId} | Delete a team (owner of a collaborative team, or administrator)|
+|[**inviteToTeam**](#invitetoteam) | **POST** /api/v1/teams/{teamId}/invitations | Invite people by exact e-mail address|
+|[**leaveTeam**](#leaveteam) | **POST** /api/v1/users/me/teams/{teamId}/leave | Leave a collaborative team|
+|[**myTeamInvitations**](#myteaminvitations) | **GET** /api/v1/users/me/team-invitations | My pending team invitations|
+|[**myTeams**](#myteams) | **GET** /api/v1/teams/mine | The teams I belong to, with their kind and whether I own them|
+|[**removeTeamMember**](#removeteammember) | **DELETE** /api/v1/teams/{teamId}/members/{userId} | Remove a member (the last owner cannot be removed)|
+|[**renameTeam**](#renameteam) | **PUT** /api/v1/teams/{teamId} | Rename a team (owner of a collaborative team, or administrator)|
+|[**teamCapabilities**](#teamcapabilities) | **GET** /api/v1/teams/capabilities | May I create teams, and how many do I own|
+|[**teamDetails**](#teamdetails) | **GET** /api/v1/teams/{teamId} | Members, owners and (for its managers) pending invitations of a team|
+
+# **acceptTeamInvitation**
+> acceptTeamInvitation()
+
+410 when the invitation was answered, cancelled or expired; 409 when the sharing policy refuses the membership.
+
+### Example
+
+```typescript
+import {
+    TeamsApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new TeamsApi(configuration);
+
+let invitationId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.acceptTeamInvitation(
+    invitationId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **invitationId** | [**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)
+
+# **addTeamOwner**
+> addTeamOwner(addTeamOwnerRequest)
+
+
+### Example
+
+```typescript
+import {
+    TeamsApi,
+    Configuration,
+    AddTeamOwnerRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new TeamsApi(configuration);
+
+let teamId: string; // (default to undefined)
+let addTeamOwnerRequest: AddTeamOwnerRequest; //
+
+const { status, data } = await apiInstance.addTeamOwner(
+    teamId,
+    addTeamOwnerRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **addTeamOwnerRequest** | **AddTeamOwnerRequest**|  | |
+| **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)
+
+# **cancelTeamInvitation**
+> cancelTeamInvitation()
+
+
+### Example
+
+```typescript
+import {
+    TeamsApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new TeamsApi(configuration);
+
+let teamId: string; // (default to undefined)
+let invitationId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.cancelTeamInvitation(
+    teamId,
+    invitationId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **teamId** | [**string**] |  | defaults to undefined|
+| **invitationId** | [**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)
+
+# **createCollaborativeTeam**
+> TeamDetails createCollaborativeTeam(createCollaborativeTeamRequest)
+
+404 unless openfilz.teams.user-managed is on; LICENSED contributors only; 409 when the name is taken or the caller already owns openfilz.teams.max-owned-per-user teams.
+
+### Example
+
+```typescript
+import {
+    TeamsApi,
+    Configuration,
+    CreateCollaborativeTeamRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new TeamsApi(configuration);
+
+let createCollaborativeTeamRequest: CreateCollaborativeTeamRequest; //
+
+const { status, data } = await apiInstance.createCollaborativeTeam(
+    createCollaborativeTeamRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createCollaborativeTeamRequest** | **CreateCollaborativeTeamRequest**|  | |
+
+
+### Return type
+
+**TeamDetails**
+
+### 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)
+
+# **declineTeamInvitation**
+> declineTeamInvitation()
+
+
+### Example
+
+```typescript
+import {
+    TeamsApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new TeamsApi(configuration);
+
+let invitationId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.declineTeamInvitation(
+    invitationId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **invitationId** | [**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)
+
+# **deleteCollaborativeTeam**
+> deleteCollaborativeTeam()
+
+
+### Example
+
+```typescript
+import {
+    TeamsApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new TeamsApi(configuration);
+
+let teamId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.deleteCollaborativeTeam(
+    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)
+
+# **inviteToTeam**
+> Array<TeamInviteResult> inviteToTeam(inviteToTeamRequest)
+
+One outcome per address: INVITED, ALREADY_MEMBER, ALREADY_INVITED, NOT_FOUND, BLOCKED_BY_POLICY. Membership starts when the invitee accepts. At most 50 addresses per call.
+
+### Example
+
+```typescript
+import {
+    TeamsApi,
+    Configuration,
+    InviteToTeamRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new TeamsApi(configuration);
+
+let teamId: string; // (default to undefined)
+let inviteToTeamRequest: InviteToTeamRequest; //
+
+const { status, data } = await apiInstance.inviteToTeam(
+    teamId,
+    inviteToTeamRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **inviteToTeamRequest** | **InviteToTeamRequest**|  | |
+| **teamId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**Array<TeamInviteResult>**
+
+### 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)
+
+# **leaveTeam**
+> leaveTeam()
+
+403 for an organisation team (an administrator removes members); 409 for its last owner.
+
+### Example
+
+```typescript
+import {
+    TeamsApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new TeamsApi(configuration);
+
+let teamId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.leaveTeam(
+    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)
+
+# **myTeamInvitations**
+> Array<TeamInvitationView> myTeamInvitations()
+
+
+### Example
+
+```typescript
+import {
+    TeamsApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new TeamsApi(configuration);
+
+const { status, data } = await apiInstance.myTeamInvitations();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<TeamInvitationView>**
+
+### 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)
+
+# **myTeams**
+> Array<MyTeam> myTeams()
+
+
+### Example
+
+```typescript
+import {
+    TeamsApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new TeamsApi(configuration);
+
+const { status, data } = await apiInstance.myTeams();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<MyTeam>**
+
+### 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)
+
+# **removeTeamMember**
+> removeTeamMember()
+
+
+### Example
+
+```typescript
+import {
+    TeamsApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new TeamsApi(configuration);
+
+let teamId: string; // (default to undefined)
+let userId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.removeTeamMember(
+    teamId,
+    userId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **teamId** | [**string**] |  | defaults to undefined|
+| **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)
+
+# **renameTeam**
+> renameTeam(renameTeamRequest)
+
+
+### Example
+
+```typescript
+import {
+    TeamsApi,
+    Configuration,
+    RenameTeamRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new TeamsApi(configuration);
+
+let teamId: string; // (default to undefined)
+let renameTeamRequest: RenameTeamRequest; //
+
+const { status, data } = await apiInstance.renameTeam(
+    teamId,
+    renameTeamRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **renameTeamRequest** | **RenameTeamRequest**|  | |
+| **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)
+
+# **teamCapabilities**
+> TeamCapabilities teamCapabilities()
+
+
+### Example
+
+```typescript
+import {
+    TeamsApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new TeamsApi(configuration);
+
+const { status, data } = await apiInstance.teamCapabilities();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**TeamCapabilities**
+
+### 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)
+
+# **teamDetails**
+> TeamDetails teamDetails()
+
+LICENSED members and administrators. 403 for a FREE caller (who never gets other users), 404 for anyone else.
+
+### Example
+
+```typescript
+import {
+    TeamsApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new TeamsApi(configuration);
+
+let teamId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.teamDetails(
+    teamId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **teamId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**TeamDetails**
+
+### 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)
+