@emilgroup/public-api-sdk 1.13.0 → 1.14.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (12) hide show
  1. package/README.md +2 -2
  2. package/dist/models/create-account-request-dto.d.ts +24 -24
  3. package/dist/models/create-lead-request-dto.d.ts +20 -14
  4. package/dist/models/lead-policy-object-class.d.ts +6 -0
  5. package/dist/models/policy-object-request-dto.d.ts +10 -4
  6. package/dist/models/update-lead-request-dto.d.ts +20 -14
  7. package/models/create-account-request-dto.ts +24 -24
  8. package/models/create-lead-request-dto.ts +20 -14
  9. package/models/lead-policy-object-class.ts +6 -0
  10. package/models/policy-object-request-dto.ts +10 -4
  11. package/models/update-lead-request-dto.ts +20 -14
  12. package/package.json +1 -1
package/README.md CHANGED
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
17
17
  Navigate to the folder of your consuming project and run one of the following commands:
18
18
 
19
19
  ```
20
- npm install @emilgroup/public-api-sdk@1.13.0 --save
20
+ npm install @emilgroup/public-api-sdk@1.14.1 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/public-api-sdk@1.13.0
24
+ yarn add @emilgroup/public-api-sdk@1.14.1
25
25
  ```
26
26
 
27
27
  And then you can import `PublicApi`.
package/dist/models/create-account-request-dto.d.ts CHANGED
@@ -16,91 +16,91 @@
16
16
  */
