@emilgroup/partner-portal-sdk 1.0.1-beta.0 → 1.1.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 +0 -3
- package/README.md +2 -2
- package/api/intermediary-api.ts +112 -112
- package/api.ts +0 -2
- 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/api.d.ts +0 -1
- package/dist/api.js +0 -1
- package/dist/common.js +2 -2
- package/dist/configuration.d.ts +6 -0
- package/dist/configuration.js +8 -0
- package/dist/models/index.d.ts +0 -2
- package/dist/models/index.js +0 -2
- package/models/index.ts +0 -2
- package/package.json +1 -1
- package/api/health-check-api.ts +0 -124
- package/dist/api/health-check-api.d.ts +0 -70
- package/dist/api/health-check-api.js +0 -200
- package/dist/models/inline-response200.d.ts +0 -54
- package/dist/models/inline-response200.js +0 -15
- package/dist/models/inline-response503.d.ts +0 -54
- package/dist/models/inline-response503.js +0 -15
- package/models/inline-response200.ts +0 -48
- package/models/inline-response503.ts +0 -48
package/api/intermediary-api.ts
CHANGED
|
@@ -43,7 +43,7 @@ import { PolicyClass } from '../models';
|
|
|
43
43
|
export const IntermediaryApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
44
44
|
return {
|
|
45
45
|
/**
|
|
46
|
-
* Retrieves the details of
|
|
46
|
+
* 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.
|
|
47
47
|
* @summary Retrieve the lead
|
|
48
48
|
* @param {string} code Unique identifier for the object.
|
|
49
49
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -88,9 +88,9 @@ export const IntermediaryApiAxiosParamCreator = function (configuration?: Config
|
|
|
88
88
|
};
|
|
89
89
|
},
|
|
90
90
|
/**
|
|
91
|
-
* Retrieves the details of the partner
|
|
91
|
+
* 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.
|
|
92
92
|
* @summary Retrieve the partner
|
|
93
|
-
* @param {string} code
|
|
93
|
+
* @param {string} code The partner code or \"me\" for the currently logged in partner.
|
|
94
94
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
95
95
|
* @param {*} [options] Override http request option.
|
|
96
96
|
* @throws {RequiredError}
|
|
@@ -133,7 +133,7 @@ export const IntermediaryApiAxiosParamCreator = function (configuration?: Config
|
|
|
133
133
|
};
|
|
134
134
|
},
|
|
135
135
|
/**
|
|
136
|
-
* Retrieves the details of
|
|
136
|
+
* 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.
|
|
137
137
|
* @summary Retrieve the policy
|
|
138
138
|
* @param {string} code Unique identifier for the object.
|
|
139
139
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -178,7 +178,7 @@ export const IntermediaryApiAxiosParamCreator = function (configuration?: Config
|
|
|
178
178
|
};
|
|
179
179
|
},
|
|
180
180
|
/**
|
|
181
|
-
* Retrieves the details of
|
|
181
|
+
* 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.
|
|
182
182
|
* @summary Retrieve the policyholder
|
|
183
183
|
* @param {string} code Unique identifier for the object.
|
|
184
184
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -223,20 +223,20 @@ export const IntermediaryApiAxiosParamCreator = function (configuration?: Config
|
|
|
223
223
|
};
|
|
224
224
|
},
|
|
225
225
|
/**
|
|
226
|
-
* Returns a list of leads
|
|
226
|
+
* 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.
|
|
227
227
|
* @summary List leads
|
|
228
228
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
229
|
-
* @param {
|
|
230
|
-
* @param {
|
|
229
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
230
|
+
* @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.
|
|
231
231
|
* @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>
|
|
232
|
-
* @param {
|
|
232
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
233
233
|
* @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>
|
|
234
234
|
* @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>
|
|
235
235
|
* @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>
|
|
236
236
|
* @param {*} [options] Override http request option.
|
|
237
237
|
* @throws {RequiredError}
|
|
238
238
|
*/
|
|
239
|
-
listLeads: async (authorization?: string, pageSize?:
|
|
239
|
+
listLeads: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
240
240
|
const localVarPath = `/partner-portal/v1/intermediary/leads`;
|
|
241
241
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
242
242
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -299,20 +299,20 @@ export const IntermediaryApiAxiosParamCreator = function (configuration?: Config
|
|
|
299
299
|
};
|
|
300
300
|
},
|
|
301
301
|
/**
|
|
302
|
-
* Returns a list of partners
|
|
302
|
+
* 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.
|
|
303
303
|
* @summary List partners
|
|
304
304
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
305
|
-
* @param {
|
|
306
|
-
* @param {
|
|
305
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
306
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
307
307
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeId, tenantUserCode, partnerNumber</i>
|
|
308
|
-
* @param {
|
|
308
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
309
309
|
* @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>
|
|
310
310
|
* @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>
|
|
311
311
|
* @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>
|
|
312
312
|
* @param {*} [options] Override http request option.
|
|
313
313
|
* @throws {RequiredError}
|
|
314
314
|
*/
|
|
315
|
-
listPartners: async (authorization?: string, pageSize?:
|
|
315
|
+
listPartners: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
316
316
|
const localVarPath = `/partner-portal/v1/intermediary/partners`;
|
|
317
317
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
318
318
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -375,20 +375,20 @@ export const IntermediaryApiAxiosParamCreator = function (configuration?: Config
|
|
|
375
375
|
};
|
|
376
376
|
},
|
|
377
377
|
/**
|
|
378
|
-
* Returns a list of policies
|
|
378
|
+
* 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.
|
|
379
379
|
* @summary List policies
|
|
380
380
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
381
|
-
* @param {
|
|
382
|
-
* @param {
|
|
381
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
382
|
+
* @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.
|
|
383
383
|
* @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>
|
|
384
|
-
* @param {
|
|
384
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
385
385
|
* @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>
|
|
386
386
|
* @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>
|
|
387
387
|
* @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>
|
|
388
388
|
* @param {*} [options] Override http request option.
|
|
389
389
|
* @throws {RequiredError}
|
|
390
390
|
*/
|
|
391
|
-
listPolicies: async (authorization?: string, pageSize?:
|
|
391
|
+
listPolicies: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
392
392
|
const localVarPath = `/partner-portal/v1/intermediary/policies`;
|
|
393
393
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
394
394
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -451,20 +451,20 @@ export const IntermediaryApiAxiosParamCreator = function (configuration?: Config
|
|
|
451
451
|
};
|
|
452
452
|
},
|
|
453
453
|
/**
|
|
454
|
-
* Returns a list of policyholders
|
|
454
|
+
* 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.
|
|
455
455
|
* @summary List policyholders
|
|
456
456
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
457
|
-
* @param {
|
|
458
|
-
* @param {
|
|
457
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
458
|
+
* @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.
|
|
459
459
|
* @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>
|
|
460
|
-
* @param {
|
|
460
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
461
461
|
* @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>
|
|
462
462
|
* @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>
|
|
463
463
|
* @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>
|
|
464
464
|
* @param {*} [options] Override http request option.
|
|
465
465
|
* @throws {RequiredError}
|
|
466
466
|
*/
|
|
467
|
-
listPolicyholders: async (authorization?: string, pageSize?:
|
|
467
|
+
listPolicyholders: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
468
468
|
const localVarPath = `/partner-portal/v1/intermediary/policyholders`;
|
|
469
469
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
470
470
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -537,7 +537,7 @@ export const IntermediaryApiFp = function(configuration?: Configuration) {
|
|
|
537
537
|
const localVarAxiosParamCreator = IntermediaryApiAxiosParamCreator(configuration)
|
|
538
538
|
return {
|
|
539
539
|
/**
|
|
540
|
-
* Retrieves the details of
|
|
540
|
+
* 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.
|
|
541
541
|
* @summary Retrieve the lead
|
|
542
542
|
* @param {string} code Unique identifier for the object.
|
|
543
543
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -549,9 +549,9 @@ export const IntermediaryApiFp = function(configuration?: Configuration) {
|
|
|
549
549
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
550
550
|
},
|
|
551
551
|
/**
|
|
552
|
-
* Retrieves the details of the partner
|
|
552
|
+
* 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.
|
|
553
553
|
* @summary Retrieve the partner
|
|
554
|
-
* @param {string} code
|
|
554
|
+
* @param {string} code The partner code or \"me\" for the currently logged in partner.
|
|
555
555
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
556
556
|
* @param {*} [options] Override http request option.
|
|
557
557
|
* @throws {RequiredError}
|
|
@@ -561,7 +561,7 @@ export const IntermediaryApiFp = function(configuration?: Configuration) {
|
|
|
561
561
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
562
562
|
},
|
|
563
563
|
/**
|
|
564
|
-
* Retrieves the details of
|
|
564
|
+
* 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.
|
|
565
565
|
* @summary Retrieve the policy
|
|
566
566
|
* @param {string} code Unique identifier for the object.
|
|
567
567
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -573,7 +573,7 @@ export const IntermediaryApiFp = function(configuration?: Configuration) {
|
|
|
573
573
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
574
574
|
},
|
|
575
575
|
/**
|
|
576
|
-
* Retrieves the details of
|
|
576
|
+
* 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.
|
|
577
577
|
* @summary Retrieve the policyholder
|
|
578
578
|
* @param {string} code Unique identifier for the object.
|
|
579
579
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -585,74 +585,74 @@ export const IntermediaryApiFp = function(configuration?: Configuration) {
|
|
|
585
585
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
586
586
|
},
|
|
587
587
|
/**
|
|
588
|
-
* Returns a list of leads
|
|
588
|
+
* 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.
|
|
589
589
|
* @summary List leads
|
|
590
590
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
591
|
-
* @param {
|
|
592
|
-
* @param {
|
|
591
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
592
|
+
* @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.
|
|
593
593
|
* @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>
|
|
594
|
-
* @param {
|
|
594
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
595
595
|
* @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>
|
|
596
596
|
* @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>
|
|
597
597
|
* @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>
|
|
598
598
|
* @param {*} [options] Override http request option.
|
|
599
599
|
* @throws {RequiredError}
|
|
600
600
|
*/
|
|
601
|
-
async listLeads(authorization?: string, pageSize?:
|
|
601
|
+
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>> {
|
|
602
602
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listLeads(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
603
603
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
604
604
|
},
|
|
605
605
|
/**
|
|
606
|
-
* Returns a list of partners
|
|
606
|
+
* 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.
|
|
607
607
|
* @summary List partners
|
|
608
608
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
609
|
-
* @param {
|
|
610
|
-
* @param {
|
|
609
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
610
|
+
* @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.
|
|
611
611
|
* @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>
|
|
612
|
-
* @param {
|
|
612
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
613
613
|
* @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>
|
|
614
614
|
* @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>
|
|
615
615
|
* @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>
|
|
616
616
|
* @param {*} [options] Override http request option.
|
|
617
617
|
* @throws {RequiredError}
|
|
618
618
|
*/
|
|
619
|
-
async listPartners(authorization?: string, pageSize?:
|
|
619
|
+
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>> {
|
|
620
620
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listPartners(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
621
621
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
622
622
|
},
|
|
623
623
|
/**
|
|
624
|
-
* Returns a list of policies
|
|
624
|
+
* 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.
|
|
625
625
|
* @summary List policies
|
|
626
626
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
627
|
-
* @param {
|
|
628
|
-
* @param {
|
|
627
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
628
|
+
* @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.
|
|
629
629
|
* @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>
|
|
630
|
-
* @param {
|
|
630
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
631
631
|
* @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>
|
|
632
632
|
* @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>
|
|
633
633
|
* @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>
|
|
634
634
|
* @param {*} [options] Override http request option.
|
|
635
635
|
* @throws {RequiredError}
|
|
636
636
|
*/
|
|
637
|
-
async listPolicies(authorization?: string, pageSize?:
|
|
637
|
+
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>> {
|
|
638
638
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listPolicies(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
639
639
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
640
640
|
},
|
|
641
641
|
/**
|
|
642
|
-
* Returns a list of policyholders
|
|
642
|
+
* 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.
|
|
643
643
|
* @summary List policyholders
|
|
644
644
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
645
|
-
* @param {
|
|
646
|
-
* @param {
|
|
645
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
646
|
+
* @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.
|
|
647
647
|
* @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>
|
|
648
|
-
* @param {
|
|
648
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
649
649
|
* @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>
|
|
650
650
|
* @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>
|
|
651
651
|
* @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>
|
|
652
652
|
* @param {*} [options] Override http request option.
|
|
653
653
|
* @throws {RequiredError}
|
|
654
654
|
*/
|
|
655
|
-
async listPolicyholders(authorization?: string, pageSize?:
|
|
655
|
+
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>> {
|
|
656
656
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listPolicyholders(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
657
657
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
658
658
|
},
|
|
@@ -667,7 +667,7 @@ export const IntermediaryApiFactory = function (configuration?: Configuration, b
|
|
|
667
667
|
const localVarFp = IntermediaryApiFp(configuration)
|
|
668
668
|
return {
|
|
669
669
|
/**
|
|
670
|
-
* Retrieves the details of
|
|
670
|
+
* 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.
|
|
671
671
|
* @summary Retrieve the lead
|
|
672
672
|
* @param {string} code Unique identifier for the object.
|
|
673
673
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -678,9 +678,9 @@ export const IntermediaryApiFactory = function (configuration?: Configuration, b
|
|
|
678
678
|
return localVarFp.getLead(code, authorization, options).then((request) => request(axios, basePath));
|
|
679
679
|
},
|
|
680
680
|
/**
|
|
681
|
-
* Retrieves the details of the partner
|
|
681
|
+
* 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.
|
|
682
682
|
* @summary Retrieve the partner
|
|
683
|
-
* @param {string} code
|
|
683
|
+
* @param {string} code The partner code or \"me\" for the currently logged in partner.
|
|
684
684
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
685
685
|
* @param {*} [options] Override http request option.
|
|
686
686
|
* @throws {RequiredError}
|
|
@@ -689,7 +689,7 @@ export const IntermediaryApiFactory = function (configuration?: Configuration, b
|
|
|
689
689
|
return localVarFp.getPartner(code, authorization, options).then((request) => request(axios, basePath));
|
|
690
690
|
},
|
|
691
691
|
/**
|
|
692
|
-
* Retrieves the details of
|
|
692
|
+
* 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.
|
|
693
693
|
* @summary Retrieve the policy
|
|
694
694
|
* @param {string} code Unique identifier for the object.
|
|
695
695
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -700,7 +700,7 @@ export const IntermediaryApiFactory = function (configuration?: Configuration, b
|
|
|
700
700
|
return localVarFp.getPolicy(code, authorization, options).then((request) => request(axios, basePath));
|
|
701
701
|
},
|
|
702
702
|
/**
|
|
703
|
-
* Retrieves the details of
|
|
703
|
+
* 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.
|
|
704
704
|
* @summary Retrieve the policyholder
|
|
705
705
|
* @param {string} code Unique identifier for the object.
|
|
706
706
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -711,71 +711,71 @@ export const IntermediaryApiFactory = function (configuration?: Configuration, b
|
|
|
711
711
|
return localVarFp.getPolicyholder(code, authorization, options).then((request) => request(axios, basePath));
|
|
712
712
|
},
|
|
713
713
|
/**
|
|
714
|
-
* Returns a list of leads
|
|
714
|
+
* 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.
|
|
715
715
|
* @summary List leads
|
|
716
716
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
717
|
-
* @param {
|
|
718
|
-
* @param {
|
|
717
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
718
|
+
* @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.
|
|
719
719
|
* @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>
|
|
720
|
-
* @param {
|
|
720
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
721
721
|
* @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>
|
|
722
722
|
* @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>
|
|
723
723
|
* @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>
|
|
724
724
|
* @param {*} [options] Override http request option.
|
|
725
725
|
* @throws {RequiredError}
|
|
726
726
|
*/
|
|
727
|
-
listLeads(authorization?: string, pageSize?:
|
|
727
|
+
listLeads(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListLeadsResponseClass> {
|
|
728
728
|
return localVarFp.listLeads(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
729
729
|
},
|
|
730
730
|
/**
|
|
731
|
-
* Returns a list of partners
|
|
731
|
+
* 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.
|
|
732
732
|
* @summary List partners
|
|
733
733
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
734
|
-
* @param {
|
|
735
|
-
* @param {
|
|
734
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
735
|
+
* @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.
|
|
736
736
|
* @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>
|
|
737
|
-
* @param {
|
|
737
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
738
738
|
* @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>
|
|
739
739
|
* @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>
|
|
740
740
|
* @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>
|
|
741
741
|
* @param {*} [options] Override http request option.
|
|
742
742
|
* @throws {RequiredError}
|
|
743
743
|
*/
|
|
744
|
-
listPartners(authorization?: string, pageSize?:
|
|
744
|
+
listPartners(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnersResponseClass> {
|
|
745
745
|
return localVarFp.listPartners(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
746
746
|
},
|
|
747
747
|
/**
|
|
748
|
-
* Returns a list of policies
|
|
748
|
+
* 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.
|
|
749
749
|
* @summary List policies
|
|
750
750
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
751
|
-
* @param {
|
|
752
|
-
* @param {
|
|
751
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
752
|
+
* @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.
|
|
753
753
|
* @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>
|
|
754
|
-
* @param {
|
|
754
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
755
755
|
* @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>
|
|
756
756
|
* @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>
|
|
757
757
|
* @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>
|
|
758
758
|
* @param {*} [options] Override http request option.
|
|
759
759
|
* @throws {RequiredError}
|
|
760
760
|
*/
|
|
761
|
-
listPolicies(authorization?: string, pageSize?:
|
|
761
|
+
listPolicies(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPoliciesResponseClass> {
|
|
762
762
|
return localVarFp.listPolicies(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
763
763
|
},
|
|
764
764
|
/**
|
|
765
|
-
* Returns a list of policyholders
|
|
765
|
+
* 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.
|
|
766
766
|
* @summary List policyholders
|
|
767
767
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
768
|
-
* @param {
|
|
769
|
-
* @param {
|
|
768
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
769
|
+
* @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.
|
|
770
770
|
* @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>
|
|
771
|
-
* @param {
|
|
771
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
772
772
|
* @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>
|
|
773
773
|
* @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>
|
|
774
774
|
* @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>
|
|
775
775
|
* @param {*} [options] Override http request option.
|
|
776
776
|
* @throws {RequiredError}
|
|
777
777
|
*/
|
|
778
|
-
listPolicyholders(authorization?: string, pageSize?:
|
|
778
|
+
listPolicyholders(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListAccountsResponseClass> {
|
|
779
779
|
return localVarFp.listPolicyholders(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
780
780
|
},
|
|
781
781
|
};
|
|
@@ -809,7 +809,7 @@ export interface IntermediaryApiGetLeadRequest {
|
|
|
809
809
|
*/
|
|
810
810
|
export interface IntermediaryApiGetPartnerRequest {
|
|
811
811
|
/**
|
|
812
|
-
*
|
|
812
|
+
* The partner code or \"me\" for the currently logged in partner.
|
|
813
813
|
* @type {string}
|
|
814
814
|
* @memberof IntermediaryApiGetPartner
|
|
815
815
|
*/
|
|
@@ -880,17 +880,17 @@ export interface IntermediaryApiListLeadsRequest {
|
|
|
880
880
|
|
|
881
881
|
/**
|
|
882
882
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
883
|
-
* @type {
|
|
883
|
+
* @type {number}
|
|
884
884
|
* @memberof IntermediaryApiListLeads
|
|
885
885
|
*/
|
|
886
|
-
readonly pageSize?:
|
|
886
|
+
readonly pageSize?: number
|
|
887
887
|
|
|
888
888
|
/**
|
|
889
|
-
* 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,
|
|
890
|
-
* @type {
|
|
889
|
+
* 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.
|
|
890
|
+
* @type {string}
|
|
891
891
|
* @memberof IntermediaryApiListLeads
|
|
892
892
|
*/
|
|
893
|
-
readonly pageToken?:
|
|
893
|
+
readonly pageToken?: string
|
|
894
894
|
|
|
895
895
|
/**
|
|
896
896
|
* 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>
|
|
@@ -901,10 +901,10 @@ export interface IntermediaryApiListLeadsRequest {
|
|
|
901
901
|
|
|
902
902
|
/**
|
|
903
903
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
904
|
-
* @type {
|
|
904
|
+
* @type {string}
|
|
905
905
|
* @memberof IntermediaryApiListLeads
|
|
906
906
|
*/
|
|
907
|
-
readonly search?:
|
|
907
|
+
readonly search?: string
|
|
908
908
|
|
|
909
909
|
/**
|
|
910
910
|
* 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>
|
|
@@ -943,17 +943,17 @@ export interface IntermediaryApiListPartnersRequest {
|
|
|
943
943
|
|
|
944
944
|
/**
|
|
945
945
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
946
|
-
* @type {
|
|
946
|
+
* @type {number}
|
|
947
947
|
* @memberof IntermediaryApiListPartners
|
|
948
948
|
*/
|
|
949
|
-
readonly pageSize?:
|
|
949
|
+
readonly pageSize?: number
|
|
950
950
|
|
|
951
951
|
/**
|
|
952
|
-
* 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,
|
|
953
|
-
* @type {
|
|
952
|
+
* 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.
|
|
953
|
+
* @type {string}
|
|
954
954
|
* @memberof IntermediaryApiListPartners
|
|
955
955
|
*/
|
|
956
|
-
readonly pageToken?:
|
|
956
|
+
readonly pageToken?: string
|
|
957
957
|
|
|
958
958
|
/**
|
|
959
959
|
* 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>
|
|
@@ -964,10 +964,10 @@ export interface IntermediaryApiListPartnersRequest {
|
|
|
964
964
|
|
|
965
965
|
/**
|
|
966
966
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
967
|
-
* @type {
|
|
967
|
+
* @type {string}
|
|
968
968
|
* @memberof IntermediaryApiListPartners
|
|
969
969
|
*/
|
|
970
|
-
readonly search?:
|
|
970
|
+
readonly search?: string
|
|
971
971
|
|
|
972
972
|
/**
|
|
973
973
|
* 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>
|
|
@@ -1006,17 +1006,17 @@ export interface IntermediaryApiListPoliciesRequest {
|
|
|
1006
1006
|
|
|
1007
1007
|
/**
|
|
1008
1008
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
1009
|
-
* @type {
|
|
1009
|
+
* @type {number}
|
|
1010
1010
|
* @memberof IntermediaryApiListPolicies
|
|
1011
1011
|
*/
|
|
1012
|
-
readonly pageSize?:
|
|
1012
|
+
readonly pageSize?: number
|
|
1013
1013
|
|
|
1014
1014
|
/**
|
|
1015
|
-
* 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,
|
|
1016
|
-
* @type {
|
|
1015
|
+
* 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.
|
|
1016
|
+
* @type {string}
|
|
1017
1017
|
* @memberof IntermediaryApiListPolicies
|
|
1018
1018
|
*/
|
|
1019
|
-
readonly pageToken?:
|
|
1019
|
+
readonly pageToken?: string
|
|
1020
1020
|
|
|
1021
1021
|
/**
|
|
1022
1022
|
* 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>
|
|
@@ -1027,10 +1027,10 @@ export interface IntermediaryApiListPoliciesRequest {
|
|
|
1027
1027
|
|
|
1028
1028
|
/**
|
|
1029
1029
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
1030
|
-
* @type {
|
|
1030
|
+
* @type {string}
|
|
1031
1031
|
* @memberof IntermediaryApiListPolicies
|
|
1032
1032
|
*/
|
|
1033
|
-
readonly search?:
|
|
1033
|
+
readonly search?: string
|
|
1034
1034
|
|
|
1035
1035
|
/**
|
|
1036
1036
|
* 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>
|
|
@@ -1069,17 +1069,17 @@ export interface IntermediaryApiListPolicyholdersRequest {
|
|
|
1069
1069
|
|
|
1070
1070
|
/**
|
|
1071
1071
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
1072
|
-
* @type {
|
|
1072
|
+
* @type {number}
|
|
1073
1073
|
* @memberof IntermediaryApiListPolicyholders
|
|
1074
1074
|
*/
|
|
1075
|
-
readonly pageSize?:
|
|
1075
|
+
readonly pageSize?: number
|
|
1076
1076
|
|
|
1077
1077
|
/**
|
|
1078
|
-
* 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,
|
|
1079
|
-
* @type {
|
|
1078
|
+
* 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.
|
|
1079
|
+
* @type {string}
|
|
1080
1080
|
* @memberof IntermediaryApiListPolicyholders
|
|
1081
1081
|
*/
|
|
1082
|
-
readonly pageToken?:
|
|
1082
|
+
readonly pageToken?: string
|
|
1083
1083
|
|
|
1084
1084
|
/**
|
|
1085
1085
|
* 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>
|
|
@@ -1090,10 +1090,10 @@ export interface IntermediaryApiListPolicyholdersRequest {
|
|
|
1090
1090
|
|
|
1091
1091
|
/**
|
|
1092
1092
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
1093
|
-
* @type {
|
|
1093
|
+
* @type {string}
|
|
1094
1094
|
* @memberof IntermediaryApiListPolicyholders
|
|
1095
1095
|
*/
|
|
1096
|
-
readonly search?:
|
|
1096
|
+
readonly search?: string
|
|
1097
1097
|
|
|
1098
1098
|
/**
|
|
1099
1099
|
* 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>
|
|
@@ -1125,7 +1125,7 @@ export interface IntermediaryApiListPolicyholdersRequest {
|
|
|
1125
1125
|
*/
|
|
1126
1126
|
export class IntermediaryApi extends BaseAPI {
|
|
1127
1127
|
/**
|
|
1128
|
-
* Retrieves the details of
|
|
1128
|
+
* 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.
|
|
1129
1129
|
* @summary Retrieve the lead
|
|
1130
1130
|
* @param {IntermediaryApiGetLeadRequest} requestParameters Request parameters.
|
|
1131
1131
|
* @param {*} [options] Override http request option.
|
|
@@ -1137,7 +1137,7 @@ export class IntermediaryApi extends BaseAPI {
|
|
|
1137
1137
|
}
|
|
1138
1138
|
|
|
1139
1139
|
/**
|
|
1140
|
-
* Retrieves the details of the partner
|
|
1140
|
+
* 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.
|
|
1141
1141
|
* @summary Retrieve the partner
|
|
1142
1142
|
* @param {IntermediaryApiGetPartnerRequest} requestParameters Request parameters.
|
|
1143
1143
|
* @param {*} [options] Override http request option.
|
|
@@ -1149,7 +1149,7 @@ export class IntermediaryApi extends BaseAPI {
|
|
|
1149
1149
|
}
|
|
1150
1150
|
|
|
1151
1151
|
/**
|
|
1152
|
-
* Retrieves the details of
|
|
1152
|
+
* 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.
|
|
1153
1153
|
* @summary Retrieve the policy
|
|
1154
1154
|
* @param {IntermediaryApiGetPolicyRequest} requestParameters Request parameters.
|
|
1155
1155
|
* @param {*} [options] Override http request option.
|
|
@@ -1161,7 +1161,7 @@ export class IntermediaryApi extends BaseAPI {
|
|
|
1161
1161
|
}
|
|
1162
1162
|
|
|
1163
1163
|
/**
|
|
1164
|
-
* Retrieves the details of
|
|
1164
|
+
* 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.
|
|
1165
1165
|
* @summary Retrieve the policyholder
|
|
1166
1166
|
* @param {IntermediaryApiGetPolicyholderRequest} requestParameters Request parameters.
|
|
1167
1167
|
* @param {*} [options] Override http request option.
|
|
@@ -1173,7 +1173,7 @@ export class IntermediaryApi extends BaseAPI {
|
|
|
1173
1173
|
}
|
|
1174
1174
|
|
|
1175
1175
|
/**
|
|
1176
|
-
* Returns a list of leads
|
|
1176
|
+
* 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.
|
|
1177
1177
|
* @summary List leads
|
|
1178
1178
|
* @param {IntermediaryApiListLeadsRequest} requestParameters Request parameters.
|
|
1179
1179
|
* @param {*} [options] Override http request option.
|
|
@@ -1185,7 +1185,7 @@ export class IntermediaryApi extends BaseAPI {
|
|
|
1185
1185
|
}
|
|
1186
1186
|
|
|
1187
1187
|
/**
|
|
1188
|
-
* Returns a list of partners
|
|
1188
|
+
* 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.
|
|
1189
1189
|
* @summary List partners
|
|
1190
1190
|
* @param {IntermediaryApiListPartnersRequest} requestParameters Request parameters.
|
|
1191
1191
|
* @param {*} [options] Override http request option.
|
|
@@ -1197,7 +1197,7 @@ export class IntermediaryApi extends BaseAPI {
|
|
|
1197
1197
|
}
|
|
1198
1198
|
|
|
1199
1199
|
/**
|
|
1200
|
-
* Returns a list of policies
|
|
1200
|
+
* 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.
|
|
1201
1201
|
* @summary List policies
|
|
1202
1202
|
* @param {IntermediaryApiListPoliciesRequest} requestParameters Request parameters.
|
|
1203
1203
|
* @param {*} [options] Override http request option.
|
|
@@ -1209,7 +1209,7 @@ export class IntermediaryApi extends BaseAPI {
|
|
|
1209
1209
|
}
|
|
1210
1210
|
|
|
1211
1211
|
/**
|
|
1212
|
-
* Returns a list of policyholders
|
|
1212
|
+
* 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.
|
|
1213
1213
|
* @summary List policyholders
|
|
1214
1214
|
* @param {IntermediaryApiListPolicyholdersRequest} requestParameters Request parameters.
|
|
1215
1215
|
* @param {*} [options] Override http request option.
|