@emilgroup/insurance-sdk-node 1.104.1-beta.5 → 1.104.1-beta.51
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/README.md +2 -2
- package/api/leads-api.ts +4 -4
- package/api/policies-api.ts +32 -32
- package/dist/api/leads-api.d.ts +4 -4
- package/dist/api/leads-api.js +3 -3
- package/dist/api/policies-api.d.ts +32 -32
- package/dist/api/policies-api.js +28 -28
- package/dist/models/create-draft-policy-request-dto.d.ts +1 -1
- package/dist/models/get-draft-policy-request-dto.d.ts +1 -1
- package/dist/models/patch-draft-policy-request-dto.d.ts +2 -2
- package/dist/models/policy-object-dto.d.ts +1 -1
- package/dist/models/policy-premium-item-class.d.ts +1 -1
- package/models/create-draft-policy-request-dto.ts +1 -1
- package/models/get-draft-policy-request-dto.ts +1 -1
- package/models/patch-draft-policy-request-dto.ts +2 -2
- package/models/policy-object-dto.ts +1 -1
- package/models/policy-premium-item-class.ts +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
|
|
|
17
17
|
Navigate to the folder of your consuming project and run one of the following commands:
|
|
18
18
|
|
|
19
19
|
```
|
|
20
|
-
npm install @emilgroup/insurance-sdk-node@1.104.1-beta.
|
|
20
|
+
npm install @emilgroup/insurance-sdk-node@1.104.1-beta.51 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/insurance-sdk-node@1.104.1-beta.
|
|
24
|
+
yarn add @emilgroup/insurance-sdk-node@1.104.1-beta.51
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `PoliciesApi`.
|
package/api/leads-api.ts
CHANGED
|
@@ -346,7 +346,7 @@ export const LeadsApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
346
346
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
347
347
|
* @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
348
348
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
349
|
-
* @param {string} [search]
|
|
349
|
+
* @param {string} [search] Free-text search across the lead\'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=path:value — e.g. search=account.lastName:Müller or search=policyObjects.data.vin:WVW123. The value matches exactly or as a prefix; paths are dot-separated and case-sensitive.
|
|
350
350
|
* @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.
|
|
351
351
|
* @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.
|
|
352
352
|
* @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.
|
|
@@ -659,7 +659,7 @@ export const LeadsApiFp = function(configuration?: Configuration) {
|
|
|
659
659
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
660
660
|
* @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
661
661
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
662
|
-
* @param {string} [search]
|
|
662
|
+
* @param {string} [search] Free-text search across the lead\'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=path:value — e.g. search=account.lastName:Müller or search=policyObjects.data.vin:WVW123. The value matches exactly or as a prefix; paths are dot-separated and case-sensitive.
|
|
663
663
|
* @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.
|
|
664
664
|
* @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.
|
|
665
665
|
* @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.
|
|
@@ -794,7 +794,7 @@ export const LeadsApiFactory = function (configuration?: Configuration, basePath
|
|
|
794
794
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
795
795
|
* @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
796
796
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
797
|
-
* @param {string} [search]
|
|
797
|
+
* @param {string} [search] Free-text search across the lead\'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=path:value — e.g. search=account.lastName:Müller or search=policyObjects.data.vin:WVW123. The value matches exactly or as a prefix; paths are dot-separated and case-sensitive.
|
|
798
798
|
* @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.
|
|
799
799
|
* @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.
|
|
800
800
|
* @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.
|
|
@@ -1018,7 +1018,7 @@ export interface LeadsApiListLeadsRequest {
|
|
|
1018
1018
|
readonly filter?: string
|
|
1019
1019
|
|
|
1020
1020
|
/**
|
|
1021
|
-
*
|
|
1021
|
+
* Free-text search across the lead\'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=path:value — e.g. search=account.lastName:Müller or search=policyObjects.data.vin:WVW123. The value matches exactly or as a prefix; paths are dot-separated and case-sensitive.
|
|
1022
1022
|
* @type {string}
|
|
1023
1023
|
* @memberof LeadsApiListLeads
|
|
1024
1024
|
*/
|
package/api/policies-api.ts
CHANGED
|
@@ -126,7 +126,7 @@ export const PoliciesApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
126
126
|
};
|
|
127
127
|
},
|
|
128
128
|
/**
|
|
129
|
-
* This
|
|
129
|
+
* 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\"
|
|
130
130
|
* @summary Create the draft-policy
|
|
131
131
|
* @param {string} policyCode Unique identifier for the object.
|
|
132
132
|
* @param {CreateDraftPolicyRequestDto} createDraftPolicyRequestDto
|
|
@@ -269,11 +269,11 @@ export const PoliciesApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
269
269
|
};
|
|
270
270
|
},
|
|
271
271
|
/**
|
|
272
|
-
* Retrieves the
|
|
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
|
|
276
|
+
* @param {string} [expand] Fields to expand in the draft response. Pass the unprefixed relation name; for example, \"premiumItems\" expands the draft premium items relation.<br/> <br/> <i>Allowed values: version, timelines, premiums, premiumItems, premiumFormulas</i>
|
|
277
277
|
* @param {*} [options] Override http request option.
|
|
278
278
|
* @throws {RequiredError}
|
|
279
279
|
*/
|
|
@@ -424,16 +424,16 @@ export const PoliciesApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
424
424
|
};
|
|
425
425
|
},
|
|
426
426
|
/**
|
|
427
|
-
* 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\"
|
|
427
|
+
* 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\"
|
|
428
428
|
* @summary List policies
|
|
429
429
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
430
430
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
431
431
|
* @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
432
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode</i>
|
|
433
|
-
* @param {string} [search]
|
|
432
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode, partnerLinks.partnerCode</i>
|
|
433
|
+
* @param {string} [search] Free-text search across the policy\'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=path:value — e.g. search=holder:Müller or search=policyObjects.data.postalCode:10115. The value matches exactly or as a prefix; paths are dot-separated and case-sensitive.
|
|
434
434
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, policyNumber, createdAt, updatedAt, policyStartDate, productVersionId, productId</i>
|
|
435
435
|
* @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.<br/> <br/> <i>Allowed values: versions, product, timelines, premiums, premiumItems, premiumFormulas, currentVersion, currentTimelines, currentPremiums, currentPremiumItems, currentPremiumFormulas, partnerLinks<i>
|
|
436
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode</i>
|
|
436
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode, partnerLinks.partnerCode</i>
|
|
437
437
|
* @param {*} [options] Override http request option.
|
|
438
438
|
* @throws {RequiredError}
|
|
439
439
|
*/
|
|
@@ -656,7 +656,7 @@ export const PoliciesApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
656
656
|
};
|
|
657
657
|
},
|
|
658
658
|
/**
|
|
659
|
-
* Updates the
|
|
659
|
+
* 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\"
|
|
660
660
|
* @summary Update the draft-policy
|
|
661
661
|
* @param {string} policyCode Unique identifier for the object.
|
|
662
662
|
* @param {PatchDraftPolicyRequestDto} patchDraftPolicyRequestDto
|
|
@@ -1036,7 +1036,7 @@ export const PoliciesApiFp = function(configuration?: Configuration) {
|
|
|
1036
1036
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1037
1037
|
},
|
|
1038
1038
|
/**
|
|
1039
|
-
* This
|
|
1039
|
+
* 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\"
|
|
1040
1040
|
* @summary Create the draft-policy
|
|
1041
1041
|
* @param {string} policyCode Unique identifier for the object.
|
|
1042
1042
|
* @param {CreateDraftPolicyRequestDto} createDraftPolicyRequestDto
|
|
@@ -1073,11 +1073,11 @@ export const PoliciesApiFp = function(configuration?: Configuration) {
|
|
|
1073
1073
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1074
1074
|
},
|
|
1075
1075
|
/**
|
|
1076
|
-
* Retrieves the
|
|
1076
|
+
* 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\"
|
|
1077
1077
|
* @summary Retrieve the draft-policy
|
|
1078
1078
|
* @param {string} policyCode Unique identifier for the object.
|
|
1079
1079
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1080
|
-
* @param {string} [expand] Fields to expand response
|
|
1080
|
+
* @param {string} [expand] Fields to expand in the draft response. Pass the unprefixed relation name; for example, \"premiumItems\" expands the draft premium items relation.<br/> <br/> <i>Allowed values: version, timelines, premiums, premiumItems, premiumFormulas</i>
|
|
1081
1081
|
* @param {*} [options] Override http request option.
|
|
1082
1082
|
* @throws {RequiredError}
|
|
1083
1083
|
*/
|
|
@@ -1113,16 +1113,16 @@ export const PoliciesApiFp = function(configuration?: Configuration) {
|
|
|
1113
1113
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1114
1114
|
},
|
|
1115
1115
|
/**
|
|
1116
|
-
* 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\"
|
|
1116
|
+
* 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\"
|
|
1117
1117
|
* @summary List policies
|
|
1118
1118
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1119
1119
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
1120
1120
|
* @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
1121
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode</i>
|
|
1122
|
-
* @param {string} [search]
|
|
1121
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode, partnerLinks.partnerCode</i>
|
|
1122
|
+
* @param {string} [search] Free-text search across the policy\'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=path:value — e.g. search=holder:Müller or search=policyObjects.data.postalCode:10115. The value matches exactly or as a prefix; paths are dot-separated and case-sensitive.
|
|
1123
1123
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, policyNumber, createdAt, updatedAt, policyStartDate, productVersionId, productId</i>
|
|
1124
1124
|
* @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.<br/> <br/> <i>Allowed values: versions, product, timelines, premiums, premiumItems, premiumFormulas, currentVersion, currentTimelines, currentPremiums, currentPremiumItems, currentPremiumFormulas, partnerLinks<i>
|
|
1125
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode</i>
|
|
1125
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode, partnerLinks.partnerCode</i>
|
|
1126
1126
|
* @param {*} [options] Override http request option.
|
|
1127
1127
|
* @throws {RequiredError}
|
|
1128
1128
|
*/
|
|
@@ -1168,7 +1168,7 @@ export const PoliciesApiFp = function(configuration?: Configuration) {
|
|
|
1168
1168
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1169
1169
|
},
|
|
1170
1170
|
/**
|
|
1171
|
-
* Updates the
|
|
1171
|
+
* 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\"
|
|
1172
1172
|
* @summary Update the draft-policy
|
|
1173
1173
|
* @param {string} policyCode Unique identifier for the object.
|
|
1174
1174
|
* @param {PatchDraftPolicyRequestDto} patchDraftPolicyRequestDto
|
|
@@ -1281,7 +1281,7 @@ export const PoliciesApiFactory = function (configuration?: Configuration, baseP
|
|
|
1281
1281
|
return localVarFp.activatePolicy(policyCode, activatePolicyRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
1282
1282
|
},
|
|
1283
1283
|
/**
|
|
1284
|
-
* This
|
|
1284
|
+
* 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\"
|
|
1285
1285
|
* @summary Create the draft-policy
|
|
1286
1286
|
* @param {string} policyCode Unique identifier for the object.
|
|
1287
1287
|
* @param {CreateDraftPolicyRequestDto} createDraftPolicyRequestDto
|
|
@@ -1315,11 +1315,11 @@ export const PoliciesApiFactory = function (configuration?: Configuration, baseP
|
|
|
1315
1315
|
return localVarFp.deleteDraftPolicy(policyCode, authorization, options).then((request) => request(axios, basePath));
|
|
1316
1316
|
},
|
|
1317
1317
|
/**
|
|
1318
|
-
* Retrieves the
|
|
1318
|
+
* 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\"
|
|
1319
1319
|
* @summary Retrieve the draft-policy
|
|
1320
1320
|
* @param {string} policyCode Unique identifier for the object.
|
|
1321
1321
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1322
|
-
* @param {string} [expand] Fields to expand response
|
|
1322
|
+
* @param {string} [expand] Fields to expand in the draft response. Pass the unprefixed relation name; for example, \"premiumItems\" expands the draft premium items relation.<br/> <br/> <i>Allowed values: version, timelines, premiums, premiumItems, premiumFormulas</i>
|
|
1323
1323
|
* @param {*} [options] Override http request option.
|
|
1324
1324
|
* @throws {RequiredError}
|
|
1325
1325
|
*/
|
|
@@ -1352,16 +1352,16 @@ export const PoliciesApiFactory = function (configuration?: Configuration, baseP
|
|
|
1352
1352
|
return localVarFp.getPolicyDataByDate(code, authorization, timesliceDate, expand, options).then((request) => request(axios, basePath));
|
|
1353
1353
|
},
|
|
1354
1354
|
/**
|
|
1355
|
-
* 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\"
|
|
1355
|
+
* 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\"
|
|
1356
1356
|
* @summary List policies
|
|
1357
1357
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1358
1358
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
1359
1359
|
* @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
1360
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode</i>
|
|
1361
|
-
* @param {string} [search]
|
|
1360
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode, partnerLinks.partnerCode</i>
|
|
1361
|
+
* @param {string} [search] Free-text search across the policy\'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=path:value — e.g. search=holder:Müller or search=policyObjects.data.postalCode:10115. The value matches exactly or as a prefix; paths are dot-separated and case-sensitive.
|
|
1362
1362
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, policyNumber, createdAt, updatedAt, policyStartDate, productVersionId, productId</i>
|
|
1363
1363
|
* @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.<br/> <br/> <i>Allowed values: versions, product, timelines, premiums, premiumItems, premiumFormulas, currentVersion, currentTimelines, currentPremiums, currentPremiumItems, currentPremiumFormulas, partnerLinks<i>
|
|
1364
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode</i>
|
|
1364
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode, partnerLinks.partnerCode</i>
|
|
1365
1365
|
* @param {*} [options] Override http request option.
|
|
1366
1366
|
* @throws {RequiredError}
|
|
1367
1367
|
*/
|
|
@@ -1404,7 +1404,7 @@ export const PoliciesApiFactory = function (configuration?: Configuration, baseP
|
|
|
1404
1404
|
return localVarFp.listPolicyVersions(policyCode, authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
1405
1405
|
},
|
|
1406
1406
|
/**
|
|
1407
|
-
* Updates the
|
|
1407
|
+
* 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\"
|
|
1408
1408
|
* @summary Update the draft-policy
|
|
1409
1409
|
* @param {string} policyCode Unique identifier for the object.
|
|
1410
1410
|
* @param {PatchDraftPolicyRequestDto} patchDraftPolicyRequestDto
|
|
@@ -1609,7 +1609,7 @@ export interface PoliciesApiGetDraftPolicyRequest {
|
|
|
1609
1609
|
readonly authorization?: string
|
|
1610
1610
|
|
|
1611
1611
|
/**
|
|
1612
|
-
* Fields to expand response
|
|
1612
|
+
* Fields to expand in the draft response. Pass the unprefixed relation name; for example, \"premiumItems\" expands the draft premium items relation.<br/> <br/> <i>Allowed values: version, timelines, premiums, premiumItems, premiumFormulas</i>
|
|
1613
1613
|
* @type {string}
|
|
1614
1614
|
* @memberof PoliciesApiGetDraftPolicy
|
|
1615
1615
|
*/
|
|
@@ -1707,14 +1707,14 @@ export interface PoliciesApiListPoliciesRequest {
|
|
|
1707
1707
|
readonly pageToken?: string
|
|
1708
1708
|
|
|
1709
1709
|
/**
|
|
1710
|
-
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode</i>
|
|
1710
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode, partnerLinks.partnerCode</i>
|
|
1711
1711
|
* @type {string}
|
|
1712
1712
|
* @memberof PoliciesApiListPolicies
|
|
1713
1713
|
*/
|
|
1714
1714
|
readonly filter?: string
|
|
1715
1715
|
|
|
1716
1716
|
/**
|
|
1717
|
-
*
|
|
1717
|
+
* Free-text search across the policy\'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=path:value — e.g. search=holder:Müller or search=policyObjects.data.postalCode:10115. The value matches exactly or as a prefix; paths are dot-separated and case-sensitive.
|
|
1718
1718
|
* @type {string}
|
|
1719
1719
|
* @memberof PoliciesApiListPolicies
|
|
1720
1720
|
*/
|
|
@@ -1735,7 +1735,7 @@ export interface PoliciesApiListPoliciesRequest {
|
|
|
1735
1735
|
readonly expand?: string
|
|
1736
1736
|
|
|
1737
1737
|
/**
|
|
1738
|
-
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode</i>
|
|
1738
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode, partnerLinks.partnerCode</i>
|
|
1739
1739
|
* @type {string}
|
|
1740
1740
|
* @memberof PoliciesApiListPolicies
|
|
1741
1741
|
*/
|
|
@@ -2091,7 +2091,7 @@ export class PoliciesApi extends BaseAPI {
|
|
|
2091
2091
|
}
|
|
2092
2092
|
|
|
2093
2093
|
/**
|
|
2094
|
-
* This
|
|
2094
|
+
* 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\"
|
|
2095
2095
|
* @summary Create the draft-policy
|
|
2096
2096
|
* @param {PoliciesApiCreateDraftPolicyRequest} requestParameters Request parameters.
|
|
2097
2097
|
* @param {*} [options] Override http request option.
|
|
@@ -2127,7 +2127,7 @@ export class PoliciesApi extends BaseAPI {
|
|
|
2127
2127
|
}
|
|
2128
2128
|
|
|
2129
2129
|
/**
|
|
2130
|
-
* Retrieves the
|
|
2130
|
+
* 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\"
|
|
2131
2131
|
* @summary Retrieve the draft-policy
|
|
2132
2132
|
* @param {PoliciesApiGetDraftPolicyRequest} requestParameters Request parameters.
|
|
2133
2133
|
* @param {*} [options] Override http request option.
|
|
@@ -2163,7 +2163,7 @@ export class PoliciesApi extends BaseAPI {
|
|
|
2163
2163
|
}
|
|
2164
2164
|
|
|
2165
2165
|
/**
|
|
2166
|
-
* 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\"
|
|
2166
|
+
* 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\"
|
|
2167
2167
|
* @summary List policies
|
|
2168
2168
|
* @param {PoliciesApiListPoliciesRequest} requestParameters Request parameters.
|
|
2169
2169
|
* @param {*} [options] Override http request option.
|
|
@@ -2199,7 +2199,7 @@ export class PoliciesApi extends BaseAPI {
|
|
|
2199
2199
|
}
|
|
2200
2200
|
|
|
2201
2201
|
/**
|
|
2202
|
-
* Updates the
|
|
2202
|
+
* 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\"
|
|
2203
2203
|
* @summary Update the draft-policy
|
|
2204
2204
|
* @param {PoliciesApiPatchDraftPolicyRequest} requestParameters Request parameters.
|
|
2205
2205
|
* @param {*} [options] Override http request option.
|
package/dist/api/leads-api.d.ts
CHANGED
|
@@ -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=1, your subsequent call can include pageToken=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]
|
|
94
|
+
* @param {string} [search] Free-text search across the lead\'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=path:value — e.g. search=account.lastName:Müller or search=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=1, your subsequent call can include pageToken=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]
|
|
201
|
+
* @param {string} [search] Free-text search across the lead\'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=path:value — e.g. search=account.lastName:Müller or search=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=1, your subsequent call can include pageToken=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]
|
|
308
|
+
* @param {string} [search] Free-text search across the lead\'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=path:value — e.g. search=account.lastName:Müller or search=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
|
-
*
|
|
504
|
+
* Free-text search across the lead\'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=path:value — e.g. search=account.lastName:Müller or search=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
|
*/
|
package/dist/api/leads-api.js
CHANGED
|
@@ -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=1, your subsequent call can include pageToken=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]
|
|
406
|
+
* @param {string} [search] Free-text search across the lead\'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=path:value — e.g. search=account.lastName:Müller or search=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=1, your subsequent call can include pageToken=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]
|
|
775
|
+
* @param {string} [search] Free-text search across the lead\'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=path:value — e.g. search=account.lastName:Müller or search=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=1, your subsequent call can include pageToken=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]
|
|
946
|
+
* @param {string} [search] Free-text search across the lead\'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=path:value — e.g. search=account.lastName:Müller or search=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
|
|
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
|
|
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
|
|
85
|
+
* @param {string} [expand] Fields to expand in the draft response. Pass the unprefixed relation name; for example, \"premiumItems\" expands the draft premium items relation.<br/> <br/> <i>Allowed values: version, timelines, premiums, premiumItems, premiumFormulas</i>
|
|
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=1, your subsequent call can include pageToken=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.<br/> <br/> <i>Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode</i>
|
|
118
|
-
* @param {string} [search]
|
|
117
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode, partnerLinks.partnerCode</i>
|
|
118
|
+
* @param {string} [search] Free-text search across the policy\'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=path:value — e.g. search=holder:Müller or search=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.<br/> <br/> <i>Allowed values: id, policyNumber, createdAt, updatedAt, policyStartDate, productVersionId, productId</i>
|
|
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.<br/> <br/> <i>Allowed values: versions, product, timelines, premiums, premiumItems, premiumFormulas, currentVersion, currentTimelines, currentPremiums, currentPremiumItems, currentPremiumFormulas, partnerLinks<i>
|
|
121
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode</i>
|
|
121
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode, partnerLinks.partnerCode</i>
|
|
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
|
|
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
|
|
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
|
|
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
|
|
276
|
+
* @param {string} [expand] Fields to expand in the draft response. Pass the unprefixed relation name; for example, \"premiumItems\" expands the draft premium items relation.<br/> <br/> <i>Allowed values: version, timelines, premiums, premiumItems, premiumFormulas</i>
|
|
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=1, your subsequent call can include pageToken=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.<br/> <br/> <i>Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode</i>
|
|
309
|
-
* @param {string} [search]
|
|
308
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode, partnerLinks.partnerCode</i>
|
|
309
|
+
* @param {string} [search] Free-text search across the policy\'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=path:value — e.g. search=holder:Müller or search=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.<br/> <br/> <i>Allowed values: id, policyNumber, createdAt, updatedAt, policyStartDate, productVersionId, productId</i>
|
|
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.<br/> <br/> <i>Allowed values: versions, product, timelines, premiums, premiumItems, premiumFormulas, currentVersion, currentTimelines, currentPremiums, currentPremiumItems, currentPremiumFormulas, partnerLinks<i>
|
|
312
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode</i>
|
|
312
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode, partnerLinks.partnerCode</i>
|
|
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
|
|
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
|
|
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
|
|
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
|
|
467
|
+
* @param {string} [expand] Fields to expand in the draft response. Pass the unprefixed relation name; for example, \"premiumItems\" expands the draft premium items relation.<br/> <br/> <i>Allowed values: version, timelines, premiums, premiumItems, premiumFormulas</i>
|
|
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=1, your subsequent call can include pageToken=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.<br/> <br/> <i>Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode</i>
|
|
500
|
-
* @param {string} [search]
|
|
499
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode, partnerLinks.partnerCode</i>
|
|
500
|
+
* @param {string} [search] Free-text search across the policy\'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=path:value — e.g. search=holder:Müller or search=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.<br/> <br/> <i>Allowed values: id, policyNumber, createdAt, updatedAt, policyStartDate, productVersionId, productId</i>
|
|
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.<br/> <br/> <i>Allowed values: versions, product, timelines, premiums, premiumItems, premiumFormulas, currentVersion, currentTimelines, currentPremiums, currentPremiumItems, currentPremiumFormulas, partnerLinks<i>
|
|
503
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode</i>
|
|
503
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode, partnerLinks.partnerCode</i>
|
|
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
|
|
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
|
|
717
|
+
* Fields to expand in the draft response. Pass the unprefixed relation name; for example, \"premiumItems\" expands the draft premium items relation.<br/> <br/> <i>Allowed values: version, timelines, premiums, premiumItems, premiumFormulas</i>
|
|
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.<br/> <br/> <i>Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode</i>
|
|
804
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode, partnerLinks.partnerCode</i>
|
|
805
805
|
* @type {string}
|
|
806
806
|
* @memberof PoliciesApiListPolicies
|
|
807
807
|
*/
|
|
808
808
|
readonly filter?: string;
|
|
809
809
|
/**
|
|
810
|
-
*
|
|
810
|
+
* Free-text search across the policy\'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=path:value — e.g. search=holder:Müller or search=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.<br/> <br/> <i>Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode</i>
|
|
828
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode, partnerLinks.partnerCode</i>
|
|
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
|
|
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
|
|
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
|
|
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.
|
package/dist/api/policies-api.js
CHANGED
|
@@ -150,7 +150,7 @@ var PoliciesApiAxiosParamCreator = function (configuration) {
|
|
|
150
150
|
});
|
|
151
151
|
},
|
|
152
152
|
/**
|
|
153
|
-
* This
|
|
153
|
+
* 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\"
|
|
154
154
|
* @summary Create the draft-policy
|
|
155
155
|
* @param {string} policyCode Unique identifier for the object.
|
|
156
156
|
* @param {CreateDraftPolicyRequestDto} createDraftPolicyRequestDto
|
|
@@ -300,11 +300,11 @@ var PoliciesApiAxiosParamCreator = function (configuration) {
|
|
|
300
300
|
});
|
|
301
301
|
},
|
|
302
302
|
/**
|
|
303
|
-
* Retrieves the
|
|
303
|
+
* 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\"
|
|
304
304
|
* @summary Retrieve the draft-policy
|
|
305
305
|
* @param {string} policyCode Unique identifier for the object.
|
|
306
306
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
307
|
-
* @param {string} [expand] Fields to expand response
|
|
307
|
+
* @param {string} [expand] Fields to expand in the draft response. Pass the unprefixed relation name; for example, \"premiumItems\" expands the draft premium items relation.<br/> <br/> <i>Allowed values: version, timelines, premiums, premiumItems, premiumFormulas</i>
|
|
308
308
|
* @param {*} [options] Override http request option.
|
|
309
309
|
* @throws {RequiredError}
|
|
310
310
|
*/
|
|
@@ -460,16 +460,16 @@ var PoliciesApiAxiosParamCreator = function (configuration) {
|
|
|
460
460
|
});
|
|
461
461
|
},
|
|
462
462
|
/**
|
|
463
|
-
* 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\"
|
|
463
|
+
* 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\"
|
|
464
464
|
* @summary List policies
|
|
465
465
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
466
466
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
467
467
|
* @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
468
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode</i>
|
|
469
|
-
* @param {string} [search]
|
|
468
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode, partnerLinks.partnerCode</i>
|
|
469
|
+
* @param {string} [search] Free-text search across the policy\'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=path:value — e.g. search=holder:Müller or search=policyObjects.data.postalCode:10115. The value matches exactly or as a prefix; paths are dot-separated and case-sensitive.
|
|
470
470
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, policyNumber, createdAt, updatedAt, policyStartDate, productVersionId, productId</i>
|
|
471
471
|
* @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.<br/> <br/> <i>Allowed values: versions, product, timelines, premiums, premiumItems, premiumFormulas, currentVersion, currentTimelines, currentPremiums, currentPremiumItems, currentPremiumFormulas, partnerLinks<i>
|
|
472
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode</i>
|
|
472
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode, partnerLinks.partnerCode</i>
|
|
473
473
|
* @param {*} [options] Override http request option.
|
|
474
474
|
* @throws {RequiredError}
|
|
475
475
|
*/
|
|
@@ -680,7 +680,7 @@ var PoliciesApiAxiosParamCreator = function (configuration) {
|
|
|
680
680
|
});
|
|
681
681
|
},
|
|
682
682
|
/**
|
|
683
|
-
* Updates the
|
|
683
|
+
* 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\"
|
|
684
684
|
* @summary Update the draft-policy
|
|
685
685
|
* @param {string} policyCode Unique identifier for the object.
|
|
686
686
|
* @param {PatchDraftPolicyRequestDto} patchDraftPolicyRequestDto
|
|
@@ -1083,7 +1083,7 @@ var PoliciesApiFp = function (configuration) {
|
|
|
1083
1083
|
});
|
|
1084
1084
|
},
|
|
1085
1085
|
/**
|
|
1086
|
-
* This
|
|
1086
|
+
* 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\"
|
|
1087
1087
|
* @summary Create the draft-policy
|
|
1088
1088
|
* @param {string} policyCode Unique identifier for the object.
|
|
1089
1089
|
* @param {CreateDraftPolicyRequestDto} createDraftPolicyRequestDto
|
|
@@ -1147,11 +1147,11 @@ var PoliciesApiFp = function (configuration) {
|
|
|
1147
1147
|
});
|
|
1148
1148
|
},
|
|
1149
1149
|
/**
|
|
1150
|
-
* Retrieves the
|
|
1150
|
+
* 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\"
|
|
1151
1151
|
* @summary Retrieve the draft-policy
|
|
1152
1152
|
* @param {string} policyCode Unique identifier for the object.
|
|
1153
1153
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1154
|
-
* @param {string} [expand] Fields to expand response
|
|
1154
|
+
* @param {string} [expand] Fields to expand in the draft response. Pass the unprefixed relation name; for example, \"premiumItems\" expands the draft premium items relation.<br/> <br/> <i>Allowed values: version, timelines, premiums, premiumItems, premiumFormulas</i>
|
|
1155
1155
|
* @param {*} [options] Override http request option.
|
|
1156
1156
|
* @throws {RequiredError}
|
|
1157
1157
|
*/
|
|
@@ -1214,16 +1214,16 @@ var PoliciesApiFp = function (configuration) {
|
|
|
1214
1214
|
});
|
|
1215
1215
|
},
|
|
1216
1216
|
/**
|
|
1217
|
-
* 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\"
|
|
1217
|
+
* 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\"
|
|
1218
1218
|
* @summary List policies
|
|
1219
1219
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1220
1220
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
1221
1221
|
* @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
1222
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode</i>
|
|
1223
|
-
* @param {string} [search]
|
|
1222
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode, partnerLinks.partnerCode</i>
|
|
1223
|
+
* @param {string} [search] Free-text search across the policy\'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=path:value — e.g. search=holder:Müller or search=policyObjects.data.postalCode:10115. The value matches exactly or as a prefix; paths are dot-separated and case-sensitive.
|
|
1224
1224
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, policyNumber, createdAt, updatedAt, policyStartDate, productVersionId, productId</i>
|
|
1225
1225
|
* @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.<br/> <br/> <i>Allowed values: versions, product, timelines, premiums, premiumItems, premiumFormulas, currentVersion, currentTimelines, currentPremiums, currentPremiumItems, currentPremiumFormulas, partnerLinks<i>
|
|
1226
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode</i>
|
|
1226
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode, partnerLinks.partnerCode</i>
|
|
1227
1227
|
* @param {*} [options] Override http request option.
|
|
1228
1228
|
* @throws {RequiredError}
|
|
1229
1229
|
*/
|
|
@@ -1296,7 +1296,7 @@ var PoliciesApiFp = function (configuration) {
|
|
|
1296
1296
|
});
|
|
1297
1297
|
},
|
|
1298
1298
|
/**
|
|
1299
|
-
* Updates the
|
|
1299
|
+
* 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\"
|
|
1300
1300
|
* @summary Update the draft-policy
|
|
1301
1301
|
* @param {string} policyCode Unique identifier for the object.
|
|
1302
1302
|
* @param {PatchDraftPolicyRequestDto} patchDraftPolicyRequestDto
|
|
@@ -1472,7 +1472,7 @@ var PoliciesApiFactory = function (configuration, basePath, axios) {
|
|
|
1472
1472
|
return localVarFp.activatePolicy(policyCode, activatePolicyRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
1473
1473
|
},
|
|
1474
1474
|
/**
|
|
1475
|
-
* This
|
|
1475
|
+
* 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\"
|
|
1476
1476
|
* @summary Create the draft-policy
|
|
1477
1477
|
* @param {string} policyCode Unique identifier for the object.
|
|
1478
1478
|
* @param {CreateDraftPolicyRequestDto} createDraftPolicyRequestDto
|
|
@@ -1506,11 +1506,11 @@ var PoliciesApiFactory = function (configuration, basePath, axios) {
|
|
|
1506
1506
|
return localVarFp.deleteDraftPolicy(policyCode, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
1507
1507
|
},
|
|
1508
1508
|
/**
|
|
1509
|
-
* Retrieves the
|
|
1509
|
+
* 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\"
|
|
1510
1510
|
* @summary Retrieve the draft-policy
|
|
1511
1511
|
* @param {string} policyCode Unique identifier for the object.
|
|
1512
1512
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1513
|
-
* @param {string} [expand] Fields to expand response
|
|
1513
|
+
* @param {string} [expand] Fields to expand in the draft response. Pass the unprefixed relation name; for example, \"premiumItems\" expands the draft premium items relation.<br/> <br/> <i>Allowed values: version, timelines, premiums, premiumItems, premiumFormulas</i>
|
|
1514
1514
|
* @param {*} [options] Override http request option.
|
|
1515
1515
|
* @throws {RequiredError}
|
|
1516
1516
|
*/
|
|
@@ -1543,16 +1543,16 @@ var PoliciesApiFactory = function (configuration, basePath, axios) {
|
|
|
1543
1543
|
return localVarFp.getPolicyDataByDate(code, authorization, timesliceDate, expand, options).then(function (request) { return request(axios, basePath); });
|
|
1544
1544
|
},
|
|
1545
1545
|
/**
|
|
1546
|
-
* 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\"
|
|
1546
|
+
* 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\"
|
|
1547
1547
|
* @summary List policies
|
|
1548
1548
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1549
1549
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
1550
1550
|
* @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
1551
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode</i>
|
|
1552
|
-
* @param {string} [search]
|
|
1551
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode, partnerLinks.partnerCode</i>
|
|
1552
|
+
* @param {string} [search] Free-text search across the policy\'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=path:value — e.g. search=holder:Müller or search=policyObjects.data.postalCode:10115. The value matches exactly or as a prefix; paths are dot-separated and case-sensitive.
|
|
1553
1553
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, policyNumber, createdAt, updatedAt, policyStartDate, productVersionId, productId</i>
|
|
1554
1554
|
* @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.<br/> <br/> <i>Allowed values: versions, product, timelines, premiums, premiumItems, premiumFormulas, currentVersion, currentTimelines, currentPremiums, currentPremiumItems, currentPremiumFormulas, partnerLinks<i>
|
|
1555
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode</i>
|
|
1555
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode, partnerLinks.partnerCode</i>
|
|
1556
1556
|
* @param {*} [options] Override http request option.
|
|
1557
1557
|
* @throws {RequiredError}
|
|
1558
1558
|
*/
|
|
@@ -1595,7 +1595,7 @@ var PoliciesApiFactory = function (configuration, basePath, axios) {
|
|
|
1595
1595
|
return localVarFp.listPolicyVersions(policyCode, authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
1596
1596
|
},
|
|
1597
1597
|
/**
|
|
1598
|
-
* Updates the
|
|
1598
|
+
* 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\"
|
|
1599
1599
|
* @summary Update the draft-policy
|
|
1600
1600
|
* @param {string} policyCode Unique identifier for the object.
|
|
1601
1601
|
* @param {PatchDraftPolicyRequestDto} patchDraftPolicyRequestDto
|
|
@@ -1705,7 +1705,7 @@ var PoliciesApi = /** @class */ (function (_super) {
|
|
|
1705
1705
|
return (0, exports.PoliciesApiFp)(this.configuration).activatePolicy(requestParameters.policyCode, requestParameters.activatePolicyRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
1706
1706
|
};
|
|
1707
1707
|
/**
|
|
1708
|
-
* This
|
|
1708
|
+
* 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\"
|
|
1709
1709
|
* @summary Create the draft-policy
|
|
1710
1710
|
* @param {PoliciesApiCreateDraftPolicyRequest} requestParameters Request parameters.
|
|
1711
1711
|
* @param {*} [options] Override http request option.
|
|
@@ -1741,7 +1741,7 @@ var PoliciesApi = /** @class */ (function (_super) {
|
|
|
1741
1741
|
return (0, exports.PoliciesApiFp)(this.configuration).deleteDraftPolicy(requestParameters.policyCode, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
1742
1742
|
};
|
|
1743
1743
|
/**
|
|
1744
|
-
* Retrieves the
|
|
1744
|
+
* 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\"
|
|
1745
1745
|
* @summary Retrieve the draft-policy
|
|
1746
1746
|
* @param {PoliciesApiGetDraftPolicyRequest} requestParameters Request parameters.
|
|
1747
1747
|
* @param {*} [options] Override http request option.
|
|
@@ -1777,7 +1777,7 @@ var PoliciesApi = /** @class */ (function (_super) {
|
|
|
1777
1777
|
return (0, exports.PoliciesApiFp)(this.configuration).getPolicyDataByDate(requestParameters.code, requestParameters.authorization, requestParameters.timesliceDate, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
1778
1778
|
};
|
|
1779
1779
|
/**
|
|
1780
|
-
* 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\"
|
|
1780
|
+
* 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\"
|
|
1781
1781
|
* @summary List policies
|
|
1782
1782
|
* @param {PoliciesApiListPoliciesRequest} requestParameters Request parameters.
|
|
1783
1783
|
* @param {*} [options] Override http request option.
|
|
@@ -1815,7 +1815,7 @@ var PoliciesApi = /** @class */ (function (_super) {
|
|
|
1815
1815
|
return (0, exports.PoliciesApiFp)(this.configuration).listPolicyVersions(requestParameters.policyCode, requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
1816
1816
|
};
|
|
1817
1817
|
/**
|
|
1818
|
-
* Updates the
|
|
1818
|
+
* 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\"
|
|
1819
1819
|
* @summary Update the draft-policy
|
|
1820
1820
|
* @param {PoliciesApiPatchDraftPolicyRequest} requestParameters Request parameters.
|
|
1821
1821
|
* @param {*} [options] Override http request option.
|
|
@@ -24,7 +24,7 @@ export interface CreateDraftPolicyRequestDto {
|
|
|
24
24
|
*/
|
|
25
25
|
'policyObjects': Array<PolicyObjectDto>;
|
|
26
26
|
/**
|
|
27
|
-
* Date from which the policy should be updated. This will create a new timeline starting from this date.
|
|
27
|
+
* Date from which the policy should be updated. This will create a new timeline starting from this date. Required — unlike on the PATCH draft endpoint, `from` cannot be omitted when creating a draft.
|
|
28
28
|
* @type {string}
|
|
29
29
|
* @memberof CreateDraftPolicyRequestDto
|
|
30
30
|
*/
|
|
@@ -22,7 +22,7 @@ export interface GetDraftPolicyRequestDto {
|
|
|
22
22
|
*/
|
|
23
23
|
'policyCode': string;
|
|
24
24
|
/**
|
|
25
|
-
* Fields to expand response
|
|
25
|
+
* Fields to expand in the draft response. Pass the unprefixed relation name; for example, \"premiumItems\" expands the draft premium items relation.<br/> <br/> <i>Allowed values: version, timelines, premiums, premiumItems, premiumFormulas</i>
|
|
26
26
|
* @type {string}
|
|
27
27
|
* @memberof GetDraftPolicyRequestDto
|
|
28
28
|
*/
|
|
@@ -24,7 +24,7 @@ export interface PatchDraftPolicyRequestDto {
|
|
|
24
24
|
*/
|
|
25
25
|
'policyObjects': Array<PolicyObjectDto>;
|
|
26
26
|
/**
|
|
27
|
-
* Date from which the policy should be updated. This will create a new timeline starting from this date.
|
|
27
|
+
* Date from which the policy should be updated. This will create a new timeline starting from this date. Optional on PATCH — omit it to leave the current version unaffected.
|
|
28
28
|
* @type {string}
|
|
29
29
|
* @memberof PatchDraftPolicyRequestDto
|
|
30
30
|
*/
|
|
@@ -36,7 +36,7 @@ export interface PatchDraftPolicyRequestDto {
|
|
|
36
36
|
*/
|
|
37
37
|
'to'?: string;
|
|
38
38
|
/**
|
|
39
|
-
* Policy revision status.
|
|
39
|
+
* Policy revision status. Terminal values change the draft lifecycle:<br/> <br/> - <b>APPROVED</b>: promotes the draft to the current policy version (`isCurrent: true`, `isDraft: false`), replacing the current version.<br/> - <b>REJECTED</b>: deletes the draft version; subsequent `GET .../draft` requests return 404.<br/> - <b>CREATED</b>, <b>IN_REVIEW</b>, or <b>REVIEWED</b>: updates the draft in place with the supplied payload and leaves it as a draft (`isCurrent: false`, `isDraft: true`).
|
|
40
40
|
* @type {string}
|
|
41
41
|
* @memberof PatchDraftPolicyRequestDto
|
|
42
42
|
*/
|
|
@@ -28,7 +28,7 @@ export interface PolicyObjectDto {
|
|
|
28
28
|
*/
|
|
29
29
|
'insuredObjectName'?: string;
|
|
30
30
|
/**
|
|
31
|
-
* Insured object data.
|
|
31
|
+
* Insured object data. For the \"Coverage\" insured object, pass the tariff variant as `tariffVariant`, for example `{ \"tariffVariant\": \"...\" }`.
|
|
32
32
|
* @type {object}
|
|
33
33
|
* @memberof PolicyObjectDto
|
|
34
34
|
*/
|
|
@@ -47,7 +47,7 @@ export interface PolicyPremiumItemClass {
|
|
|
47
47
|
*/
|
|
48
48
|
'premiumFormula': PremiumFormulaClass;
|
|
49
49
|
/**
|
|
50
|
-
*
|
|
50
|
+
* Whether this premium item is priced from an override rather than the formula. Read-only — it cannot be set directly. It is computed per formula (matched by `name` + `unit`) from whether the request included a matching entry in `premiumOverride.premiumOverrides`.
|
|
51
51
|
* @type {boolean}
|
|
52
52
|
* @memberof PolicyPremiumItemClass
|
|
53
53
|
*/
|
|
@@ -29,7 +29,7 @@ export interface CreateDraftPolicyRequestDto {
|
|
|
29
29
|
*/
|
|
30
30
|
'policyObjects': Array<PolicyObjectDto>;
|
|
31
31
|
/**
|
|
32
|
-
* Date from which the policy should be updated. This will create a new timeline starting from this date.
|
|
32
|
+
* Date from which the policy should be updated. This will create a new timeline starting from this date. Required — unlike on the PATCH draft endpoint, `from` cannot be omitted when creating a draft.
|
|
33
33
|
* @type {string}
|
|
34
34
|
* @memberof CreateDraftPolicyRequestDto
|
|
35
35
|
*/
|
|
@@ -27,7 +27,7 @@ export interface GetDraftPolicyRequestDto {
|
|
|
27
27
|
*/
|
|
28
28
|
'policyCode': string;
|
|
29
29
|
/**
|
|
30
|
-
* Fields to expand response
|
|
30
|
+
* Fields to expand in the draft response. Pass the unprefixed relation name; for example, \"premiumItems\" expands the draft premium items relation.<br/> <br/> <i>Allowed values: version, timelines, premiums, premiumItems, premiumFormulas</i>
|
|
31
31
|
* @type {string}
|
|
32
32
|
* @memberof GetDraftPolicyRequestDto
|
|
33
33
|
*/
|
|
@@ -29,7 +29,7 @@ export interface PatchDraftPolicyRequestDto {
|
|
|
29
29
|
*/
|
|
30
30
|
'policyObjects': Array<PolicyObjectDto>;
|
|
31
31
|
/**
|
|
32
|
-
* Date from which the policy should be updated. This will create a new timeline starting from this date.
|
|
32
|
+
* Date from which the policy should be updated. This will create a new timeline starting from this date. Optional on PATCH — omit it to leave the current version unaffected.
|
|
33
33
|
* @type {string}
|
|
34
34
|
* @memberof PatchDraftPolicyRequestDto
|
|
35
35
|
*/
|
|
@@ -41,7 +41,7 @@ export interface PatchDraftPolicyRequestDto {
|
|
|
41
41
|
*/
|
|
42
42
|
'to'?: string;
|
|
43
43
|
/**
|
|
44
|
-
* Policy revision status.
|
|
44
|
+
* Policy revision status. Terminal values change the draft lifecycle:<br/> <br/> - <b>APPROVED</b>: promotes the draft to the current policy version (`isCurrent: true`, `isDraft: false`), replacing the current version.<br/> - <b>REJECTED</b>: deletes the draft version; subsequent `GET .../draft` requests return 404.<br/> - <b>CREATED</b>, <b>IN_REVIEW</b>, or <b>REVIEWED</b>: updates the draft in place with the supplied payload and leaves it as a draft (`isCurrent: false`, `isDraft: true`).
|
|
45
45
|
* @type {string}
|
|
46
46
|
* @memberof PatchDraftPolicyRequestDto
|
|
47
47
|
*/
|
|
@@ -33,7 +33,7 @@ export interface PolicyObjectDto {
|
|
|
33
33
|
*/
|
|
34
34
|
'insuredObjectName'?: string;
|
|
35
35
|
/**
|
|
36
|
-
* Insured object data.
|
|
36
|
+
* Insured object data. For the \"Coverage\" insured object, pass the tariff variant as `tariffVariant`, for example `{ \"tariffVariant\": \"...\" }`.
|
|
37
37
|
* @type {object}
|
|
38
38
|
* @memberof PolicyObjectDto
|
|
39
39
|
*/
|
|
@@ -52,7 +52,7 @@ export interface PolicyPremiumItemClass {
|
|
|
52
52
|
*/
|
|
53
53
|
'premiumFormula': PremiumFormulaClass;
|
|
54
54
|
/**
|
|
55
|
-
*
|
|
55
|
+
* Whether this premium item is priced from an override rather than the formula. Read-only — it cannot be set directly. It is computed per formula (matched by `name` + `unit`) from whether the request included a matching entry in `premiumOverride.premiumOverrides`.
|
|
56
56
|
* @type {boolean}
|
|
57
57
|
* @memberof PolicyPremiumItemClass
|
|
58
58
|
*/
|