/** * 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 { TusConfigResponse } from '../models'; import type { TusFinalizeRequest } from '../models'; import type { TusUploadInfo } from '../models'; import type { UploadResponse } from '../models'; /** * TusControllerApi - axios parameter creator */ export declare const TusControllerApiAxiosParamCreator: (configuration?: Configuration) => { /** * Returns TUS protocol headers indicating supported extensions and version. * @summary TUS capability discovery * @param {*} [options] Override http request option. * @throws {RequiredError} */ _options: (options?: RawAxiosRequestConfig) => Promise; /** * Cancels an in-progress upload and cleans up temporary data. * @summary Cancel upload * @param {string} uploadId Upload identifier * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancelUpload: (uploadId: string, options?: RawAxiosRequestConfig) => Promise; /** * Creates a new TUS upload session. Client must provide Upload-Length header. Upload-Metadata header should contain base64-encoded values for: filename (required), parentFolderId (optional), allowDuplicateFileNames (optional, default false). * @summary Create new TUS upload * @param {number} uploadLength * @param {string} [uploadMetadata] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createUpload: (uploadLength: number, uploadMetadata?: string, options?: RawAxiosRequestConfig) => Promise; /** * Completes the upload by moving the file to permanent storage and creating the Document record. Call this after all chunks have been successfully uploaded. * @summary Finalize upload * @param {string} uploadId Upload identifier * @param {TusFinalizeRequest} tusFinalizeRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ finalizeUpload: (uploadId: string, tusFinalizeRequest: TusFinalizeRequest, options?: RawAxiosRequestConfig) => Promise; /** * Returns configuration values for client-side TUS setup. * @summary Get TUS configuration * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConfig: (options?: RawAxiosRequestConfig) => Promise; /** * Returns detailed information about an upload including offset, length, and expiration. * @summary Get upload information * @param {string} uploadId Upload identifier * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUploadInfo: (uploadId: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns the current upload offset (bytes received). * @summary Get upload progress * @param {string} uploadId Upload identifier * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUploadOffset: (uploadId: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns whether the upload has received all bytes. * @summary Check upload completion * @param {string} uploadId Upload identifier * @param {*} [options] Override http request option. * @throws {RequiredError} */ isUploadComplete: (uploadId: string, options?: RawAxiosRequestConfig) => Promise; /** * Uploads a chunk of data. Client must send Upload-Offset header matching current offset. * @summary Upload chunk * @param {string} uploadId Upload identifier * @param {number} uploadOffset * @param {Array} requestBody * @param {number} [contentLength] * @param {*} [options] Override http request option. * @throws {RequiredError} */ uploadChunk: (uploadId: string, uploadOffset: number, requestBody: Array, contentLength?: number, options?: RawAxiosRequestConfig) => Promise; }; /** * TusControllerApi - functional programming interface */ export declare const TusControllerApiFp: (configuration?: Configuration) => { /** * Returns TUS protocol headers indicating supported extensions and version. * @summary TUS capability discovery * @param {*} [options] Override http request option. * @throws {RequiredError} */ _options(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Cancels an in-progress upload and cleans up temporary data. * @summary Cancel upload * @param {string} uploadId Upload identifier * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancelUpload(uploadId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Creates a new TUS upload session. Client must provide Upload-Length header. Upload-Metadata header should contain base64-encoded values for: filename (required), parentFolderId (optional), allowDuplicateFileNames (optional, default false). * @summary Create new TUS upload * @param {number} uploadLength * @param {string} [uploadMetadata] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createUpload(uploadLength: number, uploadMetadata?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Completes the upload by moving the file to permanent storage and creating the Document record. Call this after all chunks have been successfully uploaded. * @summary Finalize upload * @param {string} uploadId Upload identifier * @param {TusFinalizeRequest} tusFinalizeRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ finalizeUpload(uploadId: string, tusFinalizeRequest: TusFinalizeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns configuration values for client-side TUS setup. * @summary Get TUS configuration * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConfig(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns detailed information about an upload including offset, length, and expiration. * @summary Get upload information * @param {string} uploadId Upload identifier * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUploadInfo(uploadId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the current upload offset (bytes received). * @summary Get upload progress * @param {string} uploadId Upload identifier * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUploadOffset(uploadId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns whether the upload has received all bytes. * @summary Check upload completion * @param {string} uploadId Upload identifier * @param {*} [options] Override http request option. * @throws {RequiredError} */ isUploadComplete(uploadId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Uploads a chunk of data. Client must send Upload-Offset header matching current offset. * @summary Upload chunk * @param {string} uploadId Upload identifier * @param {number} uploadOffset * @param {Array} requestBody * @param {number} [contentLength] * @param {*} [options] Override http request option. * @throws {RequiredError} */ uploadChunk(uploadId: string, uploadOffset: number, requestBody: Array, contentLength?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * TusControllerApi - factory interface */ export declare const TusControllerApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Returns TUS protocol headers indicating supported extensions and version. * @summary TUS capability discovery * @param {*} [options] Override http request option. * @throws {RequiredError} */ _options(options?: RawAxiosRequestConfig): AxiosPromise; /** * Cancels an in-progress upload and cleans up temporary data. * @summary Cancel upload * @param {string} uploadId Upload identifier * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancelUpload(uploadId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Creates a new TUS upload session. Client must provide Upload-Length header. Upload-Metadata header should contain base64-encoded values for: filename (required), parentFolderId (optional), allowDuplicateFileNames (optional, default false). * @summary Create new TUS upload * @param {number} uploadLength * @param {string} [uploadMetadata] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createUpload(uploadLength: number, uploadMetadata?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Completes the upload by moving the file to permanent storage and creating the Document record. Call this after all chunks have been successfully uploaded. * @summary Finalize upload * @param {string} uploadId Upload identifier * @param {TusFinalizeRequest} tusFinalizeRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ finalizeUpload(uploadId: string, tusFinalizeRequest: TusFinalizeRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns configuration values for client-side TUS setup. * @summary Get TUS configuration * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConfig(options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns detailed information about an upload including offset, length, and expiration. * @summary Get upload information * @param {string} uploadId Upload identifier * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUploadInfo(uploadId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the current upload offset (bytes received). * @summary Get upload progress * @param {string} uploadId Upload identifier * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUploadOffset(uploadId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns whether the upload has received all bytes. * @summary Check upload completion * @param {string} uploadId Upload identifier * @param {*} [options] Override http request option. * @throws {RequiredError} */ isUploadComplete(uploadId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Uploads a chunk of data. Client must send Upload-Offset header matching current offset. * @summary Upload chunk * @param {string} uploadId Upload identifier * @param {number} uploadOffset * @param {Array} requestBody * @param {number} [contentLength] * @param {*} [options] Override http request option. * @throws {RequiredError} */ uploadChunk(uploadId: string, uploadOffset: number, requestBody: Array, contentLength?: number, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * TusControllerApi - object-oriented interface */ export declare class TusControllerApi extends BaseAPI { /** * Returns TUS protocol headers indicating supported extensions and version. * @summary TUS capability discovery * @param {*} [options] Override http request option. * @throws {RequiredError} */ _options(options?: RawAxiosRequestConfig): Promise>; /** * Cancels an in-progress upload and cleans up temporary data. * @summary Cancel upload * @param {string} uploadId Upload identifier * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancelUpload(uploadId: string, options?: RawAxiosRequestConfig): Promise>; /** * Creates a new TUS upload session. Client must provide Upload-Length header. Upload-Metadata header should contain base64-encoded values for: filename (required), parentFolderId (optional), allowDuplicateFileNames (optional, default false). * @summary Create new TUS upload * @param {number} uploadLength * @param {string} [uploadMetadata] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createUpload(uploadLength: number, uploadMetadata?: string, options?: RawAxiosRequestConfig): Promise>; /** * Completes the upload by moving the file to permanent storage and creating the Document record. Call this after all chunks have been successfully uploaded. * @summary Finalize upload * @param {string} uploadId Upload identifier * @param {TusFinalizeRequest} tusFinalizeRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ finalizeUpload(uploadId: string, tusFinalizeRequest: TusFinalizeRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns configuration values for client-side TUS setup. * @summary Get TUS configuration * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConfig(options?: RawAxiosRequestConfig): Promise>; /** * Returns detailed information about an upload including offset, length, and expiration. * @summary Get upload information * @param {string} uploadId Upload identifier * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUploadInfo(uploadId: string, options?: RawAxiosRequestConfig): Promise>; /** * Returns the current upload offset (bytes received). * @summary Get upload progress * @param {string} uploadId Upload identifier * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUploadOffset(uploadId: string, options?: RawAxiosRequestConfig): Promise>; /** * Returns whether the upload has received all bytes. * @summary Check upload completion * @param {string} uploadId Upload identifier * @param {*} [options] Override http request option. * @throws {RequiredError} */ isUploadComplete(uploadId: string, options?: RawAxiosRequestConfig): Promise>; /** * Uploads a chunk of data. Client must send Upload-Offset header matching current offset. * @summary Upload chunk * @param {string} uploadId Upload identifier * @param {number} uploadOffset * @param {Array} requestBody * @param {number} [contentLength] * @param {*} [options] Override http request option. * @throws {RequiredError} */ uploadChunk(uploadId: string, uploadOffset: number, requestBody: Array, contentLength?: number, options?: RawAxiosRequestConfig): Promise>; }