@openfilz-sdk/typescript-ee 1.3.5

package/dist/api/tus-controller-api.d.ts

@@ -0,0 +1,338 @@
+/**
+ * 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<RequestArgs>;
+    /**
+     * 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<RequestArgs>;
+    /**
+     * 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<RequestArgs>;
+    /**
+     * 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<RequestArgs>;
+    /**
+     * Returns configuration values for client-side TUS setup.
+     * @summary Get TUS configuration
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getConfig: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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<RequestArgs>;
+    /**
+     * 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<RequestArgs>;
+    /**
+     * 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<RequestArgs>;
+    /**
+     * 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<any>} requestBody
+     * @param {number} [contentLength]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    uploadChunk: (uploadId: string, uploadOffset: number, requestBody: Array<any>, contentLength?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * 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<void>>;
+    /**
+     * 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<void>>;
+    /**
+     * 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<void>>;
+    /**
+     * 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<UploadResponse>>;
+    /**
+     * 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<TusConfigResponse>>;
+    /**
+     * 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<TusUploadInfo>>;
+    /**
+     * 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<void>>;
+    /**
+     * 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<boolean>>;
+    /**
+     * 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<any>} requestBody
+     * @param {number} [contentLength]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    uploadChunk(uploadId: string, uploadOffset: number, requestBody: Array<any>, contentLength?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+};
+/**
+ * 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<void>;
+    /**
+     * 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<void>;
+    /**
+     * 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<void>;
+    /**
+     * 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<UploadResponse>;
+    /**
+     * Returns configuration values for client-side TUS setup.
+     * @summary Get TUS configuration
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getConfig(options?: RawAxiosRequestConfig): AxiosPromise<TusConfigResponse>;
+    /**
+     * 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<TusUploadInfo>;
+    /**
+     * 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<void>;
+    /**
+     * 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<boolean>;
+    /**
+     * 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<any>} requestBody
+     * @param {number} [contentLength]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    uploadChunk(uploadId: string, uploadOffset: number, requestBody: Array<any>, contentLength?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+};
+/**
+ * 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<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * 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<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * 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<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * 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<import("axios").AxiosResponse<UploadResponse, any, {}>>;
+    /**
+     * Returns configuration values for client-side TUS setup.
+     * @summary Get TUS configuration
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getConfig(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TusConfigResponse, any, {}>>;
+    /**
+     * 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<import("axios").AxiosResponse<TusUploadInfo, any, {}>>;
+    /**
+     * 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<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * 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<import("axios").AxiosResponse<boolean, any, {}>>;
+    /**
+     * 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<any>} requestBody
+     * @param {number} [contentLength]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    uploadChunk(uploadId: string, uploadOffset: number, requestBody: Array<any>, contentLength?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+}