@emilgroup/document-sdk-node 1.28.0 → 1.28.2-beta.0

package/models/doc-template-class.ts

@@ -0,0 +1,110 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL DocumentService
+ * The EMIL DocumentService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import { HtmlTemplateClass } from './html-template-class';
+import { LayoutClass } from './layout-class';
+
+/**
+ * 
+ * @export
+ * @interface DocTemplateClass
+ */
+export interface DocTemplateClass {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof DocTemplateClass
+     */
+    'id': number;
+    /**
+     * Record owner.
+     * @type {string}
+     * @memberof DocTemplateClass
+     */
+    'owner'?: string;
+    /**
+     * Template name.
+     * @type {string}
+     * @memberof DocTemplateClass
+     */
+    'name': string;
+    /**
+     * 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;
+    /**
+     * The filename of the document template as it appears when sent to customers.
+     * @type {string}
+     * @memberof DocTemplateClass
+     */
+    'label'?: string;
+    /**
+     * Unique identifier referencing the layout.
+     * @type {number}
+     * @memberof DocTemplateClass
+     */
+    'layoutId': number;
+    /**
+     * Body Template.
+     * @type {HtmlTemplateClass}
+     * @memberof DocTemplateClass
+     */
+    'bodyTemplate'?: HtmlTemplateClass;
+    /**
+     * Template Layout.
+     * @type {LayoutClass}
+     * @memberof DocTemplateClass
+     */
+    'layout'?: LayoutClass;
+    /**
+     * 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
+     */
+    'productSlug'?: string;
+    /**
+     * 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': string;
+    /**
+     * Time at which the object was deleted.
+     * @type {string}
+     * @memberof DocTemplateClass
+     */
+    'deletedAt'?: string;
+    /**
+     * Identifier of the user who created the record.
+     * @type {string}
+     * @memberof DocTemplateClass
+     */
+    'createdBy': string;
+    /**
+     * Identifier of the user who last updated the record.
+     * @type {string}
+     * @memberof DocTemplateClass
+     */
+    'updatedBy': string;
+}
+

package/models/document-class.ts