17
17
  export interface CreateAccountRequestDto {
18
18
  /**
19
- * Customer honorific title
19
+ * Optional field to enter the honorific title you want to be called.
20
20
  * @type {string}
21
21
  * @memberof CreateAccountRequestDto
22
22
  */
23
23
  'title'?: CreateAccountRequestDtoTitleEnum;
24
24
  /**
25
- * Customer first name
25
+ * The account\'s holder first name. The account\'s first name will be validated if the \'validate\' flag is set to true.
26
26
  * @type {string}
27
27
  * @memberof CreateAccountRequestDto
28
28
  */
29
- 'firstName': string;
29
+ 'firstName'?: string;
30
30
  /**
31
- * Customer last name
31
+ * The account\'s holder first name. The account\'s first name will be validated if the \'validate\' flag is set to true.
32
32
  * @type {string}
33
33
  * @memberof CreateAccountRequestDto
34
34
  */
35
- 'lastName': string;
35
+ 'lastName'?: string;
36
36
  /**
37
- * Customer email
37
+ * 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.
38
38
  * @type {string}
39
39
  * @memberof CreateAccountRequestDto
40
40
  */
41
- 'email': string;
41
+ 'email'?: string;
42
42
  /**
43
- * Customer gender
43
+ * The account\'s holder gender. The account\'s gender will be validated if the \'validate\' flag is set to true.
44
44
  * @type {string}
45
45
  * @memberof CreateAccountRequestDto
46
46
  */
47
- 'gender': CreateAccountRequestDtoGenderEnum;
47
+ 'gender'?: CreateAccountRequestDtoGenderEnum;
48
48
  /**
49
- * Customer street
49
+ * The account\'s holder street name. The account\'s street name will be validated if the \'validate\' flag is set to true.
50
50
  * @type {string}
51
51
  * @memberof CreateAccountRequestDto
52
52
  */
53
- 'street': string;
53
+ 'street'?: string;
54
54
  /**
55
- * Customer zip code
55
+ * 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.
56
56
  * @type {string}
57
57
  * @memberof CreateAccountRequestDto
58
58
  */
59
- 'zipCode': string;
59
+ 'zipCode'?: string;
60
60
  /**
61
- * Customer city
61
+ * 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.
62
62
  * @type {string}
63
63
  * @memberof CreateAccountRequestDto
64
64
  */
65
- 'city': string;
65
+ 'city'?: string;
66
66
  /**
67
- * Customer house number
67
+ * The account\'s holder house number. The account\'s house number will be validated if the \'validate\' flag is set to true.
68
68
  * @type {string}
69
69
  * @memberof CreateAccountRequestDto
70
70
  */
71
- 'houseNumber': string;
71
+ 'houseNumber'?: string;
72
72
  /**
73
- * Customer birth date (Required for account of type person).
73
+ * 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.
74
74
  * @type {string}
75
75
  * @memberof CreateAccountRequestDto
76
76
  */
77
77
  'birthDate'?: string;
78
78
  /**
79
- * Customer phone number
79
+ * The account\'s holder phone number. The account\'s phone number will be validated if the \'validate\' flag is set to true.
80
80
  * @type {string}
81
81
  * @memberof CreateAccountRequestDto
82
82
  */
83
- 'phone': string;
83
+ 'phone'?: string;
84
84
  /**
85
- * Optional field to enter the type of the account.
85
+ * The account\'s type. Default value is person
86
86
  * @type {string}
87
87
  * @memberof CreateAccountRequestDto
88
88
  */
89
89
  'type'?: CreateAccountRequestDtoTypeEnum;
90
90
  /**
91
- * Customer company name (Required for account of type org).
91
+ * 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.
92
92
  * @type {string}
93
93
  * @memberof CreateAccountRequestDto
94
94
  */
95
95
  'companyName'?: string;
96
96
  /**
97
- * Account number
97
+ * Account number.
98
98
  * @type {string}
99
99
  * @memberof CreateAccountRequestDto
100
100
  */
101
101
  'accountNumber'?: string;
102
102
  /**
103
- * Custom fields could be included additional required/optional fields that the account would need for specific cases.
103
+ * Optional custom fields for account. It could be included additional required/optional fields that the account would need for specific cases.
104
104
  * @type {object}
105
105
  * @memberof CreateAccountRequestDto
106
106
  */
package/dist/models/create-lead-request-dto.d.ts CHANGED
@@ -22,13 +22,13 @@ import { UploadedDocumentDto } from './uploaded-document-dto';
22
22
  */
23
23
  export interface CreateLeadRequestDto {
24
24
  /**
25
- * Unique identifier for the object.
25
+ * The lead code is used in cases where the lead has been initiated before the lead creation.
26
26
  * @type {string}
27
27
  * @memberof CreateLeadRequestDto
28
28
  */
29
29
  'code'?: string;
30
30
  /**
31
- * Unique identifier referencing the product version.
31
+ * 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.
32
32
  * @type {number}
33
33
  * @memberof CreateLeadRequestDto
34
34
  */
@@ -40,57 +40,63 @@ export interface CreateLeadRequestDto {
40
40
  */
41
41
  'productCode': string;
42
42
  /**
43
- * Account. The create lead request should either contain accountCode or account.
43
+ * 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.
44
44
  * @type {CreateAccountRequestDto}
45
45
  * @memberof CreateLeadRequestDto
46
46
  */
47
47
  'account'?: CreateAccountRequestDto;
48
48
  /**
49
- * Account code. The create lead request should either contain accountCode or account.
49
+ * 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.
50
50
  * @type {string}
51
51
  * @memberof CreateLeadRequestDto
52
52
  */
53
53
  'accountCode'?: string;
54
54
  /**
55
- *
55
+ * 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
56
56
  * @type {Array<PolicyObjectRequestDto>}
57
57
  * @memberof CreateLeadRequestDto
58
58
  */
59
- 'policyObjects': Array<PolicyObjectRequestDto>;
59
+ 'policyObjects'?: Array<PolicyObjectRequestDto>;
60
60
  /**
61
- * Bank account details.
61
+ * 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.
62
62
  * @type {CreateBankAccountRequestDto}
63
63
  * @memberof CreateLeadRequestDto
64
64
  */
65
65
  'bankAccount'?: CreateBankAccountRequestDto;
66
66
  /**
67
- * Custom data.
67
+ * 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
68
68
  * @type {object}
69
69
  * @memberof CreateLeadRequestDto
70
70
  */
71
71
  'customData'?: object;
72
72
  /**
73
- * Codes for documents to be uploaded.
73
+ * 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.
74
74
  * @type {UploadedDocumentDto}
75
75
  * @memberof CreateLeadRequestDto
76
76
  */
77
77
  'uploadedDocument'?: UploadedDocumentDto;
78
78
  /**
79
- * Lead status. Default values are \"created\", \"approved\" and \"declined\". However, those can be extended using /lead-statuses endpoint from insuranceservice.
79
+ * Lead status. Default values are \"created\", \"approved\" and \"declined\". However, those can be extended using /lead-statuses endpoint from insuranceservice.
80
80
  * @type {string}
81
81
  * @memberof CreateLeadRequestDto
82
82
  */
83
83
  'status'?: string;
84
84
  /**
85
- * Premium Override.
86
- * @type {PremiumOverrideRequestDto}
85
+ * 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.
86
+ * @type {Array<PremiumOverrideRequestDto>}
87
87
  * @memberof CreateLeadRequestDto
88
88
  */
89
- 'premiumOverride'?: PremiumOverrideRequestDto;
89
+ 'premiumOverride'?: Array<PremiumOverrideRequestDto>;
90
90
  /**
91
- * Payment Method.
91
+ * 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.
92
92
  * @type {CreatePaymentMethodRequestDto}
93
93
  * @memberof CreateLeadRequestDto
94
94
  */
95
95
  'paymentMethod'?: CreatePaymentMethodRequestDto;
96
+ /**
97
+ * 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.
98
+ * @type {boolean}
99
+ * @memberof CreateLeadRequestDto
100
+ */
101
+ 'validate'?: boolean;
96
102
  }
package/dist/models/lead-policy-object-class.d.ts CHANGED
@@ -21,6 +21,12 @@ export interface LeadPolicyObjectClass {
21
21
  * @memberof LeadPolicyObjectClass
22
22
  */
23
23
  'insuredObjectId': number;
24
+ /**
25
+ * Insured object name.
26
+ * @type {object}
27
+ * @memberof LeadPolicyObjectClass
28
+ */
29
+ 'insuredObjectName'?: object;
24
30
  /**
25
31
  * Insured object data.
26
32
  * @type {object}
package/dist/models/policy-object-request-dto.d.ts CHANGED
@@ -16,17 +16,23 @@
16
16
  */
17
17
  export interface PolicyObjectRequestDto {
18
18
  /**
19
- * Unique identifier referencing the insured object.
19
+ * 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.
20
20
  * @type {number}
21
21
  * @memberof PolicyObjectRequestDto
22
22
  */
23
- 'insuredObjectId': number;
23
+ 'insuredObjectId'?: number;
24
24
  /**
25
- * Insured object data.
25
+ * Insured object name. Human readable identifier of insured object. Can be used instead of insuredObjectId
26
+ * @type {string}
27
+ * @memberof PolicyObjectRequestDto
28
+ */
29
+ 'insuredObjectName'?: string;
30
+ /**
31
+ * Insured object data. The date will be validated if the \'validate\' flag is set to true.
26
32
  * @type {object}
27
33
  * @memberof PolicyObjectRequestDto
28
34
  */
29
- 'data': object;
35
+ 'data'?: object;
30
36
  /**
31
37
  *
32
38
  * @type {string}
package/dist/models/update-lead-request-dto.d.ts CHANGED
@@ -21,13 +21,13 @@ import { UploadedDocumentDto } from './uploaded-document-dto';
21
21
  */
22
22
  export interface UpdateLeadRequestDto {
23
23
  /**
24
- * Unique identifier for the object.
24
+ * The lead code is used in cases where the lead has been initiated before the lead creation.
25
25
  * @type {string}
26
26
  * @memberof UpdateLeadRequestDto
27
27
  */
28
28
  'code': string;
29
29
  /**
30
- * Unique identifier referencing the product version.
30
+ * 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.
31
31
  * @type {number}
32
32
  * @memberof UpdateLeadRequestDto
33
33
  */
@@ -39,45 +39,51 @@ export interface UpdateLeadRequestDto {
39
39
  */
40
40
  'productCode': string;
41
41
  /**
42
- *
42
+ * 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.
43
+ * @type {CreateAccountRequestDto}
44
+ * @memberof UpdateLeadRequestDto
45
+ */
46
+ 'account': CreateAccountRequestDto;
47
+ /**
48
+ * 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
43
49
  * @type {Array<PolicyObjectRequestDto>}
44
50
  * @memberof UpdateLeadRequestDto
45
51
  */
46
- 'policyObjects': Array<PolicyObjectRequestDto>;
52
+ 'policyObjects'?: Array<PolicyObjectRequestDto>;
47
53
  /**
48
- * Bank account details
49
- * @type {CreateBankAccountRequestDto}
54
+ * 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.
55
+ * @type {Array<CreateBankAccountRequestDto>}
50
56
  * @memberof UpdateLeadRequestDto
51
57
  */
52
- 'bankAccount'?: CreateBankAccountRequestDto;
58
+ 'bankAccount'?: Array<CreateBankAccountRequestDto>;
53
59
  /**
54
- * Custom data.
60
+ * 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
55
61
  * @type {object}
56
62
  * @memberof UpdateLeadRequestDto
57
63
  */
58
64
  'customData'?: object;
59
65
  /**
60
- * Codes for documents to be uploaded.
66
+ * 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.
61
67
  * @type {UploadedDocumentDto}
62
68
  * @memberof UpdateLeadRequestDto
63
69
  */
64
70
  'uploadedDocument'?: UploadedDocumentDto;
65
71
  /**
66
- * Lead status. Default values are \"created\", \"approved\" and \"declined\". However, those can be extended using /lead-statuses endpoint from insuranceservice.
72
+ * Lead status. Default values are \"created\", \"approved\" and \"declined\". However, those can be extended using /lead-statuses endpoint from insuranceservice.
67
73
  * @type {string}
68
74
  * @memberof UpdateLeadRequestDto
69
75
  */
70
76
  'status': string;
71
77
  /**
72
- * Payment Method.
78
+ * 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.
73
79
  * @type {CreatePaymentMethodRequestDto}
74
80
  * @memberof UpdateLeadRequestDto
75
81
  */
76
82
  'paymentMethod'?: CreatePaymentMethodRequestDto;
77
83
  /**
78
- *
79
- * @type {CreateAccountRequestDto}
84
+ * 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.
85
+ * @type {boolean}
80
86
  * @memberof UpdateLeadRequestDto
81
87
  */
82
- 'account': CreateAccountRequestDto;
88
+ 'validate'?: boolean;
83
89
  }
package/models/create-account-request-dto.ts CHANGED
@@ -21,91 +21,91 @@
21
21
  */
22
22
  export interface CreateAccountRequestDto {
23
23
  /**
24
- * Customer honorific title
24
+ * Optional field to enter the honorific title you want to be called.
25
25
  * @type {string}
26
26
  * @memberof CreateAccountRequestDto
27
27
  */
28
28
  'title'?: CreateAccountRequestDtoTitleEnum;
29
29
  /**
30
- * Customer first name
30
+ * The account\'s holder first name. The account\'s first name will be validated if the \'validate\' flag is set to true.
31
31
  * @type {string}
32
32
  * @memberof CreateAccountRequestDto
33
33
  */
34
- 'firstName': string;
34
+ 'firstName'?: string;
35
35
  /**
36
- * Customer last name
36
+ * The account\'s holder first name. The account\'s first name will be validated if the \'validate\' flag is set to true.
37
37
  * @type {string}
38
38
  * @memberof CreateAccountRequestDto
39
39
  */
40
- 'lastName': string;
40
+ 'lastName'?: string;
41
41
  /**
42
- * Customer email
42
+ * 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.
43
43
  * @type {string}
44
44
  * @memberof CreateAccountRequestDto
45
45
  */
46
- 'email': string;
46
+ 'email'?: string;
47
47
  /**
48
- * Customer gender
48
+ * The account\'s holder gender. The account\'s gender will be validated if the \'validate\' flag is set to true.
49
49
  * @type {string}
50
50
  * @memberof CreateAccountRequestDto
51
51
  */
52
- 'gender': CreateAccountRequestDtoGenderEnum;
52
+ 'gender'?: CreateAccountRequestDtoGenderEnum;
53
53
  /**
54
- * Customer street
54
+ * The account\'s holder street name. The account\'s street name will be validated if the \'validate\' flag is set to true.
55
55
  * @type {string}
56
56
  * @memberof CreateAccountRequestDto
57
57
  */
58
- 'street': string;
58
+ 'street'?: string;
59
59
  /**
60
- * Customer zip code
60
+ * 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.
61
61
  * @type {string}
62
62
  * @memberof CreateAccountRequestDto
63
63
  */
64
- 'zipCode': string;
64
+ 'zipCode'?: string;
65
65
  /**
66
- * Customer city
66
+ * 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.
67
67
  * @type {string}
68
68
  * @memberof CreateAccountRequestDto
69
69
  */
70
- 'city': string;
70
+ 'city'?: string;
71
71
  /**
72
- * Customer house number
72
+ * The account\'s holder house number. The account\'s house number will be validated if the \'validate\' flag is set to true.
73
73
  * @type {string}
74
74
  * @memberof CreateAccountRequestDto
75
75
  */
76
- 'houseNumber': string;
76
+ 'houseNumber'?: string;
77
77
  /**
78
- * Customer birth date (Required for account of type person).
78
+ * 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.
79
79
  * @type {string}
80
80
  * @memberof CreateAccountRequestDto
81
81
  */
82
82
  'birthDate'?: string;
83
83
  /**
84
- * Customer phone number
84
+ * The account\'s holder phone number. The account\'s phone number will be validated if the \'validate\' flag is set to true.
85
85
  * @type {string}
86
86
  * @memberof CreateAccountRequestDto
87
87
  */
88
- 'phone': string;
88
+ 'phone'?: string;
89
89
  /**
90
- * Optional field to enter the type of the account.
90
+ * The account\'s type. Default value is person
91
91
  * @type {string}
92
92
  * @memberof CreateAccountRequestDto
93
93
  */
94
94
  'type'?: CreateAccountRequestDtoTypeEnum;
95
95
  /**
96
- * Customer company name (Required for account of type org).
96
+ * 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.
97
97
  * @type {string}
98
98
  * @memberof CreateAccountRequestDto
99
99
  */
100
100
  'companyName'?: string;
101
101
  /**
102
- * Account number
102
+ * Account number.
103
103
  * @type {string}
104
104
  * @memberof CreateAccountRequestDto
105
105
  */
106
106
  'accountNumber'?: string;
107
107
  /**
108
- * Custom fields could be included additional required/optional fields that the account would need for specific cases.
108
+ * Optional custom fields for account. It could be included additional required/optional fields that the account would need for specific cases.
109
109
  * @type {object}
110
110
  * @memberof CreateAccountRequestDto
111
111
  */
package/models/create-lead-request-dto.ts CHANGED
@@ -27,13 +27,13 @@ import { UploadedDocumentDto } from './uploaded-document-dto';
27
27
  */
28
28
  export interface CreateLeadRequestDto {
29
29
  /**
30
- * Unique identifier for the object.
30
+ * The lead code is used in cases where the lead has been initiated before the lead creation.
31
31
  * @type {string}
32
32
  * @memberof CreateLeadRequestDto
33
33
  */
34
34
  'code'?: string;
35
35
  /**
36
- * Unique identifier referencing the product version.
36
+ * 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.
37
37
  * @type {number}
38
38
  * @memberof CreateLeadRequestDto
39
39
  */
@@ -45,58 +45,64 @@ export interface CreateLeadRequestDto {
45
45
  */
46
46
  'productCode': string;
47
47
  /**
48
- * Account. The create lead request should either contain accountCode or account.
48
+ * 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.
49
49
  * @type {CreateAccountRequestDto}
50
50
  * @memberof CreateLeadRequestDto
51
51
  */
52
52
  'account'?: CreateAccountRequestDto;
53
53
  /**
54
- * Account code. The create lead request should either contain accountCode or account.
54
+ * 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.
55
55
  * @type {string}
56
56
  * @memberof CreateLeadRequestDto
57
57
  */
58
58
  'accountCode'?: string;
59
59
  /**
60
- *
60
+ * 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
61
61
  * @type {Array<PolicyObjectRequestDto>}
62
62
  * @memberof CreateLeadRequestDto
63
63
  */
64
- 'policyObjects': Array<PolicyObjectRequestDto>;
64
+ 'policyObjects'?: Array<PolicyObjectRequestDto>;
65
65
  /**
66
- * Bank account details.
66
+ * 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.
67
67
  * @type {CreateBankAccountRequestDto}
68
68
  * @memberof CreateLeadRequestDto
69
69
  */
70
70
  'bankAccount'?: CreateBankAccountRequestDto;
71
71
  /**
72
- * Custom data.
72
+ * 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
73
73
  * @type {object}
74
74
  * @memberof CreateLeadRequestDto
75
75
  */
76
76
  'customData'?: object;
77
77
  /**
78
- * Codes for documents to be uploaded.
78
+ * 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.
79
79
  * @type {UploadedDocumentDto}
80
80
  * @memberof CreateLeadRequestDto
81
81
  */
82
82
  'uploadedDocument'?: UploadedDocumentDto;
83
83
  /**
84
- * Lead status. Default values are \"created\", \"approved\" and \"declined\". However, those can be extended using /lead-statuses endpoint from insuranceservice.
84
+ * Lead status. Default values are \"created\", \"approved\" and \"declined\". However, those can be extended using /lead-statuses endpoint from insuranceservice.
85
85
  * @type {string}
86
86
  * @memberof CreateLeadRequestDto
87
87
  */
88
88
  'status'?: string;
89
89
  /**
90
- * Premium Override.
91
- * @type {PremiumOverrideRequestDto}
90
+ * 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.
91
+ * @type {Array<PremiumOverrideRequestDto>}
92
92
  * @memberof CreateLeadRequestDto
93
93
  */
94
- 'premiumOverride'?: PremiumOverrideRequestDto;
94
+ 'premiumOverride'?: Array<PremiumOverrideRequestDto>;
95
95
  /**
96
- * Payment Method.
96
+ * 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.
97
97
  * @type {CreatePaymentMethodRequestDto}
98
98
  * @memberof CreateLeadRequestDto
99
99
  */
100
100
  'paymentMethod'?: CreatePaymentMethodRequestDto;
101
+ /**
102
+ * 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.
103
+ * @type {boolean}
104
+ * @memberof CreateLeadRequestDto
105
+ */
106
+ 'validate'?: boolean;
101
107
  }
102
108
 
package/models/lead-policy-object-class.ts CHANGED
@@ -26,6 +26,12 @@ export interface LeadPolicyObjectClass {
26
26
  * @memberof LeadPolicyObjectClass
27
27
  */
28
28
  'insuredObjectId': number;
29
+ /**
30
+ * Insured object name.
31
+ * @type {object}
32
+ * @memberof LeadPolicyObjectClass
33
+ */
34
+ 'insuredObjectName'?: object;
29
35
  /**
30
36
  * Insured object data.
31
37
  * @type {object}
package/models/policy-object-request-dto.ts CHANGED
@@ -21,17 +21,23 @@
21
21
  */
22
22
  export interface PolicyObjectRequestDto {
23
23
  /**
24
- * Unique identifier referencing the insured object.
24
+ * 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.
25
25
  * @type {number}
26
26
  * @memberof PolicyObjectRequestDto
27
27
  */
28
- 'insuredObjectId': number;
28
+ 'insuredObjectId'?: number;
29
29
  /**
30
- * Insured object data.
30
+ * Insured object name. Human readable identifier of insured object. Can be used instead of insuredObjectId
31
+ * @type {string}
32
+ * @memberof PolicyObjectRequestDto
33
+ */
34
+ 'insuredObjectName'?: string;
35
+ /**
36
+ * Insured object data. The date will be validated if the \'validate\' flag is set to true.
31
37
  * @type {object}
32
38
  * @memberof PolicyObjectRequestDto
33
39
  */
34
- 'data': object;
40
+ 'data'?: object;
35
41
  /**
36
42
  *
37
43
  * @type {string}
package/models/update-lead-request-dto.ts CHANGED
@@ -26,13 +26,13 @@ import { UploadedDocumentDto } from './uploaded-document-dto';
26
26
  */
27
27
  export interface UpdateLeadRequestDto {
28
28
  /**
29
- * Unique identifier for the object.
29
+ * The lead code is used in cases where the lead has been initiated before the lead creation.
30
30
  * @type {string}
31
31
  * @memberof UpdateLeadRequestDto
32
32
  */
33
33
  'code': string;
34
34
  /**
35
- * Unique identifier referencing the product version.
35
+ * 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.
36
36
  * @type {number}
37
37
  * @memberof UpdateLeadRequestDto
38
38
  */
@@ -44,46 +44,52 @@ export interface UpdateLeadRequestDto {
44
44
  */
45
45
  'productCode': string;
46
46
  /**
47
- *
47
+ * 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.
48
+ * @type {CreateAccountRequestDto}
49
+ * @memberof UpdateLeadRequestDto
50
+ */
51
+ 'account': CreateAccountRequestDto;
52
+ /**
53
+ * 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
48
54
  * @type {Array<PolicyObjectRequestDto>}
49
55
  * @memberof UpdateLeadRequestDto
50
56
  */
51
- 'policyObjects': Array<PolicyObjectRequestDto>;
57
+ 'policyObjects'?: Array<PolicyObjectRequestDto>;
52
58
  /**
53
- * Bank account details
54
- * @type {CreateBankAccountRequestDto}
59
+ * 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.
60
+ * @type {Array<CreateBankAccountRequestDto>}
55
61
  * @memberof UpdateLeadRequestDto
56
62
  */
57
- 'bankAccount'?: CreateBankAccountRequestDto;
63
+ 'bankAccount'?: Array<CreateBankAccountRequestDto>;
58
64
  /**
59
- * Custom data.
65
+ * 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
60
66
  * @type {object}
61
67
  * @memberof UpdateLeadRequestDto
62
68
  */
63
69
  'customData'?: object;
64
70
  /**
65
- * Codes for documents to be uploaded.
71
+ * 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.
66
72
  * @type {UploadedDocumentDto}
67
73
  * @memberof UpdateLeadRequestDto
68
74
  */
69
75
  'uploadedDocument'?: UploadedDocumentDto;
70
76
  /**
71
- * Lead status. Default values are \"created\", \"approved\" and \"declined\". However, those can be extended using /lead-statuses endpoint from insuranceservice.
77
+ * Lead status. Default values are \"created\", \"approved\" and \"declined\". However, those can be extended using /lead-statuses endpoint from insuranceservice.
72
78
  * @type {string}
73
79
  * @memberof UpdateLeadRequestDto
74
80
  */
75
81
  'status': string;
76
82
  /**
77
- * Payment Method.
83
+ * 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.
78
84
  * @type {CreatePaymentMethodRequestDto}
79
85
  * @memberof UpdateLeadRequestDto
80
86
  */
81
87
  'paymentMethod'?: CreatePaymentMethodRequestDto;
82
88
  /**
83
- *
84
- * @type {CreateAccountRequestDto}
89
+ * 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.
90
+ * @type {boolean}
85
91
  * @memberof UpdateLeadRequestDto
86
92
  */
87
- 'account': CreateAccountRequestDto;
93
+ 'validate'?: boolean;
88
94
  }
89
95
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@emilgroup/public-api-sdk",
3
- "version": "1.13.0",
3
+ "version": "1.14.1",
4
4
  "description": "OpenAPI client for @emilgroup/public-api-sdk",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "keywords": [