@emilgroup/public-api-sdk-node 1.26.0 → 1.27.1

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

@@ -0,0 +1,132 @@
+/**
+ * Emil PublicAPI
+ * The Emil Public 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 CreateDocumentRequestDto
+ */
+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.
+     * @type {string}
+     * @memberof CreateDocumentRequestDto
+     */
+    'templateSlug': 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 CreateDocumentRequestDto
+     */
+    'productSlug'?: string;
+    /**
+     * Document payload.
+     * @type {object}
+     * @memberof CreateDocumentRequestDto
+     */
+    'payload': object;
+    /**
+     * Document entity type.
+     * @type {string}
+     * @memberof CreateDocumentRequestDto
+     */
+    'entityType': string;
+    /**
+     * Document description.
+     * @type {string}
+     * @memberof CreateDocumentRequestDto
+     */
+    'description': string;
+    /**
+     * Unique identifier of the policy that this object belongs to.
+     * @type {string}
+     * @memberof CreateDocumentRequestDto
+     */
+    'policyCode'?: string;
+    /**
+     * Unique identifier of the account that this object belongs to.
+     * @type {string}
+     * @memberof CreateDocumentRequestDto
+     */
+    'accountCode'?: string;
+    /**
+     * Unique identifier referencing the entity.
+     * @type {number}
+     * @memberof CreateDocumentRequestDto
+     */
+    'entityId'?: number;
+    /**
+     * Document requester.
+     * @type {string}
+     * @memberof CreateDocumentRequestDto
+     */
+    'requester': CreateDocumentRequestDtoRequesterEnum;
+    /**
+     * Metadata contains extra information that the document would need for specific cases.
+     * @type {object}
+     * @memberof CreateDocumentRequestDto
+     */
+    'metadata'?: object;
+    /**
+     * Document type.
+     * @type {string}
+     * @memberof CreateDocumentRequestDto
+     */
+    'contentType': CreateDocumentRequestDtoContentTypeEnum;
+    /**
+     * Document file name.
+     * @type {string}
+     * @memberof CreateDocumentRequestDto
+     */
+    'filename'?: string;
+    /**
+     * If true, the default margins will be skipped when generating the document.
+     * @type {boolean}
+     * @memberof CreateDocumentRequestDto
+     */
+    'shouldSkipDefaultMargins'?: boolean;
+    /**
+     * Type of the document engine to use to generate the document. Defaults to HTML.
+     * @type {string}
+     * @memberof CreateDocumentRequestDto
+     */
+    'engine'?: CreateDocumentRequestDtoEngineEnum;
+}
+export declare const CreateDocumentRequestDtoRequesterEnum: {
+    readonly Publicapi: "publicapi";
+};
+export type CreateDocumentRequestDtoRequesterEnum = typeof CreateDocumentRequestDtoRequesterEnum[keyof typeof CreateDocumentRequestDtoRequesterEnum];
+export declare const CreateDocumentRequestDtoContentTypeEnum: {
+    readonly Pdf: "pdf";
+    readonly Jpg: "jpg";
+    readonly Png: "png";
+    readonly Gz: "gz";
+    readonly Csv: "csv";
+    readonly Doc: "doc";
+    readonly Docx: "docx";
+    readonly Html: "html";
+    readonly Json: "json";
+    readonly Xml: "xml";
+    readonly Txt: "txt";
+    readonly Zip: "zip";
+    readonly Tar: "tar";
+    readonly Rar: "rar";
+    readonly Mp4: "MP4";
+    readonly Mov: "MOV";
+    readonly Wmv: "WMV";
+    readonly Avi: "AVI";
+};
+export type CreateDocumentRequestDtoContentTypeEnum = typeof CreateDocumentRequestDtoContentTypeEnum[keyof typeof CreateDocumentRequestDtoContentTypeEnum];
+export declare const CreateDocumentRequestDtoEngineEnum: {
+    readonly Docx: "docx";
+    readonly Html: "html";
+};
+export type CreateDocumentRequestDtoEngineEnum = typeof CreateDocumentRequestDtoEngineEnum[keyof typeof CreateDocumentRequestDtoEngineEnum];

