@openfilz-sdk/typescript-ee 1.12.0 → 1.12.1

package/dist/api/quota-administration-api.d.ts

@@ -0,0 +1,312 @@
+/**
+ * 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 { QuotaOverview } from '../models';
+import type { QuotaUsage } from '../models';
+import type { QuotaUserPage } from '../models';
+import type { TeamQuotaRequest } from '../models';
+import type { TeamQuotaView } from '../models';
+import type { UserQuotaRequest } from '../models';
+/**
+ * QuotaAdministrationApi - axios parameter creator
+ */
+export declare const QuotaAdministrationApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Its members fall back to their other teams or the default.
+     * @summary Remove a team\'s limit
+     * @param {string} teamId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    clear: (teamId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * The group or default limit applies again.
+     * @summary Remove one user\'s own limit
+     * @param {string} username
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    clearUserQuota: (username: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Get one user\'s storage
+     * @param {string} username
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUser: (username: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary List teams with their per-member limit and their members\' usage
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    list5: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Every user storage is charged to, with usage, effective limit and its source. Sort by usage (default), percent, limit or name.
+     * @summary List users\' storage
+     * @param {string} [search] Case-insensitive filter on the user name
+     * @param {string} [sort] usage | percent | limit | name
+     * @param {string} [order] asc | desc
+     * @param {number} [page]
+     * @param {number} [size]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listUsers: (search?: string, sort?: string, order?: string, page?: number, size?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Deployment-wide limits (MB, 0 = no limit), instance usage and the number of user overrides.
+     * @summary Quota overview
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    overview: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * quotaMb > 0 = limit per member, 0 = members exempt.
+     * @summary Set a team\'s per-member limit
+     * @param {string} teamId
+     * @param {TeamQuotaRequest} teamQuotaRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    set: (teamId: string, teamQuotaRequest: TeamQuotaRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * quotaMb > 0 = this user\'s limit, 0 = no limit for this user. Takes precedence over group and default limits.
+     * @summary Set one user\'s own limit
+     * @param {string} username
+     * @param {UserQuotaRequest} userQuotaRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    setUserQuota: (username: string, userQuotaRequest: UserQuotaRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * QuotaAdministrationApi - functional programming interface
+ */
+export declare const QuotaAdministrationApiFp: (configuration?: Configuration) => {
+    /**
+     * Its members fall back to their other teams or the default.
+     * @summary Remove a team\'s limit
+     * @param {string} teamId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    clear(teamId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TeamQuotaView>>;
+    /**
+     * The group or default limit applies again.
+     * @summary Remove one user\'s own limit
+     * @param {string} username
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    clearUserQuota(username: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuotaUsage>>;
+    /**
+     *
+     * @summary Get one user\'s storage
+     * @param {string} username
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUser(username: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuotaUsage>>;
+    /**
+     *
+     * @summary List teams with their per-member limit and their members\' usage
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    list5(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TeamQuotaView>>>;
+    /**
+     * Every user storage is charged to, with usage, effective limit and its source. Sort by usage (default), percent, limit or name.
+     * @summary List users\' storage
+     * @param {string} [search] Case-insensitive filter on the user name
+     * @param {string} [sort] usage | percent | limit | name
+     * @param {string} [order] asc | desc
+     * @param {number} [page]
+     * @param {number} [size]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listUsers(search?: string, sort?: string, order?: string, page?: number, size?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuotaUserPage>>;
+    /**
+     * Deployment-wide limits (MB, 0 = no limit), instance usage and the number of user overrides.
+     * @summary Quota overview
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    overview(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuotaOverview>>;
+    /**
+     * quotaMb > 0 = limit per member, 0 = members exempt.
+     * @summary Set a team\'s per-member limit
+     * @param {string} teamId
+     * @param {TeamQuotaRequest} teamQuotaRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    set(teamId: string, teamQuotaRequest: TeamQuotaRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TeamQuotaView>>;
+    /**
+     * quotaMb > 0 = this user\'s limit, 0 = no limit for this user. Takes precedence over group and default limits.
+     * @summary Set one user\'s own limit
+     * @param {string} username
+     * @param {UserQuotaRequest} userQuotaRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    setUserQuota(username: string, userQuotaRequest: UserQuotaRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuotaUsage>>;
+};
+/**
+ * QuotaAdministrationApi - factory interface
+ */
+export declare const QuotaAdministrationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Its members fall back to their other teams or the default.
+     * @summary Remove a team\'s limit
+     * @param {string} teamId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    clear(teamId: string, options?: RawAxiosRequestConfig): AxiosPromise<TeamQuotaView>;
+    /**
+     * The group or default limit applies again.
+     * @summary Remove one user\'s own limit
+     * @param {string} username
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    clearUserQuota(username: string, options?: RawAxiosRequestConfig): AxiosPromise<QuotaUsage>;
+    /**
+     *
+     * @summary Get one user\'s storage
+     * @param {string} username
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUser(username: string, options?: RawAxiosRequestConfig): AxiosPromise<QuotaUsage>;
+    /**
+     *
+     * @summary List teams with their per-member limit and their members\' usage
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    list5(options?: RawAxiosRequestConfig): AxiosPromise<Array<TeamQuotaView>>;
+    /**
+     * Every user storage is charged to, with usage, effective limit and its source. Sort by usage (default), percent, limit or name.
+     * @summary List users\' storage
+     * @param {string} [search] Case-insensitive filter on the user name
+     * @param {string} [sort] usage | percent | limit | name
+     * @param {string} [order] asc | desc
+     * @param {number} [page]
+     * @param {number} [size]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listUsers(search?: string, sort?: string, order?: string, page?: number, size?: number, options?: RawAxiosRequestConfig): AxiosPromise<QuotaUserPage>;
+    /**
+     * Deployment-wide limits (MB, 0 = no limit), instance usage and the number of user overrides.
+     * @summary Quota overview
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    overview(options?: RawAxiosRequestConfig): AxiosPromise<QuotaOverview>;
+    /**
+     * quotaMb > 0 = limit per member, 0 = members exempt.
+     * @summary Set a team\'s per-member limit
+     * @param {string} teamId
+     * @param {TeamQuotaRequest} teamQuotaRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    set(teamId: string, teamQuotaRequest: TeamQuotaRequest, options?: RawAxiosRequestConfig): AxiosPromise<TeamQuotaView>;
+    /**
+     * quotaMb > 0 = this user\'s limit, 0 = no limit for this user. Takes precedence over group and default limits.
+     * @summary Set one user\'s own limit
+     * @param {string} username
+     * @param {UserQuotaRequest} userQuotaRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    setUserQuota(username: string, userQuotaRequest: UserQuotaRequest, options?: RawAxiosRequestConfig): AxiosPromise<QuotaUsage>;
+};
+/**
+ * QuotaAdministrationApi - object-oriented interface
+ */
+export declare class QuotaAdministrationApi extends BaseAPI {
+    /**
+     * Its members fall back to their other teams or the default.
+     * @summary Remove a team\'s limit
+     * @param {string} teamId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    clear(teamId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TeamQuotaView, any, {}, any>>;
+    /**
+     * The group or default limit applies again.
+     * @summary Remove one user\'s own limit
+     * @param {string} username
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    clearUserQuota(username: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QuotaUsage, any, {}, any>>;
+    /**
+     *
+     * @summary Get one user\'s storage
+     * @param {string} username
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUser(username: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QuotaUsage, any, {}, any>>;
+    /**
+     *
+     * @summary List teams with their per-member limit and their members\' usage
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    list5(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TeamQuotaView[], any, {}, any>>;
+    /**
+     * Every user storage is charged to, with usage, effective limit and its source. Sort by usage (default), percent, limit or name.
+     * @summary List users\' storage
+     * @param {string} [search] Case-insensitive filter on the user name
+     * @param {string} [sort] usage | percent | limit | name
+     * @param {string} [order] asc | desc
+     * @param {number} [page]
+     * @param {number} [size]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listUsers(search?: string, sort?: string, order?: string, page?: number, size?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QuotaUserPage, any, {}, any>>;
+    /**
+     * Deployment-wide limits (MB, 0 = no limit), instance usage and the number of user overrides.
+     * @summary Quota overview
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    overview(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QuotaOverview, any, {}, any>>;
+    /**
+     * quotaMb > 0 = limit per member, 0 = members exempt.
+     * @summary Set a team\'s per-member limit
+     * @param {string} teamId
+     * @param {TeamQuotaRequest} teamQuotaRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    set(teamId: string, teamQuotaRequest: TeamQuotaRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TeamQuotaView, any, {}, any>>;
+    /**
+     * quotaMb > 0 = this user\'s limit, 0 = no limit for this user. Takes precedence over group and default limits.
+     * @summary Set one user\'s own limit
+     * @param {string} username
+     * @param {UserQuotaRequest} userQuotaRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    setUserQuota(username: string, userQuotaRequest: UserQuotaRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QuotaUsage, any, {}, any>>;
+}