@emilgroup/public-api-sdk 1.12.0 → 1.14.0

package/dist/models/index.js

@@ -33,6 +33,8 @@ __exportStar(require("./create-estimated-invoice-response-class"), exports);
 __exportStar(require("./create-lead-request-dto"), exports);
 __exportStar(require("./create-lead-response-class"), exports);
 __exportStar(require("./create-payment-method-request-dto"), exports);
+__exportStar(require("./create-presigned-post-request-dto"), exports);
+__exportStar(require("./create-presigned-post-response-class"), exports);
 __exportStar(require("./document-class"), exports);
 __exportStar(require("./get-custom-css-response-class"), exports);
 __exportStar(require("./get-lead-response-class"), exports);
@@ -47,6 +49,8 @@ __exportStar(require("./initiate-payment-setup-request-dto"), exports);
 __exportStar(require("./initiate-payment-setup-response-class"), exports);
 __exportStar(require("./initiate-stripe-payment-setup-request-dto"), exports);
 __exportStar(require("./initiate-stripe-payment-setup-response-class"), exports);
+__exportStar(require("./inline-response200"), exports);
+__exportStar(require("./inline-response503"), exports);
 __exportStar(require("./insured-object-class"), exports);
 __exportStar(require("./insured-object-type-class"), exports);
 __exportStar(require("./invoice-class"), exports);

package/dist/models/inline-response200.d.ts

@@ -0,0 +1,54 @@
+/**
+ * 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 InlineResponse200
+ */
+export interface InlineResponse200 {
+    /**
+     *
+     * @type {string}
+     * @memberof InlineResponse200
+     */
+    'status'?: string;
+    /**
+     *
+     * @type {{ [key: string]: { [key: string]: string; }; }}
+     * @memberof InlineResponse200
+     */
+    'info'?: {
+        [key: string]: {
+            [key: string]: string;
+        };
+    } | null;
+    /**
+     *
+     * @type {{ [key: string]: { [key: string]: string; }; }}
+     * @memberof InlineResponse200
+     */
+    'error'?: {
+        [key: string]: {
+            [key: string]: string;
+        };
+    } | null;
+    /**
+     *
+     * @type {{ [key: string]: { [key: string]: string; }; }}
+     * @memberof InlineResponse200
+     */
+    'details'?: {
+        [key: string]: {
+            [key: string]: string;
+        };
+    };
+}

package/dist/models/inline-response200.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/inline-response503.d.ts

@@ -0,0 +1,54 @@
+/**
+ * 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 InlineResponse503
+ */
+export interface InlineResponse503 {
+    /**
+     *
+     * @type {string}
+     * @memberof InlineResponse503
+     */
+    'status'?: string;
+    /**
+     *
+     * @type {{ [key: string]: { [key: string]: string; }; }}
+     * @memberof InlineResponse503
+     */
+    'info'?: {
+        [key: string]: {
+            [key: string]: string;
+        };
+    } | null;
+    /**
+     *
+     * @type {{ [key: string]: { [key: string]: string; }; }}
+     * @memberof InlineResponse503
+     */
+    'error'?: {
+        [key: string]: {
+            [key: string]: string;
+        };
+    } | null;
+    /**
+     *
+     * @type {{ [key: string]: { [key: string]: string; }; }}
+     * @memberof InlineResponse503
+     */
+    'details'?: {
+        [key: string]: {
+            [key: string]: string;
+        };
+    };
+}

package/dist/models/inline-response503.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/lead-policy-object-class.d.ts

