@emilgroup/insurance-sdk-node 1.20.0 → 1.21.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.
- package/.openapi-generator/FILES +3 -0
- package/README.md +2 -2
- package/dist/models/create-account-request-dto.d.ts +23 -23
- package/dist/models/create-lead-policy-request-dto.d.ts +56 -0
- package/dist/models/create-lead-policy-request-dto.js +15 -0
- package/dist/models/create-lead-request-dto.d.ts +23 -17
- package/dist/models/grpc-patch-lead-request-dto.d.ts +22 -4
- package/dist/models/grpc-update-lead-request-dto.d.ts +39 -33
- package/dist/models/index.d.ts +3 -0
- package/dist/models/index.js +3 -0
- package/dist/models/lead-class.d.ts +12 -6
- package/dist/models/patch-lead-request-dto.d.ts +10 -4
- package/dist/models/policy-object-dto.d.ts +8 -2
- package/dist/models/shared-create-lead-policy-request-dto.d.ts +56 -0
- package/dist/models/shared-create-lead-policy-request-dto.js +15 -0
- package/dist/models/shared-lead-policy-object-dto.d.ts +42 -0
- package/dist/models/shared-lead-policy-object-dto.js +15 -0
- package/dist/models/update-lead-request-dto.d.ts +35 -29
- package/models/create-account-request-dto.ts +23 -23
- package/models/create-lead-policy-request-dto.ts +62 -0
- package/models/create-lead-request-dto.ts +23 -17
- package/models/grpc-patch-lead-request-dto.ts +22 -4
- package/models/grpc-update-lead-request-dto.ts +39 -33
- package/models/index.ts +3 -0
- package/models/lead-class.ts +12 -6
- package/models/patch-lead-request-dto.ts +10 -4
- package/models/policy-object-dto.ts +8 -2
- package/models/shared-create-lead-policy-request-dto.ts +62 -0
- package/models/shared-lead-policy-object-dto.ts +48 -0
- package/models/update-lead-request-dto.ts +35 -29
- package/package.json +2 -2
package/.openapi-generator/FILES
CHANGED
|
@@ -27,6 +27,7 @@ models/create-custom-application-request-dto.ts
|
|
|
27
27
|
models/create-dummy-policy-request-dto.ts
|
|
28
28
|
models/create-insured-object-request-dto.ts
|
|
29
29
|
models/create-insured-object-response-class.ts
|
|
30
|
+
models/create-lead-policy-request-dto.ts
|
|
30
31
|
models/create-lead-request-dto.ts
|
|
31
32
|
models/create-lead-response-class.ts
|
|
32
33
|
models/create-lead-status-request-dto.ts
|
|
@@ -105,7 +106,9 @@ models/product-field-class.ts
|
|
|
105
106
|
models/product-field-type-class.ts
|
|
106
107
|
models/product-version-class.ts
|
|
107
108
|
models/sepa-dto.ts
|
|
109
|
+
models/shared-create-lead-policy-request-dto.ts
|
|
108
110
|
models/shared-invoice-class.ts
|
|
111
|
+
models/shared-lead-policy-object-dto.ts
|
|
109
112
|
models/shared-product-field-class.ts
|
|
110
113
|
models/shared-update-premium-formula-request-dto.ts
|
|
111
114
|
models/store-product-factors-request-dto.ts
|
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/insurance-sdk-node@1.
|
|
20
|
+
npm install @emilgroup/insurance-sdk-node@1.21.1 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/insurance-sdk-node@1.
|
|
24
|
+
yarn add @emilgroup/insurance-sdk-node@1.21.1
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `PoliciesApi`.
|
|
@@ -16,79 +16,79 @@
|
|
|
16
16
|
*/
|
|
17
17
|
export interface CreateAccountRequestDto {
|
|
18
18
|
/**
|
|
19
|
-
*
|
|
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
|
-
*
|
|
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'
|
|
29
|
+
'firstName'?: string;
|
|
30
30
|
/**
|
|
31
|
-
*
|
|
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'
|
|
35
|
+
'lastName'?: string;
|
|
36
36
|
/**
|
|
37
|
-
*
|
|
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'
|
|
41
|
+
'email'?: string;
|
|
42
42
|
/**
|
|
43
|
-
*
|
|
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'
|
|
47
|
+
'gender'?: string;
|
|
48
48
|
/**
|
|
49
|
-
*
|
|
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'
|
|
53
|
+
'street'?: string;
|
|
54
54
|
/**
|
|
55
|
-
*
|
|
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'
|
|
59
|
+
'zipCode'?: string;
|
|
60
60
|
/**
|
|
61
|
-
*
|
|
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'
|
|
65
|
+
'city'?: string;
|
|
66
66
|
/**
|
|
67
|
-
*
|
|
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'
|
|
71
|
+
'houseNumber'?: string;
|
|
72
72
|
/**
|
|
73
|
-
*
|
|
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
|
-
*
|
|
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'
|
|
83
|
+
'phone'?: string;
|
|
84
84
|
/**
|
|
85
|
-
*
|
|
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
|
-
* The account\'s 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
|
*/
|
|
@@ -100,7 +100,7 @@ export interface CreateAccountRequestDto {
|
|
|
100
100
|
*/
|
|
101
101
|
'accountNumber'?: string;
|
|
102
102
|
/**
|
|
103
|
-
* Optional custom fields for account. It could be included additional required/optional fields
|
|
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
|
*/
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* EMIL InsuranceService
|
|
3
|
+
* The EMIL InsuranceService API description
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0
|
|
6
|
+
* Contact: kontakt@emil.de
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import { PremiumOverrideRequestDto } from './premium-override-request-dto';
|
|
13
|
+
import { SharedLeadPolicyObjectDto } from './shared-lead-policy-object-dto';
|
|
14
|
+
/**
|
|
15
|
+
*
|
|
16
|
+
* @export
|
|
17
|
+
* @interface CreateLeadPolicyRequestDto
|
|
18
|
+
*/
|
|
19
|
+
export interface CreateLeadPolicyRequestDto {
|
|
20
|
+
/**
|
|
21
|
+
* 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.
|
|
22
|
+
* @type {number}
|
|
23
|
+
* @memberof CreateLeadPolicyRequestDto
|
|
24
|
+
*/
|
|
25
|
+
'productVersionId': number;
|
|
26
|
+
/**
|
|
27
|
+
* Unique identifier of the The account code of the account the policy is attached to. that this object belongs to.
|
|
28
|
+
* @type {string}
|
|
29
|
+
* @memberof CreateLeadPolicyRequestDto
|
|
30
|
+
*/
|
|
31
|
+
'accountCode'?: string;
|
|
32
|
+
/**
|
|
33
|
+
* Policy holder name. If not provided, the account holder name will be used.
|
|
34
|
+
* @type {string}
|
|
35
|
+
* @memberof CreateLeadPolicyRequestDto
|
|
36
|
+
*/
|
|
37
|
+
'holder'?: string;
|
|
38
|
+
/**
|
|
39
|
+
* 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
|
|
40
|
+
* @type {Array<SharedLeadPolicyObjectDto>}
|
|
41
|
+
* @memberof CreateLeadPolicyRequestDto
|
|
42
|
+
*/
|
|
43
|
+
'policyObjects'?: Array<SharedLeadPolicyObjectDto>;
|
|
44
|
+
/**
|
|
45
|
+
* 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.
|
|
46
|
+
* @type {PremiumOverrideRequestDto}
|
|
47
|
+
* @memberof CreateLeadPolicyRequestDto
|
|
48
|
+
*/
|
|
49
|
+
'premiumOverride'?: PremiumOverrideRequestDto;
|
|
50
|
+
/**
|
|
51
|
+
* Unique identifier of the lead that this object belongs to.
|
|
52
|
+
* @type {string}
|
|
53
|
+
* @memberof CreateLeadPolicyRequestDto
|
|
54
|
+
*/
|
|
55
|
+
'leadCode'?: string;
|
|
56
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* EMIL InsuranceService
|
|
6
|
+
* The EMIL InsuranceService API description
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0
|
|
9
|
+
* Contact: kontakt@emil.de
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
@@ -12,8 +12,8 @@
|
|
|
12
12
|
import { CreateAccountRequestDto } from './create-account-request-dto';
|
|
13
13
|
import { CreateBankAccountRequestDto } from './create-bank-account-request-dto';
|
|
14
14
|
import { CreatePaymentMethodRequestDto } from './create-payment-method-request-dto';
|
|
15
|
-
import { CreatePolicyRequestDto } from './create-policy-request-dto';
|
|
16
15
|
import { PremiumOverrideRequestDto } from './premium-override-request-dto';
|
|
16
|
+
import { SharedCreateLeadPolicyRequestDto } from './shared-create-lead-policy-request-dto';
|
|
17
17
|
import { UploadedDocumentDto } from './uploaded-document-dto';
|
|
18
18
|
/**
|
|
19
19
|
*
|
|
@@ -22,69 +22,75 @@ import { UploadedDocumentDto } from './uploaded-document-dto';
|
|
|
22
22
|
*/
|
|
23
23
|
export interface CreateLeadRequestDto {
|
|
24
24
|
/**
|
|
25
|
-
*
|
|
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
|
-
*
|
|
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
|
*/
|
|
35
35
|
'productVersionId'?: number;
|
|
36
36
|
/**
|
|
37
|
-
*
|
|
37
|
+
* 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.
|
|
38
38
|
* @type {string}
|
|
39
39
|
* @memberof CreateLeadRequestDto
|
|
40
40
|
*/
|
|
41
41
|
'accountCode'?: 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
|
-
'account'
|
|
47
|
+
'account': CreateAccountRequestDto;
|
|
48
48
|
/**
|
|
49
|
-
* Policy
|
|
50
|
-
* @type {
|
|
49
|
+
* The policy object contains necessary information to create a policy. The Policy content will be validated if the \'validate\' flag is set to true
|
|
50
|
+
* @type {SharedCreateLeadPolicyRequestDto}
|
|
51
51
|
* @memberof CreateLeadRequestDto
|
|
52
52
|
*/
|
|
53
|
-
'policy':
|
|
53
|
+
'policy': SharedCreateLeadPolicyRequestDto;
|
|
54
54
|
/**
|
|
55
|
-
* Bank account details.
|
|
55
|
+
* 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.
|
|
56
56
|
* @type {CreateBankAccountRequestDto}
|
|
57
57
|
* @memberof CreateLeadRequestDto
|
|
58
58
|
*/
|
|
59
59
|
'bankAccount'?: CreateBankAccountRequestDto;
|
|
60
60
|
/**
|
|
61
|
-
*
|
|
61
|
+
* 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
|
|
62
62
|
* @type {object}
|
|
63
63
|
* @memberof CreateLeadRequestDto
|
|
64
64
|
*/
|
|
65
65
|
'customData'?: object;
|
|
66
66
|
/**
|
|
67
|
-
*
|
|
67
|
+
* 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.
|
|
68
68
|
* @type {UploadedDocumentDto}
|
|
69
69
|
* @memberof CreateLeadRequestDto
|
|
70
70
|
*/
|
|
71
71
|
'uploadedDocument'?: UploadedDocumentDto;
|
|
72
72
|
/**
|
|
73
|
-
* Lead status. Default values are \"created\", \"approved\" and \"declined\".
|
|
73
|
+
* Lead status. Default values are \"created\", \"approved\" and \"declined\". However, those can be extended using /lead-statuses endpoint from insuranceservice.
|
|
74
74
|
* @type {string}
|
|
75
75
|
* @memberof CreateLeadRequestDto
|
|
76
76
|
*/
|
|
77
77
|
'status'?: string;
|
|
78
78
|
/**
|
|
79
|
-
* Premium Override
|
|
80
|
-
* @type {PremiumOverrideRequestDto}
|
|
79
|
+
* 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.
|
|
80
|
+
* @type {Array<PremiumOverrideRequestDto>}
|
|
81
81
|
* @memberof CreateLeadRequestDto
|
|
82
82
|
*/
|
|
83
|
-
'premiumOverride'?: PremiumOverrideRequestDto
|
|
83
|
+
'premiumOverride'?: Array<PremiumOverrideRequestDto>;
|
|
84
84
|
/**
|
|
85
|
-
* Payment method
|
|
85
|
+
* 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.
|
|
86
86
|
* @type {CreatePaymentMethodRequestDto}
|
|
87
87
|
* @memberof CreateLeadRequestDto
|
|
88
88
|
*/
|
|
89
89
|
'paymentMethod'?: CreatePaymentMethodRequestDto;
|
|
90
|
+
/**
|
|
91
|
+
* 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.
|
|
92
|
+
* @type {boolean}
|
|
93
|
+
* @memberof CreateLeadRequestDto
|
|
94
|
+
*/
|
|
95
|
+
'validate'?: boolean;
|
|
90
96
|
}
|
|
@@ -11,8 +11,8 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import { CreateAccountRequestDto } from './create-account-request-dto';
|
|
13
13
|
import { CreateBankAccountRequestDto } from './create-bank-account-request-dto';
|
|
14
|
+
import { CreateLeadPolicyRequestDto } from './create-lead-policy-request-dto';
|
|
14
15
|
import { CreatePaymentMethodRequestDto } from './create-payment-method-request-dto';
|
|
15
|
-
import { CreatePolicyRequestDto } from './create-policy-request-dto';
|
|
16
16
|
import { PremiumOverrideRequestDto } from './premium-override-request-dto';
|
|
17
17
|
import { UploadedDocumentDto } from './uploaded-document-dto';
|
|
18
18
|
/**
|
|
@@ -35,12 +35,12 @@ export interface GrpcPatchLeadRequestDto {
|
|
|
35
35
|
'account'?: CreateAccountRequestDto;
|
|
36
36
|
/**
|
|
37
37
|
* Policy
|
|
38
|
-
* @type {
|
|
38
|
+
* @type {CreateLeadPolicyRequestDto}
|
|
39
39
|
* @memberof GrpcPatchLeadRequestDto
|
|
40
40
|
*/
|
|
41
|
-
'policy'?:
|
|
41
|
+
'policy'?: CreateLeadPolicyRequestDto;
|
|
42
42
|
/**
|
|
43
|
-
* Lead status. Default values are \"created\", \"approved\" and \"declined\".
|
|
43
|
+
* Lead status. Default values are \"created\", \"approved\" and \"declined\". However, those can be extended using /lead-statuses endpoint from insuranceservice.
|
|
44
44
|
* @type {string}
|
|
45
45
|
* @memberof GrpcPatchLeadRequestDto
|
|
46
46
|
*/
|
|
@@ -81,4 +81,22 @@ export interface GrpcPatchLeadRequestDto {
|
|
|
81
81
|
* @memberof GrpcPatchLeadRequestDto
|
|
82
82
|
*/
|
|
83
83
|
'paymentMethod'?: CreatePaymentMethodRequestDto;
|
|
84
|
+
/**
|
|
85
|
+
*
|
|
86
|
+
* @type {string}
|
|
87
|
+
* @memberof GrpcPatchLeadRequestDto
|
|
88
|
+
*/
|
|
89
|
+
'code': string;
|
|
90
|
+
/**
|
|
91
|
+
*
|
|
92
|
+
* @type {boolean}
|
|
93
|
+
* @memberof GrpcPatchLeadRequestDto
|
|
94
|
+
*/
|
|
95
|
+
'shouldTriggerWorkflow'?: boolean;
|
|
96
|
+
/**
|
|
97
|
+
*
|
|
98
|
+
* @type {boolean}
|
|
99
|
+
* @memberof GrpcPatchLeadRequestDto
|
|
100
|
+
*/
|
|
101
|
+
'validate'?: boolean;
|
|
84
102
|
}
|
|
@@ -11,8 +11,8 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import { CreateAccountRequestDto } from './create-account-request-dto';
|
|
13
13
|
import { CreateBankAccountRequestDto } from './create-bank-account-request-dto';
|
|
14
|
+
import { CreateLeadPolicyRequestDto } from './create-lead-policy-request-dto';
|
|
14
15
|
import { CreatePaymentMethodRequestDto } from './create-payment-method-request-dto';
|
|
15
|
-
import { CreatePolicyRequestDto } from './create-policy-request-dto';
|
|
16
16
|
import { PremiumOverrideRequestDto } from './premium-override-request-dto';
|
|
17
17
|
import { UploadedDocumentDto } from './uploaded-document-dto';
|
|
18
18
|
/**
|
|
@@ -22,75 +22,81 @@ import { UploadedDocumentDto } from './uploaded-document-dto';
|
|
|
22
22
|
*/
|
|
23
23
|
export interface GrpcUpdateLeadRequestDto {
|
|
24
24
|
/**
|
|
25
|
-
*
|
|
25
|
+
* 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.
|
|
26
26
|
* @type {number}
|
|
27
27
|
* @memberof GrpcUpdateLeadRequestDto
|
|
28
28
|
*/
|
|
29
29
|
'productVersionId'?: number;
|
|
30
30
|
/**
|
|
31
|
-
*
|
|
32
|
-
* @type {
|
|
31
|
+
* 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.
|
|
32
|
+
* @type {CreateAccountRequestDto}
|
|
33
33
|
* @memberof GrpcUpdateLeadRequestDto
|
|
34
34
|
*/
|
|
35
|
-
'
|
|
35
|
+
'account': CreateAccountRequestDto;
|
|
36
36
|
/**
|
|
37
|
-
*
|
|
38
|
-
* @type {
|
|
37
|
+
* The policy object contains necessary information to create a policy. The Policy content will be validated if the \'validate\' flag is set to true
|
|
38
|
+
* @type {CreateLeadPolicyRequestDto}
|
|
39
39
|
* @memberof GrpcUpdateLeadRequestDto
|
|
40
40
|
*/
|
|
41
|
-
'
|
|
41
|
+
'policy': CreateLeadPolicyRequestDto;
|
|
42
42
|
/**
|
|
43
|
-
*
|
|
44
|
-
* @type {
|
|
43
|
+
* Lead status. Default values are \"created\", \"approved\" and \"declined\". However, those can be extended using /lead-statuses endpoint from insuranceservice.
|
|
44
|
+
* @type {string}
|
|
45
45
|
* @memberof GrpcUpdateLeadRequestDto
|
|
46
46
|
*/
|
|
47
|
-
'
|
|
47
|
+
'status': string;
|
|
48
48
|
/**
|
|
49
|
-
*
|
|
50
|
-
* @type {
|
|
49
|
+
* 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.
|
|
50
|
+
* @type {CreateBankAccountRequestDto}
|
|
51
51
|
* @memberof GrpcUpdateLeadRequestDto
|
|
52
52
|
*/
|
|
53
|
-
'
|
|
53
|
+
'bankAccount'?: CreateBankAccountRequestDto;
|
|
54
54
|
/**
|
|
55
|
-
*
|
|
56
|
-
* @type {
|
|
55
|
+
* 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
|
|
56
|
+
* @type {object}
|
|
57
57
|
* @memberof GrpcUpdateLeadRequestDto
|
|
58
58
|
*/
|
|
59
|
-
'
|
|
59
|
+
'customData'?: object;
|
|
60
60
|
/**
|
|
61
|
-
*
|
|
62
|
-
* @type {
|
|
61
|
+
* 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.
|
|
62
|
+
* @type {UploadedDocumentDto}
|
|
63
63
|
* @memberof GrpcUpdateLeadRequestDto
|
|
64
64
|
*/
|
|
65
|
-
'
|
|
65
|
+
'uploadedDocument'?: UploadedDocumentDto;
|
|
66
66
|
/**
|
|
67
|
-
*
|
|
68
|
-
* @type {
|
|
67
|
+
* 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.
|
|
68
|
+
* @type {Array<PremiumOverrideRequestDto>}
|
|
69
69
|
* @memberof GrpcUpdateLeadRequestDto
|
|
70
70
|
*/
|
|
71
|
-
'
|
|
71
|
+
'premiumOverride'?: Array<PremiumOverrideRequestDto>;
|
|
72
72
|
/**
|
|
73
|
-
*
|
|
74
|
-
* @type {
|
|
73
|
+
* 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.
|
|
74
|
+
* @type {string}
|
|
75
75
|
* @memberof GrpcUpdateLeadRequestDto
|
|
76
76
|
*/
|
|
77
|
-
'
|
|
77
|
+
'accountCode'?: string;
|
|
78
78
|
/**
|
|
79
|
-
*
|
|
80
|
-
* @type {
|
|
79
|
+
* 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.
|
|
80
|
+
* @type {CreatePaymentMethodRequestDto}
|
|
81
81
|
* @memberof GrpcUpdateLeadRequestDto
|
|
82
82
|
*/
|
|
83
|
-
'
|
|
83
|
+
'paymentMethod'?: CreatePaymentMethodRequestDto;
|
|
84
84
|
/**
|
|
85
|
-
*
|
|
86
|
-
* @type {
|
|
85
|
+
* 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.
|
|
86
|
+
* @type {boolean}
|
|
87
87
|
* @memberof GrpcUpdateLeadRequestDto
|
|
88
88
|
*/
|
|
89
|
-
'
|
|
89
|
+
'validate'?: boolean;
|
|
90
90
|
/**
|
|
91
91
|
*
|
|
92
92
|
* @type {string}
|
|
93
93
|
* @memberof GrpcUpdateLeadRequestDto
|
|
94
94
|
*/
|
|
95
|
-
'
|
|
95
|
+
'code': string;
|
|
96
|
+
/**
|
|
97
|
+
*
|
|
98
|
+
* @type {boolean}
|
|
99
|
+
* @memberof GrpcUpdateLeadRequestDto
|
|
100
|
+
*/
|
|
101
|
+
'shouldTriggerWorkflow'?: boolean;
|
|
96
102
|
}
|
package/dist/models/index.d.ts
CHANGED
|
@@ -7,6 +7,7 @@ export * from './create-custom-application-request-dto';
|
|
|
7
7
|
export * from './create-dummy-policy-request-dto';
|
|
8
8
|
export * from './create-insured-object-request-dto';
|
|
9
9
|
export * from './create-insured-object-response-class';
|
|
10
|
+
export * from './create-lead-policy-request-dto';
|
|
10
11
|
export * from './create-lead-request-dto';
|
|
11
12
|
export * from './create-lead-response-class';
|
|
12
13
|
export * from './create-lead-status-request-dto';
|
|
@@ -84,7 +85,9 @@ export * from './product-field-class';
|
|
|
84
85
|
export * from './product-field-type-class';
|
|
85
86
|
export * from './product-version-class';
|
|
86
87
|
export * from './sepa-dto';
|
|
88
|
+
export * from './shared-create-lead-policy-request-dto';
|
|
87
89
|
export * from './shared-invoice-class';
|
|
90
|
+
export * from './shared-lead-policy-object-dto';
|
|
88
91
|
export * from './shared-product-field-class';
|
|
89
92
|
export * from './shared-update-premium-formula-request-dto';
|
|
90
93
|
export * from './store-product-factors-request-dto';
|
package/dist/models/index.js
CHANGED
|
@@ -23,6 +23,7 @@ __exportStar(require("./create-custom-application-request-dto"), exports);
|
|
|
23
23
|
__exportStar(require("./create-dummy-policy-request-dto"), exports);
|
|
24
24
|
__exportStar(require("./create-insured-object-request-dto"), exports);
|
|
25
25
|
__exportStar(require("./create-insured-object-response-class"), exports);
|
|
26
|
+
__exportStar(require("./create-lead-policy-request-dto"), exports);
|
|
26
27
|
__exportStar(require("./create-lead-request-dto"), exports);
|
|
27
28
|
__exportStar(require("./create-lead-response-class"), exports);
|
|
28
29
|
__exportStar(require("./create-lead-status-request-dto"), exports);
|
|
@@ -100,7 +101,9 @@ __exportStar(require("./product-field-class"), exports);
|
|
|
100
101
|
__exportStar(require("./product-field-type-class"), exports);
|
|
101
102
|
__exportStar(require("./product-version-class"), exports);
|
|
102
103
|
__exportStar(require("./sepa-dto"), exports);
|
|
104
|
+
__exportStar(require("./shared-create-lead-policy-request-dto"), exports);
|
|
103
105
|
__exportStar(require("./shared-invoice-class"), exports);
|
|
106
|
+
__exportStar(require("./shared-lead-policy-object-dto"), exports);
|
|
104
107
|
__exportStar(require("./shared-product-field-class"), exports);
|
|
105
108
|
__exportStar(require("./shared-update-premium-formula-request-dto"), exports);
|
|
106
109
|
__exportStar(require("./store-product-factors-request-dto"), exports);
|
|
@@ -10,8 +10,8 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import { CreateAccountRequestDto } from './create-account-request-dto';
|
|
13
|
+
import { CreateLeadPolicyRequestDto } from './create-lead-policy-request-dto';
|
|
13
14
|
import { CreatePaymentMethodRequestDto } from './create-payment-method-request-dto';
|
|
14
|
-
import { CreatePolicyRequestDto } from './create-policy-request-dto';
|
|
15
15
|
import { LeadBankAccountClass } from './lead-bank-account-class';
|
|
16
16
|
import { PremiumOverrideRequestClass } from './premium-override-request-class';
|
|
17
17
|
import { SharedInvoiceClass } from './shared-invoice-class';
|
|
@@ -33,7 +33,7 @@ export interface LeadClass {
|
|
|
33
33
|
* @type {string}
|
|
34
34
|
* @memberof LeadClass
|
|
35
35
|
*/
|
|
36
|
-
'code'
|
|
36
|
+
'code': string;
|
|
37
37
|
/**
|
|
38
38
|
* Emil Resources Names (ERN) identifies the most specific owner of a resource.
|
|
39
39
|
* @type {string}
|
|
@@ -60,10 +60,10 @@ export interface LeadClass {
|
|
|
60
60
|
'account': CreateAccountRequestDto;
|
|
61
61
|
/**
|
|
62
62
|
* Lead policy.
|
|
63
|
-
* @type {
|
|
63
|
+
* @type {CreateLeadPolicyRequestDto}
|
|
64
64
|
* @memberof LeadClass
|
|
65
65
|
*/
|
|
66
|
-
'policy':
|
|
66
|
+
'policy': CreateLeadPolicyRequestDto;
|
|
67
67
|
/**
|
|
68
68
|
* Lead bank account, will be treated as a reference to payout customer claims.
|
|
69
69
|
* @type {LeadBankAccountClass}
|
|
@@ -111,11 +111,17 @@ export interface LeadClass {
|
|
|
111
111
|
* @type {SharedInvoiceClass}
|
|
112
112
|
* @memberof LeadClass
|
|
113
113
|
*/
|
|
114
|
-
'quote'
|
|
114
|
+
'quote'?: SharedInvoiceClass;
|
|
115
115
|
/**
|
|
116
116
|
* Payment method. When a payment method is provided, it needs to be handled in the workflow based on its type.
|
|
117
117
|
* @type {CreatePaymentMethodRequestDto}
|
|
118
118
|
* @memberof LeadClass
|
|
119
119
|
*/
|
|
120
|
-
'paymentMethod'
|
|
120
|
+
'paymentMethod'?: CreatePaymentMethodRequestDto;
|
|
121
|
+
/**
|
|
122
|
+
* A indicator to validate the lead.
|
|
123
|
+
* @type {boolean}
|
|
124
|
+
* @memberof LeadClass
|
|
125
|
+
*/
|
|
126
|
+
'validate': boolean;
|
|
121
127
|
}
|
|
@@ -11,8 +11,8 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import { CreateAccountRequestDto } from './create-account-request-dto';
|
|
13
13
|
import { CreateBankAccountRequestDto } from './create-bank-account-request-dto';
|
|
14
|
+
import { CreateLeadPolicyRequestDto } from './create-lead-policy-request-dto';
|
|
14
15
|
import { CreatePaymentMethodRequestDto } from './create-payment-method-request-dto';
|
|
15
|
-
import { CreatePolicyRequestDto } from './create-policy-request-dto';
|
|
16
16
|
import { PremiumOverrideRequestDto } from './premium-override-request-dto';
|
|
17
17
|
import { UploadedDocumentDto } from './uploaded-document-dto';
|
|
18
18
|
/**
|
|
@@ -35,12 +35,12 @@ export interface PatchLeadRequestDto {
|
|
|
35
35
|
'account'?: CreateAccountRequestDto;
|
|
36
36
|
/**
|
|
37
37
|
* Policy
|
|
38
|
-
* @type {
|
|
38
|
+
* @type {CreateLeadPolicyRequestDto}
|
|
39
39
|
* @memberof PatchLeadRequestDto
|
|
40
40
|
*/
|
|
41
|
-
'policy'?:
|
|
41
|
+
'policy'?: CreateLeadPolicyRequestDto;
|
|
42
42
|
/**
|
|
43
|
-
* Lead status. Default values are \"created\", \"approved\" and \"declined\".
|
|
43
|
+
* Lead status. Default values are \"created\", \"approved\" and \"declined\". However, those can be extended using /lead-statuses endpoint from insuranceservice.
|
|
44
44
|
* @type {string}
|
|
45
45
|
* @memberof PatchLeadRequestDto
|
|
46
46
|
*/
|
|
@@ -81,4 +81,10 @@ export interface PatchLeadRequestDto {
|
|
|
81
81
|
* @memberof PatchLeadRequestDto
|
|
82
82
|
*/
|
|
83
83
|
'paymentMethod'?: CreatePaymentMethodRequestDto;
|
|
84
|
+
/**
|
|
85
|
+
*
|
|
86
|
+
* @type {boolean}
|
|
87
|
+
* @memberof PatchLeadRequestDto
|
|
88
|
+
*/
|
|
89
|
+
'validate'?: boolean;
|
|
84
90
|
}
|
|
@@ -16,11 +16,17 @@
|
|
|
16
16
|
*/
|
|
17
17
|
export interface PolicyObjectDto {
|
|
18
18
|
/**
|
|
19
|
-
*
|
|
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 PolicyObjectDto
|
|
22
22
|
*/
|
|
23
|
-
'insuredObjectId'
|
|
23
|
+
'insuredObjectId'?: number;
|
|
24
|
+
/**
|
|
25
|
+
* Insured object name. Human readable identifier of insured object. Can be used instead of insuredObjectId
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof PolicyObjectDto
|
|
28
|
+
*/
|
|
29
|
+
'insuredObjectName'?: string;
|
|
24
30
|
/**
|
|
25
31
|
* Insured object data.
|
|
26
32
|
* @type {object}
|