@emilgroup/public-api-sdk-node 1.22.0 → 1.27.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.
Files changed (37) hide show
  1. package/.openapi-generator/FILES +3 -0
  2. package/README.md +2 -2
  3. package/api/documents-api.ts +114 -0
  4. package/api/products-api.ts +120 -0
  5. package/dist/api/documents-api.d.ts +64 -0
  6. package/dist/api/documents-api.js +98 -0
  7. package/dist/api/products-api.d.ts +66 -0
  8. package/dist/api/products-api.js +99 -0
  9. package/dist/models/calculate-product-fields-request-dto.d.ts +31 -0
  10. package/dist/models/calculate-product-fields-request-dto.js +15 -0
  11. package/dist/models/calculate-product-fields-response-class.d.ts +25 -0
  12. package/dist/models/calculate-product-fields-response-class.js +15 -0
  13. package/dist/models/create-estimated-invoice-response-class.d.ts +8 -1
  14. package/dist/models/create-lead-request-dto.d.ts +7 -7
  15. package/dist/models/document-class.d.ts +6 -0
  16. package/dist/models/index.d.ts +3 -0
  17. package/dist/models/index.js +3 -0
  18. package/dist/models/inline-response200.d.ts +6 -6
  19. package/dist/models/inline-response503.d.ts +6 -6
  20. package/dist/models/policy-object-request-dto.d.ts +1 -1
  21. package/dist/models/policy-object-response-class.d.ts +36 -0
  22. package/dist/models/policy-object-response-class.js +15 -0
  23. package/dist/models/product-document-class.d.ts +7 -7
  24. package/dist/models/update-lead-request-dto.d.ts +5 -5
  25. package/models/calculate-product-fields-request-dto.ts +37 -0
  26. package/models/calculate-product-fields-response-class.ts +31 -0
  27. package/models/create-estimated-invoice-response-class.ts +8 -1
  28. package/models/create-lead-request-dto.ts +7 -7
  29. package/models/document-class.ts +6 -0
  30. package/models/index.ts +3 -0
  31. package/models/inline-response200.ts +6 -6
  32. package/models/inline-response503.ts +6 -6
  33. package/models/policy-object-request-dto.ts +1 -1
  34. package/models/policy-object-response-class.ts +42 -0
  35. package/models/product-document-class.ts +7 -7
  36. package/models/update-lead-request-dto.ts +5 -5
  37. package/package.json +2 -2
@@ -13,6 +13,7 @@
13
13
  */
14
14
 
15
15
 
16
+ import { CalculateProductFieldsResponseClass } from './calculate-product-fields-response-class';
16
17
  import { InvoiceClass } from './invoice-class';
17
18
 
18
19
  /**
@@ -28,10 +29,16 @@ export interface CreateEstimatedInvoiceResponseClass {
28
29
  */
29
30
  'invoice'?: InvoiceClass;
30
31
  /**
31
- * In some cases, custom premium calculation needs to be used. In that case, a custom object is returned. It can hold up any kind of information. For more information, check the general documentation.
32
+ * In some cases, custom premium calculation needs to be used. In that case, a custom object is returned. It can hold up any kind of information. For more information, check the general documentation.
32
33
  * @type {object}
33
34
  * @memberof CreateEstimatedInvoiceResponseClass
34
35
  */
35
36
  'custom'?: object;
37
+ /**
38
+ * Calculated policy obejcts response
39
+ * @type {CalculateProductFieldsResponseClass}
40
+ * @memberof CreateEstimatedInvoiceResponseClass
41
+ */
42
+ 'policyObjects'?: CalculateProductFieldsResponseClass;
36
43
  }
37
44
 
