@emilgroup/document-sdk-node 1.0.0 → 1.1.0

package/dist/models/list-search-keywords-request-dto.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/list-search-keywords-response-class.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface ListSearchKeywordsResponseClass
+ */
+export interface ListSearchKeywordsResponseClass {
+    /**
+     * Keywords used for search and to be highlighted in the document preview
+     * @type {Array<string>}
+     * @memberof ListSearchKeywordsResponseClass
+     */
+    'keywords': Array<string>;
+}

package/dist/models/list-search-keywords-response-class.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/list-searchable-documents-response-class.d.ts

@@ -22,7 +22,7 @@ export interface ListSearchableDocumentsResponseClass {
      */
     'documents': Array<string>;
     /**
-     * Keywords used for search and to be highlighted in teh document preview
+     * Keywords used for search and to be highlighted in the document preview
      * @type {Array<string>}
      * @memberof ListSearchableDocumentsResponseClass
      */

package/dist/models/update-doc-template-request-dto.d.ts

@@ -17,23 +17,23 @@ import { CreateHtmlTemplateDto } from './create-html-template-dto';
  */
 export interface UpdateDocTemplateRequestDto {
     /**
-     * Template name
+     * Template name.
      * @type {string}
      * @memberof UpdateDocTemplateRequestDto
      */
     'name': string;
     /**
-     * Template slug
+     * A slug is a human-readable, unique identifier, used to identify a resource      instead of a less human-readable identifier like an id.
      * @type {string}
      * @memberof UpdateDocTemplateRequestDto
      */
     'slug': string;
     /**
-     * Template id
+     * Unique identifier referencing the layout.
      * @type {number}
      * @memberof UpdateDocTemplateRequestDto
      */
-    'id': number;
+    'layoutId': number;
     /**
      *
      * @type {CreateHtmlTemplateDto}
@@ -41,9 +41,15 @@ export interface UpdateDocTemplateRequestDto {
      */
     'bodyTemplate': CreateHtmlTemplateDto;
     /**
-     *
+     * Product slug
+     * @type {string}
+     * @memberof UpdateDocTemplateRequestDto
+     */
+    'productSlug'?: string | null;
+    /**
+     * Template id
      * @type {number}
      * @memberof UpdateDocTemplateRequestDto
      */
-    'layoutId': number;
+    'id': number;
 }

package/dist/models/update-document-request-dto.d.ts

@@ -33,6 +33,12 @@ export interface UpdateDocumentRequestDto {
      * @memberof UpdateDocumentRequestDto
      */
     'accountCode'?: string;
+    /**
+     * Lead code
+     * @type {string}
+     * @memberof UpdateDocumentRequestDto
+     */
+    'leadCode'?: string;
     /**
      * Entity id
      * @type {number}

package/index.ts

@@ -13,7 +13,7 @@
  */
 
 
-export { BaseAPI } from "./base";
+export { Environment, BaseAPI } from "./base";
 export * from "./api";
 export * from "./configuration";
 export * from "./models";

package/models/create-doc-template-request-dto.ts

@@ -22,19 +22,19 @@ import { CreateHtmlTemplateDto } from './create-html-template-dto';
  */
 export interface CreateDocTemplateRequestDto {
     /**
-     * Template name
+     * Template name.
      * @type {string}
      * @memberof CreateDocTemplateRequestDto
      */
     'name': string;
     /**
-     * Template slug
+     * A slug is a human-readable, unique identifier, used to identify a resource      instead of a less human-readable identifier like an id.
      * @type {string}
      * @memberof CreateDocTemplateRequestDto
      */
     'slug': string;
     /**
-     * 
+     * Unique identifier referencing the layout.
      * @type {number}
      * @memberof CreateDocTemplateRequestDto
      */
@@ -45,5 +45,11 @@ export interface CreateDocTemplateRequestDto {
      * @memberof CreateDocTemplateRequestDto
      */
     'bodyTemplate': CreateHtmlTemplateDto;
+    /**
+     * Product slug
+     * @type {string}
+     * @memberof CreateDocTemplateRequestDto
+     */
+    'productSlug'?: string | null;
 }
 

package/models/create-doc-template-response-class.ts

@@ -0,0 +1,31 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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 { DocTemplateClass } from './doc-template-class';
+
+/**
+ * 
+ * @export
+ * @interface CreateDocTemplateResponseClass
+ */
+export interface CreateDocTemplateResponseClass {
+    /**
+     * 
+     * @type {DocTemplateClass}
+     * @memberof CreateDocTemplateResponseClass
+     */
+    'template': DocTemplateClass;
+}
+

package/models/create-document-request-dto.ts

@@ -62,6 +62,12 @@ export interface CreateDocumentRequestDto {
      * @memberof CreateDocumentRequestDto
      */
     'accountCode'?: string;
+    /**
+     * Unique identifier of the lead that the document belongs to
+     * @type {string}
+     * @memberof CreateDocumentRequestDto
+     */
+    'leadCode'?: string;
     /**
      * Unique identifier referencing the entity on the service the document belongs to.
      * @type {number}
@@ -92,6 +98,12 @@ export interface CreateDocumentRequestDto {
      * @memberof CreateDocumentRequestDto
      */
     'filename'?: string;
+    /**
+     * The product slug that this file belong to.
+     * @type {string}
+     * @memberof CreateDocumentRequestDto
+     */
+    'productSlug'?: string | null;
 }
 
 export const CreateDocumentRequestDtoEntityTypeEnum = {

package/models/create-html-template-dto.ts

@@ -21,7 +21,7 @@
  */
 export interface CreateHtmlTemplateDto {
     /**
-     * Template draft content
+     * Template draft content.
      * @type {string}
      * @memberof CreateHtmlTemplateDto
      */

package/models/create-presigned-post-request-dto.ts

@@ -21,7 +21,7 @@
  */
 export interface CreatePresignedPostRequestDto {
     /**
-     * Document template slug
+     * A slug is a human-readable, unique identifier, used to identify a resource        instead of a less human-readable identifier like an id. In this case, the template used for this document.
      * @type {string}
      * @memberof CreatePresignedPostRequestDto
      */
@@ -33,41 +33,65 @@ export interface CreatePresignedPostRequestDto {
      */
     'entityType': string;
     /**
-     * Document description
+     * Identifier of the entity that the document is related to
+     * @type {number}
+     * @memberof CreatePresignedPostRequestDto
+     */
+    'entityId': number;
+    /**
+     * Description of the document. Usually a short summary about the      context in which the document is being used.
      * @type {string}
      * @memberof CreatePresignedPostRequestDto
      */
     'description': string;
     /**
-     * Unique identifier for policy
+     * Unique identifier of the policy that the document belongs to
      * @type {string}
      * @memberof CreatePresignedPostRequestDto
      */
     'policyCode'?: string;
     /**
-     * Unique identifier for account
+     * Unique identifier of the account that the document belongs to
      * @type {string}
      * @memberof CreatePresignedPostRequestDto
      */
     'accountCode'?: string;
     /**
-     * Document requester
+     * Unique identifier of the lead that the document belongs to
+     * @type {string}
+     * @memberof CreatePresignedPostRequestDto
+     */
+    'leadCode'?: string;
+    /**
+     * Identifier of the service that requested the creation of this document.
      * @type {string}
      * @memberof CreatePresignedPostRequestDto
      */
     'requester': CreatePresignedPostRequestDtoRequesterEnum;
     /**
-     * Document content type
+     * Extension of the file
      * @type {string}
      * @memberof CreatePresignedPostRequestDto
      */
     'contentType': CreatePresignedPostRequestDtoContentTypeEnum;
     /**
-     * 
+     * Content type of the file
+     * @type {string}
+     * @memberof CreatePresignedPostRequestDto
+     */
+    'isoContentType': string;
+    /**
+     * Name of the file the end user will see when he downloads it.
      * @type {string}
      * @memberof CreatePresignedPostRequestDto
      */
     'filename': string;
+    /**
+     * The product slug that this file belong to.
+     * @type {string}
+     * @memberof CreatePresignedPostRequestDto
+     */
+    'productSlug'?: string | null;
 }
 
 export const CreatePresignedPostRequestDtoRequesterEnum = {

package/models/doc-template-class.ts

@@ -23,64 +23,70 @@ import { LayoutClass } from './layout-class';
  */
 export interface DocTemplateClass {
     /**
-     * Template id
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
      * @type {number}
      * @memberof DocTemplateClass
      */
     'id': number;
     /**
-     * Record owner
+     * Record owner.
      * @type {string}
      * @memberof DocTemplateClass
      */
-    'owner': string;
+    'owner'?: string;
     /**
-     * Template name
+     * Template name.
      * @type {string}
      * @memberof DocTemplateClass
      */
     'name': string;
     /**
-     * Template slug
+     * A slug is a human-readable, unique identifier, used to identify a resource      instead of a less human-readable identifier like an id.
      * @type {string}
      * @memberof DocTemplateClass
      */
     'slug': string;
     /**
-     * Layout id
+     * Unique identifier referencing the layout.
      * @type {number}
      * @memberof DocTemplateClass
      */
     'layoutId': number;
     /**
-     * Body Template
+     * Body Template.
      * @type {HtmlTemplateClass}
      * @memberof DocTemplateClass
      */
-    'bodyTemplate': HtmlTemplateClass;
+    'bodyTemplate'?: HtmlTemplateClass;
     /**
-     * Template Layout
+     * Template Layout.
      * @type {LayoutClass}
      * @memberof DocTemplateClass
      */
-    'layout': LayoutClass;
+    'layout'?: LayoutClass;
     /**
-     * Template created at
-     * @type {object}
+     * Product slug.
+     * @type {string}
      * @memberof DocTemplateClass
      */
-    'createdAt': object;
+    'productSlug'?: string;
     /**
-     * Template updated at
-     * @type {object}
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof DocTemplateClass
+     */
+    'createdAt': string;
+    /**
+     * Time at which the object was updated.
+     * @type {string}
      * @memberof DocTemplateClass
      */
-    'updatedAt': object;
+    'updatedAt': string;
     /**
      * Template updated at
-     * @type {object}
+     * @type {string}
      * @memberof DocTemplateClass
      */
-    'deletedAt': object;
+    'deletedAt'?: string;
 }
 

package/models/document-class.ts

@@ -49,7 +49,7 @@ export interface DocumentClass {
      * @type {object}
      * @memberof DocumentClass
      */
-    'payload': object;
+    'payload'?: object;
     /**
      * Unique identifier of the policy that the document belongs to
      * @type {string}
@@ -62,6 +62,12 @@ export interface DocumentClass {
      * @memberof DocumentClass
      */
     'accountCode'?: string;
+    /**
+     * Unique identifier of the lead that the document belongs to
+     * @type {string}
+     * @memberof DocumentClass
+     */
+    'leadCode'?: string;
     /**
      * Unique identifier referencing the entity on the service the document belongs to.
      * @type {number}
@@ -79,7 +85,7 @@ export interface DocumentClass {
      * @type {object}
      * @memberof DocumentClass
      */
-    'metadata': object;
+    'metadata'?: object;
     /**
      * Description of the document. Usually a short summary about the      context in which the document is being used.
      * @type {string}
@@ -98,6 +104,12 @@ export interface DocumentClass {
      * @memberof DocumentClass
      */
     'contentType': DocumentClassContentTypeEnum;
+    /**
+     * Product that this document belong to
+     * @type {string}
+     * @memberof DocumentClass
+     */
+    'productSlug'?: string;
     /**
      * Time at which the object was created.
      * @type {string}

package/models/get-signed-s3-key-url-response-class.ts

@@ -0,0 +1,30 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface GetSignedS3KeyUrlResponseClass
+ */
+export interface GetSignedS3KeyUrlResponseClass {
+    /**
+     * Pre-signed Url
+     * @type {string}
+     * @memberof GetSignedS3KeyUrlResponseClass
+     */
+    'url': string;
+}
+

package/models/html-template-class.ts

@@ -21,43 +21,43 @@
  */
 export interface HtmlTemplateClass {
     /**
-     * Template id
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
      * @type {number}
      * @memberof HtmlTemplateClass
      */
     'id': number;
     /**
-     * Template type
+     * Template type of HTML layout elements: Header,Body and Footer.
      * @type {string}
      * @memberof HtmlTemplateClass
      */
     'type': HtmlTemplateClassTypeEnum;
     /**
-     * Template content
+     * Template content.
      * @type {string}
      * @memberof HtmlTemplateClass
      */
     'content': string;
     /**
-     * Template draft content
+     * Template draft content.
      * @type {string}
      * @memberof HtmlTemplateClass
      */
     'draftContent': string;
     /**
-     * Template created at
+     * Time at which the object was created.
      * @type {string}
      * @memberof HtmlTemplateClass
      */
     'createdAt': string;
     /**
-     * Template updated at
+     * Time at which the object was updated.
      * @type {string}
      * @memberof HtmlTemplateClass
      */
     'updatedAt': string;
     /**
-     * Template updated at
+     * Template deleted at.
      * @type {string}
      * @memberof HtmlTemplateClass
      */

package/models/index.ts

@@ -1,7 +1,10 @@
 export * from './create-doc-template-request-dto';
+export * from './create-doc-template-response-class';
 export * from './create-document-request-dto';
 export * from './create-html-template-dto';
 export * from './create-layout-request-dto';
+export * from './create-presigned-post-request-dto';
+export * from './create-presigned-post-response-class';
 export * from './delete-layout-request-dto';
 export * from './delete-request-dto';
 export * from './doc-template-class';
@@ -12,12 +15,15 @@ export * from './get-doc-template-response-class';
 export * from './get-document-download-url-response-class';
 export * from './get-layout-request-dto';
 export * from './get-layout-response-class';
+export * from './get-signed-s3-key-url-response-class';
 export * from './html-template-class';
 export * from './layout-class';
 export * from './list-doc-templates-response-class';
 export * from './list-documents-response-class';
 export * from './list-layouts-response-class';
 export * from './list-request-dto';
+export * from './list-search-keywords-request-dto';
+export * from './list-search-keywords-response-class';
 export * from './list-searchable-document-owners-response-class';
 export * from './list-searchable-documents-request-dto';
 export * from './list-searchable-documents-response-class';

package/models/layout-class.ts

@@ -22,55 +22,55 @@ import { HtmlTemplateClass } from './html-template-class';
  */
 export interface LayoutClass {
     /**
-     * Layout id
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
      * @type {number}
      * @memberof LayoutClass
      */
     'id': number;
     /**
-     * Record owner
+     * Record owner.
      * @type {string}
      * @memberof LayoutClass
      */
     'owner': string;
     /**
-     * Layout name
+     * Layout name.
      * @type {string}
      * @memberof LayoutClass
      */
     'name': string;
     /**
-     * Layout slug
+     * A slug is a human-readable, unique identifier, used to identify a resource      instead of a less human-readable identifier like an id.
      * @type {string}
      * @memberof LayoutClass
      */
     'slug': string;
     /**
-     * Layout style
+     * Layout style.
      * @type {string}
      * @memberof LayoutClass
      */
     'style': string;
     /**
-     * Header Template
+     * Header Template.
      * @type {HtmlTemplateClass}
      * @memberof LayoutClass
      */
     'headerTemplate': HtmlTemplateClass;
     /**
-     * Footer Template
+     * Footer Template.
      * @type {HtmlTemplateClass}
      * @memberof LayoutClass
      */
     'footerTemplate': HtmlTemplateClass;
     /**
-     * Layout created at
+     * Time at which the object was created.
      * @type {string}
      * @memberof LayoutClass
      */
     'createdAt': string;
     /**
-     * Layout updated at
+     * Time at which the object was updated.
      * @type {string}
      * @memberof LayoutClass
      */
@@ -80,6 +80,6 @@ export interface LayoutClass {
      * @type {string}
      * @memberof LayoutClass
      */
-    'deletedAt': string;
+    'deletedAt'?: string;
 }
 

package/models/list-search-keywords-request-dto.ts

@@ -0,0 +1,30 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface ListSearchKeywordsRequestDto
+ */
+export interface ListSearchKeywordsRequestDto {
+    /**
+     * Text to search in the documents
+     * @type {string}
+     * @memberof ListSearchKeywordsRequestDto
+     */
+    'searchText': string;
+}
+