@emilgroup/document-sdk-node 1.0.0

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

@@ -0,0 +1,372 @@
+/**
+ * EMIL DocumentService
+ * The EMIL DocumentService API description
+ *
+ * The version of the OpenAPI document: 1.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 { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { Configuration } from '../configuration';
+import { RequestArgs, BaseAPI } from '../base';
+import { CreateDocTemplateRequestDto } from '../models';
+import { GetDocTemplateResponseClass } from '../models';
+import { ListDocTemplatesResponseClass } from '../models';
+import { UpdateDocTemplateRequestDto } from '../models';
+import { UpdateDocTemplateResponseClass } from '../models';
+/**
+ * DocumentTemplatesApi - axios parameter creator
+ * @export
+ */
+export declare const DocumentTemplatesApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @param {CreateDocTemplateRequestDto} createDocTemplateRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createDocTemplate: (createDocTemplateRequestDto: CreateDocTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteDocTemplate: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {string} id
+     * @param {number} id2 Template id
+     * @param {string} [authorization] Bearer Token
+     * @param {string} [expand]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDocTemplate: (id: string, id2: number, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @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}
+     */
+    listDocTemplates: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {number} id
+     * @param {UpdateDocTemplateRequestDto} updateDocTemplateRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateDocTemplate: (id: number, updateDocTemplateRequestDto: UpdateDocTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * DocumentTemplatesApi - functional programming interface
+ * @export
+ */
+export declare const DocumentTemplatesApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @param {CreateDocTemplateRequestDto} createDocTemplateRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createDocTemplate(createDocTemplateRequestDto: CreateDocTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
+    /**
+     *
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteDocTemplate(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
+    /**
+     *
+     * @param {string} id
+     * @param {number} id2 Template id
+     * @param {string} [authorization] Bearer Token
+     * @param {string} [expand]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDocTemplate(id: string, id2: number, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDocTemplateResponseClass>>;
+    /**
+     *
+     * @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}
+     */
+    listDocTemplates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDocTemplatesResponseClass>>;
+    /**
+     *
+     * @param {number} id
+     * @param {UpdateDocTemplateRequestDto} updateDocTemplateRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateDocTemplate(id: number, updateDocTemplateRequestDto: UpdateDocTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateDocTemplateResponseClass>>;
+};
+/**
+ * DocumentTemplatesApi - factory interface
+ * @export
+ */
+export declare const DocumentTemplatesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @param {CreateDocTemplateRequestDto} createDocTemplateRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createDocTemplate(createDocTemplateRequestDto: CreateDocTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<object>;
+    /**
+     *
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteDocTemplate(id: number, authorization?: string, options?: any): AxiosPromise<object>;
+    /**
+     *
+     * @param {string} id
+     * @param {number} id2 Template id
+     * @param {string} [authorization] Bearer Token
+     * @param {string} [expand]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDocTemplate(id: string, id2: number, authorization?: string, expand?: string, options?: any): AxiosPromise<GetDocTemplateResponseClass>;
+    /**
+     *
+     * @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}
+     */
+    listDocTemplates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListDocTemplatesResponseClass>;
+    /**
+     *
+     * @param {number} id
+     * @param {UpdateDocTemplateRequestDto} updateDocTemplateRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateDocTemplate(id: number, updateDocTemplateRequestDto: UpdateDocTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateDocTemplateResponseClass>;
+};
+/**
+ * Request parameters for createDocTemplate operation in DocumentTemplatesApi.
+ * @export
+ * @interface DocumentTemplatesApiCreateDocTemplateRequest
+ */
+export interface DocumentTemplatesApiCreateDocTemplateRequest {
+    /**
+     *
+     * @type {CreateDocTemplateRequestDto}
+     * @memberof DocumentTemplatesApiCreateDocTemplate
+     */
+    readonly createDocTemplateRequestDto: CreateDocTemplateRequestDto;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof DocumentTemplatesApiCreateDocTemplate
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for deleteDocTemplate operation in DocumentTemplatesApi.
+ * @export
+ * @interface DocumentTemplatesApiDeleteDocTemplateRequest
+ */
+export interface DocumentTemplatesApiDeleteDocTemplateRequest {
+    /**
+     *
+     * @type {number}
+     * @memberof DocumentTemplatesApiDeleteDocTemplate
+     */
+    readonly id: number;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof DocumentTemplatesApiDeleteDocTemplate
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getDocTemplate operation in DocumentTemplatesApi.
+ * @export
+ * @interface DocumentTemplatesApiGetDocTemplateRequest
+ */
+export interface DocumentTemplatesApiGetDocTemplateRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof DocumentTemplatesApiGetDocTemplate
+     */
+    readonly id: string;
+    /**
+     * Template id
+     * @type {number}
+     * @memberof DocumentTemplatesApiGetDocTemplate
+     */
+    readonly id2: number;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof DocumentTemplatesApiGetDocTemplate
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof DocumentTemplatesApiGetDocTemplate
+     */
+    readonly expand?: string;
+}
+/**
+ * Request parameters for listDocTemplates operation in DocumentTemplatesApi.
+ * @export
+ * @interface DocumentTemplatesApiListDocTemplatesRequest
+ */
+export interface DocumentTemplatesApiListDocTemplatesRequest {
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof DocumentTemplatesApiListDocTemplates
+     */
+    readonly authorization?: string;
+    /**
+     * Page size
+     * @type {number}
+     * @memberof DocumentTemplatesApiListDocTemplates
+     */
+    readonly pageSize?: number;
+    /**
+     * Page token
+     * @type {string}
+     * @memberof DocumentTemplatesApiListDocTemplates
+     */
+    readonly pageToken?: string;
+    /**
+     * List filter
+     * @type {string}
+     * @memberof DocumentTemplatesApiListDocTemplates
+     */
+    readonly filter?: string;
+    /**
+     * Search query
+     * @type {string}
+     * @memberof DocumentTemplatesApiListDocTemplates
+     */
+    readonly search?: string;
+    /**
+     * Ordering criteria
+     * @type {string}
+     * @memberof DocumentTemplatesApiListDocTemplates
+     */
+    readonly order?: string;
+    /**
+     * Extra fields to fetch
+     * @type {string}
+     * @memberof DocumentTemplatesApiListDocTemplates
+     */
+    readonly expand?: string;
+}
+/**
+ * Request parameters for updateDocTemplate operation in DocumentTemplatesApi.
+ * @export
+ * @interface DocumentTemplatesApiUpdateDocTemplateRequest
+ */
+export interface DocumentTemplatesApiUpdateDocTemplateRequest {
+    /**
+     *
+     * @type {number}
+     * @memberof DocumentTemplatesApiUpdateDocTemplate
+     */
+    readonly id: number;
+    /**
+     *
+     * @type {UpdateDocTemplateRequestDto}
+     * @memberof DocumentTemplatesApiUpdateDocTemplate
+     */
+    readonly updateDocTemplateRequestDto: UpdateDocTemplateRequestDto;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof DocumentTemplatesApiUpdateDocTemplate
+     */
+    readonly authorization?: string;
+}
+/**
+ * DocumentTemplatesApi - object-oriented interface
+ * @export
+ * @class DocumentTemplatesApi
+ * @extends {BaseAPI}
+ */
+export declare class DocumentTemplatesApi extends BaseAPI {
+    /**
+     *
+     * @param {DocumentTemplatesApiCreateDocTemplateRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentTemplatesApi
+     */
+    createDocTemplate(requestParameters: DocumentTemplatesApiCreateDocTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
+    /**
+     *
+     * @param {DocumentTemplatesApiDeleteDocTemplateRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentTemplatesApi
+     */
+    deleteDocTemplate(requestParameters: DocumentTemplatesApiDeleteDocTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
+    /**
+     *
+     * @param {DocumentTemplatesApiGetDocTemplateRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentTemplatesApi
+     */
+    getDocTemplate(requestParameters: DocumentTemplatesApiGetDocTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetDocTemplateResponseClass, any>>;
+    /**
+     *
+     * @param {DocumentTemplatesApiListDocTemplatesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentTemplatesApi
+     */
+    listDocTemplates(requestParameters?: DocumentTemplatesApiListDocTemplatesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListDocTemplatesResponseClass, any>>;
+    /**
+     *
+     * @param {DocumentTemplatesApiUpdateDocTemplateRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentTemplatesApi
+     */
+    updateDocTemplate(requestParameters: DocumentTemplatesApiUpdateDocTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateDocTemplateResponseClass, any>>;
+}