@emilgroup/document-sdk 1.12.2 → 1.16.0

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

@@ -0,0 +1,385 @@
+/**
+ * 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 { CreateDocTemplateRequestDto } from '../models';
+import { CreateDocTemplateResponseClass } from '../models';
+import { DeleteResponseClass } 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) => {
+    /**
+     * This will create a document template.
+     * @summary Create the document template
+     * @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>;
+    /**
+     * Permanently deletes the document template. Supply the unique code that was returned when you created the document template and this will delete it.
+     * @summary Delete the document template
+     * @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>;
+    /**
+     * Retrieves the details of the document template that was previously created. Supply the unique document template id that was returned when you created it and Emil Api will return the corresponding document template information.
+     * @summary Retrieve the document template
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token
+     * @param {string} [expand] Use this parameter to fetch additional information about the list items.   The expand query parameter increases the set of fields that appear in the response in addition to the default ones.   Expanding resources can reduce the number of API calls required to accomplish a task. However,   use this with parsimony as some expanded fields can drastically increase payload size.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDocTemplate: (id: number, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns a list of document templates you have previously created. The document templates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List document templates
+     * @param {string} [authorization] Bearer Token
+     * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
+     * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list.   For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1,   your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
+     * @param {string} [filter] Filter response by productSlug, slug and name.
+     * @param {string} [search] Search document templates by name | slug
+     * @param {string} [order] Order response by createdAt.
+     * @param {string} [expand] Expand response by bodyTemplate.
+     * @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>;
+    /**
+     * Updates the specified document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the document template
+     * @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) => {
+    /**
+     * This will create a document template.
+     * @summary Create the document template
+     * @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<CreateDocTemplateResponseClass>>;
+    /**
+     * Permanently deletes the document template. Supply the unique code that was returned when you created the document template and this will delete it.
+     * @summary Delete the document template
+     * @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<DeleteResponseClass>>;
+    /**
+     * Retrieves the details of the document template that was previously created. Supply the unique document template id that was returned when you created it and Emil Api will return the corresponding document template information.
+     * @summary Retrieve the document template
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token
+     * @param {string} [expand] Use this parameter to fetch additional information about the list items.   The expand query parameter increases the set of fields that appear in the response in addition to the default ones.   Expanding resources can reduce the number of API calls required to accomplish a task. However,   use this with parsimony as some expanded fields can drastically increase payload size.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDocTemplate(id: number, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDocTemplateResponseClass>>;
+    /**
+     * Returns a list of document templates you have previously created. The document templates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List document templates
+     * @param {string} [authorization] Bearer Token
+     * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
+     * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list.   For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1,   your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
+     * @param {string} [filter] Filter response by productSlug, slug and name.
+     * @param {string} [search] Search document templates by name | slug
+     * @param {string} [order] Order response by createdAt.
+     * @param {string} [expand] Expand response by bodyTemplate.
+     * @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>>;
+    /**
+     * Updates the specified document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the document template
+     * @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) => {
+    /**
+     * This will create a document template.
+     * @summary Create the document template
+     * @param {CreateDocTemplateRequestDto} createDocTemplateRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createDocTemplate(createDocTemplateRequestDto: CreateDocTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<CreateDocTemplateResponseClass>;
+    /**
+     * Permanently deletes the document template. Supply the unique code that was returned when you created the document template and this will delete it.
+     * @summary Delete the document template
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteDocTemplate(id: number, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
+    /**
+     * Retrieves the details of the document template that was previously created. Supply the unique document template id that was returned when you created it and Emil Api will return the corresponding document template information.
+     * @summary Retrieve the document template
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token
+     * @param {string} [expand] Use this parameter to fetch additional information about the list items.   The expand query parameter increases the set of fields that appear in the response in addition to the default ones.   Expanding resources can reduce the number of API calls required to accomplish a task. However,   use this with parsimony as some expanded fields can drastically increase payload size.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDocTemplate(id: number, authorization?: string, expand?: string, options?: any): AxiosPromise<GetDocTemplateResponseClass>;
+    /**
+     * Returns a list of document templates you have previously created. The document templates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List document templates
+     * @param {string} [authorization] Bearer Token
+     * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
+     * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list.   For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1,   your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
+     * @param {string} [filter] Filter response by productSlug, slug and name.
+     * @param {string} [search] Search document templates by name | slug
+     * @param {string} [order] Order response by createdAt.
+     * @param {string} [expand] Expand response by bodyTemplate.
+     * @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>;
+    /**
+     * Updates the specified document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the document template
+     * @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 {number}
+     * @memberof DocumentTemplatesApiGetDocTemplate
+     */
+    readonly id: number;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof DocumentTemplatesApiGetDocTemplate
+     */
+    readonly authorization?: string;
+    /**
+     * Use this parameter to fetch additional information about the list items.   The expand query parameter increases the set of fields that appear in the response in addition to the default ones.   Expanding resources can reduce the number of API calls required to accomplish a task. However,   use this with parsimony as some expanded fields can drastically increase payload size.
+     * @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;
+    /**
+     * A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
+     * @type {number}
+     * @memberof DocumentTemplatesApiListDocTemplates
+     */
+    readonly pageSize?: number;
+    /**
+     * A cursor for use in pagination. pageToken is an ID that defines your place in the list.   For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1,   your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
+     * @type {string}
+     * @memberof DocumentTemplatesApiListDocTemplates
+     */
+    readonly pageToken?: string;
+    /**
+     * Filter response by productSlug, slug and name.
+     * @type {string}
+     * @memberof DocumentTemplatesApiListDocTemplates
+     */
+    readonly filter?: string;
+    /**
+     * Search document templates by name | slug
+     * @type {string}
+     * @memberof DocumentTemplatesApiListDocTemplates
+     */
+    readonly search?: string;
+    /**
+     * Order response by createdAt.
+     * @type {string}
+     * @memberof DocumentTemplatesApiListDocTemplates
+     */
+    readonly order?: string;
+    /**
+     * Expand response by bodyTemplate.
+     * @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 {
+    /**
+     * This will create a document template.
+     * @summary Create the document template
+     * @param {DocumentTemplatesApiCreateDocTemplateRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentTemplatesApi
+     */
+    createDocTemplate(requestParameters: DocumentTemplatesApiCreateDocTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateDocTemplateResponseClass, any>>;
+    /**
+     * Permanently deletes the document template. Supply the unique code that was returned when you created the document template and this will delete it.
+     * @summary Delete the document template
+     * @param {DocumentTemplatesApiDeleteDocTemplateRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentTemplatesApi
+     */
+    deleteDocTemplate(requestParameters: DocumentTemplatesApiDeleteDocTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any>>;
+    /**
+     * Retrieves the details of the document template that was previously created. Supply the unique document template id that was returned when you created it and Emil Api will return the corresponding document template information.
+     * @summary Retrieve the document template
+     * @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>>;
+    /**
+     * Returns a list of document templates you have previously created. The document templates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List document templates
+     * @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>>;
+    /**
+     * Updates the specified document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the document template
+     * @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>>;
+}