@emilgroup/document-sdk-node 1.1.0 → 1.2.1

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

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

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

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

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

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

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

@@ -16,7 +16,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/dist/models/html-template-class.d.ts

@@ -52,7 +52,7 @@ export interface HtmlTemplateClass {
      */
     'updatedAt': string;
     /**
-     * Template deleted at.
+     * Time at which the template was deleted.
      * @type {string}
      * @memberof HtmlTemplateClass
      */

package/dist/models/index.d.ts

@@ -1,12 +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';
@@ -18,6 +21,7 @@ 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';
@@ -27,8 +31,12 @@ 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/dist/models/index.js

@@ -17,12 +17,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./create-doc-template-request-dto"), exports);
 __exportStar(require("./create-doc-template-response-class"), exports);
 __exportStar(require("./create-document-request-dto"), exports);
+__exportStar(require("./create-document-sync-response-class"), exports);
 __exportStar(require("./create-html-template-dto"), exports);
 __exportStar(require("./create-layout-request-dto"), exports);
+__exportStar(require("./create-layout-response-class"), exports);
 __exportStar(require("./create-presigned-post-request-dto"), exports);
 __exportStar(require("./create-presigned-post-response-class"), exports);
 __exportStar(require("./delete-layout-request-dto"), exports);
 __exportStar(require("./delete-request-dto"), exports);
+__exportStar(require("./delete-response-class"), exports);
 __exportStar(require("./doc-template-class"), exports);
 __exportStar(require("./document-class"), exports);
 __exportStar(require("./download-document-request-dto"), exports);
@@ -34,6 +37,7 @@ __exportStar(require("./get-layout-response-class"), exports);
 __exportStar(require("./get-signed-s3-key-url-response-class"), exports);
 __exportStar(require("./html-template-class"), exports);
 __exportStar(require("./layout-class"), exports);
+__exportStar(require("./list-doc-template-request-dto"), exports);
 __exportStar(require("./list-doc-templates-response-class"), exports);
 __exportStar(require("./list-documents-response-class"), exports);
 __exportStar(require("./list-layouts-response-class"), exports);
@@ -43,8 +47,12 @@ __exportStar(require("./list-search-keywords-response-class"), exports);
 __exportStar(require("./list-searchable-document-owners-response-class"), exports);
 __exportStar(require("./list-searchable-documents-request-dto"), exports);
 __exportStar(require("./list-searchable-documents-response-class"), exports);
+__exportStar(require("./searchable-document-class"), exports);
+__exportStar(require("./searchable-document-owner-class"), exports);
 __exportStar(require("./update-doc-template-request-dto"), exports);
 __exportStar(require("./update-doc-template-response-class"), exports);
 __exportStar(require("./update-document-request-dto"), exports);
+__exportStar(require("./update-document-response-class"), exports);
+__exportStar(require("./update-html-template-dto"), exports);
 __exportStar(require("./update-layout-request-dto"), exports);
 __exportStar(require("./update-layout-response-class"), exports);

package/dist/models/layout-class.d.ts

@@ -71,7 +71,7 @@ export interface LayoutClass {
      */
     'updatedAt': string;
     /**
-     * Layout deleted at
+     * Time at which the layout was deleted.
      * @type {string}
      * @memberof LayoutClass
      */

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

@@ -0,0 +1,48 @@
+/**
+ * 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/dist/models/list-doc-template-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-doc-templates-response-class.d.ts

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

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

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

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

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

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

@@ -16,7 +16,7 @@
  */
 export interface ListSearchKeywordsRequestDto {
     /**
-     * Text to search in the documents
+     * Text to search in the documents.
      * @type {string}
      * @memberof ListSearchKeywordsRequestDto
      */

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

@@ -16,7 +16,7 @@
  */
 export interface ListSearchKeywordsResponseClass {
     /**
-     * Keywords used for search and to be highlighted in the document preview
+     * Keywords used for search and to be highlighted in the document preview.
      * @type {Array<string>}
      * @memberof ListSearchKeywordsResponseClass
      */

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

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { SearchableDocumentOwnerClass } from './searchable-document-owner-class';
 /**
  *
  * @export
@@ -17,8 +18,8 @@
 export interface ListSearchableDocumentOwnersResponseClass {
     /**
      * Searchable document owners
-     * @type {Array<string>}
+     * @type {Array<SearchableDocumentOwnerClass>}
      * @memberof ListSearchableDocumentOwnersResponseClass
      */
-    'owners': Array<string>;
+    'owners': Array<SearchableDocumentOwnerClass>;
 }

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

@@ -16,13 +16,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/dist/models/list-searchable-documents-response-class.d.ts

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { SearchableDocumentClass } from './searchable-document-class';
 /**
  *
  * @export
@@ -16,13 +17,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 the document preview
+     * Keywords used for search and to be highlighted in the document preview.
      * @type {Array<string>}
      * @memberof ListSearchableDocumentsResponseClass
      */

package/dist/models/searchable-document-class.d.ts

@@ -0,0 +1,66 @@
+/**
+ * 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 SearchableDocumentClass
+ */
+export interface SearchableDocumentClass {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof SearchableDocumentClass
+     */
+    'id': number;
+    /**
+     * Searchable document name.
+     * @type {string}
+     * @memberof SearchableDocumentClass
+     */
+    'name': string;
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof SearchableDocumentClass
+     */
+    'ownerId': number;
+    /**
+     * Searchable document owner name.
+     * @type {string}
+     * @memberof SearchableDocumentClass
+     */
+    'ownerName': string;
+    /**
+     * Headlines (snippets) from the document.
+     * @type {Array<string>}
+     * @memberof SearchableDocumentClass
+     */
+    'headlines': Array<string>;
+    /**
+     * S3 key of the searchable document file.
+     * @type {string}
+     * @memberof SearchableDocumentClass
+     */
+    's3Key': string;
+    /**
+     * Signed URL to download the document file from S3.
+     * @type {string}
+     * @memberof SearchableDocumentClass
+     */
+    'signedS3Url': string;
+    /**
+     * Rank of the document in the search.
+     * @type {number}
+     * @memberof SearchableDocumentClass
+     */
+    'rank': number;
+}

package/dist/models/searchable-document-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/searchable-document-owner-class.d.ts

@@ -0,0 +1,30 @@
+/**
+ * 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 SearchableDocumentOwnerClass
+ */
+export interface SearchableDocumentOwnerClass {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof SearchableDocumentOwnerClass
+     */
+    'id': number;
+    /**
+     * Searchable document owner name.
+     * @type {string}
+     * @memberof SearchableDocumentOwnerClass
+     */
+    'name': string;
+}

package/dist/models/searchable-document-owner-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/update-doc-template-request-dto.d.ts

@@ -9,7 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import { CreateHtmlTemplateDto } from './create-html-template-dto';
+import { UpdateHtmlTemplateDto } from './update-html-template-dto';
 /**
  *
  * @export
@@ -35,19 +35,19 @@ export interface UpdateDocTemplateRequestDto {
      */
     'layoutId': number;
     /**
-     *
-     * @type {CreateHtmlTemplateDto}
+     * Body templates.
+     * @type {UpdateHtmlTemplateDto}
      * @memberof UpdateDocTemplateRequestDto
      */
-    'bodyTemplate': CreateHtmlTemplateDto;
+    'bodyTemplate': UpdateHtmlTemplateDto;
     /**
-     * Product 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
      */
-    'productSlug'?: string | null;
+    'productSlug'?: string;
     /**
-     * Template id
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
      * @type {number}
      * @memberof UpdateDocTemplateRequestDto
      */

package/dist/models/update-doc-template-response-class.d.ts

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

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

@@ -16,31 +16,31 @@
  */
 export interface UpdateDocumentRequestDto {
     /**
-     * Document description
+     * Document description.
      * @type {string}
      * @memberof UpdateDocumentRequestDto
      */
     'description'?: string;
     /**
-     * Policy code
+     * Unique identifier of the policy that this object belongs to.
      * @type {string}
      * @memberof UpdateDocumentRequestDto
      */
     'policyCode'?: string;
     /**
-     * Account code
+     * Unique identifier of the account that this object belongs to.
      * @type {string}
      * @memberof UpdateDocumentRequestDto
      */
     'accountCode'?: string;
     /**
-     * Lead code
+     * Unique identifier of the lead that this object belongs to.
      * @type {string}
      * @memberof UpdateDocumentRequestDto
      */
     'leadCode'?: string;
     /**
-     * Entity id
+     * Unique identifier referencing the entity.
      * @type {number}
      * @memberof UpdateDocumentRequestDto
      */

package/dist/models/update-document-response-class.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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 { DocumentClass } from './document-class';
+/**
+ *
+ * @export
+ * @interface UpdateDocumentResponseClass
+ */
+export interface UpdateDocumentResponseClass {
+    /**
+     * Document
+     * @type {DocumentClass}
+     * @memberof UpdateDocumentResponseClass
+     */
+    'document': DocumentClass;
+}

package/dist/models/update-document-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/update-html-template-dto.d.ts

@@ -0,0 +1,42 @@
+/**
+ * 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 UpdateHtmlTemplateDto
+ */
+export interface UpdateHtmlTemplateDto {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof UpdateHtmlTemplateDto
+     */
+    'id': number;
+    /**
+     * Template type based on HTML layout elements: Header,Body and Footer.
+     * @type {string}
+     * @memberof UpdateHtmlTemplateDto
+     */
+    'type': UpdateHtmlTemplateDtoTypeEnum;
+    /**
+     * Template draft content.
+     * @type {string}
+     * @memberof UpdateHtmlTemplateDto
+     */
+    'draftContent': string;
+}
+export declare const UpdateHtmlTemplateDtoTypeEnum: {
+    readonly Header: "header";
+    readonly Footer: "footer";
+    readonly Body: "body";
+};
+export type UpdateHtmlTemplateDtoTypeEnum = typeof UpdateHtmlTemplateDtoTypeEnum[keyof typeof UpdateHtmlTemplateDtoTypeEnum];

package/dist/models/update-html-template-dto.js

@@ -0,0 +1,21 @@
+"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 });
+exports.UpdateHtmlTemplateDtoTypeEnum = void 0;
+exports.UpdateHtmlTemplateDtoTypeEnum = {
+    Header: 'header',
+    Footer: 'footer',
+    Body: 'body'
+};