@openfilz-sdk/typescript-ee 1.14.4 → 1.14.5

package/api/team-administration-api.ts

@@ -21,13 +21,15 @@ import globalAxios from 'axios';
 import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction, replaceWithSerializableTypeIfNeeded } from '../common';
 // @ts-ignore
 import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
+// @ts-ignore
+import type { TeamKindView } from '../models';
 /**
  * TeamAdministrationApi - axios parameter creator
  */
 export const TeamAdministrationApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
         /**
-         * 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).
          * @summary Add members to a team
          * @param {string} teamId 
          * @param {Array<string>} requestBody 
@@ -63,6 +65,119 @@ export const TeamAdministrationApiAxiosParamCreator = function (configuration?:
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
             localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration)
 
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Its owners are dropped and its pending invitations cancelled; administrators manage it from then on.
+         * @summary Turn a collaborative team into an organisation team
+         * @param {string} teamId 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        adminPromoteTeam: async (teamId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'teamId' is not null or undefined
+            assertParamExists('adminPromoteTeam', 'teamId', teamId)
+            const localVarPath = `/api/v1/admin/teams/{teamId}/promote`
+                .replace('{teamId}', encodeURIComponent(String(teamId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Each removed member is told (notification) and loses any ownership of the team.
+         * @summary Remove members from a team
+         * @param {string} teamId 
+         * @param {Array<string>} requestBody 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        adminRemoveTeamMembers: async (teamId: string, requestBody: Array<string>, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'teamId' is not null or undefined
+            assertParamExists('adminRemoveTeamMembers', 'teamId', teamId)
+            // verify required parameter 'requestBody' is not null or undefined
+            assertParamExists('adminRemoveTeamMembers', 'requestBody', requestBody)
+            const localVarPath = `/api/v1/admin/teams/{teamId}/members`
+                .replace('{teamId}', encodeURIComponent(String(teamId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * ORGANISATION (managed by administrators) or COLLABORATIVE (created by a contributor, owned). A collaborative team with no owner left needs an administrator.
+         * @summary Kind and owners of every team
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        adminTeamKinds: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/api/v1/admin/teams/kinds`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            localVarHeaderParameter['Accept'] = '*/*';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
             return {
                 url: toPathString(localVarUrlObj),
                 options: localVarRequestOptions,
@@ -78,7 +193,7 @@ export const TeamAdministrationApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = TeamAdministrationApiAxiosParamCreator(configuration)
     return {
         /**
-         * 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).
          * @summary Add members to a team
          * @param {string} teamId 
          * @param {Array<string>} requestBody 
@@ -91,6 +206,45 @@ export const TeamAdministrationApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['TeamAdministrationApi.adminAddTeamMembers']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Its owners are dropped and its pending invitations cancelled; administrators manage it from then on.
+         * @summary Turn a collaborative team into an organisation team
+         * @param {string} teamId 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async adminPromoteTeam(teamId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.adminPromoteTeam(teamId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['TeamAdministrationApi.adminPromoteTeam']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Each removed member is told (notification) and loses any ownership of the team.
+         * @summary Remove members from a team
+         * @param {string} teamId 
+         * @param {Array<string>} requestBody 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async adminRemoveTeamMembers(teamId: string, requestBody: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.adminRemoveTeamMembers(teamId, requestBody, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['TeamAdministrationApi.adminRemoveTeamMembers']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * ORGANISATION (managed by administrators) or COLLABORATIVE (created by a contributor, owned). A collaborative team with no owner left needs an administrator.
+         * @summary Kind and owners of every team
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async adminTeamKinds(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TeamKindView>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.adminTeamKinds(options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['TeamAdministrationApi.adminTeamKinds']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
     }
 };
 
@@ -101,7 +255,7 @@ export const TeamAdministrationApiFactory = function (configuration?: Configurat
     const localVarFp = TeamAdministrationApiFp(configuration)
     return {
         /**
-         * 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).
          * @summary Add members to a team
          * @param {string} teamId 
          * @param {Array<string>} requestBody 
@@ -111,6 +265,36 @@ export const TeamAdministrationApiFactory = function (configuration?: Configurat
         adminAddTeamMembers(teamId: string, requestBody: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<void> {
             return localVarFp.adminAddTeamMembers(teamId, requestBody, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Its owners are dropped and its pending invitations cancelled; administrators manage it from then on.
+         * @summary Turn a collaborative team into an organisation team
+         * @param {string} teamId 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        adminPromoteTeam(teamId: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
+            return localVarFp.adminPromoteTeam(teamId, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Each removed member is told (notification) and loses any ownership of the team.
+         * @summary Remove members from a team
+         * @param {string} teamId 
+         * @param {Array<string>} requestBody 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        adminRemoveTeamMembers(teamId: string, requestBody: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<void> {
+            return localVarFp.adminRemoveTeamMembers(teamId, requestBody, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * ORGANISATION (managed by administrators) or COLLABORATIVE (created by a contributor, owned). A collaborative team with no owner left needs an administrator.
+         * @summary Kind and owners of every team
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        adminTeamKinds(options?: RawAxiosRequestConfig): AxiosPromise<Array<TeamKindView>> {
+            return localVarFp.adminTeamKinds(options).then((request) => request(axios, basePath));
+        },
     };
 };
 
@@ -119,7 +303,7 @@ export const TeamAdministrationApiFactory = function (configuration?: Configurat
  */
 export class TeamAdministrationApi extends BaseAPI {
     /**
-     * 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).
      * @summary Add members to a team
      * @param {string} teamId 
      * @param {Array<string>} requestBody 
@@ -129,5 +313,38 @@ export class TeamAdministrationApi extends BaseAPI {
     public adminAddTeamMembers(teamId: string, requestBody: Array<string>, options?: RawAxiosRequestConfig) {
         return TeamAdministrationApiFp(this.configuration).adminAddTeamMembers(teamId, requestBody, options).then((request) => request(this.axios, this.basePath));
     }
+
+    /**
+     * Its owners are dropped and its pending invitations cancelled; administrators manage it from then on.
+     * @summary Turn a collaborative team into an organisation team
+     * @param {string} teamId 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public adminPromoteTeam(teamId: string, options?: RawAxiosRequestConfig) {
+        return TeamAdministrationApiFp(this.configuration).adminPromoteTeam(teamId, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Each removed member is told (notification) and loses any ownership of the team.
+     * @summary Remove members from a team
+     * @param {string} teamId 
+     * @param {Array<string>} requestBody 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public adminRemoveTeamMembers(teamId: string, requestBody: Array<string>, options?: RawAxiosRequestConfig) {
+        return TeamAdministrationApiFp(this.configuration).adminRemoveTeamMembers(teamId, requestBody, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * ORGANISATION (managed by administrators) or COLLABORATIVE (created by a contributor, owned). A collaborative team with no owner left needs an administrator.
+     * @summary Kind and owners of every team
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public adminTeamKinds(options?: RawAxiosRequestConfig) {
+        return TeamAdministrationApiFp(this.configuration).adminTeamKinds(options).then((request) => request(this.axios, this.basePath));
+    }
 }