@emilgroup/insurance-sdk-node 1.66.1-beta.1 → 1.66.1-beta.2

package/.openapi-generator/FILES

@@ -213,6 +213,7 @@ models/product-field-type-class.ts
 models/product-version-class.ts
 models/rest-clone-lead-account-request-dto.ts
 models/sepa-dto.ts
+models/shared-create-lead-policy-request-dto.ts
 models/shared-invoice-class.ts
 models/shared-lead-policy-object-dto.ts
 models/shared-product-field-class.ts

package/README.md

@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
 Navigate to the folder of your consuming project and run one of the following commands:
 
 ```
-npm install @emilgroup/insurance-sdk-node@1.66.1-beta.1 --save
+npm install @emilgroup/insurance-sdk-node@1.66.1-beta.2 --save
 ```
 or 
 ```
-yarn add @emilgroup/insurance-sdk-node@1.66.1-beta.1
+yarn add @emilgroup/insurance-sdk-node@1.66.1-beta.2
 ```
 
 And then you can import `PoliciesApi`.

package/dist/models/calculate-custom-premium-request-dto.d.ts

@@ -16,13 +16,13 @@
  */
 export interface CalculateCustomPremiumRequestDto {
     /**
-     *
+     * Custom premium data.
      * @type {object}
      * @memberof CalculateCustomPremiumRequestDto
      */
     'data': object;
     /**
-     *
+     * Custom provider name.
      * @type {string}
      * @memberof CalculateCustomPremiumRequestDto
      */

package/dist/models/create-booking-funnel-request-dto.d.ts

@@ -16,55 +16,55 @@
  */
 export interface CreateBookingFunnelRequestDto {
     /**
-     *
-     * @type {object}
-     * @memberof CreateBookingFunnelRequestDto
-     */
-    'stepsConfig'?: object;
-    /**
-     *
+     * Unique identifier for the object.
      * @type {string}
      * @memberof CreateBookingFunnelRequestDto
      */
     'code'?: string;
     /**
-     *
+     * Parent Booking funnel ID
      * @type {number}
      * @memberof CreateBookingFunnelRequestDto
      */
     'parentId'?: number;
     /**
-     *
+     * Booking funnel name
      * @type {string}
      * @memberof CreateBookingFunnelRequestDto
      */
     'name': string;
     /**
-     *
+     * Code snippet to load the booking funnel.
      * @type {string}
      * @memberof CreateBookingFunnelRequestDto
      */
     'jsCode': string;
     /**
-     *
+     * Steps configuration for the booking funnel.
+     * @type {object}
+     * @memberof CreateBookingFunnelRequestDto
+     */
+    'stepsConfig'?: object;
+    /**
+     * Custom css for the booking funnel.
      * @type {string}
      * @memberof CreateBookingFunnelRequestDto
      */
     'css'?: string;
     /**
-     *
+     * URL to fetch the logo for the booking funnel.
      * @type {string}
      * @memberof CreateBookingFunnelRequestDto
      */
     'logoPath'?: 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 CreateBookingFunnelRequestDto
      */
     'productSlug': string;
     /**
-     *
+     * Product version id. Will default to the latest version if not specified.
      * @type {number}
      * @memberof CreateBookingFunnelRequestDto
      */

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

@@ -11,10 +11,10 @@
  */
 import { CreateAccountRequestDto } from './create-account-request-dto';
 import { CreateBankAccountRequestDto } from './create-bank-account-request-dto';
-import { CreateLeadPolicyRequestDto } from './create-lead-policy-request-dto';
 import { CreatePaymentMethodRequestDto } from './create-payment-method-request-dto';
 import { LinkLeadPartnerRequestDto } from './link-lead-partner-request-dto';
 import { PremiumOverrideRequestDto } from './premium-override-request-dto';
+import { SharedCreateLeadPolicyRequestDto } from './shared-create-lead-policy-request-dto';
 import { UploadedDocumentDto } from './uploaded-document-dto';
 /**
  *
@@ -23,81 +23,81 @@ import { UploadedDocumentDto } from './uploaded-document-dto';
  */
 export interface CreateLeadRequestDto {
     /**
-     *
+     * The lead code is used in cases where the lead has been initiated before the lead creation.
      * @type {string}
      * @memberof CreateLeadRequestDto
      */
-    'accountCode': string;
-    /**
-     *
-     * @type {CreateAccountRequestDto}
-     * @memberof CreateLeadRequestDto
-     */
-    'account': CreateAccountRequestDto;
+    'code'?: string;
     /**
-     *
-     * @type {CreateLeadPolicyRequestDto}
+     * 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
      */
-    'policy': CreateLeadPolicyRequestDto;
+    'productVersionId'?: number;
     /**
-     *
-     * @type {object}
+     * 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
      */
-    'customData'?: object;
+    'accountCode'?: string;
     /**
-     *
-     * @type {LinkLeadPartnerRequestDto}
+     * 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
      */
-    'partner'?: LinkLeadPartnerRequestDto;
+    'account': CreateAccountRequestDto;
     /**
-     *
-     * @type {string}
+     * The policy object contains necessary information to create a policy.     The Policy content will be validated if the \'validate\' flag is set to true
+     * @type {SharedCreateLeadPolicyRequestDto}
      * @memberof CreateLeadRequestDto
      */
-    'code'?: string;
+    'policy': SharedCreateLeadPolicyRequestDto;
     /**
-     *
-     * @type {number}
+     * 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
      */
-    'productVersionId'?: number;
+    'bankAccount'?: CreateBankAccountRequestDto;
     /**
-     *
-     * @type {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
      */
-    'bankAccount'?: CreateBankAccountRequestDto;
+    '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;
     /**
-     *
-     * @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, 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;
+    /**
+     * Optional partner object contains necessary information to link a partner to the policy.     The partner content will be validated if the \'validate\' flag is set to true.
+     * @type {LinkLeadPartnerRequestDto}
+     * @memberof CreateLeadRequestDto
+     */
+    'partner'?: LinkLeadPartnerRequestDto;
 }

package/dist/models/create-product-field-request-dto.d.ts

@@ -16,131 +16,131 @@
  */
 export interface CreateProductFieldRequestDto {
     /**
-     *
-     * @type {object}
-     * @memberof CreateProductFieldRequestDto
-     */
-    'defaultValue': object;
-    /**
-     *
-     * @type {object}
-     * @memberof CreateProductFieldRequestDto
-     */
-    'minValue'?: object;
-    /**
-     *
-     * @type {object}
-     * @memberof CreateProductFieldRequestDto
-     */
-    'maxValue'?: object;
-    /**
-     *
-     * @type {object}
-     * @memberof CreateProductFieldRequestDto
-     */
-    'metadata'?: object;
-    /**
-     *
+     * Product field name
      * @type {string}
      * @memberof CreateProductFieldRequestDto
      */
     'name': string;
     /**
-     *
+     * Product field label
      * @type {string}
      * @memberof CreateProductFieldRequestDto
      */
     'label': string;
     /**
-     *
+     * Product field type entity
      * @type {string}
      * @memberof CreateProductFieldRequestDto
      */
     'typeEntity': CreateProductFieldRequestDtoTypeEntityEnum;
     /**
-     *
+     * Product field type id
      * @type {number}
      * @memberof CreateProductFieldRequestDto
      */
     'typeId': number;
     /**
-     *
+     * Insured object id
      * @type {number}
      * @memberof CreateProductFieldRequestDto
      */
     'insuredObjectId': number;
     /**
-     *
+     * Product field group
      * @type {string}
      * @memberof CreateProductFieldRequestDto
      */
     'group': string;
     /**
-     *
+     * Is field required?
      * @type {boolean}
      * @memberof CreateProductFieldRequestDto
      */
     'isRequired': boolean;
     /**
-     *
+     * Is field hidden on the booking funnel?
      * @type {boolean}
      * @memberof CreateProductFieldRequestDto
      */
     'isHidden': boolean;
     /**
-     *
+     * Should the field value be unique across policies?
      * @type {boolean}
      * @memberof CreateProductFieldRequestDto
      */
     'isUnique': boolean;
     /**
-     *
+     * Should the field be hidden on customer portal?
      * @type {boolean}
      * @memberof CreateProductFieldRequestDto
      */
     'isHiddenCustomerPortal': boolean;
     /**
-     *
+     * Should the field be editable on customer portal?
      * @type {boolean}
      * @memberof CreateProductFieldRequestDto
      */
     'isEditableCustomerPortal': boolean;
     /**
-     *
+     * Default value of the field. For the field type date-time, it should be { \"templated\" : \"{{today}}\" }
+     * @type {object}
+     * @memberof CreateProductFieldRequestDto
+     */
+    'defaultValue': object;
+    /**
+     * Default value of the field. For the field type date-time, it should be { \"templated\" : \"{{today}}\" }
+     * @type {object}
+     * @memberof CreateProductFieldRequestDto
+     */
+    'minValue'?: object;
+    /**
+     * Booking funnel description
      * @type {string}
      * @memberof CreateProductFieldRequestDto
      */
     'bfDescription'?: string;
     /**
-     *
+     * Booking funnel tooltip
      * @type {string}
      * @memberof CreateProductFieldRequestDto
      */
     'bfTooltip'?: string;
     /**
-     *
+     * Booking funnel label
      * @type {string}
      * @memberof CreateProductFieldRequestDto
      */
     'bfLabel'?: string;
     /**
-     *
+     * Expression to calculate the field.
      * @type {string}
      * @memberof CreateProductFieldRequestDto
      */
     'expression'?: string;
     /**
-     *
+     * Default value of the field. For the field type date-time, it should be { \"templated\" : \"{{today}}\" }
+     * @type {object}
+     * @memberof CreateProductFieldRequestDto
+     */
+    'maxValue'?: object;
+    /**
+     * Order index for the product field item, used to define the order of the items in the insured object. The order will also impact the order of the items in the policy itself.
      * @type {number}
      * @memberof CreateProductFieldRequestDto
      */
     'order'?: number;
     /**
-     *
+     * order index for the product field for display on the booking funnel, not defined for hidden fields.
      * @type {number}
      * @memberof CreateProductFieldRequestDto
      */
     'legacyBfOrder'?: number;
+    /**
+     * Product field metadata object. The field may contain special data specific to the product.
+     * @type {object}
+     * @memberof CreateProductFieldRequestDto
+     */
+    'metadata'?: object;
 }
 export declare const CreateProductFieldRequestDtoTypeEntityEnum: {
     readonly SystemProductFieldType: "system_product_field_type";

package/dist/models/get-draft-policy-request-dto.d.ts

@@ -16,13 +16,13 @@
  */
 export interface GetDraftPolicyRequestDto {
     /**
-     *
+     * Unique identifier of the Draft Policy that this object belongs to.
      * @type {string}
      * @memberof GetDraftPolicyRequestDto
      */
     'policyCode': string;
     /**
-     *
+     * Fields to expand response by.
      * @type {string}
      * @memberof GetDraftPolicyRequestDto
      */

package/dist/models/grpc-clone-lead-account-request-dto.d.ts

@@ -16,95 +16,95 @@
  */
 export interface GrpcCloneLeadAccountRequestDto {
     /**
-     *
-     * @type {string}
-     * @memberof GrpcCloneLeadAccountRequestDto
-     */
-    'birthDate'?: string;
-    /**
-     *
-     * @type {object}
-     * @memberof GrpcCloneLeadAccountRequestDto
-     */
-    'customFields'?: object;
-    /**
-     *
+     * Optional field to enter the honorific title you want to be called.
      * @type {string}
      * @memberof GrpcCloneLeadAccountRequestDto
      */
     'title'?: GrpcCloneLeadAccountRequestDtoTitleEnum;
     /**
-     *
+     * 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 GrpcCloneLeadAccountRequestDto
      */
     'firstName'?: string;
     /**
-     *
+     * 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 GrpcCloneLeadAccountRequestDto
      */
     'lastName'?: string;
     /**
-     *
+     * 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 GrpcCloneLeadAccountRequestDto
      */
     'email'?: string;
     /**
-     *
+     * The account\'s holder gender.     The account\'s gender will be validated if the \'validate\' flag is set to true.
      * @type {string}
      * @memberof GrpcCloneLeadAccountRequestDto
      */
     'gender'?: string;
     /**
-     *
+     * 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 GrpcCloneLeadAccountRequestDto
      */
     'street'?: string;
     /**
-     *
+     * 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 GrpcCloneLeadAccountRequestDto
      */
     'zipCode'?: string;
     /**
-     *
+     * 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 GrpcCloneLeadAccountRequestDto
      */
     'city'?: string;
     /**
-     *
+     * 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 GrpcCloneLeadAccountRequestDto
      */
     'houseNumber'?: string;
     /**
-     *
+     * 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 GrpcCloneLeadAccountRequestDto
+     */
+    'birthDate'?: string;
+    /**
+     * 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 GrpcCloneLeadAccountRequestDto
      */
     'phone'?: string;
     /**
-     *
+     * The account\'s type. Default value is person
      * @type {string}
      * @memberof GrpcCloneLeadAccountRequestDto
      */
     'type'?: GrpcCloneLeadAccountRequestDtoTypeEnum;
     /**
-     *
+     * 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 GrpcCloneLeadAccountRequestDto
      */
     'companyName'?: string;
     /**
-     *
+     * Account number.
      * @type {string}
      * @memberof GrpcCloneLeadAccountRequestDto
      */
     'accountNumber'?: string;
+    /**
+     * Optional custom fields for account. It could be included additional required/optional fields       that the account would need for specific cases.
+     * @type {object}
+     * @memberof GrpcCloneLeadAccountRequestDto
+     */
+    'customFields'?: object;
 }
 export declare const GrpcCloneLeadAccountRequestDtoTitleEnum: {
     readonly Empty: "";

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

@@ -23,87 +23,87 @@ import { UploadedDocumentDto } from './uploaded-document-dto';
  */
 export interface GrpcUpdateLeadRequestDto {
     /**
-     *
-     * @type {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 GrpcUpdateLeadRequestDto
      */
-    'code': string;
+    'productVersionId'?: number;
     /**
-     *
+     * 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 GrpcUpdateLeadRequestDto
      */
     'account': CreateAccountRequestDto;
     /**
-     *
+     * The policy object contains necessary information to create a policy.     The Policy content will be validated if the \'validate\' flag is set to true
      * @type {CreateLeadPolicyRequestDto}
      * @memberof GrpcUpdateLeadRequestDto
      */
     'policy': CreateLeadPolicyRequestDto;
     /**
-     *
-     * @type {object}
+     * Lead status. Default values are \"created\", \"approved\" and \"declined\".     However, those can be extended using /lead-statuses endpoint from insuranceservice.
+     * @type {string}
      * @memberof GrpcUpdateLeadRequestDto
      */
-    'customData'?: object;
+    'status': string;
     /**
-     *
-     * @type {boolean}
+     * 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 GrpcUpdateLeadRequestDto
      */
-    'shouldTriggerWorkflow'?: boolean;
+    'bankAccount'?: CreateBankAccountRequestDto;
     /**
-     *
-     * @type {LinkLeadPartnerRequestDto}
+     * 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 GrpcUpdateLeadRequestDto
      */
-    'partner'?: LinkLeadPartnerRequestDto;
+    'customData'?: object;
     /**
-     *
-     * @type {number}
+     * 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 GrpcUpdateLeadRequestDto
      */
-    'productVersionId'?: number;
+    'uploadedDocument'?: UploadedDocumentDto;
     /**
-     *
-     * @type {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 GrpcUpdateLeadRequestDto
      */
-    'status': string;
+    'premiumOverride'?: Array<PremiumOverrideRequestDto>;
     /**
-     *
-     * @type {CreateBankAccountRequestDto}
+     * 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 GrpcUpdateLeadRequestDto
      */
-    'bankAccount'?: CreateBankAccountRequestDto;
+    'accountCode'?: string;
     /**
-     *
-     * @type {UploadedDocumentDto}
+     * 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 GrpcUpdateLeadRequestDto
      */
-    'uploadedDocument'?: UploadedDocumentDto;
+    'paymentMethod'?: CreatePaymentMethodRequestDto;
     /**
-     *
-     * @type {PremiumOverrideRequestDto}
+     * 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 GrpcUpdateLeadRequestDto
      */
-    'premiumOverride'?: PremiumOverrideRequestDto;
+    'validate'?: boolean;
     /**
-     *
-     * @type {string}
+     * Optional partner object contains necessary information to link a partner to the policy.     The partner content will be validated if the \'validate\' flag is set to true.
+     * @type {LinkLeadPartnerRequestDto}
      * @memberof GrpcUpdateLeadRequestDto
      */
-    'accountCode'?: string;
+    'partner'?: LinkLeadPartnerRequestDto;
     /**
      *
-     * @type {CreatePaymentMethodRequestDto}
+     * @type {string}
      * @memberof GrpcUpdateLeadRequestDto
      */
-    'paymentMethod'?: CreatePaymentMethodRequestDto;
+    'code': string;
     /**
      *
      * @type {boolean}
      * @memberof GrpcUpdateLeadRequestDto
      */
-    'validate'?: boolean;
+    'shouldTriggerWorkflow'?: boolean;
 }