@emilgroup/document-sdk-node 1.2.0 → 1.2.1

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}
+     * 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
      */
-    'createdAt': object;
+    'productSlug'?: string;
     /**
-     * Template updated at
-     * @type {object}
+     * Time at which the object was created.
+     * @type {string}
      * @memberof DocTemplateClass
      */
-    'updatedAt': object;
+    'createdAt': string;
     /**
-     * Template updated at
-     * @type {object}
+     * Time at which the object was updated.
+     * @type {string}
+     * @memberof DocTemplateClass
+     */
+    'updatedAt': string;
+    /**
+     * Time at which the object was deleted.
+     * @type {string}
      * @memberof DocTemplateClass
      */
-    'deletedAt': object;
+    'deletedAt'?: string;
 }
 

package/models/document-class.ts

@@ -33,13 +33,13 @@ export interface DocumentClass {
      */
     'code': string;
     /**
-     * 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.
+     * 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 DocumentClass
      */
     'templateSlug': string;
     /**
-     * Document entity type
+     * Document entity type.
      * @type {string}
      * @memberof DocumentClass
      */
@@ -49,21 +49,27 @@ export interface DocumentClass {
      * @type {object}
      * @memberof DocumentClass
      */
-    'payload': object;
+    'payload'?: object;
     /**
-     * Unique identifier of the policy that the document belongs to
+     * Unique identifier of the policy that this object belongs to.
      * @type {string}
      * @memberof DocumentClass
      */
     'policyCode'?: string;
     /**
-     * Unique identifier of the account that the document belongs to
+     * Unique identifier of the account that this object belongs to.
      * @type {string}
      * @memberof DocumentClass
      */
     'accountCode'?: string;
     /**
-     * Unique identifier referencing the entity on the service the document belongs to.
+     * Unique identifier of the lead that this object belongs to.
+     * @type {string}
+     * @memberof DocumentClass
+     */
+    'leadCode'?: string;
+    /**
+     * Unique identifier referencing the entity.
      * @type {number}
      * @memberof DocumentClass
      */
@@ -75,11 +81,11 @@ export interface DocumentClass {
      */
     'requester': DocumentClassRequesterEnum;
     /**
-     * Metadata can contain extra information that the document would need for specific cases.
+     * Metadata contains extra information that the object would need for specific cases.
      * @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;
+    /**
+     * 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 DocumentClass
+     */
+    'productSlug'?: string;
     /**
      * Time at which the object was created.
      * @type {string}

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

@@ -21,13 +21,13 @@
  */
 export interface DownloadDocumentRequestDto {
     /**
-     * Document code
+     * 
      * @type {string}
      * @memberof DownloadDocumentRequestDto
      */
     'code': string;
     /**
-     * Document key
+     * 
      * @type {string}
      * @memberof DownloadDocumentRequestDto
      */

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

@@ -21,7 +21,7 @@
  */
 export interface GetDocTemplateRequestDto {
     /**
-     * Template id
+     * 
      * @type {number}
      * @memberof GetDocTemplateRequestDto
      */

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

@@ -22,7 +22,7 @@ import { DocTemplateClass } from './doc-template-class';
  */
 export interface GetDocTemplateResponseClass {
     /**
-     * Template
+     * Document template.
      * @type {DocTemplateClass}
      * @memberof GetDocTemplateResponseClass
      */

package/models/get-document-download-url-response-class.ts

@@ -21,7 +21,7 @@
  */
 export interface GetDocumentDownloadUrlResponseClass {
     /**
-     * Pre-signed Url
+     * Pre-signed Url.
      * @type {string}
      * @memberof GetDocumentDownloadUrlResponseClass
      */

package/models/get-layout-request-dto.ts

@@ -21,7 +21,7 @@
  */
 export interface GetLayoutRequestDto {
     /**
-     * Layout id
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
      * @type {number}
      * @memberof GetLayoutRequestDto
      */

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
+     * Time at which the template was deleted.
      * @type {string}
      * @memberof HtmlTemplateClass
      */

package/models/index.ts

@@ -1,9 +1,15 @@
 export * from './create-doc-template-request-dto';
+export * from './create-doc-template-response-class';
 export * from './create-document-request-dto';
+export * from './create-document-sync-response-class';
 export * from './create-html-template-dto';
 export * from './create-layout-request-dto';
+export * from './create-layout-response-class';
+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 './delete-response-class';
 export * from './doc-template-class';
 export * from './document-class';
 export * from './download-document-request-dto';
@@ -12,17 +18,25 @@ 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-template-request-dto';
 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';
+export * from './searchable-document-class';
+export * from './searchable-document-owner-class';
 export * from './update-doc-template-request-dto';
 export * from './update-doc-template-response-class';
 export * from './update-document-request-dto';
+export * from './update-document-response-class';
+export * from './update-html-template-dto';
 export * from './update-layout-request-dto';
 export * from './update-layout-response-class';

package/models/layout-class.ts

@@ -22,64 +22,64 @@ 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
      */
     'updatedAt': string;
     /**
-     * Layout deleted at
+     * Time at which the layout was deleted.
      * @type {string}
      * @memberof LayoutClass
      */
-    'deletedAt': string;
+    'deletedAt'?: string;
 }
 

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

@@ -0,0 +1,54 @@
+/* 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 ListDocTemplateRequestDto
+ */
+export interface ListDocTemplateRequestDto {
+    /**
+     * 
+     * @type {number}
+     * @memberof ListDocTemplateRequestDto
+     */
+    'pageSize'?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof ListDocTemplateRequestDto
+     */
+    'pageToken'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ListDocTemplateRequestDto
+     */
+    'filter'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ListDocTemplateRequestDto
+     */
+    'order'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ListDocTemplateRequestDto
+     */
+    'expand'?: string;
+}
+

package/models/list-doc-templates-response-class.ts

@@ -28,7 +28,7 @@ export interface ListDocTemplatesResponseClass {
      */
     'templates': Array<DocTemplateClass>;
     /**
-     * Next page token
+     * Next page token.
      * @type {string}
      * @memberof ListDocTemplatesResponseClass
      */

package/models/list-documents-response-class.ts

@@ -28,7 +28,7 @@ export interface ListDocumentsResponseClass {
      */
     'items': Array<DocumentClass>;
     /**
-     * Next page token
+     * Next page token.
      * @type {string}
      * @memberof ListDocumentsResponseClass
      */

package/models/list-layouts-response-class.ts

@@ -28,7 +28,7 @@ export interface ListLayoutsResponseClass {
      */
     'layouts': Array<LayoutClass>;
     /**
-     * Next page token
+     * Next page token.
      * @type {string}
      * @memberof ListLayoutsResponseClass
      */

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;
+}
+

package/models/list-search-keywords-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 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/models/list-searchable-document-owners-response-class.ts

@@ -13,6 +13,7 @@
  */
 
 
+import { SearchableDocumentOwnerClass } from './searchable-document-owner-class';
 
 /**
  * 
@@ -22,9 +23,9 @@
 export interface ListSearchableDocumentOwnersResponseClass {
     /**
      * Searchable document owners
-     * @type {Array<string>}
+     * @type {Array<SearchableDocumentOwnerClass>}
      * @memberof ListSearchableDocumentOwnersResponseClass
      */
-    'owners': Array<string>;
+    'owners': Array<SearchableDocumentOwnerClass>;
 }
 

package/models/list-searchable-documents-request-dto.ts

@@ -21,13 +21,13 @@
  */
 export interface ListSearchableDocumentsRequestDto {
     /**
-     * Text to search in the documents
+     * Text to search in the documents.
      * @type {string}
      * @memberof ListSearchableDocumentsRequestDto
      */
     'searchText': string;
     /**
-     * List of searched document owner IDs separated with | (search in all documents if an \'*\' list provided)
+     * List of searched document owner IDs separated with | (search in all documents if an \'*\' list provided).
      * @type {string}
      * @memberof ListSearchableDocumentsRequestDto
      */

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

@@ -13,6 +13,7 @@
  */
 
 
+import { SearchableDocumentClass } from './searchable-document-class';
 
 /**
  * 
@@ -21,13 +22,13 @@
  */
 export interface ListSearchableDocumentsResponseClass {
     /**
-     * Searchable documents that match the search criteria
-     * @type {Array<string>}
+     * Searchable documents that match the search criteria.
+     * @type {Array<SearchableDocumentClass>}
      * @memberof ListSearchableDocumentsResponseClass
      */
-    'documents': Array<string>;
+    'documents': Array<SearchableDocumentClass>;
     /**
-     * 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
      */