@emilgroup/document-sdk-node 1.2.0 → 1.2.1

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

@@ -13,6 +13,8 @@ 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';
@@ -23,7 +25,8 @@ import { UpdateDocTemplateResponseClass } from '../models';
  */
 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.
@@ -31,7 +34,8 @@ export declare const DocumentTemplatesApiAxiosParamCreator: (configuration?: Con
      */
     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.
@@ -39,30 +43,31 @@ export declare const DocumentTemplatesApiAxiosParamCreator: (configuration?: Con
      */
     deleteDocTemplate: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *
-     * @param {string} id
-     * @param {number} id2 Template id
+     * 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]
+     * @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: string, id2: number, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    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] 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 {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} [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>;
+    listDocTemplates: (authorization?: string, pageSize?: number, pageToken?: string, filter?: 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
@@ -77,46 +82,49 @@ export declare const DocumentTemplatesApiAxiosParamCreator: (configuration?: Con
  */
 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<object>>;
+    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<object>>;
+    deleteDocTemplate(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
     /**
-     *
-     * @param {string} id
-     * @param {number} id2 Template id
+     * 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]
+     * @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: string, id2: number, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDocTemplateResponseClass>>;
+    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] 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 {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} [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>>;
+    listDocTemplates(authorization?: string, pageSize?: number, pageToken?: string, filter?: 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
@@ -131,46 +139,49 @@ export declare const DocumentTemplatesApiFp: (configuration?: Configuration) =>
  */
 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<object>;
+    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<object>;
+    deleteDocTemplate(id: number, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
     /**
-     *
-     * @param {string} id
-     * @param {number} id2 Template id
+     * 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]
+     * @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: string, id2: number, authorization?: string, expand?: string, options?: any): AxiosPromise<GetDocTemplateResponseClass>;
+    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] 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 {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} [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>;
+    listDocTemplates(authorization?: string, pageSize?: number, pageToken?: string, filter?: 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
@@ -225,16 +236,10 @@ export interface DocumentTemplatesApiDeleteDocTemplateRequest {
 export interface DocumentTemplatesApiGetDocTemplateRequest {
     /**
      *
-     * @type {string}
-     * @memberof DocumentTemplatesApiGetDocTemplate
-     */
-    readonly id: string;
-    /**
-     * Template id
      * @type {number}
      * @memberof DocumentTemplatesApiGetDocTemplate
      */
-    readonly id2: number;
+    readonly id: number;
     /**
      * Bearer Token
      * @type {string}
@@ -242,7 +247,7 @@ export interface DocumentTemplatesApiGetDocTemplateRequest {
      */
     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
      */
@@ -261,37 +266,31 @@ export interface DocumentTemplatesApiListDocTemplatesRequest {
      */
     readonly authorization?: string;
     /**
-     * Page size
+     * 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;
     /**
-     * Page token
+     * 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;
     /**
-     * List filter
+     * Filter response by productSlug, slug and name.
      * @type {string}
      * @memberof DocumentTemplatesApiListDocTemplates
      */
     readonly filter?: string;
     /**
-     * Search query
-     * @type {string}
-     * @memberof DocumentTemplatesApiListDocTemplates
-     */
-    readonly search?: string;
-    /**
-     * Ordering criteria
+     * Order response by createdAt.
      * @type {string}
      * @memberof DocumentTemplatesApiListDocTemplates
      */
     readonly order?: string;
     /**
-     * Extra fields to fetch
+     * Expand response by bodyTemplate.
      * @type {string}
      * @memberof DocumentTemplatesApiListDocTemplates
      */
@@ -330,23 +329,26 @@ export interface DocumentTemplatesApiUpdateDocTemplateRequest {
  */
 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<object, any>>;
+    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<object, any>>;
+    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}
@@ -354,7 +356,8 @@ export declare class DocumentTemplatesApi extends BaseAPI {
      */
     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}
@@ -362,7 +365,8 @@ export declare class DocumentTemplatesApi extends BaseAPI {
      */
     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}