@@ -0,0 +1,181 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL DocumentService
+ * The EMIL DocumentService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * 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 DocumentClass
+ */
+export interface DocumentClass {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof DocumentClass
+     */
+    'id': number;
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof 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.
+     * @type {string}
+     * @memberof DocumentClass
+     */
+    'templateSlug': string;
+    /**
+     * Document entity type.
+     * @type {string}
+     * @memberof DocumentClass
+     */
+    'entityType': string;
+    /**
+     * Payload used to replace variables in the template.
+     * @type {object}
+     * @memberof DocumentClass
+     */
+    'payload'?: object;
+    /**
+     * Unique identifier of the policy that this object belongs to.
+     * @type {string}
+     * @memberof DocumentClass
+     */
+    'policyCode'?: string;
+    /**
+     * Unique identifier of the account that this object belongs to.
+     * @type {string}
+     * @memberof DocumentClass
+     */
+    'accountCode'?: string;
+    /**
+     * 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
+     */
+    'entityId'?: number;
+    /**
+     * Identifier of the service that requested the creation of this document.
+     * @type {string}
+     * @memberof DocumentClass
+     */
+    'requester': DocumentClassRequesterEnum;
+    /**
+     * Metadata contains extra information that the object would need for specific cases.
+     * @type {object}
+     * @memberof DocumentClass
+     */
+    'metadata'?: object;
+    /**
+     * Description of the document. Usually a short summary about the      context in which the document is being used.
+     * @type {string}
+     * @memberof DocumentClass
+     */
+    'description': string;
+    /**
+     * The unique key used by Amazon Simple Storage Service (S3).
+     * @type {string}
+     * @memberof DocumentClass
+     */
+    's3Key': string;
+    /**
+     * Type of the document expressed with its file extension.
+     * @type {string}
+     * @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;
+    /**
+     * Identifier of the user who created the record.
+     * @type {string}
+     * @memberof DocumentClass
+     */
+    'createdBy': string;
+    /**
+     * Identifier of the user who last updated the record.
+     * @type {string}
+     * @memberof DocumentClass
+     */
+    'updatedBy': string;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof DocumentClass
+     */
+    'createdAt': string;
+    /**
+     * Emil Resources Names (ERN) identifies the most specific owner of a resource.
+     * @type {string}
+     * @memberof DocumentClass
+     */
+    'ern': string;
+}
+
+export const DocumentClassRequesterEnum = {
+    Accountservice: 'accountservice',
+    Insuranceservice: 'insuranceservice',
+    Billingservice: 'billingservice',
+    Tenantservice: 'tenantservice',
+    BookingFunnel: 'bookingFunnel',
+    Publicapi: 'publicapi',
+    Admin: 'admin',
+    Claimservice: 'claimservice',
+    Customerservice: 'customerservice',
+    Notificationservice: 'notificationservice',
+    Paymentservice: 'paymentservice',
+    Processmanager: 'processmanager',
+    Gdvservice: 'gdvservice',
+    Documentservice: 'documentservice',
+    Partnerservice: 'partnerservice'
+} as const;
+
+export type DocumentClassRequesterEnum = typeof DocumentClassRequesterEnum[keyof typeof DocumentClassRequesterEnum];
+export const DocumentClassContentTypeEnum = {
+    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 DocumentClassContentTypeEnum = typeof DocumentClassContentTypeEnum[keyof typeof DocumentClassContentTypeEnum];
+
+

package/models/docx-template-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
+ * Contact: kontakt@emil.de
+ *
+ * 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 DocxTemplateClass
+ */
+export interface DocxTemplateClass {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof DocxTemplateClass
+     */
+    'id': number;
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof DocxTemplateClass
+     */
+    '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.
+     * @type {string}
+     * @memberof DocxTemplateClass
+     */
+    'slug': string;
+    /**
+     * 
+     * @type {number}
+     * @memberof DocxTemplateClass
+     */
+    'productVersionId': number;
+    /**
+     * 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 DocxTemplateClass
+     */
+    'productSlug': string;
+    /**
+     * Description of the document. Usually a short summary about the      context in which the document is being used.
+     * @type {string}
+     * @memberof DocxTemplateClass
+     */
+    'description': string;
+    /**
+     * The unique key used by Amazon Simple Storage Service (S3).
+     * @type {string}
+     * @memberof DocxTemplateClass
+     */
+    's3Key': string;
+    /**
+     * Document entity type.
+     * @type {string}
+     * @memberof DocxTemplateClass
+     */
+    'entityType': string;
+    /**
+     * Name of the file the end user will see when he downloads it.
+     * @type {string}
+     * @memberof DocxTemplateClass
+     */
+    'filename': string;
+    /**
+     * Version number of the template, incremented each time a new version is uploaded.
+     * @type {number}
+     * @memberof DocxTemplateClass
+     */
+    'versionNumber': number;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof DocxTemplateClass
+     */
+    'createdAt': string;
+    /**
+     * Time at which the object was updated.
+     * @type {string}
+     * @memberof DocxTemplateClass
+     */
+    'updatedAt': string;
+    /**
+     * Identifier of the user who created the record.
+     * @type {string}
+     * @memberof DocxTemplateClass
+     */
+    'createdBy': string;
+    /**
+     * Identifier of the user who last updated the record.
+     * @type {string}
+     * @memberof DocxTemplateClass
+     */
+    'updatedBy': string;
+}
+

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

@@ -0,0 +1,36 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL DocumentService
+ * The EMIL DocumentService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * 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 DownloadDocumentRequestDto
+ */
+export interface DownloadDocumentRequestDto {
+    /**
+     * 
+     * @type {string}
+     * @memberof DownloadDocumentRequestDto
+     */
+    'code': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof DownloadDocumentRequestDto
+     */
+    'documentKey': string;
+}
+

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

@@ -0,0 +1,36 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL DocumentService
+ * The EMIL DocumentService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * 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 GetDocTemplateRequestDto
+ */
+export interface GetDocTemplateRequestDto {
+    /**
+     * 
+     * @type {number}
+     * @memberof GetDocTemplateRequestDto
+     */
+    'id': number;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetDocTemplateRequestDto
+     */
+    'expand'?: string;
+}
+

package/models/get-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
+ * Contact: kontakt@emil.de
+ *
+ * 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 GetDocTemplateResponseClass
+ */
+export interface GetDocTemplateResponseClass {
+    /**
+     * Document template.
+     * @type {DocTemplateClass}
+     * @memberof GetDocTemplateResponseClass
+     */
+    'template': DocTemplateClass;
+}
+

package/models/get-document-download-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
+ * Contact: kontakt@emil.de
+ *
+ * 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 GetDocumentDownloadUrlResponseClass
+ */
+export interface GetDocumentDownloadUrlResponseClass {
+    /**
+     * Pre-signed Url.
+     * @type {string}
+     * @memberof GetDocumentDownloadUrlResponseClass
+     */
+    'url': string;
+}
+

package/models/get-docx-template-download-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
+ * Contact: kontakt@emil.de
+ *
+ * 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 GetDocxTemplateDownloadUrlResponseClass
+ */
+export interface GetDocxTemplateDownloadUrlResponseClass {
+    /**
+     * Pre-signed url for downloading the docx template.
+     * @type {string}
+     * @memberof GetDocxTemplateDownloadUrlResponseClass
+     */
+    'url': string;
+}
+

package/models/get-docx-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
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import { DocxTemplateClass } from './docx-template-class';
+
+/**
+ * 
+ * @export
+ * @interface GetDocxTemplateResponseClass
+ */
+export interface GetDocxTemplateResponseClass {
+    /**
+     * Docx Template
+     * @type {DocxTemplateClass}
+     * @memberof GetDocxTemplateResponseClass
+     */
+    'docxTemplate': DocxTemplateClass;
+}
+

package/models/get-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
+ * Contact: kontakt@emil.de
+ *
+ * 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 GetLayoutResponseClass
+ */
+export interface GetLayoutResponseClass {
+    /**
+     * Layout
+     * @type {LayoutClass}
+     * @memberof GetLayoutResponseClass
+     */
+    'layout': LayoutClass;
+}
+

package/models/get-product-document-download-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
+ * Contact: kontakt@emil.de
+ *
+ * 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 GetProductDocumentDownloadUrlResponseClass
+ */
+export interface GetProductDocumentDownloadUrlResponseClass {
+    /**
+     * Pre-signed url for downloading product documents.
+     * @type {string}
+     * @memberof GetProductDocumentDownloadUrlResponseClass
+     */
+    'url': string;
+}
+

package/models/get-product-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
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import { ProductDocumentClass } from './product-document-class';
+
+/**
+ * 
+ * @export
+ * @interface GetProductDocumentResponseClass
+ */
+export interface GetProductDocumentResponseClass {
+    /**
+     * Product Document
+     * @type {ProductDocumentClass}
+     * @memberof GetProductDocumentResponseClass
+     */
+    'productDocument': ProductDocumentClass;
+}
+