@openfilz-sdk/typescript-ee 1.14.4 → 1.14.6

package/docs/TeamAdministrationApi.md

@@ -5,11 +5,14 @@ All URIs are relative to *http://localhost:8081*
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
 |[**adminAddTeamMembers**](#adminaddteammembers) | **POST** /api/v1/admin/teams/{teamId}/members | Add members to a team|
+|[**adminPromoteTeam**](#adminpromoteteam) | **POST** /api/v1/admin/teams/{teamId}/promote | Turn a collaborative team into an organisation team|
+|[**adminRemoveTeamMembers**](#adminremoveteammembers) | **DELETE** /api/v1/admin/teams/{teamId}/members | Remove members from a team|
+|[**adminTeamKinds**](#adminteamkinds) | **GET** /api/v1/admin/teams/kinds | Kind and owners of every team|
 
 # **adminAddTeamMembers**
 > adminAddTeamMembers(requestBody)
 
-Idempotent for existing members. 409 TEAM_MEMBER_EXTERNAL (counts of members, owners and documents) when documents shared with the team may not be shared with a new member under the sharing policy.
+Idempotent for existing members. 409 TEAM_MEMBER_EXTERNAL (counts of members, owners and documents) when documents shared with the team may not be shared with a new member under the sharing policy. New members are told (notification + e-mail); a collaborative team, or openfilz.teams.admin-add-requires-consent, turns the addition into invitations (docs/directory-visibility.md §3.7.2).
 
 ### Example
 
@@ -60,3 +63,152 @@ 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)
 
+# **adminPromoteTeam**
+> adminPromoteTeam()
+
+Its owners are dropped and its pending invitations cancelled; administrators manage it from then on.
+
+### Example
+
+```typescript
+import {
+    TeamAdministrationApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new TeamAdministrationApi(configuration);
+
+let teamId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.adminPromoteTeam(
+    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)
+
+# **adminRemoveTeamMembers**
+> adminRemoveTeamMembers(requestBody)
+
+Each removed member is told (notification) and loses any ownership of the team.
+
+### Example
+
+```typescript
+import {
+    TeamAdministrationApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new TeamAdministrationApi(configuration);
+
+let teamId: string; // (default to undefined)
+let requestBody: Array<string>; //
+
+const { status, data } = await apiInstance.adminRemoveTeamMembers(
+    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)
+
+# **adminTeamKinds**
+> Array<TeamKindView> adminTeamKinds()
+
+ORGANISATION (managed by administrators) or COLLABORATIVE (created by a contributor, owned). A collaborative team with no owner left needs an administrator.
+
+### Example
+
+```typescript
+import {
+    TeamAdministrationApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new TeamAdministrationApi(configuration);
+
+const { status, data } = await apiInstance.adminTeamKinds();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<TeamKindView>**
+
+### 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/TeamCapabilities.md

@@ -0,0 +1,28 @@
+# TeamCapabilities
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**userManaged** | **boolean** |  | [optional] [default to undefined]
+**canCreate** | **boolean** |  | [optional] [default to undefined]
+**maxOwned** | **number** |  | [optional] [default to undefined]
+**owned** | **number** |  | [optional] [default to undefined]
+**invitationExpiryDays** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TeamCapabilities } from '@openfilz-sdk/typescript-ee';
+
+const instance: TeamCapabilities = {
+    userManaged,
+    canCreate,
+    maxOwned,
+    owned,
+    invitationExpiryDays,
+};
+```
+
+[[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/TeamDetails.md

@@ -0,0 +1,34 @@
+# TeamDetails
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**kind** | **string** |  | [optional] [default to undefined]
+**owner** | **boolean** |  | [optional] [default to undefined]
+**canManage** | **boolean** |  | [optional] [default to undefined]
+**owners** | [**Array<TeamPerson>**](TeamPerson.md) |  | [optional] [default to undefined]
+**members** | [**Array<TeamPerson>**](TeamPerson.md) |  | [optional] [default to undefined]
+**pendingInvitations** | [**Array<TeamPendingInvitee>**](TeamPendingInvitee.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TeamDetails } from '@openfilz-sdk/typescript-ee';
+
+const instance: TeamDetails = {
+    id,
+    name,
+    kind,
+    owner,
+    canManage,
+    owners,
+    members,
+    pendingInvitations,
+};
+```
+
+[[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/TeamInvitationView.md

@@ -0,0 +1,32 @@
+# TeamInvitationView
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**teamId** | **string** |  | [optional] [default to undefined]
+**teamName** | **string** |  | [optional] [default to undefined]
+**invitedByName** | **string** |  | [optional] [default to undefined]
+**invitedByEmail** | **string** |  | [optional] [default to undefined]
+**createdAt** | **string** |  | [optional] [default to undefined]
+**expiresAt** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TeamInvitationView } from '@openfilz-sdk/typescript-ee';
+
+const instance: TeamInvitationView = {
+    id,
+    teamId,
+    teamName,
+    invitedByName,
+    invitedByEmail,
+    createdAt,
+    expiresAt,
+};
+```
+
+[[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/TeamInviteResult.md

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

@@ -0,0 +1,26 @@
+# TeamKindView
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**teamId** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**kind** | **string** |  | [optional] [default to undefined]
+**owners** | [**Array<TeamOwnerView>**](TeamOwnerView.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TeamKindView } from '@openfilz-sdk/typescript-ee';
+
+const instance: TeamKindView = {
+    teamId,
+    name,
+    kind,
+    owners,
+};
+```
+
+[[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/TeamOwnerView.md

@@ -0,0 +1,24 @@
+# TeamOwnerView
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**email** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TeamOwnerView } from '@openfilz-sdk/typescript-ee';
+
+const instance: TeamOwnerView = {
+    id,
+    email,
+    name,
+};
+```
+
+[[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/TeamPendingInvitee.md

@@ -0,0 +1,30 @@
+# TeamPendingInvitee
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**userId** | **string** |  | [optional] [default to undefined]
+**email** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**createdAt** | **string** |  | [optional] [default to undefined]
+**expiresAt** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TeamPendingInvitee } from '@openfilz-sdk/typescript-ee';
+
+const instance: TeamPendingInvitee = {
+    id,
+    userId,
+    email,
+    name,
+    createdAt,
+    expiresAt,
+};
+```
+
+[[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/TeamPerson.md

@@ -0,0 +1,26 @@
+# TeamPerson
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**email** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**status** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TeamPerson } from '@openfilz-sdk/typescript-ee';
+
+const instance: TeamPerson = {
+    id,
+    email,
+    name,
+    status,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)