@emilgroup/document-sdk 1.12.2 → 1.16.0

package/dist/api/documents-api.d.ts

@@ -0,0 +1,488 @@
+/**
+ * EMIL DocumentService
+ * The EMIL DocumentService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { Configuration } from '../configuration';
+import { RequestArgs, BaseAPI } from '../base';
+import { CreateDocumentRequestDto } from '../models';
+import { CreateDocumentSyncResponseClass } from '../models';
+import { CreatePresignedPostRequestDto } from '../models';
+import { CreatePresignedPostResponseClass } from '../models';
+import { GetDocumentDownloadUrlResponseClass } from '../models';
+import { GetSignedS3KeyUrlResponseClass } from '../models';
+import { ListDocumentsResponseClass } from '../models';
+import { UpdateDocumentRequestDto } from '../models';
+import { UpdateDocumentResponseClass } from '../models';
+/**
+ * DocumentsApi - axios parameter creator
+ * @export
+ */
+export declare const DocumentsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * This will create a document in database and upload the file to Amazon Simple Storage Service (S3).
+     * @summary Create the document
+     * @param {CreateDocumentRequestDto} createDocumentRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createDocument: (createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * This will create a URL that allows user upload its documents in Database.The URL will be expires between 5 minutes to 7 days.
+     * @summary Upload documents using pre-signed URL
+     * @param {CreatePresignedPostRequestDto} createPresignedPostRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPresignedPost: (createPresignedPostRequestDto: CreatePresignedPostRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Permanently deletes the document. Supply the unique code that was returned when you created the document and this will delete it.
+     * @summary Delete the document
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteDocument: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * This will return a presigned URL to download the document.
+     * @summary Fetches a document download URL
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDocumentDownloadUrl: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * This will return a presigned URL for a random S3 key
+     * @summary Fetches a presigned URL for a S3 key
+     * @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSignedS3keyUrl: (s3Key: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns a list of documents you have previously created. The documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List documents
+     * @param {string} [authorization] Bearer Token
+     * @param {number} [pageSize] Page size
+     * @param {string} [pageToken] Page token
+     * @param {string} [filter] List filter
+     * @param {string} [search] Search query
+     * @param {string} [order] Ordering criteria
+     * @param {string} [expand] Extra fields to fetch
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listDocuments: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Updates the specified document by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the document
+     * @param {string} code
+     * @param {UpdateDocumentRequestDto} updateDocumentRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateDocument: (code: string, updateDocumentRequestDto: UpdateDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * DocumentsApi - functional programming interface
+ * @export
+ */
+export declare const DocumentsApiFp: (configuration?: Configuration) => {
+    /**
+     * This will create a document in database and upload the file to Amazon Simple Storage Service (S3).
+     * @summary Create the document
+     * @param {CreateDocumentRequestDto} createDocumentRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createDocument(createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateDocumentSyncResponseClass>>;
+    /**
+     * This will create a URL that allows user upload its documents in Database.The URL will be expires between 5 minutes to 7 days.
+     * @summary Upload documents using pre-signed URL
+     * @param {CreatePresignedPostRequestDto} createPresignedPostRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPresignedPost(createPresignedPostRequestDto: CreatePresignedPostRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePresignedPostResponseClass>>;
+    /**
+     * Permanently deletes the document. Supply the unique code that was returned when you created the document and this will delete it.
+     * @summary Delete the document
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteDocument(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
+    /**
+     * This will return a presigned URL to download the document.
+     * @summary Fetches a document download URL
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDocumentDownloadUrl(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDocumentDownloadUrlResponseClass>>;
+    /**
+     * This will return a presigned URL for a random S3 key
+     * @summary Fetches a presigned URL for a S3 key
+     * @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSignedS3keyUrl(s3Key: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSignedS3KeyUrlResponseClass>>;
+    /**
+     * Returns a list of documents you have previously created. The documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List documents
+     * @param {string} [authorization] Bearer Token
+     * @param {number} [pageSize] Page size
+     * @param {string} [pageToken] Page token
+     * @param {string} [filter] List filter
+     * @param {string} [search] Search query
+     * @param {string} [order] Ordering criteria
+     * @param {string} [expand] Extra fields to fetch
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listDocuments(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDocumentsResponseClass>>;
+    /**
+     * Updates the specified document by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the document
+     * @param {string} code
+     * @param {UpdateDocumentRequestDto} updateDocumentRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateDocument(code: string, updateDocumentRequestDto: UpdateDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateDocumentResponseClass>>;
+};
+/**
+ * DocumentsApi - factory interface
+ * @export
+ */
+export declare const DocumentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * This will create a document in database and upload the file to Amazon Simple Storage Service (S3).
+     * @summary Create the document
+     * @param {CreateDocumentRequestDto} createDocumentRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createDocument(createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options?: any): AxiosPromise<CreateDocumentSyncResponseClass>;
+    /**
+     * This will create a URL that allows user upload its documents in Database.The URL will be expires between 5 minutes to 7 days.
+     * @summary Upload documents using pre-signed URL
+     * @param {CreatePresignedPostRequestDto} createPresignedPostRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPresignedPost(createPresignedPostRequestDto: CreatePresignedPostRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePresignedPostResponseClass>;
+    /**
+     * Permanently deletes the document. Supply the unique code that was returned when you created the document and this will delete it.
+     * @summary Delete the document
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteDocument(code: string, authorization?: string, options?: any): AxiosPromise<object>;
+    /**
+     * This will return a presigned URL to download the document.
+     * @summary Fetches a document download URL
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDocumentDownloadUrl(code: string, authorization?: string, options?: any): AxiosPromise<GetDocumentDownloadUrlResponseClass>;
+    /**
+     * This will return a presigned URL for a random S3 key
+     * @summary Fetches a presigned URL for a S3 key
+     * @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSignedS3keyUrl(s3Key: string, authorization?: string, options?: any): AxiosPromise<GetSignedS3KeyUrlResponseClass>;
+    /**
+     * Returns a list of documents you have previously created. The documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List documents
+     * @param {string} [authorization] Bearer Token
+     * @param {number} [pageSize] Page size
+     * @param {string} [pageToken] Page token
+     * @param {string} [filter] List filter
+     * @param {string} [search] Search query
+     * @param {string} [order] Ordering criteria
+     * @param {string} [expand] Extra fields to fetch
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listDocuments(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListDocumentsResponseClass>;
+    /**
+     * Updates the specified document by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the document
+     * @param {string} code
+     * @param {UpdateDocumentRequestDto} updateDocumentRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateDocument(code: string, updateDocumentRequestDto: UpdateDocumentRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateDocumentResponseClass>;
+};
+/**
+ * Request parameters for createDocument operation in DocumentsApi.
+ * @export
+ * @interface DocumentsApiCreateDocumentRequest
+ */
+export interface DocumentsApiCreateDocumentRequest {
+    /**
+     *
+     * @type {CreateDocumentRequestDto}
+     * @memberof DocumentsApiCreateDocument
+     */
+    readonly createDocumentRequestDto: CreateDocumentRequestDto;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof DocumentsApiCreateDocument
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for createPresignedPost operation in DocumentsApi.
+ * @export
+ * @interface DocumentsApiCreatePresignedPostRequest
+ */
+export interface DocumentsApiCreatePresignedPostRequest {
+    /**
+     *
+     * @type {CreatePresignedPostRequestDto}
+     * @memberof DocumentsApiCreatePresignedPost
+     */
+    readonly createPresignedPostRequestDto: CreatePresignedPostRequestDto;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof DocumentsApiCreatePresignedPost
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for deleteDocument operation in DocumentsApi.
+ * @export
+ * @interface DocumentsApiDeleteDocumentRequest
+ */
+export interface DocumentsApiDeleteDocumentRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof DocumentsApiDeleteDocument
+     */
+    readonly code: string;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof DocumentsApiDeleteDocument
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getDocumentDownloadUrl operation in DocumentsApi.
+ * @export
+ * @interface DocumentsApiGetDocumentDownloadUrlRequest
+ */
+export interface DocumentsApiGetDocumentDownloadUrlRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof DocumentsApiGetDocumentDownloadUrl
+     */
+    readonly code: string;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof DocumentsApiGetDocumentDownloadUrl
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getSignedS3keyUrl operation in DocumentsApi.
+ * @export
+ * @interface DocumentsApiGetSignedS3keyUrlRequest
+ */
+export interface DocumentsApiGetSignedS3keyUrlRequest {
+    /**
+     * Key for the file in S3 bucket to create the presigned download URL for
+     * @type {string}
+     * @memberof DocumentsApiGetSignedS3keyUrl
+     */
+    readonly s3Key: string;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof DocumentsApiGetSignedS3keyUrl
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for listDocuments operation in DocumentsApi.
+ * @export
+ * @interface DocumentsApiListDocumentsRequest
+ */
+export interface DocumentsApiListDocumentsRequest {
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof DocumentsApiListDocuments
+     */
+    readonly authorization?: string;
+    /**
+     * Page size
+     * @type {number}
+     * @memberof DocumentsApiListDocuments
+     */
+    readonly pageSize?: number;
+    /**
+     * Page token
+     * @type {string}
+     * @memberof DocumentsApiListDocuments
+     */
+    readonly pageToken?: string;
+    /**
+     * List filter
+     * @type {string}
+     * @memberof DocumentsApiListDocuments
+     */
+    readonly filter?: string;
+    /**
+     * Search query
+     * @type {string}
+     * @memberof DocumentsApiListDocuments
+     */
+    readonly search?: string;
+    /**
+     * Ordering criteria
+     * @type {string}
+     * @memberof DocumentsApiListDocuments
+     */
+    readonly order?: string;
+    /**
+     * Extra fields to fetch
+     * @type {string}
+     * @memberof DocumentsApiListDocuments
+     */
+    readonly expand?: string;
+}
+/**
+ * Request parameters for updateDocument operation in DocumentsApi.
+ * @export
+ * @interface DocumentsApiUpdateDocumentRequest
+ */
+export interface DocumentsApiUpdateDocumentRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof DocumentsApiUpdateDocument
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {UpdateDocumentRequestDto}
+     * @memberof DocumentsApiUpdateDocument
+     */
+    readonly updateDocumentRequestDto: UpdateDocumentRequestDto;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof DocumentsApiUpdateDocument
+     */
+    readonly authorization?: string;
+}
+/**
+ * DocumentsApi - object-oriented interface
+ * @export
+ * @class DocumentsApi
+ * @extends {BaseAPI}
+ */
+export declare class DocumentsApi extends BaseAPI {
+    /**
+     * This will create a document in database and upload the file to Amazon Simple Storage Service (S3).
+     * @summary Create the document
+     * @param {DocumentsApiCreateDocumentRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentsApi
+     */
+    createDocument(requestParameters: DocumentsApiCreateDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateDocumentSyncResponseClass, any>>;
+    /**
+     * This will create a URL that allows user upload its documents in Database.The URL will be expires between 5 minutes to 7 days.
+     * @summary Upload documents using pre-signed URL
+     * @param {DocumentsApiCreatePresignedPostRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentsApi
+     */
+    createPresignedPost(requestParameters: DocumentsApiCreatePresignedPostRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePresignedPostResponseClass, any>>;
+    /**
+     * Permanently deletes the document. Supply the unique code that was returned when you created the document and this will delete it.
+     * @summary Delete the document
+     * @param {DocumentsApiDeleteDocumentRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentsApi
+     */
+    deleteDocument(requestParameters: DocumentsApiDeleteDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
+    /**
+     * This will return a presigned URL to download the document.
+     * @summary Fetches a document download URL
+     * @param {DocumentsApiGetDocumentDownloadUrlRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentsApi
+     */
+    getDocumentDownloadUrl(requestParameters: DocumentsApiGetDocumentDownloadUrlRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetDocumentDownloadUrlResponseClass, any>>;
+    /**
+     * This will return a presigned URL for a random S3 key
+     * @summary Fetches a presigned URL for a S3 key
+     * @param {DocumentsApiGetSignedS3keyUrlRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentsApi
+     */
+    getSignedS3keyUrl(requestParameters: DocumentsApiGetSignedS3keyUrlRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSignedS3KeyUrlResponseClass, any>>;
+    /**
+     * Returns a list of documents you have previously created. The documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List documents
+     * @param {DocumentsApiListDocumentsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentsApi
+     */
+    listDocuments(requestParameters?: DocumentsApiListDocumentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListDocumentsResponseClass, any>>;
+    /**
+     * Updates the specified document by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the document
+     * @param {DocumentsApiUpdateDocumentRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentsApi
+     */
+    updateDocument(requestParameters: DocumentsApiUpdateDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateDocumentResponseClass, any>>;
+}