@emilgroup/insurance-sdk 1.107.1-beta.29 → 1.107.1-beta.30
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/policies-api.ts +20 -20
- package/dist/api/policies-api.d.ts +20 -20
- package/dist/api/policies-api.js +19 -19
- 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@1.107.1-beta.
|
|
20
|
+
npm install @emilgroup/insurance-sdk@1.107.1-beta.30 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/insurance-sdk@1.107.1-beta.
|
|
24
|
+
yarn add @emilgroup/insurance-sdk@1.107.1-beta.30
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `PoliciesApi`.
|
package/api/policies-api.ts
CHANGED
|
@@ -122,7 +122,7 @@ export const PoliciesApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
122
122
|
};
|
|
123
123
|
},
|
|
124
124
|
/**
|
|
125
|
-
* This
|
|
125
|
+
* 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\"
|
|
126
126
|
* @summary Create the draft-policy
|
|
127
127
|
* @param {string} policyCode Unique identifier for the object.
|
|
128
128
|
* @param {CreateDraftPolicyRequestDto} createDraftPolicyRequestDto
|
|
@@ -265,11 +265,11 @@ export const PoliciesApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
265
265
|
};
|
|
266
266
|
},
|
|
267
267
|
/**
|
|
268
|
-
* Retrieves the
|
|
268
|
+
* 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\"
|
|
269
269
|
* @summary Retrieve the draft-policy
|
|
270
270
|
* @param {string} policyCode Unique identifier for the object.
|
|
271
271
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
272
|
-
* @param {string} [expand] Fields to expand response
|
|
272
|
+
* @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>
|
|
273
273
|
* @param {*} [options] Override http request option.
|
|
274
274
|
* @throws {RequiredError}
|
|
275
275
|
*/
|
|
@@ -420,7 +420,7 @@ export const PoliciesApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
420
420
|
};
|
|
421
421
|
},
|
|
422
422
|
/**
|
|
423
|
-
* 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\"
|
|
423
|
+
* 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\"
|
|
424
424
|
* @summary List policies
|
|
425
425
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
426
426
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
@@ -652,7 +652,7 @@ export const PoliciesApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
652
652
|
};
|
|
653
653
|
},
|
|
654
654
|
/**
|
|
655
|
-
* Updates the
|
|
655
|
+
* 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\"
|
|
656
656
|
* @summary Update the draft-policy
|
|
657
657
|
* @param {string} policyCode Unique identifier for the object.
|
|
658
658
|
* @param {PatchDraftPolicyRequestDto} patchDraftPolicyRequestDto
|
|
@@ -1032,7 +1032,7 @@ export const PoliciesApiFp = function(configuration?: Configuration) {
|
|
|
1032
1032
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1033
1033
|
},
|
|
1034
1034
|
/**
|
|
1035
|
-
* This
|
|
1035
|
+
* 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\"
|
|
1036
1036
|
* @summary Create the draft-policy
|
|
1037
1037
|
* @param {string} policyCode Unique identifier for the object.
|
|
1038
1038
|
* @param {CreateDraftPolicyRequestDto} createDraftPolicyRequestDto
|
|
@@ -1069,11 +1069,11 @@ export const PoliciesApiFp = function(configuration?: Configuration) {
|
|
|
1069
1069
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1070
1070
|
},
|
|
1071
1071
|
/**
|
|
1072
|
-
* Retrieves the
|
|
1072
|
+
* 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\"
|
|
1073
1073
|
* @summary Retrieve the draft-policy
|
|
1074
1074
|
* @param {string} policyCode Unique identifier for the object.
|
|
1075
1075
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1076
|
-
* @param {string} [expand] Fields to expand response
|
|
1076
|
+
* @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>
|
|
1077
1077
|
* @param {*} [options] Override http request option.
|
|
1078
1078
|
* @throws {RequiredError}
|
|
1079
1079
|
*/
|
|
@@ -1109,7 +1109,7 @@ export const PoliciesApiFp = function(configuration?: Configuration) {
|
|
|
1109
1109
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1110
1110
|
},
|
|
1111
1111
|
/**
|
|
1112
|
-
* 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\"
|
|
1112
|
+
* 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\"
|
|
1113
1113
|
* @summary List policies
|
|
1114
1114
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1115
1115
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
@@ -1164,7 +1164,7 @@ export const PoliciesApiFp = function(configuration?: Configuration) {
|
|
|
1164
1164
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1165
1165
|
},
|
|
1166
1166
|
/**
|
|
1167
|
-
* Updates the
|
|
1167
|
+
* 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\"
|
|
1168
1168
|
* @summary Update the draft-policy
|
|
1169
1169
|
* @param {string} policyCode Unique identifier for the object.
|
|
1170
1170
|
* @param {PatchDraftPolicyRequestDto} patchDraftPolicyRequestDto
|
|
@@ -1277,7 +1277,7 @@ export const PoliciesApiFactory = function (configuration?: Configuration, baseP
|
|
|
1277
1277
|
return localVarFp.activatePolicy(policyCode, activatePolicyRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
1278
1278
|
},
|
|
1279
1279
|
/**
|
|
1280
|
-
* This
|
|
1280
|
+
* 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\"
|
|
1281
1281
|
* @summary Create the draft-policy
|
|
1282
1282
|
* @param {string} policyCode Unique identifier for the object.
|
|
1283
1283
|
* @param {CreateDraftPolicyRequestDto} createDraftPolicyRequestDto
|
|
@@ -1311,11 +1311,11 @@ export const PoliciesApiFactory = function (configuration?: Configuration, baseP
|
|
|
1311
1311
|
return localVarFp.deleteDraftPolicy(policyCode, authorization, options).then((request) => request(axios, basePath));
|
|
1312
1312
|
},
|
|
1313
1313
|
/**
|
|
1314
|
-
* Retrieves the
|
|
1314
|
+
* 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\"
|
|
1315
1315
|
* @summary Retrieve the draft-policy
|
|
1316
1316
|
* @param {string} policyCode Unique identifier for the object.
|
|
1317
1317
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1318
|
-
* @param {string} [expand] Fields to expand response
|
|
1318
|
+
* @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>
|
|
1319
1319
|
* @param {*} [options] Override http request option.
|
|
1320
1320
|
* @throws {RequiredError}
|
|
1321
1321
|
*/
|
|
@@ -1348,7 +1348,7 @@ export const PoliciesApiFactory = function (configuration?: Configuration, baseP
|
|
|
1348
1348
|
return localVarFp.getPolicyDataByDate(code, authorization, timesliceDate, expand, options).then((request) => request(axios, basePath));
|
|
1349
1349
|
},
|
|
1350
1350
|
/**
|
|
1351
|
-
* 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\"
|
|
1351
|
+
* 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\"
|
|
1352
1352
|
* @summary List policies
|
|
1353
1353
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1354
1354
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
@@ -1400,7 +1400,7 @@ export const PoliciesApiFactory = function (configuration?: Configuration, baseP
|
|
|
1400
1400
|
return localVarFp.listPolicyVersions(policyCode, authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
1401
1401
|
},
|
|
1402
1402
|
/**
|
|
1403
|
-
* Updates the
|
|
1403
|
+
* 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\"
|
|
1404
1404
|
* @summary Update the draft-policy
|
|
1405
1405
|
* @param {string} policyCode Unique identifier for the object.
|
|
1406
1406
|
* @param {PatchDraftPolicyRequestDto} patchDraftPolicyRequestDto
|
|
@@ -1605,7 +1605,7 @@ export interface PoliciesApiGetDraftPolicyRequest {
|
|
|
1605
1605
|
readonly authorization?: string
|
|
1606
1606
|
|
|
1607
1607
|
/**
|
|
1608
|
-
* Fields to expand response
|
|
1608
|
+
* 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>
|
|
1609
1609
|
* @type {string}
|
|
1610
1610
|
* @memberof PoliciesApiGetDraftPolicy
|
|
1611
1611
|
*/
|
|
@@ -2087,7 +2087,7 @@ export class PoliciesApi extends BaseAPI {
|
|
|
2087
2087
|
}
|
|
2088
2088
|
|
|
2089
2089
|
/**
|
|
2090
|
-
* This
|
|
2090
|
+
* 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\"
|
|
2091
2091
|
* @summary Create the draft-policy
|
|
2092
2092
|
* @param {PoliciesApiCreateDraftPolicyRequest} requestParameters Request parameters.
|
|
2093
2093
|
* @param {*} [options] Override http request option.
|
|
@@ -2123,7 +2123,7 @@ export class PoliciesApi extends BaseAPI {
|
|
|
2123
2123
|
}
|
|
2124
2124
|
|
|
2125
2125
|
/**
|
|
2126
|
-
* Retrieves the
|
|
2126
|
+
* 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\"
|
|
2127
2127
|
* @summary Retrieve the draft-policy
|
|
2128
2128
|
* @param {PoliciesApiGetDraftPolicyRequest} requestParameters Request parameters.
|
|
2129
2129
|
* @param {*} [options] Override http request option.
|
|
@@ -2159,7 +2159,7 @@ export class PoliciesApi extends BaseAPI {
|
|
|
2159
2159
|
}
|
|
2160
2160
|
|
|
2161
2161
|
/**
|
|
2162
|
-
* 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\"
|
|
2162
|
+
* 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\"
|
|
2163
2163
|
* @summary List policies
|
|
2164
2164
|
* @param {PoliciesApiListPoliciesRequest} requestParameters Request parameters.
|
|
2165
2165
|
* @param {*} [options] Override http request option.
|
|
@@ -2195,7 +2195,7 @@ export class PoliciesApi extends BaseAPI {
|
|
|
2195
2195
|
}
|
|
2196
2196
|
|
|
2197
2197
|
/**
|
|
2198
|
-
* Updates the
|
|
2198
|
+
* 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\"
|
|
2199
2199
|
* @summary Update the draft-policy
|
|
2200
2200
|
* @param {PoliciesApiPatchDraftPolicyRequest} requestParameters Request parameters.
|
|
2201
2201
|
* @param {*} [options] Override http request option.
|
|
@@ -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,7 +109,7 @@ 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.
|
|
@@ -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,7 +300,7 @@ 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.
|
|
@@ -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,7 +491,7 @@ 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.
|
|
@@ -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
|
*/
|
|
@@ -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
|
@@ -146,7 +146,7 @@ var PoliciesApiAxiosParamCreator = function (configuration) {
|
|
|
146
146
|
});
|
|
147
147
|
},
|
|
148
148
|
/**
|
|
149
|
-
* This
|
|
149
|
+
* 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\"
|
|
150
150
|
* @summary Create the draft-policy
|
|
151
151
|
* @param {string} policyCode Unique identifier for the object.
|
|
152
152
|
* @param {CreateDraftPolicyRequestDto} createDraftPolicyRequestDto
|
|
@@ -296,11 +296,11 @@ var PoliciesApiAxiosParamCreator = function (configuration) {
|
|
|
296
296
|
});
|
|
297
297
|
},
|
|
298
298
|
/**
|
|
299
|
-
* Retrieves the
|
|
299
|
+
* 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\"
|
|
300
300
|
* @summary Retrieve the draft-policy
|
|
301
301
|
* @param {string} policyCode Unique identifier for the object.
|
|
302
302
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
303
|
-
* @param {string} [expand] Fields to expand response
|
|
303
|
+
* @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>
|
|
304
304
|
* @param {*} [options] Override http request option.
|
|
305
305
|
* @throws {RequiredError}
|
|
306
306
|
*/
|
|
@@ -456,7 +456,7 @@ var PoliciesApiAxiosParamCreator = function (configuration) {
|
|
|
456
456
|
});
|
|
457
457
|
},
|
|
458
458
|
/**
|
|
459
|
-
* 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\"
|
|
459
|
+
* 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\"
|
|
460
460
|
* @summary List policies
|
|
461
461
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
462
462
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
@@ -676,7 +676,7 @@ var PoliciesApiAxiosParamCreator = function (configuration) {
|
|
|
676
676
|
});
|
|
677
677
|
},
|
|
678
678
|
/**
|
|
679
|
-
* Updates the
|
|
679
|
+
* 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\"
|
|
680
680
|
* @summary Update the draft-policy
|
|
681
681
|
* @param {string} policyCode Unique identifier for the object.
|
|
682
682
|
* @param {PatchDraftPolicyRequestDto} patchDraftPolicyRequestDto
|
|
@@ -1079,7 +1079,7 @@ var PoliciesApiFp = function (configuration) {
|
|
|
1079
1079
|
});
|
|
1080
1080
|
},
|
|
1081
1081
|
/**
|
|
1082
|
-
* This
|
|
1082
|
+
* 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\"
|
|
1083
1083
|
* @summary Create the draft-policy
|
|
1084
1084
|
* @param {string} policyCode Unique identifier for the object.
|
|
1085
1085
|
* @param {CreateDraftPolicyRequestDto} createDraftPolicyRequestDto
|
|
@@ -1143,11 +1143,11 @@ var PoliciesApiFp = function (configuration) {
|
|
|
1143
1143
|
});
|
|
1144
1144
|
},
|
|
1145
1145
|
/**
|
|
1146
|
-
* Retrieves the
|
|
1146
|
+
* 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\"
|
|
1147
1147
|
* @summary Retrieve the draft-policy
|
|
1148
1148
|
* @param {string} policyCode Unique identifier for the object.
|
|
1149
1149
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1150
|
-
* @param {string} [expand] Fields to expand response
|
|
1150
|
+
* @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>
|
|
1151
1151
|
* @param {*} [options] Override http request option.
|
|
1152
1152
|
* @throws {RequiredError}
|
|
1153
1153
|
*/
|
|
@@ -1210,7 +1210,7 @@ var PoliciesApiFp = function (configuration) {
|
|
|
1210
1210
|
});
|
|
1211
1211
|
},
|
|
1212
1212
|
/**
|
|
1213
|
-
* 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\"
|
|
1213
|
+
* 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\"
|
|
1214
1214
|
* @summary List policies
|
|
1215
1215
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1216
1216
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
@@ -1292,7 +1292,7 @@ var PoliciesApiFp = function (configuration) {
|
|
|
1292
1292
|
});
|
|
1293
1293
|
},
|
|
1294
1294
|
/**
|
|
1295
|
-
* Updates the
|
|
1295
|
+
* 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\"
|
|
1296
1296
|
* @summary Update the draft-policy
|
|
1297
1297
|
* @param {string} policyCode Unique identifier for the object.
|
|
1298
1298
|
* @param {PatchDraftPolicyRequestDto} patchDraftPolicyRequestDto
|
|
@@ -1468,7 +1468,7 @@ var PoliciesApiFactory = function (configuration, basePath, axios) {
|
|
|
1468
1468
|
return localVarFp.activatePolicy(policyCode, activatePolicyRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
1469
1469
|
},
|
|
1470
1470
|
/**
|
|
1471
|
-
* This
|
|
1471
|
+
* 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\"
|
|
1472
1472
|
* @summary Create the draft-policy
|
|
1473
1473
|
* @param {string} policyCode Unique identifier for the object.
|
|
1474
1474
|
* @param {CreateDraftPolicyRequestDto} createDraftPolicyRequestDto
|
|
@@ -1502,11 +1502,11 @@ var PoliciesApiFactory = function (configuration, basePath, axios) {
|
|
|
1502
1502
|
return localVarFp.deleteDraftPolicy(policyCode, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
1503
1503
|
},
|
|
1504
1504
|
/**
|
|
1505
|
-
* Retrieves the
|
|
1505
|
+
* 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\"
|
|
1506
1506
|
* @summary Retrieve the draft-policy
|
|
1507
1507
|
* @param {string} policyCode Unique identifier for the object.
|
|
1508
1508
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1509
|
-
* @param {string} [expand] Fields to expand response
|
|
1509
|
+
* @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>
|
|
1510
1510
|
* @param {*} [options] Override http request option.
|
|
1511
1511
|
* @throws {RequiredError}
|
|
1512
1512
|
*/
|
|
@@ -1539,7 +1539,7 @@ var PoliciesApiFactory = function (configuration, basePath, axios) {
|
|
|
1539
1539
|
return localVarFp.getPolicyDataByDate(code, authorization, timesliceDate, expand, options).then(function (request) { return request(axios, basePath); });
|
|
1540
1540
|
},
|
|
1541
1541
|
/**
|
|
1542
|
-
* 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\"
|
|
1542
|
+
* 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\"
|
|
1543
1543
|
* @summary List policies
|
|
1544
1544
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1545
1545
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
@@ -1591,7 +1591,7 @@ var PoliciesApiFactory = function (configuration, basePath, axios) {
|
|
|
1591
1591
|
return localVarFp.listPolicyVersions(policyCode, authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
1592
1592
|
},
|
|
1593
1593
|
/**
|
|
1594
|
-
* Updates the
|
|
1594
|
+
* 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\"
|
|
1595
1595
|
* @summary Update the draft-policy
|
|
1596
1596
|
* @param {string} policyCode Unique identifier for the object.
|
|
1597
1597
|
* @param {PatchDraftPolicyRequestDto} patchDraftPolicyRequestDto
|
|
@@ -1701,7 +1701,7 @@ var PoliciesApi = /** @class */ (function (_super) {
|
|
|
1701
1701
|
return (0, exports.PoliciesApiFp)(this.configuration).activatePolicy(requestParameters.policyCode, requestParameters.activatePolicyRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
1702
1702
|
};
|
|
1703
1703
|
/**
|
|
1704
|
-
* This
|
|
1704
|
+
* 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\"
|
|
1705
1705
|
* @summary Create the draft-policy
|
|
1706
1706
|
* @param {PoliciesApiCreateDraftPolicyRequest} requestParameters Request parameters.
|
|
1707
1707
|
* @param {*} [options] Override http request option.
|
|
@@ -1737,7 +1737,7 @@ var PoliciesApi = /** @class */ (function (_super) {
|
|
|
1737
1737
|
return (0, exports.PoliciesApiFp)(this.configuration).deleteDraftPolicy(requestParameters.policyCode, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
1738
1738
|
};
|
|
1739
1739
|
/**
|
|
1740
|
-
* Retrieves the
|
|
1740
|
+
* 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\"
|
|
1741
1741
|
* @summary Retrieve the draft-policy
|
|
1742
1742
|
* @param {PoliciesApiGetDraftPolicyRequest} requestParameters Request parameters.
|
|
1743
1743
|
* @param {*} [options] Override http request option.
|
|
@@ -1773,7 +1773,7 @@ var PoliciesApi = /** @class */ (function (_super) {
|
|
|
1773
1773
|
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); });
|
|
1774
1774
|
};
|
|
1775
1775
|
/**
|
|
1776
|
-
* 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\"
|
|
1776
|
+
* 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\"
|
|
1777
1777
|
* @summary List policies
|
|
1778
1778
|
* @param {PoliciesApiListPoliciesRequest} requestParameters Request parameters.
|
|
1779
1779
|
* @param {*} [options] Override http request option.
|
|
@@ -1811,7 +1811,7 @@ var PoliciesApi = /** @class */ (function (_super) {
|
|
|
1811
1811
|
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); });
|
|
1812
1812
|
};
|
|
1813
1813
|
/**
|
|
1814
|
-
* Updates the
|
|
1814
|
+
* 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\"
|
|
1815
1815
|
* @summary Update the draft-policy
|
|
1816
1816
|
* @param {PoliciesApiPatchDraftPolicyRequest} requestParameters Request parameters.
|
|
1817
1817
|
* @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
|
*/
|