@@ -57,7 +57,7 @@ export interface CreateLeadRequestDto {
57
57
  */
58
58
  'account'?: CreateAccountRequestDto;
59
59
  /**
60
- * 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.
60
+ * 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.
61
61
  * @type {string}
62
62
  * @memberof CreateLeadRequestDto
63
63
  */
@@ -69,31 +69,31 @@ export interface CreateLeadRequestDto {
69
69
  */
70
70
  'policyObjects'?: Array<PolicyObjectRequestDto>;
71
71
  /**
72
- * 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.
72
+ * 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.
73
73
  * @type {CreateBankAccountRequestDto}
74
74
  * @memberof CreateLeadRequestDto
75
75
  */
76
76
  'bankAccount'?: CreateBankAccountRequestDto;
77
77
  /**
78
- * 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
78
+ * 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
79
79
  * @type {object}
80
80
  * @memberof CreateLeadRequestDto
81
81
  */
82
82
  'customData'?: object;
83
83
  /**
84
- * 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.
84
+ * 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.
85
85
  * @type {UploadedDocumentDto}
86
86
  * @memberof CreateLeadRequestDto
87
87
  */
88
88
  'uploadedDocument'?: UploadedDocumentDto;
89
89
  /**
90
- * Lead status. Default values are \"created\", \"approved\" and \"declined\". However, those can be extended using /lead-statuses endpoint from insuranceservice.
90
+ * Lead status. Default values are \"created\", \"approved\" and \"declined\". However, those can be extended using /lead-statuses endpoint from insuranceservice.
91
91
  * @type {string}
92
92
  * @memberof CreateLeadRequestDto
93
93
  */
94
94
  'status'?: string;
95
95
  /**
96
- * 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.
96
+ * 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.
97
97
  * @type {Array<PremiumOverrideRequestDto>}
98
98
  * @memberof CreateLeadRequestDto
99
99
  */
@@ -105,7 +105,7 @@ export interface CreateLeadRequestDto {
105
105
  */
106
106
  'paymentMethod'?: CreatePaymentMethodRequestDto;
107
107
  /**
108
- * 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.
108
+ * 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.
109
109
  * @type {boolean}
110
110
  * @memberof CreateLeadRequestDto
111
111
  */
@@ -98,6 +98,12 @@ export interface DocumentClass {
98
98
  * @memberof DocumentClass
99
99
  */
100
100
  'filename': string;
101
+ /**
102
+ * Lead
103
+ * @type {string}
104
+ * @memberof DocumentClass
105
+ */
106
+ 'leadCode': string;
101
107
  /**
102
108
  * Time at which the object was created.
103
109
  * @type {string}
package/models/index.ts CHANGED
@@ -1,6 +1,8 @@
1
1
  export * from './address-completion-item-class';
2
2
  export * from './address-completion-response-class';
3
3
  export * from './address-field-score-class';
4
+ export * from './calculate-product-fields-request-dto';
5
+ export * from './calculate-product-fields-response-class';
4
6
  export * from './complete-braintree-payment-setup-request-dto';
5
7
  export * from './complete-email-verification-dto';
6
8
  export * from './complete-email-verification-response-class';
@@ -51,6 +53,7 @@ export * from './list-product-documents-response-class';
51
53
  export * from './list-products-response-class';
52
54
  export * from './payment-method-class';
53
55
  export * from './policy-object-request-dto';
56
+ export * from './policy-object-response-class';
54
57
  export * from './premium-override-dto';
55
58
  export * from './premium-override-request-dto';
56
59
  export * from './product-class';
@@ -28,21 +28,21 @@ export interface InlineResponse200 {
28
28
  'status'?: string;
29
29
  /**
30
30
  *
31
- * @type {{ [key: string]: { [key: string]: string; }; }}
31
+ * @type {{ [key: string]: { [key: string]: object; }; }}
32
32
  * @memberof InlineResponse200
33
33
  */
34
- 'info'?: { [key: string]: { [key: string]: string; }; } | null;
34
+ 'info'?: { [key: string]: { [key: string]: object; }; } | null;
35
35
  /**
36
36
  *
37
- * @type {{ [key: string]: { [key: string]: string; }; }}
37
+ * @type {{ [key: string]: { [key: string]: object; }; }}
38
38
  * @memberof InlineResponse200
39
39
  */
40
- 'error'?: { [key: string]: { [key: string]: string; }; } | null;
40
+ 'error'?: { [key: string]: { [key: string]: object; }; } | null;
41
41
  /**
42
42
  *
43
- * @type {{ [key: string]: { [key: string]: string; }; }}
43
+ * @type {{ [key: string]: { [key: string]: object; }; }}
44
44
  * @memberof InlineResponse200
45
45
  */
46
- 'details'?: { [key: string]: { [key: string]: string; }; };
46
+ 'details'?: { [key: string]: { [key: string]: object; }; };
47
47
  }
48
48
 
@@ -28,21 +28,21 @@ export interface InlineResponse503 {
28
28
  'status'?: string;
29
29
  /**
30
30
  *
31
- * @type {{ [key: string]: { [key: string]: string; }; }}
31
+ * @type {{ [key: string]: { [key: string]: object; }; }}
32
32
  * @memberof InlineResponse503
33
33
  */
34
- 'info'?: { [key: string]: { [key: string]: string; }; } | null;
34
+ 'info'?: { [key: string]: { [key: string]: object; }; } | null;
35
35
  /**
36
36
  *
37
- * @type {{ [key: string]: { [key: string]: string; }; }}
37
+ * @type {{ [key: string]: { [key: string]: object; }; }}
38
38
  * @memberof InlineResponse503
39
39
  */
40
- 'error'?: { [key: string]: { [key: string]: string; }; } | null;
40
+ 'error'?: { [key: string]: { [key: string]: object; }; } | null;
41
41
  /**
42
42
  *
43
- * @type {{ [key: string]: { [key: string]: string; }; }}
43
+ * @type {{ [key: string]: { [key: string]: object; }; }}
44
44
  * @memberof InlineResponse503
45
45
  */
46
- 'details'?: { [key: string]: { [key: string]: string; }; };
46
+ 'details'?: { [key: string]: { [key: string]: object; }; };
47
47
  }
48
48
 
@@ -27,7 +27,7 @@ export interface PolicyObjectRequestDto {
27
27
  */
28
28
  'insuredObjectId'?: number;
29
29
  /**
30
- * Insured object name. Human readable identifier of insured object. Can be used instead of insuredObjectId
30
+ * Insured object name. Human readable identifier of insured object. Can be used instead of insuredObjectId
31
31
  * @type {string}
32
32
  * @memberof PolicyObjectRequestDto
33
33
  */
@@ -0,0 +1,42 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Emil PublicAPI
5
+ * The Emil Public API description
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ *
19
+ * @export
20
+ * @interface PolicyObjectResponseClass
21
+ */
22
+ export interface PolicyObjectResponseClass {
23
+ /**
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
+ * @type {number}
26
+ * @memberof PolicyObjectResponseClass
27
+ */
28
+ 'insuredObjectId': number;
29
+ /**
30
+ * Insured object name. Human readable identifier of insured object. Can be used instead of insuredObjectId
31
+ * @type {string}
32
+ * @memberof PolicyObjectResponseClass
33
+ */
34
+ 'insuredObjectName': string;
35
+ /**
36
+ * Insured object data. The date will be validated if the \'validate\' flag is set to true.
37
+ * @type {object}
38
+ * @memberof PolicyObjectResponseClass
39
+ */
40
+ 'data': object;
41
+ }
42
+
@@ -74,12 +74,6 @@ export interface ProductDocumentClass {
74
74
  * @memberof ProductDocumentClass
75
75
  */
76
76
  'productSlug': string;
77
- /**
78
- * Time at which the object was created.
79
- * @type {string}
80
- * @memberof ProductDocumentClass
81
- */
82
- 'createdAt': string;
83
77
  /**
84
78
  * A slug is a human-readable, unique identifier, used to identify a resource instead of a less human-readable identifier like an id.
85
79
  * @type {string}
@@ -87,11 +81,17 @@ export interface ProductDocumentClass {
87
81
  */
88
82
  'slug': string;
89
83
  /**
90
- * The current verison of a document.
84
+ * Version number of the document, incremented each time the document is updated.
91
85
  * @type {number}
92
86
  * @memberof ProductDocumentClass
93
87
  */
94
88
  'versionNumber': number;
89
+ /**
90
+ * Time at which the object was created.
91
+ * @type {string}
92
+ * @memberof ProductDocumentClass
93
+ */
94
+ 'createdAt': string;
95
95
  }
96
96
 
97
97
  export const ProductDocumentClassContentTypeEnum = {
@@ -62,25 +62,25 @@ export interface UpdateLeadRequestDto {
62
62
  */
63
63
  'policyObjects'?: Array<PolicyObjectRequestDto>;
64
64
  /**
65
- * 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.
65
+ * 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.
66
66
  * @type {CreateBankAccountRequestDto}
67
67
  * @memberof UpdateLeadRequestDto
68
68
  */
69
69
  'bankAccount'?: CreateBankAccountRequestDto;
70
70
  /**
71
- * 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
71
+ * 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
72
72
  * @type {object}
73
73
  * @memberof UpdateLeadRequestDto
74
74
  */
75
75
  'customData'?: object;
76
76
  /**
77
- * 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.
77
+ * 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.
78
78
  * @type {UploadedDocumentDto}
79
79
  * @memberof UpdateLeadRequestDto
80
80
  */
81
81
  'uploadedDocument'?: UploadedDocumentDto;
82
82
  /**
83
- * Lead status. Default values are \"created\", \"approved\" and \"declined\". However, those can be extended using /lead-statuses endpoint from insuranceservice.
83
+ * Lead status. Default values are \"created\", \"approved\" and \"declined\". However, those can be extended using /lead-statuses endpoint from insuranceservice.
84
84
  * @type {string}
85
85
  * @memberof UpdateLeadRequestDto
86
86
  */
@@ -92,7 +92,7 @@ export interface UpdateLeadRequestDto {
92
92
  */
93
93
  'paymentMethod'?: CreatePaymentMethodRequestDto;
94
94
  /**
95
- * 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.
95
+ * 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.
96
96
  * @type {boolean}
97
97
  * @memberof UpdateLeadRequestDto
98
98
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@emilgroup/public-api-sdk-node",
3
- "version": "1.22.0",
3
+ "version": "1.27.0",
4
4
  "description": "OpenAPI client for @emilgroup/public-api-sdk-node",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "keywords": [
@@ -23,7 +23,7 @@
23
23
  "url": "^0.11.0"
24
24
  },
25
25
  "devDependencies": {
26
- "@types/node": "^12.11.5",
26
+ "@types/node": "^12.11.5",
27
27
  "typescript": "^4.0"
28
28
  }
29
29
  }