package/dist/models/create-document-request-dto.js

@@ -0,0 +1,43 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Emil PublicAPI
+ * The Emil Public 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateDocumentRequestDtoEngineEnum = exports.CreateDocumentRequestDtoContentTypeEnum = exports.CreateDocumentRequestDtoRequesterEnum = void 0;
+exports.CreateDocumentRequestDtoRequesterEnum = {
+    Publicapi: 'publicapi'
+};
+exports.CreateDocumentRequestDtoContentTypeEnum = {
+    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'
+};
+exports.CreateDocumentRequestDtoEngineEnum = {
+    Docx: 'docx',
+    Html: 'html'
+};

package/dist/models/create-estimated-invoice-request-dto.d.ts

@@ -0,0 +1,55 @@
+/**
+ * Emil PublicAPI
+ * The Emil Public 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 { PolicyObjectRequestDto } from './policy-object-request-dto';
+import { PremiumOverrideRequestDto } from './premium-override-request-dto';
+/**
+ *
+ * @export
+ * @interface CreateEstimatedInvoiceRequestDto
+ */
+export interface CreateEstimatedInvoiceRequestDto {
+    /**
+     * Unique identifier referencing the product version.
+     * @type {number}
+     * @memberof CreateEstimatedInvoiceRequestDto
+     */
+    'productVersionId'?: number;
+    /**
+     * The policy objects to calculate premium.
+     * @type {Array<PolicyObjectRequestDto>}
+     * @memberof CreateEstimatedInvoiceRequestDto
+     */
+    'policyObjects'?: Array<PolicyObjectRequestDto>;
+    /**
+     * Customer custom data for premium calculation. Necessary when no policyObjects are provided.
+     * @type {object}
+     * @memberof CreateEstimatedInvoiceRequestDto
+     */
+    'data'?: object;
+    /**
+     * Custom provider name. Necessary if data is provided.
+     * @type {string}
+     * @memberof CreateEstimatedInvoiceRequestDto
+     */
+    'provider'?: CreateEstimatedInvoiceRequestDtoProviderEnum;
+    /**
+     * Premium Override.
+     * @type {PremiumOverrideRequestDto}
+     * @memberof CreateEstimatedInvoiceRequestDto
+     */
+    'premiumOverride'?: PremiumOverrideRequestDto;
+}
+export declare const CreateEstimatedInvoiceRequestDtoProviderEnum: {
+    readonly Squarelife: "squarelife";
+    readonly Janitos: "janitos";
+};
+export type CreateEstimatedInvoiceRequestDtoProviderEnum = typeof CreateEstimatedInvoiceRequestDtoProviderEnum[keyof typeof CreateEstimatedInvoiceRequestDtoProviderEnum];

package/dist/models/create-estimated-invoice-request-dto.js

@@ -0,0 +1,20 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Emil PublicAPI
+ * The Emil Public 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateEstimatedInvoiceRequestDtoProviderEnum = void 0;
+exports.CreateEstimatedInvoiceRequestDtoProviderEnum = {
+    Squarelife: 'squarelife',
+    Janitos: 'janitos'
+};

package/dist/models/create-estimated-invoice-response-class.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Emil PublicAPI
+ * The Emil Public 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 { CalculateProductFieldsResponseClass } from './calculate-product-fields-response-class';
+import { InvoiceClass } from './invoice-class';
+/**
+ *
+ * @export
+ * @interface CreateEstimatedInvoiceResponseClass
+ */
+export interface CreateEstimatedInvoiceResponseClass {
+    /**
+     * Estimated invoice response
+     * @type {InvoiceClass}
+     * @memberof CreateEstimatedInvoiceResponseClass
+     */
+    'invoice'?: InvoiceClass;
+    /**
+     * In some cases, custom premium calculation needs to be used.     In that case, a custom object is returned. It can hold up any kind of information. For more information,     check the general documentation.
+     * @type {object}
+     * @memberof CreateEstimatedInvoiceResponseClass
+     */
+    'custom'?: object;
+    /**
+     * Calculated policy obejcts response
+     * @type {CalculateProductFieldsResponseClass}
+     * @memberof CreateEstimatedInvoiceResponseClass
+     */
+    'policyObjects'?: CalculateProductFieldsResponseClass;
+}

