@emilgroup/insurance-sdk-node 1.104.1-beta.7 → 1.104.1-beta.70

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 (51) hide show
  1. package/.openapi-generator/FILES +3 -2
  2. package/README.md +2 -2
  3. package/api/health-check-api.ts +6 -10
  4. package/api/leads-api.ts +4 -4
  5. package/api/policies-api.ts +32 -32
  6. package/api/premium-calculation-api.ts +169 -0
  7. package/api.ts +2 -0
  8. package/dist/api/health-check-api.d.ts +7 -8
  9. package/dist/api/health-check-api.js +4 -4
  10. package/dist/api/leads-api.d.ts +4 -4
  11. package/dist/api/leads-api.js +3 -3
  12. package/dist/api/policies-api.d.ts +32 -32
  13. package/dist/api/policies-api.js +28 -28
  14. package/dist/api/premium-calculation-api.d.ts +97 -0
  15. package/dist/api/premium-calculation-api.js +228 -0
  16. package/dist/api.d.ts +1 -0
  17. package/dist/api.js +1 -0
  18. package/dist/models/calculate-premium-response-class.d.ts +39 -0
  19. package/dist/models/calculated-policy-objects-class.d.ts +25 -0
  20. package/dist/models/create-draft-policy-request-dto.d.ts +1 -1
  21. package/dist/models/create-premium-formula-request-dto.d.ts +6 -0
  22. package/dist/models/create-product-request-dto.d.ts +12 -0
  23. package/dist/models/create-product-version-request-dto.d.ts +6 -0
  24. package/dist/models/get-draft-policy-request-dto.d.ts +1 -1
  25. package/dist/models/index.d.ts +2 -2
  26. package/dist/models/index.js +2 -2
  27. package/dist/models/partner-class.d.ts +6 -0
  28. package/dist/models/patch-draft-policy-request-dto.d.ts +2 -2
  29. package/dist/models/policy-object-dto.d.ts +1 -1
  30. package/dist/models/policy-premium-item-class.d.ts +1 -1
  31. package/dist/models/premium-formula-class.d.ts +6 -0
  32. package/models/calculate-premium-response-class.ts +45 -0
  33. package/models/calculated-policy-objects-class.ts +31 -0
  34. package/models/create-draft-policy-request-dto.ts +1 -1
  35. package/models/create-premium-formula-request-dto.ts +6 -0
  36. package/models/create-product-request-dto.ts +12 -0
  37. package/models/create-product-version-request-dto.ts +6 -0
  38. package/models/get-draft-policy-request-dto.ts +1 -1
  39. package/models/index.ts +2 -2
  40. package/models/partner-class.ts +6 -0
  41. package/models/patch-draft-policy-request-dto.ts +2 -2
  42. package/models/policy-object-dto.ts +1 -1
  43. package/models/policy-premium-item-class.ts +1 -1
  44. package/models/premium-formula-class.ts +6 -0
  45. package/package.json +1 -1
  46. package/dist/models/inline-response200.d.ts +0 -54
  47. package/dist/models/inline-response503.d.ts +0 -54
  48. package/models/inline-response200.ts +0 -48
  49. package/models/inline-response503.ts +0 -48
  50. /package/dist/models/{inline-response200.js → calculate-premium-response-class.js} +0 -0
  51. /package/dist/models/{inline-response503.js → calculated-policy-objects-class.js} +0 -0
@@ -12,14 +12,13 @@
12
12
  import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
13
  import { Configuration } from '../configuration';
14
14
  import { RequestArgs, BaseAPI } from '../base';
15
- import { InlineResponse200 } from '../models';
16
15
  /**
17
16
  * HealthCheckApi - axios parameter creator
18
17
  * @export
19
18
  */
