@emilgroup/document-sdk 1.12.2 → 1.12.3

package/dist/api/docx-templates-api.d.ts

@@ -0,0 +1,432 @@
+/**
+ * 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 { DeleteResponseClass } from '../models';
+import { GetDocxTemplateDownloadUrlResponseClass } from '../models';
+import { GetDocxTemplateResponseClass } from '../models';
+import { ListDocxTemplatesResponseClass } from '../models';
+import { SharedUpdateDocxTemplateRequestDto } from '../models';
+import { UpdateDocxTemplateResponseClass } from '../models';
+import { UploadDocxTemplateRequestDto } from '../models';
+import { UploadDocxTemplateResponseClass } from '../models';
+/**
+ * DocxTemplatesApi - axios parameter creator
+ * @export
+ */
+export declare const DocxTemplatesApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Permanently deletes the docx template. Supply the unique code that was returned when you created the docx template and this will delete it.
+     * @summary Delete the docx template
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteDocxTemplate: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get a pre-signed download url for the given docx template.
+     * @summary Get pre-signed url for downloading docx template
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadDocxTemplate: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get a docx template.
+     * @summary Retrieve the docx template
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDocxTemplate: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns a list of docx templates you have previously created. The docx templates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List docx templates
+     * @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}
+     */
+    listDocxTemplates: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Updates a docx template metadata.
+     * @summary Update the docx template
+     * @param {string} code
+     * @param {SharedUpdateDocxTemplateRequestDto} sharedUpdateDocxTemplateRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateDocxTemplate: (code: string, sharedUpdateDocxTemplateRequestDto: SharedUpdateDocxTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Upload a docx template via a presigned Url.
+     * @summary Upload a docx template.
+     * @param {UploadDocxTemplateRequestDto} uploadDocxTemplateRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    uploadDocxTemplate: (uploadDocxTemplateRequestDto: UploadDocxTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * DocxTemplatesApi - functional programming interface
+ * @export
+ */
+export declare const DocxTemplatesApiFp: (configuration?: Configuration) => {
+    /**
+     * Permanently deletes the docx template. Supply the unique code that was returned when you created the docx template and this will delete it.
+     * @summary Delete the docx template
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteDocxTemplate(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
+    /**
+     * Get a pre-signed download url for the given docx template.
+     * @summary Get pre-signed url for downloading docx template
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadDocxTemplate(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDocxTemplateDownloadUrlResponseClass>>;
+    /**
+     * Get a docx template.
+     * @summary Retrieve the docx template
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDocxTemplate(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDocxTemplateResponseClass>>;
+    /**
+     * Returns a list of docx templates you have previously created. The docx templates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List docx templates
+     * @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}
+     */
+    listDocxTemplates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDocxTemplatesResponseClass>>;
+    /**
+     * Updates a docx template metadata.
+     * @summary Update the docx template
+     * @param {string} code
+     * @param {SharedUpdateDocxTemplateRequestDto} sharedUpdateDocxTemplateRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateDocxTemplate(code: string, sharedUpdateDocxTemplateRequestDto: SharedUpdateDocxTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateDocxTemplateResponseClass>>;
+    /**
+     * Upload a docx template via a presigned Url.
+     * @summary Upload a docx template.
+     * @param {UploadDocxTemplateRequestDto} uploadDocxTemplateRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    uploadDocxTemplate(uploadDocxTemplateRequestDto: UploadDocxTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UploadDocxTemplateResponseClass>>;
+};
+/**
+ * DocxTemplatesApi - factory interface
+ * @export
+ */
+export declare const DocxTemplatesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Permanently deletes the docx template. Supply the unique code that was returned when you created the docx template and this will delete it.
+     * @summary Delete the docx template
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteDocxTemplate(code: string, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
+    /**
+     * Get a pre-signed download url for the given docx template.
+     * @summary Get pre-signed url for downloading docx template
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadDocxTemplate(code: string, authorization?: string, options?: any): AxiosPromise<GetDocxTemplateDownloadUrlResponseClass>;
+    /**
+     * Get a docx template.
+     * @summary Retrieve the docx template
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDocxTemplate(code: string, authorization?: string, options?: any): AxiosPromise<GetDocxTemplateResponseClass>;
+    /**
+     * Returns a list of docx templates you have previously created. The docx templates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List docx templates
+     * @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}
+     */
+    listDocxTemplates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListDocxTemplatesResponseClass>;
+    /**
+     * Updates a docx template metadata.
+     * @summary Update the docx template
+     * @param {string} code
+     * @param {SharedUpdateDocxTemplateRequestDto} sharedUpdateDocxTemplateRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateDocxTemplate(code: string, sharedUpdateDocxTemplateRequestDto: SharedUpdateDocxTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateDocxTemplateResponseClass>;
+    /**
+     * Upload a docx template via a presigned Url.
+     * @summary Upload a docx template.
+     * @param {UploadDocxTemplateRequestDto} uploadDocxTemplateRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    uploadDocxTemplate(uploadDocxTemplateRequestDto: UploadDocxTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<UploadDocxTemplateResponseClass>;
+};
+/**
+ * Request parameters for deleteDocxTemplate operation in DocxTemplatesApi.
+ * @export
+ * @interface DocxTemplatesApiDeleteDocxTemplateRequest
+ */
+export interface DocxTemplatesApiDeleteDocxTemplateRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof DocxTemplatesApiDeleteDocxTemplate
+     */
+    readonly code: string;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof DocxTemplatesApiDeleteDocxTemplate
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for downloadDocxTemplate operation in DocxTemplatesApi.
+ * @export
+ * @interface DocxTemplatesApiDownloadDocxTemplateRequest
+ */
+export interface DocxTemplatesApiDownloadDocxTemplateRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof DocxTemplatesApiDownloadDocxTemplate
+     */
+    readonly code: string;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof DocxTemplatesApiDownloadDocxTemplate
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getDocxTemplate operation in DocxTemplatesApi.
+ * @export
+ * @interface DocxTemplatesApiGetDocxTemplateRequest
+ */
+export interface DocxTemplatesApiGetDocxTemplateRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof DocxTemplatesApiGetDocxTemplate
+     */
+    readonly code: string;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof DocxTemplatesApiGetDocxTemplate
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for listDocxTemplates operation in DocxTemplatesApi.
+ * @export
+ * @interface DocxTemplatesApiListDocxTemplatesRequest
+ */
+export interface DocxTemplatesApiListDocxTemplatesRequest {
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof DocxTemplatesApiListDocxTemplates
+     */
+    readonly authorization?: string;
+    /**
+     * Page size
+     * @type {number}
+     * @memberof DocxTemplatesApiListDocxTemplates
+     */
+    readonly pageSize?: number;
+    /**
+     * Page token
+     * @type {string}
+     * @memberof DocxTemplatesApiListDocxTemplates
+     */
+    readonly pageToken?: string;
+    /**
+     * List filter
+     * @type {string}
+     * @memberof DocxTemplatesApiListDocxTemplates
+     */
+    readonly filter?: string;
+    /**
+     * Search query
+     * @type {string}
+     * @memberof DocxTemplatesApiListDocxTemplates
+     */
+    readonly search?: string;
+    /**
+     * Ordering criteria
+     * @type {string}
+     * @memberof DocxTemplatesApiListDocxTemplates
+     */
+    readonly order?: string;
+    /**
+     * Extra fields to fetch
+     * @type {string}
+     * @memberof DocxTemplatesApiListDocxTemplates
+     */
+    readonly expand?: string;
+}
+/**
+ * Request parameters for updateDocxTemplate operation in DocxTemplatesApi.
+ * @export
+ * @interface DocxTemplatesApiUpdateDocxTemplateRequest
+ */
+export interface DocxTemplatesApiUpdateDocxTemplateRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof DocxTemplatesApiUpdateDocxTemplate
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {SharedUpdateDocxTemplateRequestDto}
+     * @memberof DocxTemplatesApiUpdateDocxTemplate
+     */
+    readonly sharedUpdateDocxTemplateRequestDto: SharedUpdateDocxTemplateRequestDto;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof DocxTemplatesApiUpdateDocxTemplate
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for uploadDocxTemplate operation in DocxTemplatesApi.
+ * @export
+ * @interface DocxTemplatesApiUploadDocxTemplateRequest
+ */
+export interface DocxTemplatesApiUploadDocxTemplateRequest {
+    /**
+     *
+     * @type {UploadDocxTemplateRequestDto}
+     * @memberof DocxTemplatesApiUploadDocxTemplate
+     */
+    readonly uploadDocxTemplateRequestDto: UploadDocxTemplateRequestDto;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof DocxTemplatesApiUploadDocxTemplate
+     */
+    readonly authorization?: string;
+}
+/**
+ * DocxTemplatesApi - object-oriented interface
+ * @export
+ * @class DocxTemplatesApi
+ * @extends {BaseAPI}
+ */
+export declare class DocxTemplatesApi extends BaseAPI {
+    /**
+     * Permanently deletes the docx template. Supply the unique code that was returned when you created the docx template and this will delete it.
+     * @summary Delete the docx template
+     * @param {DocxTemplatesApiDeleteDocxTemplateRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocxTemplatesApi
+     */
+    deleteDocxTemplate(requestParameters: DocxTemplatesApiDeleteDocxTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any>>;
+    /**
+     * Get a pre-signed download url for the given docx template.
+     * @summary Get pre-signed url for downloading docx template
+     * @param {DocxTemplatesApiDownloadDocxTemplateRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocxTemplatesApi
+     */
+    downloadDocxTemplate(requestParameters: DocxTemplatesApiDownloadDocxTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetDocxTemplateDownloadUrlResponseClass, any>>;
+    /**
+     * Get a docx template.
+     * @summary Retrieve the docx template
+     * @param {DocxTemplatesApiGetDocxTemplateRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocxTemplatesApi
+     */
+    getDocxTemplate(requestParameters: DocxTemplatesApiGetDocxTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetDocxTemplateResponseClass, any>>;
+    /**
+     * Returns a list of docx templates you have previously created. The docx templates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List docx templates
+     * @param {DocxTemplatesApiListDocxTemplatesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocxTemplatesApi
+     */
+    listDocxTemplates(requestParameters?: DocxTemplatesApiListDocxTemplatesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListDocxTemplatesResponseClass, any>>;
+    /**
+     * Updates a docx template metadata.
+     * @summary Update the docx template
+     * @param {DocxTemplatesApiUpdateDocxTemplateRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocxTemplatesApi
+     */
+    updateDocxTemplate(requestParameters: DocxTemplatesApiUpdateDocxTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateDocxTemplateResponseClass, any>>;
+    /**
+     * Upload a docx template via a presigned Url.
+     * @summary Upload a docx template.
+     * @param {DocxTemplatesApiUploadDocxTemplateRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocxTemplatesApi
+     */
+    uploadDocxTemplate(requestParameters: DocxTemplatesApiUploadDocxTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UploadDocxTemplateResponseClass, any>>;
+}