@emilgroup/document-sdk-node 1.2.0 → 1.3.0

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
      */

package/models/product-document-class.ts

@@ -0,0 +1,108 @@
+/* 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 ProductDocumentClass
+ */
+export interface ProductDocumentClass {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof ProductDocumentClass
+     */
+    'id': number;
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof ProductDocumentClass
+     */
+    'code': string;
+    /**
+     * Unique identifier of the product that this object belongs to.
+     * @type {string}
+     * @memberof ProductDocumentClass
+     */
+    'productCode': string;
+    /**
+     * Unique identifier referencing the product.
+     * @type {number}
+     * @memberof ProductDocumentClass
+     */
+    'productVersionId': number;
+    /**
+     * Type of the product document.
+     * @type {string}
+     * @memberof ProductDocumentClass
+     */
+    'type': string;
+    /**
+     * Description of the document. Usually a short summary about the      context in which the document is being used.
+     * @type {string}
+     * @memberof ProductDocumentClass
+     */
+    'description': string;
+    /**
+     * The unique key used by Amazon Simple Storage Service (S3).
+     * @type {string}
+     * @memberof ProductDocumentClass
+     */
+    's3Key': string;
+    /**
+     * Type of the document expressed with its file extension.
+     * @type {string}
+     * @memberof ProductDocumentClass
+     */
+    'contentType': ProductDocumentClassContentTypeEnum;
+    /**
+     * 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 ProductDocumentClass
+     */
+    'productSlug': string;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof ProductDocumentClass
+     */
+    'createdAt': string;
+}
+
+export const ProductDocumentClassContentTypeEnum = {
+    Pdf: 'pdf',
+    Jpg: 'jpg',
+    Png: 'png',
+    Gz: 'gz',
+    Csv: 'csv',
+    Doc: 'doc',
+    Docx: 'docx',
+    Html: 'html',
+    Json: 'json',
+    Xml: 'xml',
+    Txt: 'txt',
+    Zip: 'zip',
+    Tar: 'tar',
+    Rar: 'rar',
+    Mp4: 'MP4',
+    Mov: 'MOV',
+    Wmv: 'WMV',
+    Avi: 'AVI'
+} as const;
+
+export type ProductDocumentClassContentTypeEnum = typeof ProductDocumentClassContentTypeEnum[keyof typeof ProductDocumentClassContentTypeEnum];
+
+

package/models/searchable-document-class.ts

@@ -0,0 +1,72 @@
+/* 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 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/models/searchable-document-owner-class.ts

@@ -0,0 +1,36 @@
+/* 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 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/models/update-doc-template-request-dto.ts

@@ -13,7 +13,7 @@
  */
 
 
-import { CreateHtmlTemplateDto } from './create-html-template-dto';
+import { UpdateHtmlTemplateDto } from './update-html-template-dto';
 
 /**
  * 
@@ -22,34 +22,40 @@ 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;
+    /**
+     * Body templates.
+     * @type {UpdateHtmlTemplateDto}
+     * @memberof UpdateDocTemplateRequestDto
+     */
+    'bodyTemplate': UpdateHtmlTemplateDto;
     /**
-     * 
-     * @type {CreateHtmlTemplateDto}
+     * 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
      */
-    'bodyTemplate': CreateHtmlTemplateDto;
+    'productSlug'?: string;
     /**
-     * 
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
      * @type {number}
      * @memberof UpdateDocTemplateRequestDto
      */
-    'layoutId': number;
+    'id': number;
 }
 

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

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

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

@@ -21,25 +21,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;
     /**
-     * Entity id
+     * Unique identifier of the lead that this object belongs to.
+     * @type {string}
+     * @memberof UpdateDocumentRequestDto
+     */
+    'leadCode'?: string;
+    /**
+     * Unique identifier referencing the entity.
      * @type {number}
      * @memberof UpdateDocumentRequestDto
      */

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

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

@@ -0,0 +1,51 @@
+/* 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 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 const UpdateHtmlTemplateDtoTypeEnum = {
+    Header: 'header',
+    Footer: 'footer',
+    Body: 'body'
+} as const;
+
+export type UpdateHtmlTemplateDtoTypeEnum = typeof UpdateHtmlTemplateDtoTypeEnum[keyof typeof UpdateHtmlTemplateDtoTypeEnum];
+
+

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

@@ -13,7 +13,7 @@
  */
 
 