20
19
  export declare const HealthCheckApiAxiosParamCreator: (configuration?: Configuration) => {
21
20
  /**
22
- * Returns the health status of the insurance service. This endpoint is used to monitor the operational status of the insurance service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
21
+ * Returns the health status of the insuranceservice service. This endpoint is used to monitor the operational status of the insuranceservice service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
23
22
  * @summary Health Check
24
23
  * @param {*} [options] Override http request option.
25
24
  * @throws {RequiredError}
@@ -32,12 +31,12 @@ export declare const HealthCheckApiAxiosParamCreator: (configuration?: Configura
32
31
  */
33
32
  export declare const HealthCheckApiFp: (configuration?: Configuration) => {
34
33
  /**
35
- * Returns the health status of the insurance service. This endpoint is used to monitor the operational status of the insurance service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
34
+ * Returns the health status of the insuranceservice service. This endpoint is used to monitor the operational status of the insuranceservice service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
36
35
  * @summary Health Check
37
36
  * @param {*} [options] Override http request option.
38
37
  * @throws {RequiredError}
39
38
  */
40
- check(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse200>>;
39
+ check(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
41
40
  };
42
41
  /**
43
42
  * HealthCheckApi - factory interface
@@ -45,12 +44,12 @@ export declare const HealthCheckApiFp: (configuration?: Configuration) => {
45
44
  */
46
45
  export declare const HealthCheckApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
47
46
  /**
48
- * Returns the health status of the insurance service. This endpoint is used to monitor the operational status of the insurance service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
47
+ * Returns the health status of the insuranceservice service. This endpoint is used to monitor the operational status of the insuranceservice service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
49
48
  * @summary Health Check
50
49
  * @param {*} [options] Override http request option.
51
50
  * @throws {RequiredError}
52
51
  */
53
- check(options?: any): AxiosPromise<InlineResponse200>;
52
+ check(options?: any): AxiosPromise<void>;
54
53
  };
55
54
  /**
56
55
  * HealthCheckApi - object-oriented interface
@@ -60,11 +59,11 @@ export declare const HealthCheckApiFactory: (configuration?: Configuration, base
60
59
  */
61
60
  export declare class HealthCheckApi extends BaseAPI {
62
61
  /**
63
- * Returns the health status of the insurance service. This endpoint is used to monitor the operational status of the insurance service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
62
+ * Returns the health status of the insuranceservice service. This endpoint is used to monitor the operational status of the insuranceservice service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
64
63
  * @summary Health Check
65
64
  * @param {*} [options] Override http request option.
66
65
  * @throws {RequiredError}
67
66
  * @memberof HealthCheckApi
68
67
  */
69
- check(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InlineResponse200, any, {}>>;
68
+ check(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
70
69
  }
@@ -97,7 +97,7 @@ var HealthCheckApiAxiosParamCreator = function (configuration) {
97
97
  var _this = this;
98
98
  return {
99
99
  /**
100
- * Returns the health status of the insurance service. This endpoint is used to monitor the operational status of the insurance service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
100
+ * Returns the health status of the insuranceservice service. This endpoint is used to monitor the operational status of the insuranceservice service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
101
101
  * @summary Health Check
102
102
  * @param {*} [options] Override http request option.
103
103
  * @throws {RequiredError}
@@ -137,7 +137,7 @@ var HealthCheckApiFp = function (configuration) {
137
137
  var localVarAxiosParamCreator = (0, exports.HealthCheckApiAxiosParamCreator)(configuration);
138
138
  return {
139
139
  /**
140
- * Returns the health status of the insurance service. This endpoint is used to monitor the operational status of the insurance service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
140
+ * Returns the health status of the insuranceservice service. This endpoint is used to monitor the operational status of the insuranceservice service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
141
141
  * @summary Health Check
142
142
  * @param {*} [options] Override http request option.
143
143
  * @throws {RequiredError}
@@ -166,7 +166,7 @@ var HealthCheckApiFactory = function (configuration, basePath, axios) {
166
166
  var localVarFp = (0, exports.HealthCheckApiFp)(configuration);
167
167
  return {
168
168
  /**
169
- * Returns the health status of the insurance service. This endpoint is used to monitor the operational status of the insurance service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
169
+ * Returns the health status of the insuranceservice service. This endpoint is used to monitor the operational status of the insuranceservice service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
170
170
  * @summary Health Check
171
171
  * @param {*} [options] Override http request option.
172
172
  * @throws {RequiredError}
@@ -189,7 +189,7 @@ var HealthCheckApi = /** @class */ (function (_super) {
189
189
  return _super !== null && _super.apply(this, arguments) || this;
190
190
  }
191
191
  /**
192
- * Returns the health status of the insurance service. This endpoint is used to monitor the operational status of the insurance service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
192
+ * Returns the health status of the insuranceservice service. This endpoint is used to monitor the operational status of the insuranceservice service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
193
193
  * @summary Health Check
194
194
  * @param {*} [options] Override http request option.
195
195
  * @throws {RequiredError}
@@ -91,7 +91,7 @@ export declare const LeadsApiAxiosParamCreator: (configuration?: Configuration)
91
91
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
92
92
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
93
93
  * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
94
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
94
+ * @param {string} [search] Free-text search across the lead\&#39;s key fields: codes, status, product, account data (name, company, e-mail, address, phone), policy and insured-object data, bank and quote values. Matching is case- and accent-insensitive (mueller finds Müller), tolerates typos, and ranks results by relevance. To search a single field, pass search&#x3D;path:value — e.g. search&#x3D;account.lastName:Müller or search&#x3D;policyObjects.data.vin:WVW123. The value matches exactly or as a prefix; paths are dot-separated and case-sensitive.
95
95
  * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
96
96
  * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
97
97
  * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
@@ -198,7 +198,7 @@ export declare const LeadsApiFp: (configuration?: Configuration) => {
198
198
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
199
199
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
200
200
  * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
201
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
201
+ * @param {string} [search] Free-text search across the lead\&#39;s key fields: codes, status, product, account data (name, company, e-mail, address, phone), policy and insured-object data, bank and quote values. Matching is case- and accent-insensitive (mueller finds Müller), tolerates typos, and ranks results by relevance. To search a single field, pass search&#x3D;path:value — e.g. search&#x3D;account.lastName:Müller or search&#x3D;policyObjects.data.vin:WVW123. The value matches exactly or as a prefix; paths are dot-separated and case-sensitive.
202
202
  * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
203
203
  * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
204
204
  * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
@@ -305,7 +305,7 @@ export declare const LeadsApiFactory: (configuration?: Configuration, basePath?:
305
305
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
306
306
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
307
307
  * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
308
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
308
+ * @param {string} [search] Free-text search across the lead\&#39;s key fields: codes, status, product, account data (name, company, e-mail, address, phone), policy and insured-object data, bank and quote values. Matching is case- and accent-insensitive (mueller finds Müller), tolerates typos, and ranks results by relevance. To search a single field, pass search&#x3D;path:value — e.g. search&#x3D;account.lastName:Müller or search&#x3D;policyObjects.data.vin:WVW123. The value matches exactly or as a prefix; paths are dot-separated and case-sensitive.
309
309
  * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
310
310
  * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
311
311
  * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
@@ -501,7 +501,7 @@ export interface LeadsApiListLeadsRequest {
501
501
  */
502
502
  readonly filter?: string;
503
503
  /**
504
- * To search the list by any field, pass search&#x3D;xxx to fetch the result.
504
+ * Free-text search across the lead\&#39;s key fields: codes, status, product, account data (name, company, e-mail, address, phone), policy and insured-object data, bank and quote values. Matching is case- and accent-insensitive (mueller finds Müller), tolerates typos, and ranks results by relevance. To search a single field, pass search&#x3D;path:value — e.g. search&#x3D;account.lastName:Müller or search&#x3D;policyObjects.data.vin:WVW123. The value matches exactly or as a prefix; paths are dot-separated and case-sensitive.
505
505
  * @type {string}
506
506
  * @memberof LeadsApiListLeads
507
507
  */
@@ -403,7 +403,7 @@ var LeadsApiAxiosParamCreator = function (configuration) {
403
403
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
404
404
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
405
405
  * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
406
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
406
+ * @param {string} [search] Free-text search across the lead\&#39;s key fields: codes, status, product, account data (name, company, e-mail, address, phone), policy and insured-object data, bank and quote values. Matching is case- and accent-insensitive (mueller finds Müller), tolerates typos, and ranks results by relevance. To search a single field, pass search&#x3D;path:value — e.g. search&#x3D;account.lastName:Müller or search&#x3D;policyObjects.data.vin:WVW123. The value matches exactly or as a prefix; paths are dot-separated and case-sensitive.
407
407
  * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
408
408
  * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
409
409
  * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
@@ -772,7 +772,7 @@ var LeadsApiFp = function (configuration) {
772
772
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
773
773
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
774
774
  * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
775
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
775
+ * @param {string} [search] Free-text search across the lead\&#39;s key fields: codes, status, product, account data (name, company, e-mail, address, phone), policy and insured-object data, bank and quote values. Matching is case- and accent-insensitive (mueller finds Müller), tolerates typos, and ranks results by relevance. To search a single field, pass search&#x3D;path:value — e.g. search&#x3D;account.lastName:Müller or search&#x3D;policyObjects.data.vin:WVW123. The value matches exactly or as a prefix; paths are dot-separated and case-sensitive.
776
776
  * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
777
777
  * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
778
778
  * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
@@ -943,7 +943,7 @@ var LeadsApiFactory = function (configuration, basePath, axios) {
943
943
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
944
944
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
945
945
  * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
946
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
946
+ * @param {string} [search] Free-text search across the lead\&#39;s key fields: codes, status, product, account data (name, company, e-mail, address, phone), policy and insured-object data, bank and quote values. Matching is case- and accent-insensitive (mueller finds Müller), tolerates typos, and ranks results by relevance. To search a single field, pass search&#x3D;path:value — e.g. search&#x3D;account.lastName:Müller or search&#x3D;policyObjects.data.vin:WVW123. The value matches exactly or as a prefix; paths are dot-separated and case-sensitive.
947
947
  * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
948
948
  * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
949
949
  * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
@@ -50,7 +50,7 @@ export declare const PoliciesApiAxiosParamCreator: (configuration?: Configuratio
50
50
  */
51
51
  activatePolicy: (policyCode: string, activatePolicyRequestDto: ActivatePolicyRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
52
52
  /**
53
- * This will create a draft policy in the database. **Required Permissions** \"policy-management.policies.create\"
53
+ * Creates a draft version of the policy update, without affecting the current version. This adds a new version to the existing policy — it does not create a new policy. The draft is returned with `isDraft: true` and `isCurrent: false`; the current version is unchanged until the draft is approved via `PATCH .../draft` with `revisionStatus: APPROVED`. **Required Permissions** \"policy-management.policies.create\"
54
54
  * @summary Create the draft-policy
55
55
  * @param {string} policyCode Unique identifier for the object.
56
56
  * @param {CreateDraftPolicyRequestDto} createDraftPolicyRequestDto
@@ -78,11 +78,11 @@ export declare const PoliciesApiAxiosParamCreator: (configuration?: Configuratio
78
78
  */
79
79
  deleteDraftPolicy: (policyCode: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
80
80
  /**
81
- * Retrieves the details of the draft-policy that was previously created. Supply the unique draft-policy code that was returned when you created it and Emil Api will return the corresponding draft-policy information. **Required Permissions** \"policy-management.policies.view\"
81
+ * Retrieves the draft version of the policy, if one exists. The returned version has `isDraft: true` and `isCurrent: false` — it is never the current/live version. Returns a 404 if no draft exists (e.g. after it has been approved or rejected). **Required Permissions** \"policy-management.policies.view\"
82
82
  * @summary Retrieve the draft-policy
83
83
  * @param {string} policyCode Unique identifier for the object.
84
84
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
85
- * @param {string} [expand] Fields to expand response by.
85
+ * @param {string} [expand] Fields to expand in the draft response. Pass the unprefixed relation name; for example, \&quot;premiumItems\&quot; expands the draft premium items relation.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: version, timelines, premiums, premiumItems, premiumFormulas&lt;/i&gt;
86
86
  * @param {*} [options] Override http request option.
87
87
  * @throws {RequiredError}
88
88
  */
@@ -109,16 +109,16 @@ export declare const PoliciesApiAxiosParamCreator: (configuration?: Configuratio
109
109
  */
110
110
  getPolicyDataByDate: (code: string, authorization?: string, timesliceDate?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
111
111
  /**
112
- * Returns a list of policies you have previously created. The policies are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"policy-management.policies.view\"
112
+ * Returns a list of policies you have previously created. The policies are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.<br/> <br/> <b>Notes on filtering:</b><br/> - The `partnerCode` filter matches any policy that has ever had a link to that partner — past, current, or future-dated — not only currently-assigned ones. There is currently no separate filter to match only the currently-active link.<br/> - An unrecognized filter field name is silently ignored: the request returns 200 with the unfiltered (or partially filtered, if combined with valid fields) result set rather than an error. **Required Permissions** \"policy-management.policies.view\"
113
113
  * @summary List policies
114
114
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
115
115
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
116
116
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
117
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode&lt;/i&gt;
118
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
117
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode, partnerLinks.partnerCode&lt;/i&gt;
118
+ * @param {string} [search] Free-text search across the policy\&#39;s key fields: policy codes and numbers, holder, status, product, account and lead codes, start date, and insured-object data (policyObjects.data). Matching is case- and accent-insensitive (mueller finds Müller), tolerates typos, and ranks results by relevance. To search a single field, pass search&#x3D;path:value — e.g. search&#x3D;holder:Müller or search&#x3D;policyObjects.data.postalCode:10115. The value matches exactly or as a prefix; paths are dot-separated and case-sensitive.
119
119
  * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, policyNumber, createdAt, updatedAt, policyStartDate, productVersionId, productId&lt;/i&gt;
120
120
  * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: versions, product, timelines, premiums, premiumItems, premiumFormulas, currentVersion, currentTimelines, currentPremiums, currentPremiumItems, currentPremiumFormulas, partnerLinks&lt;i&gt;
121
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode&lt;/i&gt;
121
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode, partnerLinks.partnerCode&lt;/i&gt;
122
122
  * @param {*} [options] Override http request option.
123
123
  * @throws {RequiredError}
124
124
  */
@@ -155,7 +155,7 @@ export declare const PoliciesApiAxiosParamCreator: (configuration?: Configuratio
155
155
  */
156
156
  listPolicyVersions: (policyCode: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
157
157
  /**
158
- * Updates the specified draft-policy by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"policy-management.policies.update\"
158
+ * Updates the draft version, or changes its lifecycle state via `revisionStatus` (see that field\'s description for what each value does — most notably, `APPROVED` promotes the draft to the current policy version and `REJECTED` deletes it). **Required Permissions** \"policy-management.policies.update\"
159
159
  * @summary Update the draft-policy
160
160
  * @param {string} policyCode Unique identifier for the object.
161
161
  * @param {PatchDraftPolicyRequestDto} patchDraftPolicyRequestDto
@@ -241,7 +241,7 @@ export declare const PoliciesApiFp: (configuration?: Configuration) => {
241
241
  */
242
242
  activatePolicy(policyCode: string, activatePolicyRequestDto: ActivatePolicyRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ActivatePolicyResponseClass>>;
243
243
  /**
244
- * This will create a draft policy in the database. **Required Permissions** \"policy-management.policies.create\"
244
+ * Creates a draft version of the policy update, without affecting the current version. This adds a new version to the existing policy — it does not create a new policy. The draft is returned with `isDraft: true` and `isCurrent: false`; the current version is unchanged until the draft is approved via `PATCH .../draft` with `revisionStatus: APPROVED`. **Required Permissions** \"policy-management.policies.create\"
245
245
  * @summary Create the draft-policy
246
246
  * @param {string} policyCode Unique identifier for the object.
247
247
  * @param {CreateDraftPolicyRequestDto} createDraftPolicyRequestDto
@@ -269,11 +269,11 @@ export declare const PoliciesApiFp: (configuration?: Configuration) => {
269
269
  */
270
270
  deleteDraftPolicy(policyCode: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
271
271
  /**
272
- * Retrieves the details of the draft-policy that was previously created. Supply the unique draft-policy code that was returned when you created it and Emil Api will return the corresponding draft-policy information. **Required Permissions** \"policy-management.policies.view\"
272
+ * Retrieves the draft version of the policy, if one exists. The returned version has `isDraft: true` and `isCurrent: false` — it is never the current/live version. Returns a 404 if no draft exists (e.g. after it has been approved or rejected). **Required Permissions** \"policy-management.policies.view\"
273
273
  * @summary Retrieve the draft-policy
274
274
  * @param {string} policyCode Unique identifier for the object.
275
275
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
276
- * @param {string} [expand] Fields to expand response by.
276
+ * @param {string} [expand] Fields to expand in the draft response. Pass the unprefixed relation name; for example, \&quot;premiumItems\&quot; expands the draft premium items relation.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: version, timelines, premiums, premiumItems, premiumFormulas&lt;/i&gt;
277
277
  * @param {*} [options] Override http request option.
278
278
  * @throws {RequiredError}
279
279
  */
@@ -300,16 +300,16 @@ export declare const PoliciesApiFp: (configuration?: Configuration) => {
300
300
  */
301
301
  getPolicyDataByDate(code: string, authorization?: string, timesliceDate?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPolicyResponseClass>>;
302
302
  /**
303
- * Returns a list of policies you have previously created. The policies are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"policy-management.policies.view\"
303
+ * Returns a list of policies you have previously created. The policies are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.<br/> <br/> <b>Notes on filtering:</b><br/> - The `partnerCode` filter matches any policy that has ever had a link to that partner — past, current, or future-dated — not only currently-assigned ones. There is currently no separate filter to match only the currently-active link.<br/> - An unrecognized filter field name is silently ignored: the request returns 200 with the unfiltered (or partially filtered, if combined with valid fields) result set rather than an error. **Required Permissions** \"policy-management.policies.view\"
304
304
  * @summary List policies
305
305
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
306
306
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
307
307
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
308
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode&lt;/i&gt;
309
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
308
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode, partnerLinks.partnerCode&lt;/i&gt;
309
+ * @param {string} [search] Free-text search across the policy\&#39;s key fields: policy codes and numbers, holder, status, product, account and lead codes, start date, and insured-object data (policyObjects.data). Matching is case- and accent-insensitive (mueller finds Müller), tolerates typos, and ranks results by relevance. To search a single field, pass search&#x3D;path:value — e.g. search&#x3D;holder:Müller or search&#x3D;policyObjects.data.postalCode:10115. The value matches exactly or as a prefix; paths are dot-separated and case-sensitive.
310
310
  * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, policyNumber, createdAt, updatedAt, policyStartDate, productVersionId, productId&lt;/i&gt;
311
311
  * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: versions, product, timelines, premiums, premiumItems, premiumFormulas, currentVersion, currentTimelines, currentPremiums, currentPremiumItems, currentPremiumFormulas, partnerLinks&lt;i&gt;
312
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode&lt;/i&gt;
312
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode, partnerLinks.partnerCode&lt;/i&gt;
313
313
  * @param {*} [options] Override http request option.
314
314
  * @throws {RequiredError}
315
315
  */
@@ -346,7 +346,7 @@ export declare const PoliciesApiFp: (configuration?: Configuration) => {
346
346
  */
347
347
  listPolicyVersions(policyCode: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPolicyVersionResponseClass>>;
348
348
  /**
349
- * Updates the specified draft-policy by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"policy-management.policies.update\"
349
+ * Updates the draft version, or changes its lifecycle state via `revisionStatus` (see that field\'s description for what each value does — most notably, `APPROVED` promotes the draft to the current policy version and `REJECTED` deletes it). **Required Permissions** \"policy-management.policies.update\"
350
350
  * @summary Update the draft-policy
351
351
  * @param {string} policyCode Unique identifier for the object.
352
352
  * @param {PatchDraftPolicyRequestDto} patchDraftPolicyRequestDto
@@ -432,7 +432,7 @@ export declare const PoliciesApiFactory: (configuration?: Configuration, basePat
432
432
  */
433
433
  activatePolicy(policyCode: string, activatePolicyRequestDto: ActivatePolicyRequestDto, authorization?: string, options?: any): AxiosPromise<ActivatePolicyResponseClass>;
434
434
  /**
435
- * This will create a draft policy in the database. **Required Permissions** \"policy-management.policies.create\"
435
+ * Creates a draft version of the policy update, without affecting the current version. This adds a new version to the existing policy — it does not create a new policy. The draft is returned with `isDraft: true` and `isCurrent: false`; the current version is unchanged until the draft is approved via `PATCH .../draft` with `revisionStatus: APPROVED`. **Required Permissions** \"policy-management.policies.create\"
436
436
  * @summary Create the draft-policy
437
437
  * @param {string} policyCode Unique identifier for the object.
438
438
  * @param {CreateDraftPolicyRequestDto} createDraftPolicyRequestDto
@@ -460,11 +460,11 @@ export declare const PoliciesApiFactory: (configuration?: Configuration, basePat
460
460
  */
461
461
  deleteDraftPolicy(policyCode: string, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
462
462
  /**
463
- * Retrieves the details of the draft-policy that was previously created. Supply the unique draft-policy code that was returned when you created it and Emil Api will return the corresponding draft-policy information. **Required Permissions** \"policy-management.policies.view\"
463
+ * Retrieves the draft version of the policy, if one exists. The returned version has `isDraft: true` and `isCurrent: false` — it is never the current/live version. Returns a 404 if no draft exists (e.g. after it has been approved or rejected). **Required Permissions** \"policy-management.policies.view\"
464
464
  * @summary Retrieve the draft-policy
465
465
  * @param {string} policyCode Unique identifier for the object.
466
466
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
467
- * @param {string} [expand] Fields to expand response by.
467
+ * @param {string} [expand] Fields to expand in the draft response. Pass the unprefixed relation name; for example, \&quot;premiumItems\&quot; expands the draft premium items relation.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: version, timelines, premiums, premiumItems, premiumFormulas&lt;/i&gt;
468
468
  * @param {*} [options] Override http request option.
469
469
  * @throws {RequiredError}
470
470
  */
@@ -491,16 +491,16 @@ export declare const PoliciesApiFactory: (configuration?: Configuration, basePat
491
491
  */
492
492
  getPolicyDataByDate(code: string, authorization?: string, timesliceDate?: string, expand?: string, options?: any): AxiosPromise<GetPolicyResponseClass>;
493
493
  /**
494
- * Returns a list of policies you have previously created. The policies are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"policy-management.policies.view\"
494
+ * Returns a list of policies you have previously created. The policies are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.<br/> <br/> <b>Notes on filtering:</b><br/> - The `partnerCode` filter matches any policy that has ever had a link to that partner — past, current, or future-dated — not only currently-assigned ones. There is currently no separate filter to match only the currently-active link.<br/> - An unrecognized filter field name is silently ignored: the request returns 200 with the unfiltered (or partially filtered, if combined with valid fields) result set rather than an error. **Required Permissions** \"policy-management.policies.view\"
495
495
  * @summary List policies
496
496
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
497
497
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
498
498
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
499
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode&lt;/i&gt;
500
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
499
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode, partnerLinks.partnerCode&lt;/i&gt;
500
+ * @param {string} [search] Free-text search across the policy\&#39;s key fields: policy codes and numbers, holder, status, product, account and lead codes, start date, and insured-object data (policyObjects.data). Matching is case- and accent-insensitive (mueller finds Müller), tolerates typos, and ranks results by relevance. To search a single field, pass search&#x3D;path:value — e.g. search&#x3D;holder:Müller or search&#x3D;policyObjects.data.postalCode:10115. The value matches exactly or as a prefix; paths are dot-separated and case-sensitive.
501
501
  * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, policyNumber, createdAt, updatedAt, policyStartDate, productVersionId, productId&lt;/i&gt;
502
502
  * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: versions, product, timelines, premiums, premiumItems, premiumFormulas, currentVersion, currentTimelines, currentPremiums, currentPremiumItems, currentPremiumFormulas, partnerLinks&lt;i&gt;
503
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode&lt;/i&gt;
503
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode, partnerLinks.partnerCode&lt;/i&gt;
504
504
  * @param {*} [options] Override http request option.
505
505
  * @throws {RequiredError}
506
506
  */
@@ -537,7 +537,7 @@ export declare const PoliciesApiFactory: (configuration?: Configuration, basePat
537
537
  */
538
538
  listPolicyVersions(policyCode: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPolicyVersionResponseClass>;
539
539
  /**
540
- * Updates the specified draft-policy by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"policy-management.policies.update\"
540
+ * Updates the draft version, or changes its lifecycle state via `revisionStatus` (see that field\'s description for what each value does — most notably, `APPROVED` promotes the draft to the current policy version and `REJECTED` deletes it). **Required Permissions** \"policy-management.policies.update\"
541
541
  * @summary Update the draft-policy
542
542
  * @param {string} policyCode Unique identifier for the object.
543
543
  * @param {PatchDraftPolicyRequestDto} patchDraftPolicyRequestDto
@@ -714,7 +714,7 @@ export interface PoliciesApiGetDraftPolicyRequest {
714
714
  */
715
715
  readonly authorization?: string;
716
716
  /**
717
- * Fields to expand response by.
717
+ * Fields to expand in the draft response. Pass the unprefixed relation name; for example, \&quot;premiumItems\&quot; expands the draft premium items relation.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: version, timelines, premiums, premiumItems, premiumFormulas&lt;/i&gt;
718
718
  * @type {string}
719
719
  * @memberof PoliciesApiGetDraftPolicy
720
720
  */
@@ -801,13 +801,13 @@ export interface PoliciesApiListPoliciesRequest {
801
801
  */
802
802
  readonly pageToken?: string;
803
803
  /**
804
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode&lt;/i&gt;
804
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode, partnerLinks.partnerCode&lt;/i&gt;
805
805
  * @type {string}
806
806
  * @memberof PoliciesApiListPolicies
807
807
  */
808
808
  readonly filter?: string;
809
809
  /**
810
- * To search the list by any field, pass search&#x3D;xxx to fetch the result.
810
+ * Free-text search across the policy\&#39;s key fields: policy codes and numbers, holder, status, product, account and lead codes, start date, and insured-object data (policyObjects.data). Matching is case- and accent-insensitive (mueller finds Müller), tolerates typos, and ranks results by relevance. To search a single field, pass search&#x3D;path:value — e.g. search&#x3D;holder:Müller or search&#x3D;policyObjects.data.postalCode:10115. The value matches exactly or as a prefix; paths are dot-separated and case-sensitive.
811
811
  * @type {string}
812
812
  * @memberof PoliciesApiListPolicies
813
813
  */
@@ -825,7 +825,7 @@ export interface PoliciesApiListPoliciesRequest {
825
825
  */
826
826
  readonly expand?: string;
827
827
  /**
828
- * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode&lt;/i&gt;
828
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode, partnerLinks.partnerCode&lt;/i&gt;
829
829
  * @type {string}
830
830
  * @memberof PoliciesApiListPolicies
831
831
  */
@@ -1139,7 +1139,7 @@ export declare class PoliciesApi extends BaseAPI {
1139
1139
  */
1140
1140
  activatePolicy(requestParameters: PoliciesApiActivatePolicyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ActivatePolicyResponseClass, any, {}>>;
1141
1141
  /**
1142
- * This will create a draft policy in the database. **Required Permissions** \"policy-management.policies.create\"
1142
+ * Creates a draft version of the policy update, without affecting the current version. This adds a new version to the existing policy — it does not create a new policy. The draft is returned with `isDraft: true` and `isCurrent: false`; the current version is unchanged until the draft is approved via `PATCH .../draft` with `revisionStatus: APPROVED`. **Required Permissions** \"policy-management.policies.create\"
1143
1143
  * @summary Create the draft-policy
1144
1144
  * @param {PoliciesApiCreateDraftPolicyRequest} requestParameters Request parameters.
1145
1145
  * @param {*} [options] Override http request option.
@@ -1166,7 +1166,7 @@ export declare class PoliciesApi extends BaseAPI {
1166
1166
  */
1167
1167
  deleteDraftPolicy(requestParameters: PoliciesApiDeleteDraftPolicyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any, {}>>;
1168
1168
  /**
1169
- * Retrieves the details of the draft-policy that was previously created. Supply the unique draft-policy code that was returned when you created it and Emil Api will return the corresponding draft-policy information. **Required Permissions** \"policy-management.policies.view\"
1169
+ * Retrieves the draft version of the policy, if one exists. The returned version has `isDraft: true` and `isCurrent: false` — it is never the current/live version. Returns a 404 if no draft exists (e.g. after it has been approved or rejected). **Required Permissions** \"policy-management.policies.view\"
1170
1170
  * @summary Retrieve the draft-policy
1171
1171
  * @param {PoliciesApiGetDraftPolicyRequest} requestParameters Request parameters.
1172
1172
  * @param {*} [options] Override http request option.
@@ -1193,7 +1193,7 @@ export declare class PoliciesApi extends BaseAPI {
1193
1193
  */
1194
1194
  getPolicyDataByDate(requestParameters: PoliciesApiGetPolicyDataByDateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPolicyResponseClass, any, {}>>;
1195
1195
  /**
1196
- * Returns a list of policies you have previously created. The policies are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"policy-management.policies.view\"
1196
+ * Returns a list of policies you have previously created. The policies are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.<br/> <br/> <b>Notes on filtering:</b><br/> - The `partnerCode` filter matches any policy that has ever had a link to that partner — past, current, or future-dated — not only currently-assigned ones. There is currently no separate filter to match only the currently-active link.<br/> - An unrecognized filter field name is silently ignored: the request returns 200 with the unfiltered (or partially filtered, if combined with valid fields) result set rather than an error. **Required Permissions** \"policy-management.policies.view\"
1197
1197
  * @summary List policies
1198
1198
  * @param {PoliciesApiListPoliciesRequest} requestParameters Request parameters.
1199
1199
  * @param {*} [options] Override http request option.
@@ -1220,7 +1220,7 @@ export declare class PoliciesApi extends BaseAPI {
1220
1220
  */
1221
1221
  listPolicyVersions(requestParameters: PoliciesApiListPolicyVersionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPolicyVersionResponseClass, any, {}>>;
1222
1222
  /**
1223
- * Updates the specified draft-policy by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"policy-management.policies.update\"
1223
+ * Updates the draft version, or changes its lifecycle state via `revisionStatus` (see that field\'s description for what each value does — most notably, `APPROVED` promotes the draft to the current policy version and `REJECTED` deletes it). **Required Permissions** \"policy-management.policies.update\"
1224
1224
  * @summary Update the draft-policy
1225
1225
  * @param {PoliciesApiPatchDraftPolicyRequest} requestParameters Request parameters.
1226
1226
  * @param {*} [options] Override http request option.