@openfilz-sdk/typescript-ee 1.9.11 → 1.10.1

package/dist/esm/api/ai-archiving-admin-controller-api.d.ts

@@ -0,0 +1,262 @@
+/**
+ * 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 { ArchivingProposalRequest } from '../models';
+import type { ArchivingProposalResult } from '../models';
+import type { ArchivingScheduleRequest } from '../models';
+import type { ArchivingScheduleView } from '../models';
+/**
+ * AiArchivingAdminControllerApi - axios parameter creator
+ */
+export declare const AiArchivingAdminControllerApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Create an archiving schedule
+     * @param {ArchivingScheduleRequest} archivingScheduleRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    create4: (archivingScheduleRequest: ArchivingScheduleRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Delete an archiving schedule
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    delete3: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Get an archiving schedule
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    get7: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Selects the active documents under the root untouched for N months (legal hold excluded, capped) and creates a PROPOSED reorganisation plan as ownerEmail. Nothing is moved.
+     * @summary Propose an archiving plan now (admin only)
+     * @param {ArchivingProposalRequest} archivingProposalRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    propose: (archivingProposalRequest: ArchivingProposalRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Produces one PROPOSED plan for the schedule\'s owner and records the outcome on the schedule.
+     * @summary Run an archiving schedule now
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    run1: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary List archiving schedules
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    schedules: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Update an archiving schedule
+     * @param {string} id
+     * @param {ArchivingScheduleRequest} archivingScheduleRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    update4: (id: string, archivingScheduleRequest: ArchivingScheduleRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * AiArchivingAdminControllerApi - functional programming interface
+ */
+export declare const AiArchivingAdminControllerApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Create an archiving schedule
+     * @param {ArchivingScheduleRequest} archivingScheduleRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    create4(archivingScheduleRequest: ArchivingScheduleRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ArchivingScheduleView>>;
+    /**
+     *
+     * @summary Delete an archiving schedule
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    delete3(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary Get an archiving schedule
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    get7(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ArchivingScheduleView>>;
+    /**
+     * Selects the active documents under the root untouched for N months (legal hold excluded, capped) and creates a PROPOSED reorganisation plan as ownerEmail. Nothing is moved.
+     * @summary Propose an archiving plan now (admin only)
+     * @param {ArchivingProposalRequest} archivingProposalRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    propose(archivingProposalRequest: ArchivingProposalRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ArchivingProposalResult>>;
+    /**
+     * Produces one PROPOSED plan for the schedule\'s owner and records the outcome on the schedule.
+     * @summary Run an archiving schedule now
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    run1(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ArchivingProposalResult>>;
+    /**
+     *
+     * @summary List archiving schedules
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    schedules(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ArchivingScheduleView>>>;
+    /**
+     *
+     * @summary Update an archiving schedule
+     * @param {string} id
+     * @param {ArchivingScheduleRequest} archivingScheduleRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    update4(id: string, archivingScheduleRequest: ArchivingScheduleRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ArchivingScheduleView>>;
+};
+/**
+ * AiArchivingAdminControllerApi - factory interface
+ */
+export declare const AiArchivingAdminControllerApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Create an archiving schedule
+     * @param {ArchivingScheduleRequest} archivingScheduleRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    create4(archivingScheduleRequest: ArchivingScheduleRequest, options?: RawAxiosRequestConfig): AxiosPromise<ArchivingScheduleView>;
+    /**
+     *
+     * @summary Delete an archiving schedule
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    delete3(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary Get an archiving schedule
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    get7(id: string, options?: RawAxiosRequestConfig): AxiosPromise<ArchivingScheduleView>;
+    /**
+     * Selects the active documents under the root untouched for N months (legal hold excluded, capped) and creates a PROPOSED reorganisation plan as ownerEmail. Nothing is moved.
+     * @summary Propose an archiving plan now (admin only)
+     * @param {ArchivingProposalRequest} archivingProposalRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    propose(archivingProposalRequest: ArchivingProposalRequest, options?: RawAxiosRequestConfig): AxiosPromise<ArchivingProposalResult>;
+    /**
+     * Produces one PROPOSED plan for the schedule\'s owner and records the outcome on the schedule.
+     * @summary Run an archiving schedule now
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    run1(id: string, options?: RawAxiosRequestConfig): AxiosPromise<ArchivingProposalResult>;
+    /**
+     *
+     * @summary List archiving schedules
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    schedules(options?: RawAxiosRequestConfig): AxiosPromise<Array<ArchivingScheduleView>>;
+    /**
+     *
+     * @summary Update an archiving schedule
+     * @param {string} id
+     * @param {ArchivingScheduleRequest} archivingScheduleRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    update4(id: string, archivingScheduleRequest: ArchivingScheduleRequest, options?: RawAxiosRequestConfig): AxiosPromise<ArchivingScheduleView>;
+};
+/**
+ * AiArchivingAdminControllerApi - object-oriented interface
+ */
+export declare class AiArchivingAdminControllerApi extends BaseAPI {
+    /**
+     *
+     * @summary Create an archiving schedule
+     * @param {ArchivingScheduleRequest} archivingScheduleRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    create4(archivingScheduleRequest: ArchivingScheduleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ArchivingScheduleView, any, {}, any>>;
+    /**
+     *
+     * @summary Delete an archiving schedule
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    delete3(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}, any>>;
+    /**
+     *
+     * @summary Get an archiving schedule
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    get7(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ArchivingScheduleView, any, {}, any>>;
+    /**
+     * Selects the active documents under the root untouched for N months (legal hold excluded, capped) and creates a PROPOSED reorganisation plan as ownerEmail. Nothing is moved.
+     * @summary Propose an archiving plan now (admin only)
+     * @param {ArchivingProposalRequest} archivingProposalRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    propose(archivingProposalRequest: ArchivingProposalRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ArchivingProposalResult, any, {}, any>>;
+    /**
+     * Produces one PROPOSED plan for the schedule\'s owner and records the outcome on the schedule.
+     * @summary Run an archiving schedule now
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    run1(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ArchivingProposalResult, any, {}, any>>;
+    /**
+     *
+     * @summary List archiving schedules
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    schedules(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ArchivingScheduleView[], any, {}, any>>;
+    /**
+     *
+     * @summary Update an archiving schedule
+     * @param {string} id
+     * @param {ArchivingScheduleRequest} archivingScheduleRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    update4(id: string, archivingScheduleRequest: ArchivingScheduleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ArchivingScheduleView, any, {}, any>>;
+}