@emilgroup/partner-portal-sdk-node 1.0.1-beta.0 → 1.0.1-beta.2
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/intermediary-api.ts +112 -112
- package/base.ts +1 -1
- package/common.ts +2 -2
- package/configuration.ts +9 -0
- package/dist/api/intermediary-api.d.ts +112 -112
- package/dist/api/intermediary-api.js +71 -71
- package/dist/base.js +1 -1
- package/dist/common.js +2 -2
- package/dist/configuration.d.ts +6 -0
- package/dist/configuration.js +8 -0
- package/git_push.sh +1 -1
- package/package.json +1 -1
package/api/intermediary-api.ts
CHANGED
|
@@ -47,7 +47,7 @@ const FormData = require('form-data');
|
|
|
47
47
|
export const IntermediaryApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
48
48
|
return {
|
|
49
49
|
/**
|
|
50
|
-
* Retrieves the details of
|
|
50
|
+
* Retrieves the details of a lead associated with the logged-in partner. Supply the unique lead code, and Emil API will return the corresponding lead information.
|
|
51
51
|
* @summary Retrieve the lead
|
|
52
52
|
* @param {string} code Unique identifier for the object.
|
|
53
53
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -92,9 +92,9 @@ export const IntermediaryApiAxiosParamCreator = function (configuration?: Config
|
|
|
92
92
|
};
|
|
93
93
|
},
|
|
94
94
|
/**
|
|
95
|
-
* Retrieves the details of the partner
|
|
95
|
+
* Retrieves the details of a related partner or the logged-in partner if their code or \'me\' is provided. Supply the unique partner code, and Emil API will return the corresponding partner information.
|
|
96
96
|
* @summary Retrieve the partner
|
|
97
|
-
* @param {string} code
|
|
97
|
+
* @param {string} code The partner code or \"me\" for the currently logged in partner.
|
|
98
98
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
99
99
|
* @param {*} [options] Override http request option.
|
|
100
100
|
* @throws {RequiredError}
|
|
@@ -137,7 +137,7 @@ export const IntermediaryApiAxiosParamCreator = function (configuration?: Config
|
|
|
137
137
|
};
|
|
138
138
|
},
|
|
139
139
|
/**
|
|
140
|
-
* Retrieves the details of
|
|
140
|
+
* Retrieves the details of a policy associated with the logged-in partner. Supply the unique policy code, and Emil API will return the corresponding policy information.
|
|
141
141
|
* @summary Retrieve the policy
|
|
142
142
|
* @param {string} code Unique identifier for the object.
|
|
143
143
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -182,7 +182,7 @@ export const IntermediaryApiAxiosParamCreator = function (configuration?: Config
|
|
|
182
182
|
};
|
|
183
183
|
},
|
|
184
184
|
/**
|
|
185
|
-
* Retrieves the details of
|
|
185
|
+
* Retrieves the details of a policyholder linked to the leads and policies the logged-in partner is associated with. Supply the unique policyholder code, and Emil API will return the corresponding policyholder information.
|
|
186
186
|
* @summary Retrieve the policyholder
|
|
187
187
|
* @param {string} code Unique identifier for the object.
|
|
188
188
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -227,20 +227,20 @@ export const IntermediaryApiAxiosParamCreator = function (configuration?: Config
|
|
|
227
227
|
};
|
|
228
228
|
},
|
|
229
229
|
/**
|
|
230
|
-
* Returns a list of leads
|
|
230
|
+
* Returns a list of leads associated with the logged-in partner. The leads are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
231
231
|
* @summary List leads
|
|
232
232
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
233
|
-
* @param {
|
|
234
|
-
* @param {
|
|
233
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
234
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
235
235
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, status, leadNumber, accountCode, productSlug, ern, createdAt, updatedAt, partnerCode</i>
|
|
236
|
-
* @param {
|
|
236
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
237
237
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, code, status, leadNumber, updatedAt</i>
|
|
238
238
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partnerLinks<i>
|
|
239
239
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, status, leadNumber, accountCode, productSlug, ern, createdAt, updatedAt, partnerCode</i>
|
|
240
240
|
* @param {*} [options] Override http request option.
|
|
241
241
|
* @throws {RequiredError}
|
|
242
242
|
*/
|
|
243
|
-
listLeads: async (authorization?: string, pageSize?:
|
|
243
|
+
listLeads: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
244
244
|
const localVarPath = `/partner-portal/v1/intermediary/leads`;
|
|
245
245
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
246
246
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -303,20 +303,20 @@ export const IntermediaryApiAxiosParamCreator = function (configuration?: Config
|
|
|
303
303
|
};
|
|
304
304
|
},
|
|
305
305
|
/**
|
|
306
|
-
* Returns a list of partners
|
|
306
|
+
* Returns a list of partners related to the logged-in partner. The partners are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
307
307
|
* @summary List partners
|
|
308
308
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
309
|
-
* @param {
|
|
310
|
-
* @param {
|
|
309
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
310
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
311
311
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber</i>
|
|
312
|
-
* @param {
|
|
312
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
313
313
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, version, tagSlugs</i>
|
|
314
314
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partner<i>
|
|
315
315
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber</i>
|
|
316
316
|
* @param {*} [options] Override http request option.
|
|
317
317
|
* @throws {RequiredError}
|
|
318
318
|
*/
|
|
319
|
-
listPartners: async (authorization?: string, pageSize?:
|
|
319
|
+
listPartners: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
320
320
|
const localVarPath = `/partner-portal/v1/intermediary/partners`;
|
|
321
321
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
322
322
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -379,20 +379,20 @@ export const IntermediaryApiAxiosParamCreator = function (configuration?: Config
|
|
|
379
379
|
};
|
|
380
380
|
},
|
|
381
381
|
/**
|
|
382
|
-
* Returns a list of policies
|
|
382
|
+
* Returns a list of policies associated with the logged-in partner. The policies are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
383
383
|
* @summary List policies
|
|
384
384
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
385
|
-
* @param {
|
|
386
|
-
* @param {
|
|
385
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
386
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
387
387
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode</i>
|
|
388
|
-
* @param {
|
|
388
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
389
389
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, policyNumber, createdAt, updatedAt, policyStartDate, productVersionId, productId</i>
|
|
390
390
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: currentVersion, partnerLinks<i>
|
|
391
391
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode</i>
|
|
392
392
|
* @param {*} [options] Override http request option.
|
|
393
393
|
* @throws {RequiredError}
|
|
394
394
|
*/
|
|
395
|
-
listPolicies: async (authorization?: string, pageSize?:
|
|
395
|
+
listPolicies: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
396
396
|
const localVarPath = `/partner-portal/v1/intermediary/policies`;
|
|
397
397
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
398
398
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -455,20 +455,20 @@ export const IntermediaryApiAxiosParamCreator = function (configuration?: Config
|
|
|
455
455
|
};
|
|
456
456
|
},
|
|
457
457
|
/**
|
|
458
|
-
* Returns a list of policyholders
|
|
458
|
+
* Returns a list of policyholders linked to the leads and policies the logged-in partner is associated with. The policyholders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
459
459
|
* @summary List policyholders
|
|
460
460
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
461
|
-
* @param {
|
|
462
|
-
* @param {
|
|
461
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
462
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
463
463
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: firstName, code, email, createdAt, birthDate, accountNumber, title, lastName, gender, street, zipCode, city, houseNumber, phone, type, companyName</i>
|
|
464
|
-
* @param {
|
|
464
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
465
465
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, firstName, lastName, email, createdAt, accountNumber</i>
|
|
466
466
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: <i>
|
|
467
467
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: firstName, code, email, createdAt, birthDate, accountNumber, title, lastName, gender, street, zipCode, city, houseNumber, phone, type, companyName</i>
|
|
468
468
|
* @param {*} [options] Override http request option.
|
|
469
469
|
* @throws {RequiredError}
|
|
470
470
|
*/
|
|
471
|
-
listPolicyholders: async (authorization?: string, pageSize?:
|
|
471
|
+
listPolicyholders: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
472
472
|
const localVarPath = `/partner-portal/v1/intermediary/policyholders`;
|
|
473
473
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
474
474
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -541,7 +541,7 @@ export const IntermediaryApiFp = function(configuration?: Configuration) {
|
|
|
541
541
|
const localVarAxiosParamCreator = IntermediaryApiAxiosParamCreator(configuration)
|
|
542
542
|
return {
|
|
543
543
|
/**
|
|
544
|
-
* Retrieves the details of
|
|
544
|
+
* Retrieves the details of a lead associated with the logged-in partner. Supply the unique lead code, and Emil API will return the corresponding lead information.
|
|
545
545
|
* @summary Retrieve the lead
|
|
546
546
|
* @param {string} code Unique identifier for the object.
|
|
547
547
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -553,9 +553,9 @@ export const IntermediaryApiFp = function(configuration?: Configuration) {
|
|
|
553
553
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
554
554
|
},
|
|
555
555
|
/**
|
|
556
|
-
* Retrieves the details of the partner
|
|
556
|
+
* Retrieves the details of a related partner or the logged-in partner if their code or \'me\' is provided. Supply the unique partner code, and Emil API will return the corresponding partner information.
|
|
557
557
|
* @summary Retrieve the partner
|
|
558
|
-
* @param {string} code
|
|
558
|
+
* @param {string} code The partner code or \"me\" for the currently logged in partner.
|
|
559
559
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
560
560
|
* @param {*} [options] Override http request option.
|
|
561
561
|
* @throws {RequiredError}
|
|
@@ -565,7 +565,7 @@ export const IntermediaryApiFp = function(configuration?: Configuration) {
|
|
|
565
565
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
566
566
|
},
|
|
567
567
|
/**
|
|
568
|
-
* Retrieves the details of
|
|
568
|
+
* Retrieves the details of a policy associated with the logged-in partner. Supply the unique policy code, and Emil API will return the corresponding policy information.
|
|
569
569
|
* @summary Retrieve the policy
|
|
570
570
|
* @param {string} code Unique identifier for the object.
|
|
571
571
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -577,7 +577,7 @@ export const IntermediaryApiFp = function(configuration?: Configuration) {
|
|
|
577
577
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
578
578
|
},
|
|
579
579
|
/**
|
|
580
|
-
* Retrieves the details of
|
|
580
|
+
* Retrieves the details of a policyholder linked to the leads and policies the logged-in partner is associated with. Supply the unique policyholder code, and Emil API will return the corresponding policyholder information.
|
|
581
581
|
* @summary Retrieve the policyholder
|
|
582
582
|
* @param {string} code Unique identifier for the object.
|
|
583
583
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -589,74 +589,74 @@ export const IntermediaryApiFp = function(configuration?: Configuration) {
|
|
|
589
589
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
590
590
|
},
|
|
591
591
|
/**
|
|
592
|
-
* Returns a list of leads
|
|
592
|
+
* Returns a list of leads associated with the logged-in partner. The leads are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
593
593
|
* @summary List leads
|
|
594
594
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
595
|
-
* @param {
|
|
596
|
-
* @param {
|
|
595
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
596
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
597
597
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, status, leadNumber, accountCode, productSlug, ern, createdAt, updatedAt, partnerCode</i>
|
|
598
|
-
* @param {
|
|
598
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
599
599
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, code, status, leadNumber, updatedAt</i>
|
|
600
600
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partnerLinks<i>
|
|
601
601
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, status, leadNumber, accountCode, productSlug, ern, createdAt, updatedAt, partnerCode</i>
|
|
602
602
|
* @param {*} [options] Override http request option.
|
|
603
603
|
* @throws {RequiredError}
|
|
604
604
|
*/
|
|
605
|
-
async listLeads(authorization?: string, pageSize?:
|
|
605
|
+
async listLeads(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListLeadsResponseClass>> {
|
|
606
606
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listLeads(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
607
607
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
608
608
|
},
|
|
609
609
|
/**
|
|
610
|
-
* Returns a list of partners
|
|
610
|
+
* Returns a list of partners related to the logged-in partner. The partners are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
611
611
|
* @summary List partners
|
|
612
612
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
613
|
-
* @param {
|
|
614
|
-
* @param {
|
|
613
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
614
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
615
615
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber</i>
|
|
616
|
-
* @param {
|
|
616
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
617
617
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, version, tagSlugs</i>
|
|
618
618
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partner<i>
|
|
619
619
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber</i>
|
|
620
620
|
* @param {*} [options] Override http request option.
|
|
621
621
|
* @throws {RequiredError}
|
|
622
622
|
*/
|
|
623
|
-
async listPartners(authorization?: string, pageSize?:
|
|
623
|
+
async listPartners(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPartnersResponseClass>> {
|
|
624
624
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listPartners(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
625
625
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
626
626
|
},
|
|
627
627
|
/**
|
|
628
|
-
* Returns a list of policies
|
|
628
|
+
* Returns a list of policies associated with the logged-in partner. The policies are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
629
629
|
* @summary List policies
|
|
630
630
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
631
|
-
* @param {
|
|
632
|
-
* @param {
|
|
631
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
632
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
633
633
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode</i>
|
|
634
|
-
* @param {
|
|
634
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
635
635
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, policyNumber, createdAt, updatedAt, policyStartDate, productVersionId, productId</i>
|
|
636
636
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: currentVersion, partnerLinks<i>
|
|
637
637
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode</i>
|
|
638
638
|
* @param {*} [options] Override http request option.
|
|
639
639
|
* @throws {RequiredError}
|
|
640
640
|
*/
|
|
641
|
-
async listPolicies(authorization?: string, pageSize?:
|
|
641
|
+
async listPolicies(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPoliciesResponseClass>> {
|
|
642
642
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listPolicies(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
643
643
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
644
644
|
},
|
|
645
645
|
/**
|
|
646
|
-
* Returns a list of policyholders
|
|
646
|
+
* Returns a list of policyholders linked to the leads and policies the logged-in partner is associated with. The policyholders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
647
647
|
* @summary List policyholders
|
|
648
648
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
649
|
-
* @param {
|
|
650
|
-
* @param {
|
|
649
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
650
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
651
651
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: firstName, code, email, createdAt, birthDate, accountNumber, title, lastName, gender, street, zipCode, city, houseNumber, phone, type, companyName</i>
|
|
652
|
-
* @param {
|
|
652
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
653
653
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, firstName, lastName, email, createdAt, accountNumber</i>
|
|
654
654
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: <i>
|
|
655
655
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: firstName, code, email, createdAt, birthDate, accountNumber, title, lastName, gender, street, zipCode, city, houseNumber, phone, type, companyName</i>
|
|
656
656
|
* @param {*} [options] Override http request option.
|
|
657
657
|
* @throws {RequiredError}
|
|
658
658
|
*/
|
|
659
|
-
async listPolicyholders(authorization?: string, pageSize?:
|
|
659
|
+
async listPolicyholders(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListAccountsResponseClass>> {
|
|
660
660
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listPolicyholders(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
661
661
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
662
662
|
},
|
|
@@ -671,7 +671,7 @@ export const IntermediaryApiFactory = function (configuration?: Configuration, b
|
|
|
671
671
|
const localVarFp = IntermediaryApiFp(configuration)
|
|
672
672
|
return {
|
|
673
673
|
/**
|
|
674
|
-
* Retrieves the details of
|
|
674
|
+
* Retrieves the details of a lead associated with the logged-in partner. Supply the unique lead code, and Emil API will return the corresponding lead information.
|
|
675
675
|
* @summary Retrieve the lead
|
|
676
676
|
* @param {string} code Unique identifier for the object.
|
|
677
677
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -682,9 +682,9 @@ export const IntermediaryApiFactory = function (configuration?: Configuration, b
|
|
|
682
682
|
return localVarFp.getLead(code, authorization, options).then((request) => request(axios, basePath));
|
|
683
683
|
},
|
|
684
684
|
/**
|
|
685
|
-
* Retrieves the details of the partner
|
|
685
|
+
* Retrieves the details of a related partner or the logged-in partner if their code or \'me\' is provided. Supply the unique partner code, and Emil API will return the corresponding partner information.
|
|
686
686
|
* @summary Retrieve the partner
|
|
687
|
-
* @param {string} code
|
|
687
|
+
* @param {string} code The partner code or \"me\" for the currently logged in partner.
|
|
688
688
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
689
689
|
* @param {*} [options] Override http request option.
|
|
690
690
|
* @throws {RequiredError}
|
|
@@ -693,7 +693,7 @@ export const IntermediaryApiFactory = function (configuration?: Configuration, b
|
|
|
693
693
|
return localVarFp.getPartner(code, authorization, options).then((request) => request(axios, basePath));
|
|
694
694
|
},
|
|
695
695
|
/**
|
|
696
|
-
* Retrieves the details of
|
|
696
|
+
* Retrieves the details of a policy associated with the logged-in partner. Supply the unique policy code, and Emil API will return the corresponding policy information.
|
|
697
697
|
* @summary Retrieve the policy
|
|
698
698
|
* @param {string} code Unique identifier for the object.
|
|
699
699
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -704,7 +704,7 @@ export const IntermediaryApiFactory = function (configuration?: Configuration, b
|
|
|
704
704
|
return localVarFp.getPolicy(code, authorization, options).then((request) => request(axios, basePath));
|
|
705
705
|
},
|
|
706
706
|
/**
|
|
707
|
-
* Retrieves the details of
|
|
707
|
+
* Retrieves the details of a policyholder linked to the leads and policies the logged-in partner is associated with. Supply the unique policyholder code, and Emil API will return the corresponding policyholder information.
|
|
708
708
|
* @summary Retrieve the policyholder
|
|
709
709
|
* @param {string} code Unique identifier for the object.
|
|
710
710
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -715,71 +715,71 @@ export const IntermediaryApiFactory = function (configuration?: Configuration, b
|
|
|
715
715
|
return localVarFp.getPolicyholder(code, authorization, options).then((request) => request(axios, basePath));
|
|
716
716
|
},
|
|
717
717
|
/**
|
|
718
|
-
* Returns a list of leads
|
|
718
|
+
* Returns a list of leads associated with the logged-in partner. The leads are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
719
719
|
* @summary List leads
|
|
720
720
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
721
|
-
* @param {
|
|
722
|
-
* @param {
|
|
721
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
722
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
723
723
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, status, leadNumber, accountCode, productSlug, ern, createdAt, updatedAt, partnerCode</i>
|
|
724
|
-
* @param {
|
|
724
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
725
725
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, code, status, leadNumber, updatedAt</i>
|
|
726
726
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partnerLinks<i>
|
|
727
727
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, status, leadNumber, accountCode, productSlug, ern, createdAt, updatedAt, partnerCode</i>
|
|
728
728
|
* @param {*} [options] Override http request option.
|
|
729
729
|
* @throws {RequiredError}
|
|
730
730
|
*/
|
|
731
|
-
listLeads(authorization?: string, pageSize?:
|
|
731
|
+
listLeads(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListLeadsResponseClass> {
|
|
732
732
|
return localVarFp.listLeads(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
733
733
|
},
|
|
734
734
|
/**
|
|
735
|
-
* Returns a list of partners
|
|
735
|
+
* Returns a list of partners related to the logged-in partner. The partners are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
736
736
|
* @summary List partners
|
|
737
737
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
738
|
-
* @param {
|
|
739
|
-
* @param {
|
|
738
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
739
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
740
740
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber</i>
|
|
741
|
-
* @param {
|
|
741
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
742
742
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, version, tagSlugs</i>
|
|
743
743
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partner<i>
|
|
744
744
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber</i>
|
|
745
745
|
* @param {*} [options] Override http request option.
|
|
746
746
|
* @throws {RequiredError}
|
|
747
747
|
*/
|
|
748
|
-
listPartners(authorization?: string, pageSize?:
|
|
748
|
+
listPartners(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnersResponseClass> {
|
|
749
749
|
return localVarFp.listPartners(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
750
750
|
},
|
|
751
751
|
/**
|
|
752
|
-
* Returns a list of policies
|
|
752
|
+
* Returns a list of policies associated with the logged-in partner. The policies are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
753
753
|
* @summary List policies
|
|
754
754
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
755
|
-
* @param {
|
|
756
|
-
* @param {
|
|
755
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
756
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
757
757
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode</i>
|
|
758
|
-
* @param {
|
|
758
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
759
759
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, policyNumber, createdAt, updatedAt, policyStartDate, productVersionId, productId</i>
|
|
760
760
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: currentVersion, partnerLinks<i>
|
|
761
761
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode</i>
|
|
762
762
|
* @param {*} [options] Override http request option.
|
|
763
763
|
* @throws {RequiredError}
|
|
764
764
|
*/
|
|
765
|
-
listPolicies(authorization?: string, pageSize?:
|
|
765
|
+
listPolicies(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPoliciesResponseClass> {
|
|
766
766
|
return localVarFp.listPolicies(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
767
767
|
},
|
|
768
768
|
/**
|
|
769
|
-
* Returns a list of policyholders
|
|
769
|
+
* Returns a list of policyholders linked to the leads and policies the logged-in partner is associated with. The policyholders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
770
770
|
* @summary List policyholders
|
|
771
771
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
772
|
-
* @param {
|
|
773
|
-
* @param {
|
|
772
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
773
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
774
774
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: firstName, code, email, createdAt, birthDate, accountNumber, title, lastName, gender, street, zipCode, city, houseNumber, phone, type, companyName</i>
|
|
775
|
-
* @param {
|
|
775
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
776
776
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, firstName, lastName, email, createdAt, accountNumber</i>
|
|
777
777
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: <i>
|
|
778
778
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: firstName, code, email, createdAt, birthDate, accountNumber, title, lastName, gender, street, zipCode, city, houseNumber, phone, type, companyName</i>
|
|
779
779
|
* @param {*} [options] Override http request option.
|
|
780
780
|
* @throws {RequiredError}
|
|
781
781
|
*/
|
|
782
|
-
listPolicyholders(authorization?: string, pageSize?:
|
|
782
|
+
listPolicyholders(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListAccountsResponseClass> {
|
|
783
783
|
return localVarFp.listPolicyholders(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
784
784
|
},
|
|
785
785
|
};
|
|
@@ -813,7 +813,7 @@ export interface IntermediaryApiGetLeadRequest {
|
|
|
813
813
|
*/
|
|
814
814
|
export interface IntermediaryApiGetPartnerRequest {
|
|
815
815
|
/**
|
|
816
|
-
*
|
|
816
|
+
* The partner code or \"me\" for the currently logged in partner.
|
|
817
817
|
* @type {string}
|
|
818
818
|
* @memberof IntermediaryApiGetPartner
|
|
819
819
|
*/
|
|
@@ -884,17 +884,17 @@ export interface IntermediaryApiListLeadsRequest {
|
|
|
884
884
|
|
|
885
885
|
/**
|
|
886
886
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
887
|
-
* @type {
|
|
887
|
+
* @type {number}
|
|
888
888
|
* @memberof IntermediaryApiListLeads
|
|
889
889
|
*/
|
|
890
|
-
readonly pageSize?:
|
|
890
|
+
readonly pageSize?: number
|
|
891
891
|
|
|
892
892
|
/**
|
|
893
|
-
* 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,
|
|
894
|
-
* @type {
|
|
893
|
+
* 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.
|
|
894
|
+
* @type {string}
|
|
895
895
|
* @memberof IntermediaryApiListLeads
|
|
896
896
|
*/
|
|
897
|
-
readonly pageToken?:
|
|
897
|
+
readonly pageToken?: string
|
|
898
898
|
|
|
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, code, status, leadNumber, accountCode, productSlug, ern, createdAt, updatedAt, partnerCode</i>
|
|
@@ -905,10 +905,10 @@ export interface IntermediaryApiListLeadsRequest {
|
|
|
905
905
|
|
|
906
906
|
/**
|
|
907
907
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
908
|
-
* @type {
|
|
908
|
+
* @type {string}
|
|
909
909
|
* @memberof IntermediaryApiListLeads
|
|
910
910
|
*/
|
|
911
|
-
readonly search?:
|
|
911
|
+
readonly search?: string
|
|
912
912
|
|
|
913
913
|
/**
|
|
914
914
|
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, code, status, leadNumber, updatedAt</i>
|
|
@@ -947,17 +947,17 @@ export interface IntermediaryApiListPartnersRequest {
|
|
|
947
947
|
|
|
948
948
|
/**
|
|
949
949
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
950
|
-
* @type {
|
|
950
|
+
* @type {number}
|
|
951
951
|
* @memberof IntermediaryApiListPartners
|
|
952
952
|
*/
|
|
953
|
-
readonly pageSize?:
|
|
953
|
+
readonly pageSize?: number
|
|
954
954
|
|
|
955
955
|
/**
|
|
956
|
-
* 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,
|
|
957
|
-
* @type {
|
|
956
|
+
* 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.
|
|
957
|
+
* @type {string}
|
|
958
958
|
* @memberof IntermediaryApiListPartners
|
|
959
959
|
*/
|
|
960
|
-
readonly pageToken?:
|
|
960
|
+
readonly pageToken?: string
|
|
961
961
|
|
|
962
962
|
/**
|
|
963
963
|
* 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, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber</i>
|
|
@@ -968,10 +968,10 @@ export interface IntermediaryApiListPartnersRequest {
|
|
|
968
968
|
|
|
969
969
|
/**
|
|
970
970
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
971
|
-
* @type {
|
|
971
|
+
* @type {string}
|
|
972
972
|
* @memberof IntermediaryApiListPartners
|
|
973
973
|
*/
|
|
974
|
-
readonly search?:
|
|
974
|
+
readonly search?: string
|
|
975
975
|
|
|
976
976
|
/**
|
|
977
977
|
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, version, tagSlugs</i>
|
|
@@ -1010,17 +1010,17 @@ export interface IntermediaryApiListPoliciesRequest {
|
|
|
1010
1010
|
|
|
1011
1011
|
/**
|
|
1012
1012
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
1013
|
-
* @type {
|
|
1013
|
+
* @type {number}
|
|
1014
1014
|
* @memberof IntermediaryApiListPolicies
|
|
1015
1015
|
*/
|
|
1016
|
-
readonly pageSize?:
|
|
1016
|
+
readonly pageSize?: number
|
|
1017
1017
|
|
|
1018
1018
|
/**
|
|
1019
|
-
* 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,
|
|
1020
|
-
* @type {
|
|
1019
|
+
* 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.
|
|
1020
|
+
* @type {string}
|
|
1021
1021
|
* @memberof IntermediaryApiListPolicies
|
|
1022
1022
|
*/
|
|
1023
|
-
readonly pageToken?:
|
|
1023
|
+
readonly pageToken?: string
|
|
1024
1024
|
|
|
1025
1025
|
/**
|
|
1026
1026
|
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode</i>
|
|
@@ -1031,10 +1031,10 @@ export interface IntermediaryApiListPoliciesRequest {
|
|
|
1031
1031
|
|
|
1032
1032
|
/**
|
|
1033
1033
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
1034
|
-
* @type {
|
|
1034
|
+
* @type {string}
|
|
1035
1035
|
* @memberof IntermediaryApiListPolicies
|
|
1036
1036
|
*/
|
|
1037
|
-
readonly search?:
|
|
1037
|
+
readonly search?: string
|
|
1038
1038
|
|
|
1039
1039
|
/**
|
|
1040
1040
|
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, policyNumber, createdAt, updatedAt, policyStartDate, productVersionId, productId</i>
|
|
@@ -1073,17 +1073,17 @@ export interface IntermediaryApiListPolicyholdersRequest {
|
|
|
1073
1073
|
|
|
1074
1074
|
/**
|
|
1075
1075
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
1076
|
-
* @type {
|
|
1076
|
+
* @type {number}
|
|
1077
1077
|
* @memberof IntermediaryApiListPolicyholders
|
|
1078
1078
|
*/
|
|
1079
|
-
readonly pageSize?:
|
|
1079
|
+
readonly pageSize?: number
|
|
1080
1080
|
|
|
1081
1081
|
/**
|
|
1082
|
-
* 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,
|
|
1083
|
-
* @type {
|
|
1082
|
+
* 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.
|
|
1083
|
+
* @type {string}
|
|
1084
1084
|
* @memberof IntermediaryApiListPolicyholders
|
|
1085
1085
|
*/
|
|
1086
|
-
readonly pageToken?:
|
|
1086
|
+
readonly pageToken?: string
|
|
1087
1087
|
|
|
1088
1088
|
/**
|
|
1089
1089
|
* 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: firstName, code, email, createdAt, birthDate, accountNumber, title, lastName, gender, street, zipCode, city, houseNumber, phone, type, companyName</i>
|
|
@@ -1094,10 +1094,10 @@ export interface IntermediaryApiListPolicyholdersRequest {
|
|
|
1094
1094
|
|
|
1095
1095
|
/**
|
|
1096
1096
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
1097
|
-
* @type {
|
|
1097
|
+
* @type {string}
|
|
1098
1098
|
* @memberof IntermediaryApiListPolicyholders
|
|
1099
1099
|
*/
|
|
1100
|
-
readonly search?:
|
|
1100
|
+
readonly search?: string
|
|
1101
1101
|
|
|
1102
1102
|
/**
|
|
1103
1103
|
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, firstName, lastName, email, createdAt, accountNumber</i>
|
|
@@ -1129,7 +1129,7 @@ export interface IntermediaryApiListPolicyholdersRequest {
|
|
|
1129
1129
|
*/
|
|
1130
1130
|
export class IntermediaryApi extends BaseAPI {
|
|
1131
1131
|
/**
|
|
1132
|
-
* Retrieves the details of
|
|
1132
|
+
* Retrieves the details of a lead associated with the logged-in partner. Supply the unique lead code, and Emil API will return the corresponding lead information.
|
|
1133
1133
|
* @summary Retrieve the lead
|
|
1134
1134
|
* @param {IntermediaryApiGetLeadRequest} requestParameters Request parameters.
|
|
1135
1135
|
* @param {*} [options] Override http request option.
|
|
@@ -1141,7 +1141,7 @@ export class IntermediaryApi extends BaseAPI {
|
|
|
1141
1141
|
}
|
|
1142
1142
|
|
|
1143
1143
|
/**
|
|
1144
|
-
* Retrieves the details of the partner
|
|
1144
|
+
* Retrieves the details of a related partner or the logged-in partner if their code or \'me\' is provided. Supply the unique partner code, and Emil API will return the corresponding partner information.
|
|
1145
1145
|
* @summary Retrieve the partner
|
|
1146
1146
|
* @param {IntermediaryApiGetPartnerRequest} requestParameters Request parameters.
|
|
1147
1147
|
* @param {*} [options] Override http request option.
|
|
@@ -1153,7 +1153,7 @@ export class IntermediaryApi extends BaseAPI {
|
|
|
1153
1153
|
}
|
|
1154
1154
|
|
|
1155
1155
|
/**
|
|
1156
|
-
* Retrieves the details of
|
|
1156
|
+
* Retrieves the details of a policy associated with the logged-in partner. Supply the unique policy code, and Emil API will return the corresponding policy information.
|
|
1157
1157
|
* @summary Retrieve the policy
|
|
1158
1158
|
* @param {IntermediaryApiGetPolicyRequest} requestParameters Request parameters.
|
|
1159
1159
|
* @param {*} [options] Override http request option.
|
|
@@ -1165,7 +1165,7 @@ export class IntermediaryApi extends BaseAPI {
|
|
|
1165
1165
|
}
|
|
1166
1166
|
|
|
1167
1167
|
/**
|
|
1168
|
-
* Retrieves the details of
|
|
1168
|
+
* Retrieves the details of a policyholder linked to the leads and policies the logged-in partner is associated with. Supply the unique policyholder code, and Emil API will return the corresponding policyholder information.
|
|
1169
1169
|
* @summary Retrieve the policyholder
|
|
1170
1170
|
* @param {IntermediaryApiGetPolicyholderRequest} requestParameters Request parameters.
|
|
1171
1171
|
* @param {*} [options] Override http request option.
|
|
@@ -1177,7 +1177,7 @@ export class IntermediaryApi extends BaseAPI {
|
|
|
1177
1177
|
}
|
|
1178
1178
|
|
|
1179
1179
|
/**
|
|
1180
|
-
* Returns a list of leads
|
|
1180
|
+
* Returns a list of leads associated with the logged-in partner. The leads are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
1181
1181
|
* @summary List leads
|
|
1182
1182
|
* @param {IntermediaryApiListLeadsRequest} requestParameters Request parameters.
|
|
1183
1183
|
* @param {*} [options] Override http request option.
|
|
@@ -1189,7 +1189,7 @@ export class IntermediaryApi extends BaseAPI {
|
|
|
1189
1189
|
}
|
|
1190
1190
|
|
|
1191
1191
|
/**
|
|
1192
|
-
* Returns a list of partners
|
|
1192
|
+
* Returns a list of partners related to the logged-in partner. The partners are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
1193
1193
|
* @summary List partners
|
|
1194
1194
|
* @param {IntermediaryApiListPartnersRequest} requestParameters Request parameters.
|
|
1195
1195
|
* @param {*} [options] Override http request option.
|
|
@@ -1201,7 +1201,7 @@ export class IntermediaryApi extends BaseAPI {
|
|
|
1201
1201
|
}
|
|
1202
1202
|
|
|
1203
1203
|
/**
|
|
1204
|
-
* Returns a list of policies
|
|
1204
|
+
* Returns a list of policies associated with the logged-in partner. The policies are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
1205
1205
|
* @summary List policies
|
|
1206
1206
|
* @param {IntermediaryApiListPoliciesRequest} requestParameters Request parameters.
|
|
1207
1207
|
* @param {*} [options] Override http request option.
|
|
@@ -1213,7 +1213,7 @@ export class IntermediaryApi extends BaseAPI {
|
|
|
1213
1213
|
}
|
|
1214
1214
|
|
|
1215
1215
|
/**
|
|
1216
|
-
* Returns a list of policyholders
|
|
1216
|
+
* Returns a list of policyholders linked to the leads and policies the logged-in partner is associated with. The policyholders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
1217
1217
|
* @summary List policyholders
|
|
1218
1218
|
* @param {IntermediaryApiListPolicyholdersRequest} requestParameters Request parameters.
|
|
1219
1219
|
* @param {*} [options] Override http request option.
|