package/dist/models/create-estimated-invoice-response-class.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Emil PublicAPI
+ * The Emil Public 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/create-lead-async-response-class.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Emil PublicAPI
+ * The Emil Public 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 CreateLeadAsyncResponseClass
+ */
+export interface CreateLeadAsyncResponseClass {
+    /**
+     * Unique identifier of the lead that this object belongs to.
+     * @type {string}
+     * @memberof CreateLeadAsyncResponseClass
+     */
+    'code': string;
+}

package/dist/models/create-lead-async-response-class.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Emil PublicAPI
+ * The Emil Public 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/create-lead-request-dto.d.ts

@@ -0,0 +1,108 @@
+/**
+ * Emil PublicAPI
+ * The Emil Public 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 { CreateAccountRequestDto } from './create-account-request-dto';
+import { CreateBankAccountRequestDto } from './create-bank-account-request-dto';
+import { CreatePaymentMethodRequestDto } from './create-payment-method-request-dto';
+import { PolicyObjectRequestDto } from './policy-object-request-dto';
+import { PremiumOverrideRequestDto } from './premium-override-request-dto';
+import { UploadedDocumentDto } from './uploaded-document-dto';
+/**
+ *
+ * @export
+ * @interface CreateLeadRequestDto
+ */
+export interface CreateLeadRequestDto {
+    /**
+     * The lead code is used in cases where the lead has been initiated before the lead creation.
+     * @type {string}
+     * @memberof CreateLeadRequestDto
+     */
+    'code'?: string;
+    /**
+     * The product version id of the product version to be used for the lead.     The product version id will be validated if the \'validate\' flag is set to true.
+     * @type {number}
+     * @memberof CreateLeadRequestDto
+     */
+    'productVersionId'?: number;
+    /**
+     * Unique identifier of the product that this object belongs to.
+     * @type {string}
+     * @memberof CreateLeadRequestDto
+     */
+    'productCode'?: 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 CreateLeadRequestDto
+     */
+    'productSlug'?: string;
+    /**
+     * Account object. The create lead request should either contain accountCode or account.     The account content will be validated if the \'validate\' flag is set to true. an empty object is required if \'validate flag is set to false.
+     * @type {CreateAccountRequestDto}
+     * @memberof CreateLeadRequestDto
+     */
+    'account'?: CreateAccountRequestDto;
+    /**
+     * The account code is used in cases where the account has been created before the lead.     The create lead request should include either the \'accountCode\' or \'account\'.     The account code will be validated if the \'validate\' flag is set to true.
+     * @type {string}
+     * @memberof CreateLeadRequestDto
+     */
+    'accountCode'?: string;
+    /**
+     * The policy objects contains necessary information to create a policy.     The Policy objects array will be validated if the \'validate\' flag is set to true
+     * @type {Array<PolicyObjectRequestDto>}
+     * @memberof CreateLeadRequestDto
+     */
+    'policyObjects'?: Array<PolicyObjectRequestDto>;
+    /**
+     * Bank account details, to be used for direct debit payments,     the created bank account will be attached to the lead for later use, such as paying claims.     The bank account content will be validated if the \'validate\' flag is set to true.
+     * @type {CreateBankAccountRequestDto}
+     * @memberof CreateLeadRequestDto
+     */
+    'bankAccount'?: CreateBankAccountRequestDto;
+    /**
+     * Optional custom data for the lead.     This field is useful for edge cases where the lead requires additional data for the risk carrier,     such as creating an application in the risk carrier platform or performing a premium calculation.     The custom data should include three main entities: \'data\', \'provider\', and \'productCode\'.     The \'data\' entity contains information used in the risk carrier platform,     the \'provider\' field contains the name of the provider (usually the risk carrier\'s name), the provider must be supported in EMIL,     The \'productCode\' field contains the product code in EMIL
+     * @type {object}
+     * @memberof CreateLeadRequestDto
+     */
+    'customData'?: object;
+    /**
+     * Used to pass pre-uploaded documents to the lead.     By providing the codes of the uploaded documents, they will be attached to the lead.     The uploaded document content will be validated if the \'validate\' flag is set to true.
+     * @type {UploadedDocumentDto}
+     * @memberof CreateLeadRequestDto
+     */
+    'uploadedDocument'?: UploadedDocumentDto;
+    /**
+     * Lead status. Default values are \"created\", \"approved\" and \"declined\".     However, those can be extended using /lead-statuses endpoint from insuranceservice.
+     * @type {string}
+     * @memberof CreateLeadRequestDto
+     */
+    'status'?: string;
+    /**
+     * Premium Override is utilized to override the premium calculation.     The premium formulas will be disregarded when this object is present.     The premium override content will be validated if the \'validate\' flag is set to true.
+     * @type {Array<PremiumOverrideRequestDto>}
+     * @memberof CreateLeadRequestDto
+     */
+    'premiumOverride'?: Array<PremiumOverrideRequestDto>;
+    /**
+     * Payment method, used to for payment method support, such as SEPA, invoice, etc.     The payment method content will be validated if the \'validate\' flag is set to true.
+     * @type {CreatePaymentMethodRequestDto}
+     * @memberof CreateLeadRequestDto
+     */
+    'paymentMethod'?: CreatePaymentMethodRequestDto;
+    /**
+     * The validation indicator, with a default value of true, serves as a toggle.     When set to false, it allows the bypassing of validation—a useful option for saving leads for later processing.     This feature provides flexibility by enabling users to choose whether to enforce validation checks during     the current stage or defer them for a subsequent time.
+     * @type {boolean}
+     * @memberof CreateLeadRequestDto
+     */
+    'validate'?: boolean;
+}