-import { CreateHtmlTemplateDto } from './create-html-template-dto';
+import { UpdateHtmlTemplateDto } from './update-html-template-dto';
 
 /**
  * 
@@ -22,40 +22,40 @@ import { CreateHtmlTemplateDto } from './create-html-template-dto';
  */
 export interface UpdateLayoutRequestDto {
     /**
-     * Layout name
+     * Layout name.
      * @type {string}
      * @memberof UpdateLayoutRequestDto
      */
     '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 UpdateLayoutRequestDto
      */
     'slug': string;
     /**
-     * Layout style
-     * @type {string}
+     * Header template.
+     * @type {UpdateHtmlTemplateDto}
      * @memberof UpdateLayoutRequestDto
      */
-    'style': string;
+    'headerTemplate': UpdateHtmlTemplateDto;
     /**
-     * Layout id
-     * @type {number}
+     * Footer template.
+     * @type {UpdateHtmlTemplateDto}
      * @memberof UpdateLayoutRequestDto
      */
-    'id': number;
+    'footerTemplate': UpdateHtmlTemplateDto;
     /**
-     * 
-     * @type {CreateHtmlTemplateDto}
+     * Layout style.
+     * @type {string}
      * @memberof UpdateLayoutRequestDto
      */
-    'headerTemplate': CreateHtmlTemplateDto;
+    'style': string;
     /**
-     * 
-     * @type {CreateHtmlTemplateDto}
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
      * @memberof UpdateLayoutRequestDto
      */
-    'footerTemplate': CreateHtmlTemplateDto;
+    'id': number;
 }
 

package/models/update-layout-response-class.ts

@@ -22,7 +22,7 @@ import { LayoutClass } from './layout-class';
  */
 export interface UpdateLayoutResponseClass {
     /**
-     * Layout id
+     * Layout
      * @type {LayoutClass}
      * @memberof UpdateLayoutResponseClass
      */

package/models/upload-product-document-request-dto.ts

@@ -0,0 +1,72 @@
+/* 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 UploadProductDocumentRequestDto
+ */
+export interface UploadProductDocumentRequestDto {
+    /**
+     * Slug of the product.
+     * @type {string}
+     * @memberof UploadProductDocumentRequestDto
+     */
+    'productSlug'?: string;
+    /**
+     * Extension of the file.
+     * @type {string}
+     * @memberof UploadProductDocumentRequestDto
+     */
+    'contentType': UploadProductDocumentRequestDtoContentTypeEnum;
+    /**
+     * Description of the document. Usually a short summary about the      context in which the document is being used.
+     * @type {string}
+     * @memberof UploadProductDocumentRequestDto
+     */
+    'description': string;
+    /**
+     * Name of the file the end user will see when he downloads it.
+     * @type {string}
+     * @memberof UploadProductDocumentRequestDto
+     */
+    'filename': string;
+    /**
+     * Type of the product document.
+     * @type {string}
+     * @memberof UploadProductDocumentRequestDto
+     */
+    'type': string;
+    /**
+     * Id of the product version, and is optional. If not provided, the document will be attached        to the latest version of the product.
+     * @type {number}
+     * @memberof UploadProductDocumentRequestDto
+     */
+    'productVersionId'?: number;
+}
+
+export const UploadProductDocumentRequestDtoContentTypeEnum = {
+    Pdf: 'pdf',
+    Jpg: 'jpg',
+    Png: 'png',
+    Csv: 'csv',
+    Doc: 'doc',
+    Docx: 'docx'
+} as const;
+
+export type UploadProductDocumentRequestDtoContentTypeEnum = typeof UploadProductDocumentRequestDtoContentTypeEnum[keyof typeof UploadProductDocumentRequestDtoContentTypeEnum];
+
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@emilgroup/document-sdk-node",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "OpenAPI client for @emilgroup/document-sdk-node",
   "author": "OpenAPI-Generator Contributors",
   "keywords": [
@@ -23,7 +23,7 @@
     "url": "^0.11.0"
   },
   "devDependencies": {
-   "@types/node": "^12.11.5",
+    "@types/node": "^12.11.5",
     "typescript": "^4.0"
   }
 }