/** * 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 { AutoFileInboxRequest } from '../models'; import type { AutoFileJobView } from '../models'; import type { AutoFileJobsRequest } from '../models'; import type { AutoFileRequest } from '../models'; import type { FilingOutcome } from '../models'; /** * SmartFilingApi - axios parameter creator */ export declare const SmartFilingApiAxiosParamCreator: (configuration?: Configuration) => { /** * Runs smart filing for the given documents (e.g. the contents of an Inbox) and returns the job at once. * @summary File existing documents on demand * @param {AutoFileRequest} autoFileRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ file: (autoFileRequest: AutoFileRequest, options?: RawAxiosRequestConfig) => Promise; /** * Schedules one filing job for every active file directly in the caller\'s Inbox folder (the per-user Inbox of the smart-filing preferences) and returns the job at once, like the on-demand endpoint. 404 when the caller has no Inbox, 400 when the deployment does not offer it. * @summary File everything lying loose in the caller\'s Inbox * @param {AutoFileInboxRequest} [autoFileInboxRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ fileInbox: (autoFileInboxRequest?: AutoFileInboxRequest, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Progress and outcome of a filing job * @param {string} jobId * @param {*} [options] Override http request option. * @throws {RequiredError} */ job: (jobId: string, options?: RawAxiosRequestConfig) => Promise; /** * Follows a whole upload batch in one call: the browser sends one upload request per file, so a batch leaves as many jobs to poll. Jobs that do not exist, or belong to somebody else, are left out of the answer rather than failing it. A POST because a batch of ids does not fit in a query string. * @summary Progress and outcome of several filing jobs * @param {AutoFileJobsRequest} autoFileJobsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ jobs: (autoFileJobsRequest: AutoFileJobsRequest, options?: RawAxiosRequestConfig) => Promise; /** * * @summary The latest filing record of a document (the \"Filed by OpenFilz\" chip) * @param {string} documentId * @param {*} [options] Override http request option. * @throws {RequiredError} */ lastFiling: (documentId: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Move every document the job filed back where it came from * @param {string} jobId * @param {*} [options] Override http request option. * @throws {RequiredError} */ undo: (jobId: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Move one filed document back (the chip\'s \"Move back\") * @param {string} planId * @param {*} [options] Override http request option. * @throws {RequiredError} */ undoFiling: (planId: string, options?: RawAxiosRequestConfig) => Promise; }; /** * SmartFilingApi - functional programming interface */ export declare const SmartFilingApiFp: (configuration?: Configuration) => { /** * Runs smart filing for the given documents (e.g. the contents of an Inbox) and returns the job at once. * @summary File existing documents on demand * @param {AutoFileRequest} autoFileRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ file(autoFileRequest: AutoFileRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Schedules one filing job for every active file directly in the caller\'s Inbox folder (the per-user Inbox of the smart-filing preferences) and returns the job at once, like the on-demand endpoint. 404 when the caller has no Inbox, 400 when the deployment does not offer it. * @summary File everything lying loose in the caller\'s Inbox * @param {AutoFileInboxRequest} [autoFileInboxRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ fileInbox(autoFileInboxRequest?: AutoFileInboxRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Progress and outcome of a filing job * @param {string} jobId * @param {*} [options] Override http request option. * @throws {RequiredError} */ job(jobId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Follows a whole upload batch in one call: the browser sends one upload request per file, so a batch leaves as many jobs to poll. Jobs that do not exist, or belong to somebody else, are left out of the answer rather than failing it. A POST because a batch of ids does not fit in a query string. * @summary Progress and outcome of several filing jobs * @param {AutoFileJobsRequest} autoFileJobsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ jobs(autoFileJobsRequest: AutoFileJobsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * * @summary The latest filing record of a document (the \"Filed by OpenFilz\" chip) * @param {string} documentId * @param {*} [options] Override http request option. * @throws {RequiredError} */ lastFiling(documentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Move every document the job filed back where it came from * @param {string} jobId * @param {*} [options] Override http request option. * @throws {RequiredError} */ undo(jobId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Move one filed document back (the chip\'s \"Move back\") * @param {string} planId * @param {*} [options] Override http request option. * @throws {RequiredError} */ undoFiling(planId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * SmartFilingApi - factory interface */ export declare const SmartFilingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Runs smart filing for the given documents (e.g. the contents of an Inbox) and returns the job at once. * @summary File existing documents on demand * @param {AutoFileRequest} autoFileRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ file(autoFileRequest: AutoFileRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Schedules one filing job for every active file directly in the caller\'s Inbox folder (the per-user Inbox of the smart-filing preferences) and returns the job at once, like the on-demand endpoint. 404 when the caller has no Inbox, 400 when the deployment does not offer it. * @summary File everything lying loose in the caller\'s Inbox * @param {AutoFileInboxRequest} [autoFileInboxRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ fileInbox(autoFileInboxRequest?: AutoFileInboxRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Progress and outcome of a filing job * @param {string} jobId * @param {*} [options] Override http request option. * @throws {RequiredError} */ job(jobId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Follows a whole upload batch in one call: the browser sends one upload request per file, so a batch leaves as many jobs to poll. Jobs that do not exist, or belong to somebody else, are left out of the answer rather than failing it. A POST because a batch of ids does not fit in a query string. * @summary Progress and outcome of several filing jobs * @param {AutoFileJobsRequest} autoFileJobsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ jobs(autoFileJobsRequest: AutoFileJobsRequest, options?: RawAxiosRequestConfig): AxiosPromise>; /** * * @summary The latest filing record of a document (the \"Filed by OpenFilz\" chip) * @param {string} documentId * @param {*} [options] Override http request option. * @throws {RequiredError} */ lastFiling(documentId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Move every document the job filed back where it came from * @param {string} jobId * @param {*} [options] Override http request option. * @throws {RequiredError} */ undo(jobId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Move one filed document back (the chip\'s \"Move back\") * @param {string} planId * @param {*} [options] Override http request option. * @throws {RequiredError} */ undoFiling(planId: string, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * SmartFilingApi - object-oriented interface */ export declare class SmartFilingApi extends BaseAPI { /** * Runs smart filing for the given documents (e.g. the contents of an Inbox) and returns the job at once. * @summary File existing documents on demand * @param {AutoFileRequest} autoFileRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ file(autoFileRequest: AutoFileRequest, options?: RawAxiosRequestConfig): Promise>; /** * Schedules one filing job for every active file directly in the caller\'s Inbox folder (the per-user Inbox of the smart-filing preferences) and returns the job at once, like the on-demand endpoint. 404 when the caller has no Inbox, 400 when the deployment does not offer it. * @summary File everything lying loose in the caller\'s Inbox * @param {AutoFileInboxRequest} [autoFileInboxRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ fileInbox(autoFileInboxRequest?: AutoFileInboxRequest, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Progress and outcome of a filing job * @param {string} jobId * @param {*} [options] Override http request option. * @throws {RequiredError} */ job(jobId: string, options?: RawAxiosRequestConfig): Promise>; /** * Follows a whole upload batch in one call: the browser sends one upload request per file, so a batch leaves as many jobs to poll. Jobs that do not exist, or belong to somebody else, are left out of the answer rather than failing it. A POST because a batch of ids does not fit in a query string. * @summary Progress and outcome of several filing jobs * @param {AutoFileJobsRequest} autoFileJobsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ jobs(autoFileJobsRequest: AutoFileJobsRequest, options?: RawAxiosRequestConfig): Promise>; /** * * @summary The latest filing record of a document (the \"Filed by OpenFilz\" chip) * @param {string} documentId * @param {*} [options] Override http request option. * @throws {RequiredError} */ lastFiling(documentId: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Move every document the job filed back where it came from * @param {string} jobId * @param {*} [options] Override http request option. * @throws {RequiredError} */ undo(jobId: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Move one filed document back (the chip\'s \"Move back\") * @param {string} planId * @param {*} [options] Override http request option. * @throws {RequiredError} */ undoFiling(planId: string, options?: RawAxiosRequestConfig): Promise>; }