@emilgroup/document-sdk-node 1.1.0 → 1.2.1

package/dist/models/update-layout-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
@@ -17,39 +17,39 @@ 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/dist/models/update-layout-response-class.d.ts

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

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

@@ -40,16 +40,16 @@ export interface CreateDocTemplateRequestDto {
      */
     'layoutId': number;
     /**
-     * 
+     * Body template.
      * @type {CreateHtmlTemplateDto}
      * @memberof CreateDocTemplateRequestDto
      */
     'bodyTemplate': CreateHtmlTemplateDto;
     /**
-     * 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 CreateDocTemplateRequestDto
      */
-    'productSlug'?: string | null;
+    'productSlug'?: string;
 }
 

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

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

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

@@ -21,7 +21,7 @@
  */
 export interface CreateDocumentRequestDto {
     /**
-     * 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 CreateDocumentRequestDto
      */
@@ -33,13 +33,13 @@ export interface CreateDocumentRequestDto {
      */
     'payload': object;
     /**
-     * Document entity type
+     * Document entity type.
      * @type {string}
      * @memberof CreateDocumentRequestDto
      */
     'entityType': CreateDocumentRequestDtoEntityTypeEnum;
     /**
-     * Description of the document. Usually a short summary about the      context in which the document is being used.
+     * Specifies the document creation strategy to be used, either synchronous or asynchronous.
      * @type {string}
      * @memberof CreateDocumentRequestDto
      */
@@ -51,25 +51,25 @@ export interface CreateDocumentRequestDto {
      */
     'description': string;
     /**
-     * Unique identifier of the policy that the document belongs to
+     * Unique identifier of the policy that this object belongs to.
      * @type {string}
      * @memberof CreateDocumentRequestDto
      */
     '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 CreateDocumentRequestDto
      */
     'accountCode'?: string;
     /**
-     * Unique identifier of the lead that the document belongs to
+     * Unique identifier of the lead that this object belongs to.
      * @type {string}
      * @memberof CreateDocumentRequestDto
      */
     'leadCode'?: string;
     /**
-     * Unique identifier referencing the entity on the service the document belongs to.
+     * Unique identifier referencing the entity.
      * @type {number}
      * @memberof CreateDocumentRequestDto
      */
@@ -81,7 +81,7 @@ export interface CreateDocumentRequestDto {
      */
     'requester': CreateDocumentRequestDtoRequesterEnum;
     /**
-     * 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 CreateDocumentRequestDto
      */
@@ -91,7 +91,7 @@ export interface CreateDocumentRequestDto {
      * @type {string}
      * @memberof CreateDocumentRequestDto
      */
-    'contentType'?: CreateDocumentRequestDtoContentTypeEnum;
+    'contentType': CreateDocumentRequestDtoContentTypeEnum;
     /**
      * Name of the file the end user will see when he downloads it.
      * @type {string}
@@ -99,11 +99,11 @@ export interface CreateDocumentRequestDto {
      */
     'filename'?: string;
     /**
-     * The product slug that this file belong to.
+     * 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 CreateDocumentRequestDto
      */
-    'productSlug'?: string | null;
+    'productSlug'?: string;
 }
 
 export const CreateDocumentRequestDtoEntityTypeEnum = {

package/models/create-document-sync-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 CreateDocumentSyncResponseClass
+ */
+export interface CreateDocumentSyncResponseClass {
+    /**
+     * Document
+     * @type {DocumentClass}
+     * @memberof CreateDocumentSyncResponseClass
+     */
+    'document': DocumentClass;
+}
+

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

@@ -22,34 +22,34 @@ import { CreateHtmlTemplateDto } from './create-html-template-dto';
  */
 export interface CreateLayoutRequestDto {
     /**
-     * Layout name
+     * Layout name.
      * @type {string}
      * @memberof CreateLayoutRequestDto
      */
     '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 CreateLayoutRequestDto
      */
     'slug': string;
     /**
-     * Layout style
-     * @type {string}
-     * @memberof CreateLayoutRequestDto
-     */
-    'style': string;
-    /**
-     * 
+     * Header template.
      * @type {CreateHtmlTemplateDto}
      * @memberof CreateLayoutRequestDto
      */
     'headerTemplate': CreateHtmlTemplateDto;
     /**
-     * 
+     * Footer template.
      * @type {CreateHtmlTemplateDto}
      * @memberof CreateLayoutRequestDto
      */
     'footerTemplate': CreateHtmlTemplateDto;
+    /**
+     * Layout style.
+     * @type {string}
+     * @memberof CreateLayoutRequestDto
+     */
+    'style': string;
 }
 

package/models/create-layout-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 { LayoutClass } from './layout-class';
+
+/**
+ * 
+ * @export
+ * @interface CreateLayoutResponseClass
+ */
+export interface CreateLayoutResponseClass {
+    /**
+     * Layout
+     * @type {LayoutClass}
+     * @memberof CreateLayoutResponseClass
+     */
+    'layout': LayoutClass;
+}
+

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

@@ -21,19 +21,19 @@
  */
 export interface CreatePresignedPostRequestDto {
     /**
-     * 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 CreatePresignedPostRequestDto
      */
     'templateSlug': string;
     /**
-     * Document entity type
+     * Document entity type.
      * @type {string}
      * @memberof CreatePresignedPostRequestDto
      */
     'entityType': string;
     /**
-     * Identifier of the entity that the document is related to
+     * Unique identifier referencing the entity.
      * @type {number}
      * @memberof CreatePresignedPostRequestDto
      */
@@ -45,19 +45,19 @@ export interface CreatePresignedPostRequestDto {
      */
     'description': string;
     /**
-     * Unique identifier of the policy that the document belongs to
+     * Unique identifier of the policy that this object belongs to.
      * @type {string}
      * @memberof CreatePresignedPostRequestDto
      */
     '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 CreatePresignedPostRequestDto
      */
     'accountCode'?: string;
     /**
-     * Unique identifier of the lead that the document belongs to
+     * Unique identifier of the lead that this object belongs to.
      * @type {string}
      * @memberof CreatePresignedPostRequestDto
      */
@@ -69,13 +69,13 @@ export interface CreatePresignedPostRequestDto {
      */
     'requester': CreatePresignedPostRequestDtoRequesterEnum;
     /**
-     * Extension of the file
+     * Extension of the file.
      * @type {string}
      * @memberof CreatePresignedPostRequestDto
      */
     'contentType': CreatePresignedPostRequestDtoContentTypeEnum;
     /**
-     * Content type of the file
+     * Content type of the file.
      * @type {string}
      * @memberof CreatePresignedPostRequestDto
      */
@@ -87,11 +87,11 @@ export interface CreatePresignedPostRequestDto {
      */
     'filename': string;
     /**
-     * The product slug that this file belong to.
+     * 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 CreatePresignedPostRequestDto
      */
-    'productSlug'?: string | null;
+    'productSlug'?: string;
 }
 
 export const CreatePresignedPostRequestDtoRequesterEnum = {

package/models/create-presigned-post-response-class.ts

@@ -21,13 +21,13 @@
  */
 export interface CreatePresignedPostResponseClass {
     /**
-     * Upload document fields
+     * Upload document fields.
      * @type {object}
      * @memberof CreatePresignedPostResponseClass
      */
     'fields': object;
     /**
-     * Pre-signed Url
+     * Pre-signed Url.
      * @type {string}
      * @memberof CreatePresignedPostResponseClass
      */

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

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

package/models/delete-request-dto.ts

@@ -21,7 +21,7 @@
  */
 export interface DeleteRequestDto {
     /**
-     * Resource id
+     * Unique identifier for the object.
      * @type {string}
      * @memberof DeleteRequestDto
      */

package/models/delete-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 DeleteResponseClass
+ */
+export interface DeleteResponseClass {
+    /**
+     * 
+     * @type {object}
+     * @memberof DeleteResponseClass
+     */
+    'response': object;
+}
+

package/models/doc-template-class.ts

@@ -65,7 +65,7 @@ export interface DocTemplateClass {
      */
     'layout'?: LayoutClass;
     /**
-     * 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 DocTemplateClass
      */
@@ -83,7 +83,7 @@ export interface DocTemplateClass {
      */
     'updatedAt': string;
     /**
-     * Template updated at
+     * Time at which the object was deleted.
      * @type {string}
      * @memberof DocTemplateClass
      */

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
      */
@@ -51,25 +51,25 @@ export interface DocumentClass {
      */
     '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 of the lead that 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 on the service the document belongs to.
+     * Unique identifier referencing the entity.
      * @type {number}
      * @memberof DocumentClass
      */
@@ -81,7 +81,7 @@ 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
      */
@@ -105,7 +105,7 @@ export interface DocumentClass {
      */
     'contentType': DocumentClassContentTypeEnum;
     /**
-     * Product that this document belong to
+     * 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
      */

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/html-template-class.ts

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

package/models/index.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/models/layout-class.ts

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