@@ -17,10 +17,16 @@
 export interface LeadPolicyObjectClass {
     /**
      * Unique identifier referencing the insured object.
-     * @type {number}
+     * @type {object}
+     * @memberof LeadPolicyObjectClass
+     */
+    'insuredObjectId': object;
+    /**
+     * Insured object name.
+     * @type {object}
      * @memberof LeadPolicyObjectClass
      */
-    'insuredObjectId': number;
+    'insuredObjectName'?: object;
     /**
      * Insured object data.
      * @type {object}

package/dist/models/policy-object-request-dto.d.ts

@@ -16,17 +16,23 @@
  */
 export interface PolicyObjectRequestDto {
     /**
-     * Unique identifier referencing the insured object.
-     * @type {number}
+     * The id of the insured object to be used in the policy.     The insured object id will be validated if the \'validate\' flag is set to true.
+     * @type {object}
+     * @memberof PolicyObjectRequestDto
+     */
+    'insuredObjectId'?: object;
+    /**
+     * Insured object name. Human readable identifier of insured object.        Can be used instead of insuredObjectId
+     * @type {string}
      * @memberof PolicyObjectRequestDto
      */
-    'insuredObjectId': number;
+    'insuredObjectName'?: string;
     /**
-     * Insured object data.
+     * Insured object data.     The date will be validated if the \'validate\' flag is set to true.
      * @type {object}
      * @memberof PolicyObjectRequestDto
      */
-    'data': object;
+    'data'?: object;
     /**
      *
      * @type {string}

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

@@ -71,4 +71,10 @@ export interface ProductClass {
      * @memberof ProductClass
      */
     'updatedAt': string;
+    /**
+     * Default language of the product.
+     * @type {string}
+     * @memberof ProductClass
+     */
+    'defaultLanguage': string;
 }

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

@@ -87,5 +87,13 @@ export declare const ProductDocumentClassContentTypeEnum: {
     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 ProductDocumentClassContentTypeEnum = typeof ProductDocumentClassContentTypeEnum[keyof typeof ProductDocumentClassContentTypeEnum];

package/dist/models/product-document-class.js

@@ -24,5 +24,13 @@ exports.ProductDocumentClassContentTypeEnum = {
     Docx: 'docx',
     Html: 'html',
     Json: 'json',
-    Xml: 'xml'
+    Xml: 'xml',
+    Txt: 'txt',
+    Zip: 'zip',
+    Tar: 'tar',
+    Rar: 'rar',
+    Mp4: 'MP4',
+    Mov: 'MOV',
+    Wmv: 'WMV',
+    Avi: 'AVI'
 };

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

@@ -21,13 +21,13 @@ import { UploadedDocumentDto } from './uploaded-document-dto';
  */
 export interface UpdateLeadRequestDto {
     /**
-     * Unique identifier for the object.
+     * The lead code is used in cases where the lead has been initiated before the lead creation.
      * @type {string}
      * @memberof UpdateLeadRequestDto
      */
     'code': string;
     /**
-     * Unique identifier referencing the product version.
+     * 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 UpdateLeadRequestDto
      */
@@ -39,45 +39,51 @@ export interface UpdateLeadRequestDto {
      */
     'productCode': 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 UpdateLeadRequestDto
+     */
+    'account': CreateAccountRequestDto;
+    /**
+     * 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 UpdateLeadRequestDto
      */
-    'policyObjects': Array<PolicyObjectRequestDto>;
+    'policyObjects'?: Array<PolicyObjectRequestDto>;
     /**
-     * Bank account details
-     * @type {CreateBankAccountRequestDto}
+     * 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 {Array<CreateBankAccountRequestDto>}
      * @memberof UpdateLeadRequestDto
      */
-    'bankAccount'?: CreateBankAccountRequestDto;
+    'bankAccount'?: Array<CreateBankAccountRequestDto>;
     /**
-     * Custom data.
+     * 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 UpdateLeadRequestDto
      */
     'customData'?: object;
     /**
-     * Codes for documents to be uploaded.
+     * 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 UpdateLeadRequestDto
      */
     'uploadedDocument'?: UploadedDocumentDto;
     /**
-     * Lead status. Default values are \"created\", \"approved\" and \"declined\". However, those can be extended using /lead-statuses endpoint from insuranceservice.
+     * Lead status. Default values are \"created\", \"approved\" and \"declined\".      However, those can be extended using /lead-statuses endpoint from insuranceservice.
      * @type {string}
      * @memberof UpdateLeadRequestDto
      */
     'status': string;
     /**
-     * Payment Method.
+     * 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 UpdateLeadRequestDto
      */
     'paymentMethod'?: CreatePaymentMethodRequestDto;
     /**
-     *
-     * @type {CreateAccountRequestDto}
+     * 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 UpdateLeadRequestDto
      */
-    'account': CreateAccountRequestDto;
+    'validate'?: boolean;
 }

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

@@ -21,91 +21,91 @@
  */
 export interface CreateAccountRequestDto {
     /**
-     * Customer honorific title
+     * Optional field to enter the honorific title you want to be called.
      * @type {string}
      * @memberof CreateAccountRequestDto
      */
     'title'?: CreateAccountRequestDtoTitleEnum;
     /**
-     * Customer first name
+     * The account\'s holder first name.     The account\'s first name will be validated if the \'validate\' flag is set to true.
      * @type {string}
      * @memberof CreateAccountRequestDto
      */
-    'firstName': string;
+    'firstName'?: string;
     /**
-     * Customer last name
+     * The account\'s holder first name.     The account\'s first name will be validated if the \'validate\' flag is set to true.
      * @type {string}
      * @memberof CreateAccountRequestDto
      */
-    'lastName': string;
+    'lastName'?: string;
     /**
-     * Customer email
+     * The account\'s holder email address. It is displayed alongside the account in your dashboard       and can be useful for searching and tracking.       The account\'s email address will be validated if the \'validate\' flag is set to true.
      * @type {string}
      * @memberof CreateAccountRequestDto
      */
-    'email': string;
+    'email'?: string;
     /**
-     * Customer gender
+     * The account\'s holder gender.     The account\'s gender will be validated if the \'validate\' flag is set to true.
      * @type {string}
      * @memberof CreateAccountRequestDto
      */
-    'gender': CreateAccountRequestDtoGenderEnum;
+    'gender'?: CreateAccountRequestDtoGenderEnum;
     /**
-     * Customer street
+     * The account\'s holder street name.     The account\'s street name will be validated if the \'validate\' flag is set to true.
      * @type {string}
      * @memberof CreateAccountRequestDto
      */
-    'street': string;
+    'street'?: string;
     /**
-     * Customer zip code
+     * The account\'s holder ZIP or postal code.     The account\'s ZIP or postal code will be validated if the \'validate\' flag is set to true.
      * @type {string}
      * @memberof CreateAccountRequestDto
      */
-    'zipCode': string;
+    'zipCode'?: string;
     /**
-     * Customer city
+     * The account\'s holder city, district, suburb, town, or village.     The account\'s city will be validated if the \'validate\' flag is set to true.
      * @type {string}
      * @memberof CreateAccountRequestDto
      */
-    'city': string;
+    'city'?: string;
     /**
-     * Customer house number
+     * The account\'s holder house number.     The account\'s house number will be validated if the \'validate\' flag is set to true.
      * @type {string}
      * @memberof CreateAccountRequestDto
      */
-    'houseNumber': string;
+    'houseNumber'?: string;
     /**
-     * Customer birth date (Required for account of type person).
+     * The account\'s holder date of birth (Required for account of type person).     The account\'s date of birth will be validated if the \'validate\' flag is set to true.
      * @type {string}
      * @memberof CreateAccountRequestDto
      */
     'birthDate'?: string;
     /**
-     * Customer phone number
+     * The account\'s holder phone number.     The account\'s phone number will be validated if the \'validate\' flag is set to true.
      * @type {string}
      * @memberof CreateAccountRequestDto
      */
-    'phone': string;
+    'phone'?: string;
     /**
-     * Optional field to enter the type of the account.
+     * The account\'s type. Default value is person
      * @type {string}
      * @memberof CreateAccountRequestDto
      */
     'type'?: CreateAccountRequestDtoTypeEnum;
     /**
-     * Customer company name (Required for account of type org).
+     * The account\'s company name (Required for account of type org).     The account\'s company name will be validated if the \'validate\' flag is set to true.
      * @type {string}
      * @memberof CreateAccountRequestDto
      */
     'companyName'?: string;
     /**
-     * Account number
+     * Account number.
      * @type {string}
      * @memberof CreateAccountRequestDto
      */
     'accountNumber'?: string;
     /**
-     * Custom fields could be included additional required/optional fields that the account would need for specific cases.
+     * Optional custom fields for account. It could be included additional required/optional fields       that the account would need for specific cases.
      * @type {object}
      * @memberof CreateAccountRequestDto
      */

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

@@ -109,7 +109,15 @@ export const CreateDocumentRequestDtoContentTypeEnum = {
     Docx: 'docx',
     Html: 'html',
     Json: 'json',
-    Xml: 'xml'
+    Xml: 'xml',
+    Txt: 'txt',
+    Zip: 'zip',
+    Tar: 'tar',
+    Rar: 'rar',
+    Mp4: 'MP4',
+    Mov: 'MOV',
+    Wmv: 'WMV',
+    Avi: 'AVI'
 } as const;
 
 export type CreateDocumentRequestDtoContentTypeEnum = typeof CreateDocumentRequestDtoContentTypeEnum[keyof typeof CreateDocumentRequestDtoContentTypeEnum];

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

@@ -27,13 +27,13 @@ import { UploadedDocumentDto } from './uploaded-document-dto';
  */
 export interface CreateLeadRequestDto {
     /**
-     * Unique identifier for the object.
+     * The lead code is used in cases where the lead has been initiated before the lead creation.
      * @type {string}
      * @memberof CreateLeadRequestDto
      */
     'code'?: string;
     /**
-     * Unique identifier referencing the product version.
+     * 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
      */
@@ -45,58 +45,64 @@ export interface CreateLeadRequestDto {
      */
     'productCode': string;
     /**
-     * Account. The create lead request should either contain accountCode or account.
+     * 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;
     /**
-     * Account code. The create lead request should either contain accountCode or account.
+     * 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>;
+    'policyObjects'?: Array<PolicyObjectRequestDto>;
     /**
-     * Bank account details.
+     * 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;
     /**
-     * Custom data.
+     * 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;
     /**
-     * Codes for documents to be uploaded.
+     * 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.
+     * 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.
-     * @type {PremiumOverrideRequestDto}
+     * 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'?: PremiumOverrideRequestDto;
+    'premiumOverride'?: Array<PremiumOverrideRequestDto>;
     /**
-     * Payment Method.
+     * 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;
 }