@emilgroup/document-sdk-node 1.1.0 → 1.2.1

package/.openapi-generator/FILES

@@ -17,12 +17,15 @@ index.ts
 models/create-doc-template-request-dto.ts
 models/create-doc-template-response-class.ts
 models/create-document-request-dto.ts
+models/create-document-sync-response-class.ts
 models/create-html-template-dto.ts
 models/create-layout-request-dto.ts
+models/create-layout-response-class.ts
 models/create-presigned-post-request-dto.ts
 models/create-presigned-post-response-class.ts
 models/delete-layout-request-dto.ts
 models/delete-request-dto.ts
+models/delete-response-class.ts
 models/doc-template-class.ts
 models/document-class.ts
 models/download-document-request-dto.ts
@@ -35,6 +38,7 @@ models/get-signed-s3-key-url-response-class.ts
 models/html-template-class.ts
 models/index.ts
 models/layout-class.ts
+models/list-doc-template-request-dto.ts
 models/list-doc-templates-response-class.ts
 models/list-documents-response-class.ts
 models/list-layouts-response-class.ts
@@ -44,9 +48,13 @@ models/list-search-keywords-response-class.ts
 models/list-searchable-document-owners-response-class.ts
 models/list-searchable-documents-request-dto.ts
 models/list-searchable-documents-response-class.ts
+models/searchable-document-class.ts
+models/searchable-document-owner-class.ts
 models/update-doc-template-request-dto.ts
 models/update-doc-template-response-class.ts
 models/update-document-request-dto.ts
+models/update-document-response-class.ts
+models/update-html-template-dto.ts
 models/update-layout-request-dto.ts
 models/update-layout-response-class.ts
 package.json

package/README.md

@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
 Navigate to the folder of your consuming project and run one of the following commands:
 
 ```
-npm install @emilgroup/document-sdk-node@1.1.0 --save
+npm install @emilgroup/document-sdk-node@1.2.1 --save
 ```
 or 
 ```
-yarn add @emilgroup/document-sdk-node@1.1.0
+yarn add @emilgroup/document-sdk-node@1.2.1
 ```
 
 And then you can import `DocumentsApi`.

package/api/document-templates-api.ts

@@ -25,6 +25,8 @@ import { CreateDocTemplateRequestDto } from '../models';
 // @ts-ignore
 import { CreateDocTemplateResponseClass } from '../models';
 // @ts-ignore
+import { DeleteResponseClass } from '../models';
+// @ts-ignore
 import { GetDocTemplateResponseClass } from '../models';
 // @ts-ignore
 import { ListDocTemplatesResponseClass } from '../models';
@@ -43,7 +45,8 @@ const FormData = require('form-data');
 export const DocumentTemplatesApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
         /**
-         * 
+         * 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.
@@ -89,7 +92,8 @@ export const DocumentTemplatesApiAxiosParamCreator = function (configuration?: C
             };
         },
         /**
-         * 
+         * 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.
@@ -133,19 +137,17 @@ export const DocumentTemplatesApiAxiosParamCreator = function (configuration?: C
             };
         },
         /**
-         * 
-         * @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: async (id: string, id2: number, authorization?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+        getDocTemplate: async (id: number, authorization?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'id' is not null or undefined
             assertParamExists('getDocTemplate', 'id', id)
-            // verify required parameter 'id2' is not null or undefined
-            assertParamExists('getDocTemplate', 'id2', id2)
             const localVarPath = `/documentservice/v1/doc-templates/{id}`
                 .replace(`{${"id"}}`, encodeURIComponent(String(id)));
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -165,10 +167,6 @@ export const DocumentTemplatesApiAxiosParamCreator = function (configuration?: C
             // http bearer authentication required
             await setBearerAuthToObject(localVarHeaderParameter, configuration)
 
-            if (id2 !== undefined) {
-                localVarQueryParameter['id'] = id2;
-            }
-
             if (expand !== undefined) {
                 localVarQueryParameter['expand'] = expand;
             }
@@ -189,18 +187,18 @@ export const DocumentTemplatesApiAxiosParamCreator = function (configuration?: C
             };
         },
         /**
-         * 
+         * 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: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+        listDocTemplates: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
             const localVarPath = `/documentservice/v1/doc-templates`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -231,10 +229,6 @@ export const DocumentTemplatesApiAxiosParamCreator = function (configuration?: C
                 localVarQueryParameter['filter'] = filter;
             }
 
-            if (search !== undefined) {
-                localVarQueryParameter['search'] = search;
-            }
-
             if (order !== undefined) {
                 localVarQueryParameter['order'] = order;
             }
@@ -259,7 +253,8 @@ export const DocumentTemplatesApiAxiosParamCreator = function (configuration?: C
             };
         },
         /**
-         * 
+         * 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
@@ -319,7 +314,8 @@ export const DocumentTemplatesApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = DocumentTemplatesApiAxiosParamCreator(configuration)
     return {
         /**
-         * 
+         * 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.
@@ -330,47 +326,49 @@ export const DocumentTemplatesApiFp = function(configuration?: Configuration) {
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
-         * 
+         * 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}
          */
