@openfilz-sdk/typescript-ee 1.14.4 → 1.14.5

package/dist/esm/api/teams-api.d.ts

@@ -0,0 +1,499 @@
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import { type RequestArgs, BaseAPI } from '../base';
+import type { AddTeamOwnerRequest } from '../models';
+import type { CreateCollaborativeTeamRequest } from '../models';
+import type { InviteToTeamRequest } from '../models';
+import type { MyTeam } from '../models';
+import type { RenameTeamRequest } from '../models';
+import type { TeamCapabilities } from '../models';
+import type { TeamDetails } from '../models';
+import type { TeamInvitationView } from '../models';
+import type { TeamInviteResult } from '../models';
+/**
+ * TeamsApi - axios parameter creator
+ */
+export declare const TeamsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * 410 when the invitation was answered, cancelled or expired; 409 when the sharing policy refuses the membership.
+     * @summary Join the team
+     * @param {string} invitationId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    acceptTeamInvitation: (invitationId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Make a licensed member a co-owner of a collaborative team
+     * @param {string} teamId
+     * @param {AddTeamOwnerRequest} addTeamOwnerRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    addTeamOwner: (teamId: string, addTeamOwnerRequest: AddTeamOwnerRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Cancel a pending invitation
+     * @param {string} teamId
+     * @param {string} invitationId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    cancelTeamInvitation: (teamId: string, invitationId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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.
+     * @summary Create a collaborative team (I become its owner)
+     * @param {CreateCollaborativeTeamRequest} createCollaborativeTeamRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createCollaborativeTeam: (createCollaborativeTeamRequest: CreateCollaborativeTeamRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Decline the invitation
+     * @param {string} invitationId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    declineTeamInvitation: (invitationId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Delete a team (owner of a collaborative team, or administrator)
+     * @param {string} teamId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteCollaborativeTeam: (teamId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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.
+     * @summary Invite people by exact e-mail address
+     * @param {string} teamId
+     * @param {InviteToTeamRequest} inviteToTeamRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    inviteToTeam: (teamId: string, inviteToTeamRequest: InviteToTeamRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 403 for an organisation team (an administrator removes members); 409 for its last owner.
+     * @summary Leave a collaborative team
+     * @param {string} teamId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    leaveTeam: (teamId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary My pending team invitations
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    myTeamInvitations: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary The teams I belong to, with their kind and whether I own them
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    myTeams: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Remove a member (the last owner cannot be removed)
+     * @param {string} teamId
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    removeTeamMember: (teamId: string, userId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Rename a team (owner of a collaborative team, or administrator)
+     * @param {string} teamId
+     * @param {RenameTeamRequest} renameTeamRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    renameTeam: (teamId: string, renameTeamRequest: RenameTeamRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary May I create teams, and how many do I own
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    teamCapabilities: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * LICENSED members and administrators. 403 for a FREE caller (who never gets other users), 404 for anyone else.
+     * @summary Members, owners and (for its managers) pending invitations of a team
+     * @param {string} teamId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    teamDetails: (teamId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * TeamsApi - functional programming interface
+ */
+export declare const TeamsApiFp: (configuration?: Configuration) => {
+    /**
+     * 410 when the invitation was answered, cancelled or expired; 409 when the sharing policy refuses the membership.
+     * @summary Join the team
+     * @param {string} invitationId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    acceptTeamInvitation(invitationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary Make a licensed member a co-owner of a collaborative team
+     * @param {string} teamId
+     * @param {AddTeamOwnerRequest} addTeamOwnerRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    addTeamOwner(teamId: string, addTeamOwnerRequest: AddTeamOwnerRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary Cancel a pending invitation
+     * @param {string} teamId
+     * @param {string} invitationId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    cancelTeamInvitation(teamId: string, invitationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * 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.
+     * @summary Create a collaborative team (I become its owner)
+     * @param {CreateCollaborativeTeamRequest} createCollaborativeTeamRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createCollaborativeTeam(createCollaborativeTeamRequest: CreateCollaborativeTeamRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TeamDetails>>;
+    /**
+     *
+     * @summary Decline the invitation
+     * @param {string} invitationId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    declineTeamInvitation(invitationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary Delete a team (owner of a collaborative team, or administrator)
+     * @param {string} teamId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteCollaborativeTeam(teamId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * 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.
+     * @summary Invite people by exact e-mail address
+     * @param {string} teamId
+     * @param {InviteToTeamRequest} inviteToTeamRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    inviteToTeam(teamId: string, inviteToTeamRequest: InviteToTeamRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TeamInviteResult>>>;
+    /**
+     * 403 for an organisation team (an administrator removes members); 409 for its last owner.
+     * @summary Leave a collaborative team
+     * @param {string} teamId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    leaveTeam(teamId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary My pending team invitations
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    myTeamInvitations(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TeamInvitationView>>>;
+    /**
+     *
+     * @summary The teams I belong to, with their kind and whether I own them
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    myTeams(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MyTeam>>>;
+    /**
+     *
+     * @summary Remove a member (the last owner cannot be removed)
+     * @param {string} teamId
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    removeTeamMember(teamId: string, userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary Rename a team (owner of a collaborative team, or administrator)
+     * @param {string} teamId
+     * @param {RenameTeamRequest} renameTeamRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    renameTeam(teamId: string, renameTeamRequest: RenameTeamRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary May I create teams, and how many do I own
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    teamCapabilities(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TeamCapabilities>>;
+    /**
+     * LICENSED members and administrators. 403 for a FREE caller (who never gets other users), 404 for anyone else.
+     * @summary Members, owners and (for its managers) pending invitations of a team
+     * @param {string} teamId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    teamDetails(teamId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TeamDetails>>;
+};
+/**
+ * TeamsApi - factory interface
+ */
+export declare const TeamsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * 410 when the invitation was answered, cancelled or expired; 409 when the sharing policy refuses the membership.
+     * @summary Join the team
+     * @param {string} invitationId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    acceptTeamInvitation(invitationId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary Make a licensed member a co-owner of a collaborative team
+     * @param {string} teamId
+     * @param {AddTeamOwnerRequest} addTeamOwnerRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    addTeamOwner(teamId: string, addTeamOwnerRequest: AddTeamOwnerRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary Cancel a pending invitation
+     * @param {string} teamId
+     * @param {string} invitationId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    cancelTeamInvitation(teamId: string, invitationId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * 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.
+     * @summary Create a collaborative team (I become its owner)
+     * @param {CreateCollaborativeTeamRequest} createCollaborativeTeamRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createCollaborativeTeam(createCollaborativeTeamRequest: CreateCollaborativeTeamRequest, options?: RawAxiosRequestConfig): AxiosPromise<TeamDetails>;
+    /**
+     *
+     * @summary Decline the invitation
+     * @param {string} invitationId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    declineTeamInvitation(invitationId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary Delete a team (owner of a collaborative team, or administrator)
+     * @param {string} teamId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteCollaborativeTeam(teamId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * 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.
+     * @summary Invite people by exact e-mail address
+     * @param {string} teamId
+     * @param {InviteToTeamRequest} inviteToTeamRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    inviteToTeam(teamId: string, inviteToTeamRequest: InviteToTeamRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<TeamInviteResult>>;
+    /**
+     * 403 for an organisation team (an administrator removes members); 409 for its last owner.
+     * @summary Leave a collaborative team
+     * @param {string} teamId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    leaveTeam(teamId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary My pending team invitations
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    myTeamInvitations(options?: RawAxiosRequestConfig): AxiosPromise<Array<TeamInvitationView>>;
+    /**
+     *
+     * @summary The teams I belong to, with their kind and whether I own them
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    myTeams(options?: RawAxiosRequestConfig): AxiosPromise<Array<MyTeam>>;
+    /**
+     *
+     * @summary Remove a member (the last owner cannot be removed)
+     * @param {string} teamId
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    removeTeamMember(teamId: string, userId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary Rename a team (owner of a collaborative team, or administrator)
+     * @param {string} teamId
+     * @param {RenameTeamRequest} renameTeamRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    renameTeam(teamId: string, renameTeamRequest: RenameTeamRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary May I create teams, and how many do I own
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    teamCapabilities(options?: RawAxiosRequestConfig): AxiosPromise<TeamCapabilities>;
+    /**
+     * LICENSED members and administrators. 403 for a FREE caller (who never gets other users), 404 for anyone else.
+     * @summary Members, owners and (for its managers) pending invitations of a team
+     * @param {string} teamId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    teamDetails(teamId: string, options?: RawAxiosRequestConfig): AxiosPromise<TeamDetails>;
+};
+/**
+ * TeamsApi - object-oriented interface
+ */
+export declare class TeamsApi extends BaseAPI {
+    /**
+     * 410 when the invitation was answered, cancelled or expired; 409 when the sharing policy refuses the membership.
+     * @summary Join the team
+     * @param {string} invitationId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    acceptTeamInvitation(invitationId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}, any>>;
+    /**
+     *
+     * @summary Make a licensed member a co-owner of a collaborative team
+     * @param {string} teamId
+     * @param {AddTeamOwnerRequest} addTeamOwnerRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    addTeamOwner(teamId: string, addTeamOwnerRequest: AddTeamOwnerRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}, any>>;
+    /**
+     *
+     * @summary Cancel a pending invitation
+     * @param {string} teamId
+     * @param {string} invitationId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    cancelTeamInvitation(teamId: string, invitationId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}, any>>;
+    /**
+     * 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.
+     * @summary Create a collaborative team (I become its owner)
+     * @param {CreateCollaborativeTeamRequest} createCollaborativeTeamRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createCollaborativeTeam(createCollaborativeTeamRequest: CreateCollaborativeTeamRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TeamDetails, any, {}, any>>;
+    /**
+     *
+     * @summary Decline the invitation
+     * @param {string} invitationId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    declineTeamInvitation(invitationId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}, any>>;
+    /**
+     *
+     * @summary Delete a team (owner of a collaborative team, or administrator)
+     * @param {string} teamId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteCollaborativeTeam(teamId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}, any>>;
+    /**
+     * 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.
+     * @summary Invite people by exact e-mail address
+     * @param {string} teamId
+     * @param {InviteToTeamRequest} inviteToTeamRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    inviteToTeam(teamId: string, inviteToTeamRequest: InviteToTeamRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TeamInviteResult[], any, {}, any>>;
+    /**
+     * 403 for an organisation team (an administrator removes members); 409 for its last owner.
+     * @summary Leave a collaborative team
+     * @param {string} teamId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    leaveTeam(teamId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}, any>>;
+    /**
+     *
+     * @summary My pending team invitations
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    myTeamInvitations(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TeamInvitationView[], any, {}, any>>;
+    /**
+     *
+     * @summary The teams I belong to, with their kind and whether I own them
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    myTeams(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MyTeam[], any, {}, any>>;
+    /**
+     *
+     * @summary Remove a member (the last owner cannot be removed)
+     * @param {string} teamId
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    removeTeamMember(teamId: string, userId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}, any>>;
+    /**
+     *
+     * @summary Rename a team (owner of a collaborative team, or administrator)
+     * @param {string} teamId
+     * @param {RenameTeamRequest} renameTeamRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    renameTeam(teamId: string, renameTeamRequest: RenameTeamRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}, any>>;
+    /**
+     *
+     * @summary May I create teams, and how many do I own
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    teamCapabilities(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TeamCapabilities, any, {}, any>>;
+    /**
+     * LICENSED members and administrators. 403 for a FREE caller (who never gets other users), 404 for anyone else.
+     * @summary Members, owners and (for its managers) pending invitations of a team
+     * @param {string} teamId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    teamDetails(teamId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TeamDetails, any, {}, any>>;
+}