@emilgroup/public-api-sdk-node 1.15.0 → 1.16.0

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.
@@ -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-node",
3
- "version": "1.15.0",
3
+ "version": "1.16.0",
4
4
  "description": "OpenAPI client for @emilgroup/public-api-sdk-node",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "keywords": [