package/dist/models/create-lead-request-dto.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Emil PublicAPI
+ * The Emil Public 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/create-lead-response-class.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Emil PublicAPI
+ * The Emil Public 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 { LeadClass } from './lead-class';
+/**
+ *
+ * @export
+ * @interface CreateLeadResponseClass
+ */
+export interface CreateLeadResponseClass {
+    /**
+     * The list of leads.
+     * @type {LeadClass}
+     * @memberof CreateLeadResponseClass
+     */
+    'lead': LeadClass;
+}

package/dist/models/create-lead-response-class.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Emil PublicAPI
+ * The Emil Public 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/create-payment-method-request-dto.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Emil PublicAPI
+ * The Emil Public 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 { SepaDto } from './sepa-dto';
+/**
+ *
+ * @export
+ * @interface CreatePaymentMethodRequestDto
+ */
+export interface CreatePaymentMethodRequestDto {
+    /**
+     *
+     * @type {string}
+     * @memberof CreatePaymentMethodRequestDto
+     */
+    'type': CreatePaymentMethodRequestDtoTypeEnum;
+    /**
+     *
+     * @type {SepaDto}
+     * @memberof CreatePaymentMethodRequestDto
+     */
+    'sepa'?: SepaDto;
+}
+export declare const CreatePaymentMethodRequestDtoTypeEnum: {
+    readonly Sepa: "sepa";
+    readonly Invoice: "invoice";
+};
+export type CreatePaymentMethodRequestDtoTypeEnum = typeof CreatePaymentMethodRequestDtoTypeEnum[keyof typeof CreatePaymentMethodRequestDtoTypeEnum];

package/dist/models/create-payment-method-request-dto.js

@@ -0,0 +1,20 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Emil PublicAPI
+ * The Emil Public 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreatePaymentMethodRequestDtoTypeEnum = void 0;
+exports.CreatePaymentMethodRequestDtoTypeEnum = {
+    Sepa: 'sepa',
+    Invoice: 'invoice'
+};