@emilgroup/insurance-sdk-node 1.47.0 → 1.48.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +10 -0
- package/README.md +2 -2
- package/api/booking-funnel-versions-api.ts +375 -0
- package/api/booking-funnels-api.ts +4 -4
- package/api/lead-versions-api.ts +4 -4
- package/api/leads-api.ts +4 -4
- package/api/policies-api.ts +123 -123
- package/api/policy-partner-roles-api.ts +683 -0
- package/api/status-transition-rules-api.ts +4 -4
- package/api.ts +4 -0
- package/dist/api/booking-funnel-versions-api.d.ts +222 -0
- package/dist/api/booking-funnel-versions-api.js +367 -0
- package/dist/api/booking-funnels-api.d.ts +4 -4
- package/dist/api/booking-funnels-api.js +3 -3
- package/dist/api/lead-versions-api.d.ts +4 -4
- package/dist/api/lead-versions-api.js +3 -3
- package/dist/api/leads-api.d.ts +4 -4
- package/dist/api/leads-api.js +3 -3
- package/dist/api/policies-api.d.ts +123 -123
- package/dist/api/policies-api.js +60 -60
- package/dist/api/policy-partner-roles-api.d.ts +385 -0
- package/dist/api/policy-partner-roles-api.js +640 -0
- package/dist/api/status-transition-rules-api.d.ts +4 -4
- package/dist/api/status-transition-rules-api.js +3 -3
- package/dist/api.d.ts +2 -0
- package/dist/api.js +2 -0
- package/dist/models/booking-funnel-class.d.ts +6 -0
- package/dist/models/create-policy-partner-role-request-dto.d.ts +30 -0
- package/dist/models/create-policy-partner-role-request-dto.js +15 -0
- package/dist/models/create-policy-partner-role-response-class.d.ts +25 -0
- package/dist/models/create-policy-partner-role-response-class.js +15 -0
- package/dist/models/get-booking-funnel-version-request-dto.d.ts +30 -0
- package/dist/models/get-booking-funnel-version-request-dto.js +15 -0
- package/dist/models/get-policy-partner-role-response-class.d.ts +25 -0
- package/dist/models/get-policy-partner-role-response-class.js +15 -0
- package/dist/models/index.d.ts +8 -0
- package/dist/models/index.js +8 -0
- package/dist/models/list-policy-partner-roles-response-class.d.ts +31 -0
- package/dist/models/list-policy-partner-roles-response-class.js +15 -0
- package/dist/models/policy-partner-role-class.d.ts +54 -0
- package/dist/models/policy-partner-role-class.js +15 -0
- package/dist/models/update-policy-partner-role-request-dto.d.ts +30 -0
- package/dist/models/update-policy-partner-role-request-dto.js +15 -0
- package/dist/models/update-policy-partner-role-response-class.d.ts +25 -0
- package/dist/models/update-policy-partner-role-response-class.js +15 -0
- package/models/booking-funnel-class.ts +6 -0
- package/models/create-policy-partner-role-request-dto.ts +36 -0
- package/models/create-policy-partner-role-response-class.ts +31 -0
- package/models/get-booking-funnel-version-request-dto.ts +36 -0
- package/models/get-policy-partner-role-response-class.ts +31 -0
- package/models/index.ts +8 -0
- package/models/list-policy-partner-roles-response-class.ts +37 -0
- package/models/policy-partner-role-class.ts +60 -0
- package/models/update-policy-partner-role-request-dto.ts +36 -0
- package/models/update-policy-partner-role-response-class.ts +31 -0
- package/package.json +1 -1
|
@@ -111,48 +111,48 @@ export declare const PoliciesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
111
111
|
* 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.
|
|
112
112
|
* @summary List policies
|
|
113
113
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
114
|
-
* @param {
|
|
115
|
-
* @param {
|
|
116
|
-
* @param {
|
|
117
|
-
* @param {
|
|
118
|
-
* @param {
|
|
114
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
115
|
+
* @param {any} [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.
|
|
116
|
+
* @param {any} [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</i>
|
|
117
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
118
|
+
* @param {any} [order] Order allowing you to specify the desired order of entities retrieved from the server.<br/> <br/> <i>Allowed values: id, policyNumber, createdAt, updatedAt, policyStartDate, productVersionId, productId</i>
|
|
119
119
|
* @param {'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas'} [expand] You can expand policy versions list in this endpoint. By default, versions will be an empty array.
|
|
120
|
-
* @param {
|
|
120
|
+
* @param {any} [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.
|
|
121
121
|
* @param {*} [options] Override http request option.
|
|
122
122
|
* @throws {RequiredError}
|
|
123
123
|
*/
|
|
124
|
-
listPolicies: (authorization?: string, pageSize?:
|
|
124
|
+
listPolicies: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: 'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas', filters?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
125
125
|
/**
|
|
126
126
|
* This will return a policy objects for the given policy. You may filter the objects to return by the insured object, or return only the objects that exists for a particular date (providing the object code or ID).
|
|
127
127
|
* @summary List policy objects
|
|
128
|
-
* @param {
|
|
128
|
+
* @param {any} 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, insuredObjectId, insuredObjectName, policyCode, date</i> <br/> <i>policyCode</i> is required, other filters are optional.
|
|
129
129
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
130
|
-
* @param {
|
|
131
|
-
* @param {
|
|
132
|
-
* @param {
|
|
133
|
-
* @param {
|
|
134
|
-
* @param {
|
|
135
|
-
* @param {
|
|
130
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
131
|
+
* @param {any} [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.
|
|
132
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
133
|
+
* @param {any} [order] Order allowing you to specify the desired order of entities retrieved from the server.<br/> <br/> <i>Allowed values: id, code, timesliceId, insuredObjectId, createdAt, updatedAt</i>
|
|
134
|
+
* @param {any} [expand] No expanding supported
|
|
135
|
+
* @param {any} [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.
|
|
136
136
|
* @param {*} [options] Override http request option.
|
|
137
137
|
* @throws {RequiredError}
|
|
138
138
|
*/
|
|
139
|
-
listPolicyObjects: (filter:
|
|
139
|
+
listPolicyObjects: (filter: any, authorization?: string, pageSize?: any, pageToken?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
140
140
|
/**
|
|
141
141
|
* Returns a list of policy versions you have previously created. The policy versions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
142
142
|
* @summary List policy versions
|
|
143
143
|
* @param {string} policyCode
|
|
144
144
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
145
|
-
* @param {
|
|
146
|
-
* @param {
|
|
147
|
-
* @param {
|
|
148
|
-
* @param {
|
|
149
|
-
* @param {
|
|
150
|
-
* @param {
|
|
151
|
-
* @param {
|
|
145
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
146
|
+
* @param {any} [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.
|
|
147
|
+
* @param {any} [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, policyId</i>
|
|
148
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
149
|
+
* @param {any} [order] Order allowing you to specify the desired order of entities retrieved from the server.<br/> <br/> <i>Allowed values: id, policyId, createdAt, updatedAt</i>
|
|
150
|
+
* @param {any} [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.
|
|
151
|
+
* @param {any} [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.
|
|
152
152
|
* @param {*} [options] Override http request option.
|
|
153
153
|
* @throws {RequiredError}
|
|
154
154
|
*/
|
|
155
|
-
listPolicyVersions: (policyCode: string, authorization?: string, pageSize?:
|
|
155
|
+
listPolicyVersions: (policyCode: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
156
156
|
/**
|
|
157
157
|
* Updates the specified policy by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
158
158
|
* @summary Update the policy
|
|
@@ -294,48 +294,48 @@ export declare const PoliciesApiFp: (configuration?: Configuration) => {
|
|
|
294
294
|
* 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.
|
|
295
295
|
* @summary List policies
|
|
296
296
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
297
|
-
* @param {
|
|
298
|
-
* @param {
|
|
299
|
-
* @param {
|
|
300
|
-
* @param {
|
|
301
|
-
* @param {
|
|
297
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
298
|
+
* @param {any} [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.
|
|
299
|
+
* @param {any} [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</i>
|
|
300
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
301
|
+
* @param {any} [order] Order allowing you to specify the desired order of entities retrieved from the server.<br/> <br/> <i>Allowed values: id, policyNumber, createdAt, updatedAt, policyStartDate, productVersionId, productId</i>
|
|
302
302
|
* @param {'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas'} [expand] You can expand policy versions list in this endpoint. By default, versions will be an empty array.
|
|
303
|
-
* @param {
|
|
303
|
+
* @param {any} [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.
|
|
304
304
|
* @param {*} [options] Override http request option.
|
|
305
305
|
* @throws {RequiredError}
|
|
306
306
|
*/
|
|
307
|
-
listPolicies(authorization?: string, pageSize?:
|
|
307
|
+
listPolicies(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: 'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas', filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPoliciesResponseClass>>;
|
|
308
308
|
/**
|
|
309
309
|
* This will return a policy objects for the given policy. You may filter the objects to return by the insured object, or return only the objects that exists for a particular date (providing the object code or ID).
|
|
310
310
|
* @summary List policy objects
|
|
311
|
-
* @param {
|
|
311
|
+
* @param {any} 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, insuredObjectId, insuredObjectName, policyCode, date</i> <br/> <i>policyCode</i> is required, other filters are optional.
|
|
312
312
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
313
|
-
* @param {
|
|
314
|
-
* @param {
|
|
315
|
-
* @param {
|
|
316
|
-
* @param {
|
|
317
|
-
* @param {
|
|
318
|
-
* @param {
|
|
313
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
314
|
+
* @param {any} [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.
|
|
315
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
316
|
+
* @param {any} [order] Order allowing you to specify the desired order of entities retrieved from the server.<br/> <br/> <i>Allowed values: id, code, timesliceId, insuredObjectId, createdAt, updatedAt</i>
|
|
317
|
+
* @param {any} [expand] No expanding supported
|
|
318
|
+
* @param {any} [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.
|
|
319
319
|
* @param {*} [options] Override http request option.
|
|
320
320
|
* @throws {RequiredError}
|
|
321
321
|
*/
|
|
322
|
-
listPolicyObjects(filter:
|
|
322
|
+
listPolicyObjects(filter: any, authorization?: string, pageSize?: any, pageToken?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPolicyObjectsResponseClass>>;
|
|
323
323
|
/**
|
|
324
324
|
* Returns a list of policy versions you have previously created. The policy versions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
325
325
|
* @summary List policy versions
|
|
326
326
|
* @param {string} policyCode
|
|
327
327
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
328
|
-
* @param {
|
|
329
|
-
* @param {
|
|
330
|
-
* @param {
|
|
331
|
-
* @param {
|
|
332
|
-
* @param {
|
|
333
|
-
* @param {
|
|
334
|
-
* @param {
|
|
328
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
329
|
+
* @param {any} [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.
|
|
330
|
+
* @param {any} [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, policyId</i>
|
|
331
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
332
|
+
* @param {any} [order] Order allowing you to specify the desired order of entities retrieved from the server.<br/> <br/> <i>Allowed values: id, policyId, createdAt, updatedAt</i>
|
|
333
|
+
* @param {any} [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.
|
|
334
|
+
* @param {any} [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.
|
|
335
335
|
* @param {*} [options] Override http request option.
|
|
336
336
|
* @throws {RequiredError}
|
|
337
337
|
*/
|
|
338
|
-
listPolicyVersions(policyCode: string, authorization?: string, pageSize?:
|
|
338
|
+
listPolicyVersions(policyCode: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPolicyVersionResponseClass>>;
|
|
339
339
|
/**
|
|
340
340
|
* Updates the specified policy by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
341
341
|
* @summary Update the policy
|
|
@@ -477,48 +477,48 @@ export declare const PoliciesApiFactory: (configuration?: Configuration, basePat
|
|
|
477
477
|
* 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.
|
|
478
478
|
* @summary List policies
|
|
479
479
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
480
|
-
* @param {
|
|
481
|
-
* @param {
|
|
482
|
-
* @param {
|
|
483
|
-
* @param {
|
|
484
|
-
* @param {
|
|
480
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
481
|
+
* @param {any} [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.
|
|
482
|
+
* @param {any} [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</i>
|
|
483
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
484
|
+
* @param {any} [order] Order allowing you to specify the desired order of entities retrieved from the server.<br/> <br/> <i>Allowed values: id, policyNumber, createdAt, updatedAt, policyStartDate, productVersionId, productId</i>
|
|
485
485
|
* @param {'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas'} [expand] You can expand policy versions list in this endpoint. By default, versions will be an empty array.
|
|
486
|
-
* @param {
|
|
486
|
+
* @param {any} [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.
|
|
487
487
|
* @param {*} [options] Override http request option.
|
|
488
488
|
* @throws {RequiredError}
|
|
489
489
|
*/
|
|
490
|
-
listPolicies(authorization?: string, pageSize?:
|
|
490
|
+
listPolicies(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: 'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas', filters?: any, options?: any): AxiosPromise<ListPoliciesResponseClass>;
|
|
491
491
|
/**
|
|
492
492
|
* This will return a policy objects for the given policy. You may filter the objects to return by the insured object, or return only the objects that exists for a particular date (providing the object code or ID).
|
|
493
493
|
* @summary List policy objects
|
|
494
|
-
* @param {
|
|
494
|
+
* @param {any} 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, insuredObjectId, insuredObjectName, policyCode, date</i> <br/> <i>policyCode</i> is required, other filters are optional.
|
|
495
495
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
496
|
-
* @param {
|
|
497
|
-
* @param {
|
|
498
|
-
* @param {
|
|
499
|
-
* @param {
|
|
500
|
-
* @param {
|
|
501
|
-
* @param {
|
|
496
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
497
|
+
* @param {any} [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.
|
|
498
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
499
|
+
* @param {any} [order] Order allowing you to specify the desired order of entities retrieved from the server.<br/> <br/> <i>Allowed values: id, code, timesliceId, insuredObjectId, createdAt, updatedAt</i>
|
|
500
|
+
* @param {any} [expand] No expanding supported
|
|
501
|
+
* @param {any} [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.
|
|
502
502
|
* @param {*} [options] Override http request option.
|
|
503
503
|
* @throws {RequiredError}
|
|
504
504
|
*/
|
|
505
|
-
listPolicyObjects(filter:
|
|
505
|
+
listPolicyObjects(filter: any, authorization?: string, pageSize?: any, pageToken?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<ListPolicyObjectsResponseClass>;
|
|
506
506
|
/**
|
|
507
507
|
* Returns a list of policy versions you have previously created. The policy versions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
508
508
|
* @summary List policy versions
|
|
509
509
|
* @param {string} policyCode
|
|
510
510
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
511
|
-
* @param {
|
|
512
|
-
* @param {
|
|
513
|
-
* @param {
|
|
514
|
-
* @param {
|
|
515
|
-
* @param {
|
|
516
|
-
* @param {
|
|
517
|
-
* @param {
|
|
511
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
512
|
+
* @param {any} [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.
|
|
513
|
+
* @param {any} [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, policyId</i>
|
|
514
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
515
|
+
* @param {any} [order] Order allowing you to specify the desired order of entities retrieved from the server.<br/> <br/> <i>Allowed values: id, policyId, createdAt, updatedAt</i>
|
|
516
|
+
* @param {any} [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.
|
|
517
|
+
* @param {any} [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.
|
|
518
518
|
* @param {*} [options] Override http request option.
|
|
519
519
|
* @throws {RequiredError}
|
|
520
520
|
*/
|
|
521
|
-
listPolicyVersions(policyCode: string, authorization?: string, pageSize?:
|
|
521
|
+
listPolicyVersions(policyCode: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<ListPolicyVersionResponseClass>;
|
|
522
522
|
/**
|
|
523
523
|
* Updates the specified policy by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
524
524
|
* @summary Update the policy
|
|
@@ -769,35 +769,35 @@ export interface PoliciesApiListPoliciesRequest {
|
|
|
769
769
|
*/
|
|
770
770
|
readonly authorization?: string;
|
|
771
771
|
/**
|
|
772
|
-
*
|
|
773
|
-
* @type {
|
|
772
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
773
|
+
* @type {any}
|
|
774
774
|
* @memberof PoliciesApiListPolicies
|
|
775
775
|
*/
|
|
776
|
-
readonly pageSize?:
|
|
776
|
+
readonly pageSize?: any;
|
|
777
777
|
/**
|
|
778
|
-
*
|
|
779
|
-
* @type {
|
|
778
|
+
* 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.
|
|
779
|
+
* @type {any}
|
|
780
780
|
* @memberof PoliciesApiListPolicies
|
|
781
781
|
*/
|
|
782
|
-
readonly pageToken?:
|
|
782
|
+
readonly pageToken?: any;
|
|
783
783
|
/**
|
|
784
784
|
* 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</i>
|
|
785
|
-
* @type {
|
|
785
|
+
* @type {any}
|
|
786
786
|
* @memberof PoliciesApiListPolicies
|
|
787
787
|
*/
|
|
788
|
-
readonly filter?:
|
|
788
|
+
readonly filter?: any;
|
|
789
789
|
/**
|
|
790
|
-
*
|
|
791
|
-
* @type {
|
|
790
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
791
|
+
* @type {any}
|
|
792
792
|
* @memberof PoliciesApiListPolicies
|
|
793
793
|
*/
|
|
794
|
-
readonly search?:
|
|
794
|
+
readonly search?: any;
|
|
795
795
|
/**
|
|
796
796
|
* Order allowing you to specify the desired order of entities retrieved from the server.<br/> <br/> <i>Allowed values: id, policyNumber, createdAt, updatedAt, policyStartDate, productVersionId, productId</i>
|
|
797
|
-
* @type {
|
|
797
|
+
* @type {any}
|
|
798
798
|
* @memberof PoliciesApiListPolicies
|
|
799
799
|
*/
|
|
800
|
-
readonly order?:
|
|
800
|
+
readonly order?: any;
|
|
801
801
|
/**
|
|
802
802
|
* You can expand policy versions list in this endpoint. By default, versions will be an empty array.
|
|
803
803
|
* @type {'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas'}
|
|
@@ -805,11 +805,11 @@ export interface PoliciesApiListPoliciesRequest {
|
|
|
805
805
|
*/
|
|
806
806
|
readonly expand?: 'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas';
|
|
807
807
|
/**
|
|
808
|
-
*
|
|
809
|
-
* @type {
|
|
808
|
+
* 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.
|
|
809
|
+
* @type {any}
|
|
810
810
|
* @memberof PoliciesApiListPolicies
|
|
811
811
|
*/
|
|
812
|
-
readonly filters?:
|
|
812
|
+
readonly filters?: any;
|
|
813
813
|
}
|
|
814
814
|
/**
|
|
815
815
|
* Request parameters for listPolicyObjects operation in PoliciesApi.
|
|
@@ -818,11 +818,11 @@ export interface PoliciesApiListPoliciesRequest {
|
|
|
818
818
|
*/
|
|
819
819
|
export interface PoliciesApiListPolicyObjectsRequest {
|
|
820
820
|
/**
|
|
821
|
-
* 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, insuredObjectId, policyCode, date</i> <br/> <i>policyCode</i> is required, other filters are optional.
|
|
822
|
-
* @type {
|
|
821
|
+
* 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, insuredObjectId, insuredObjectName, policyCode, date</i> <br/> <i>policyCode</i> is required, other filters are optional.
|
|
822
|
+
* @type {any}
|
|
823
823
|
* @memberof PoliciesApiListPolicyObjects
|
|
824
824
|
*/
|
|
825
|
-
readonly filter:
|
|
825
|
+
readonly filter: any;
|
|
826
826
|
/**
|
|
827
827
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
828
828
|
* @type {string}
|
|
@@ -830,41 +830,41 @@ export interface PoliciesApiListPolicyObjectsRequest {
|
|
|
830
830
|
*/
|
|
831
831
|
readonly authorization?: string;
|
|
832
832
|
/**
|
|
833
|
-
*
|
|
834
|
-
* @type {
|
|
833
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
834
|
+
* @type {any}
|
|
835
835
|
* @memberof PoliciesApiListPolicyObjects
|
|
836
836
|
*/
|
|
837
|
-
readonly pageSize?:
|
|
837
|
+
readonly pageSize?: any;
|
|
838
838
|
/**
|
|
839
|
-
*
|
|
840
|
-
* @type {
|
|
839
|
+
* 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.
|
|
840
|
+
* @type {any}
|
|
841
841
|
* @memberof PoliciesApiListPolicyObjects
|
|
842
842
|
*/
|
|
843
|
-
readonly pageToken?:
|
|
843
|
+
readonly pageToken?: any;
|
|
844
844
|
/**
|
|
845
|
-
*
|
|
846
|
-
* @type {
|
|
845
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
846
|
+
* @type {any}
|
|
847
847
|
* @memberof PoliciesApiListPolicyObjects
|
|
848
848
|
*/
|
|
849
|
-
readonly search?:
|
|
849
|
+
readonly search?: any;
|
|
850
850
|
/**
|
|
851
851
|
* Order allowing you to specify the desired order of entities retrieved from the server.<br/> <br/> <i>Allowed values: id, code, timesliceId, insuredObjectId, createdAt, updatedAt</i>
|
|
852
|
-
* @type {
|
|
852
|
+
* @type {any}
|
|
853
853
|
* @memberof PoliciesApiListPolicyObjects
|
|
854
854
|
*/
|
|
855
|
-
readonly order?:
|
|
855
|
+
readonly order?: any;
|
|
856
856
|
/**
|
|
857
857
|
* No expanding supported
|
|
858
|
-
* @type {
|
|
858
|
+
* @type {any}
|
|
859
859
|
* @memberof PoliciesApiListPolicyObjects
|
|
860
860
|
*/
|
|
861
|
-
readonly expand?:
|
|
861
|
+
readonly expand?: any;
|
|
862
862
|
/**
|
|
863
|
-
*
|
|
864
|
-
* @type {
|
|
863
|
+
* 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.
|
|
864
|
+
* @type {any}
|
|
865
865
|
* @memberof PoliciesApiListPolicyObjects
|
|
866
866
|
*/
|
|
867
|
-
readonly filters?:
|
|
867
|
+
readonly filters?: any;
|
|
868
868
|
}
|
|
869
869
|
/**
|
|
870
870
|
* Request parameters for listPolicyVersions operation in PoliciesApi.
|
|
@@ -885,47 +885,47 @@ export interface PoliciesApiListPolicyVersionsRequest {
|
|
|
885
885
|
*/
|
|
886
886
|
readonly authorization?: string;
|
|
887
887
|
/**
|
|
888
|
-
*
|
|
889
|
-
* @type {
|
|
888
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
889
|
+
* @type {any}
|
|
890
890
|
* @memberof PoliciesApiListPolicyVersions
|
|
891
891
|
*/
|
|
892
|
-
readonly pageSize?:
|
|
892
|
+
readonly pageSize?: any;
|
|
893
893
|
/**
|
|
894
|
-
*
|
|
895
|
-
* @type {
|
|
894
|
+
* 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.
|
|
895
|
+
* @type {any}
|
|
896
896
|
* @memberof PoliciesApiListPolicyVersions
|
|
897
897
|
*/
|
|
898
|
-
readonly pageToken?:
|
|
898
|
+
readonly pageToken?: any;
|
|
899
899
|
/**
|
|
900
900
|
* 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, policyId</i>
|
|
901
|
-
* @type {
|
|
901
|
+
* @type {any}
|
|
902
902
|
* @memberof PoliciesApiListPolicyVersions
|
|
903
903
|
*/
|
|
904
|
-
readonly filter?:
|
|
904
|
+
readonly filter?: any;
|
|
905
905
|
/**
|
|
906
|
-
*
|
|
907
|
-
* @type {
|
|
906
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
907
|
+
* @type {any}
|
|
908
908
|
* @memberof PoliciesApiListPolicyVersions
|
|
909
909
|
*/
|
|
910
|
-
readonly search?:
|
|
910
|
+
readonly search?: any;
|
|
911
911
|
/**
|
|
912
912
|
* Order allowing you to specify the desired order of entities retrieved from the server.<br/> <br/> <i>Allowed values: id, policyId, createdAt, updatedAt</i>
|
|
913
|
-
* @type {
|
|
913
|
+
* @type {any}
|
|
914
914
|
* @memberof PoliciesApiListPolicyVersions
|
|
915
915
|
*/
|
|
916
|
-
readonly order?:
|
|
916
|
+
readonly order?: any;
|
|
917
917
|
/**
|
|
918
|
-
*
|
|
919
|
-
* @type {
|
|
918
|
+
* 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.
|
|
919
|
+
* @type {any}
|
|
920
920
|
* @memberof PoliciesApiListPolicyVersions
|
|
921
921
|
*/
|
|
922
|
-
readonly expand?:
|
|
922
|
+
readonly expand?: any;
|
|
923
923
|
/**
|
|
924
|
-
*
|
|
925
|
-
* @type {
|
|
924
|
+
* 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.
|
|
925
|
+
* @type {any}
|
|
926
926
|
* @memberof PoliciesApiListPolicyVersions
|
|
927
927
|
*/
|
|
928
|
-
readonly filters?:
|
|
928
|
+
readonly filters?: any;
|
|
929
929
|
}
|
|
930
930
|
/**
|
|
931
931
|
* Request parameters for patchPolicy operation in PoliciesApi.
|