-        async deleteDocTemplate(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>> {
+        async deleteDocTemplate(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>> {
             const localVarAxiosArgs = await localVarAxiosParamCreator.deleteDocTemplate(id, authorization, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
-         * 
-         * @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}
          */
-        async getDocTemplate(id: string, id2: number, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDocTemplateResponseClass>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.getDocTemplate(id, id2, authorization, expand, options);
+        async getDocTemplate(id: number, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDocTemplateResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getDocTemplate(id, authorization, expand, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
-         * 
+         * 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}
          */
-        async listDocTemplates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDocTemplatesResponseClass>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.listDocTemplates(authorization, pageSize, pageToken, filter, search, order, expand, options);
+        async listDocTemplates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDocTemplatesResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listDocTemplates(authorization, pageSize, pageToken, filter, order, expand, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
-         * 
+         * 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
@@ -392,7 +390,8 @@ export const DocumentTemplatesApiFactory = function (configuration?: Configurati
     const localVarFp = DocumentTemplatesApiFp(configuration)
     return {
         /**
-         * 
+         * 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.
@@ -402,44 +401,46 @@ export const DocumentTemplatesApiFactory = function (configuration?: Configurati
             return localVarFp.createDocTemplate(createDocTemplateRequestDto, authorization, options).then((request) => request(axios, basePath));
         },
         /**
-         * 
+         * 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> {
             return localVarFp.deleteDocTemplate(id, authorization, options).then((request) => request(axios, basePath));
         },
         /**
-         * 
-         * @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> {
-            return localVarFp.getDocTemplate(id, id2, authorization, expand, options).then((request) => request(axios, basePath));
+        getDocTemplate(id: number, authorization?: string, expand?: string, options?: any): AxiosPromise<GetDocTemplateResponseClass> {
+            return localVarFp.getDocTemplate(id, authorization, expand, options).then((request) => request(axios, basePath));
         },
         /**
-         * 
+         * 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> {
-            return localVarFp.listDocTemplates(authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
+        listDocTemplates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListDocTemplatesResponseClass> {
+            return localVarFp.listDocTemplates(authorization, pageSize, pageToken, filter, order, expand, options).then((request) => request(axios, basePath));
         },
         /**
-         * 
+         * 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
@@ -502,17 +503,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
@@ -522,7 +516,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
      */
@@ -543,42 +537,35 @@ 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
      */
@@ -621,7 +608,8 @@ export interface DocumentTemplatesApiUpdateDocTemplateRequest {
  */
 export 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}
@@ -632,7 +620,8 @@ export class DocumentTemplatesApi extends BaseAPI {
     }
 
     /**
-     * 
+     * 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}
@@ -643,29 +632,32 @@ export class DocumentTemplatesApi extends BaseAPI {
     }
 
     /**
-     * 
+     * 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
      */
     public getDocTemplate(requestParameters: DocumentTemplatesApiGetDocTemplateRequest, options?: AxiosRequestConfig) {
-        return DocumentTemplatesApiFp(this.configuration).getDocTemplate(requestParameters.id, requestParameters.id2, requestParameters.authorization, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
+        return DocumentTemplatesApiFp(this.configuration).getDocTemplate(requestParameters.id, requestParameters.authorization, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**
-     * 
+     * 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
      */
     public listDocTemplates(requestParameters: DocumentTemplatesApiListDocTemplatesRequest = {}, options?: AxiosRequestConfig) {
-        return DocumentTemplatesApiFp(this.configuration).listDocTemplates(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
+        return DocumentTemplatesApiFp(this.configuration).listDocTemplates(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**
-     * 
+     * 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}