@emilgroup/partner-portal-sdk-node 1.0.1-beta.0 → 1.0.1-beta.1
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/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/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
|
@@ -26,7 +26,7 @@ import { PolicyClass } from '../models';
|
|
|
26
26
|
*/
|
|
27
27
|
export declare const IntermediaryApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
28
28
|
/**
|
|
29
|
-
* Retrieves the details of
|
|
29
|
+
* 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.
|
|
30
30
|
* @summary Retrieve the lead
|
|
31
31
|
* @param {string} code Unique identifier for the object.
|
|
32
32
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -35,16 +35,16 @@ export declare const IntermediaryApiAxiosParamCreator: (configuration?: Configur
|
|
|
35
35
|
*/
|
|
36
36
|
getLead: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37
37
|
/**
|
|
38
|
-
* Retrieves the details of the partner
|
|
38
|
+
* 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.
|
|
39
39
|
* @summary Retrieve the partner
|
|
40
|
-
* @param {string} code
|
|
40
|
+
* @param {string} code The partner code or \"me\" for the currently logged in partner.
|
|
41
41
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
42
42
|
* @param {*} [options] Override http request option.
|
|
43
43
|
* @throws {RequiredError}
|
|
44
44
|
*/
|
|
45
45
|
getPartner: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46
46
|
/**
|
|
47
|
-
* Retrieves the details of
|
|
47
|
+
* 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.
|
|
48
48
|
* @summary Retrieve the policy
|
|
49
49
|
* @param {string} code Unique identifier for the object.
|
|
50
50
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -53,7 +53,7 @@ export declare const IntermediaryApiAxiosParamCreator: (configuration?: Configur
|
|
|
53
53
|
*/
|
|
54
54
|
getPolicy: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55
55
|
/**
|
|
56
|
-
* Retrieves the details of
|
|
56
|
+
* 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.
|
|
57
57
|
* @summary Retrieve the policyholder
|
|
58
58
|
* @param {string} code Unique identifier for the object.
|
|
59
59
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -62,65 +62,65 @@ export declare const IntermediaryApiAxiosParamCreator: (configuration?: Configur
|
|
|
62
62
|
*/
|
|
63
63
|
getPolicyholder: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
64
64
|
/**
|
|
65
|
-
* Returns a list of leads
|
|
65
|
+
* 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.
|
|
66
66
|
* @summary List leads
|
|
67
67
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
68
|
-
* @param {
|
|
69
|
-
* @param {
|
|
68
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
69
|
+
* @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.
|
|
70
70
|
* @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>
|
|
71
|
-
* @param {
|
|
71
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
72
72
|
* @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>
|
|
73
73
|
* @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>
|
|
74
74
|
* @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>
|
|
75
75
|
* @param {*} [options] Override http request option.
|
|
76
76
|
* @throws {RequiredError}
|
|
77
77
|
*/
|
|
78
|
-
listLeads: (authorization?: string, pageSize?:
|
|
78
|
+
listLeads: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
79
79
|
/**
|
|
80
|
-
* Returns a list of partners
|
|
80
|
+
* 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.
|
|
81
81
|
* @summary List partners
|
|
82
82
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
83
|
-
* @param {
|
|
84
|
-
* @param {
|
|
83
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
84
|
+
* @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.
|
|
85
85
|
* @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>
|
|
86
|
-
* @param {
|
|
86
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
87
87
|
* @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>
|
|
88
88
|
* @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>
|
|
89
89
|
* @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>
|
|
90
90
|
* @param {*} [options] Override http request option.
|
|
91
91
|
* @throws {RequiredError}
|
|
92
92
|
*/
|
|
93
|
-
listPartners: (authorization?: string, pageSize?:
|
|
93
|
+
listPartners: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
94
94
|
/**
|
|
95
|
-
* Returns a list of policies
|
|
95
|
+
* 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.
|
|
96
96
|
* @summary List policies
|
|
97
97
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
98
|
-
* @param {
|
|
99
|
-
* @param {
|
|
98
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
99
|
+
* @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.
|
|
100
100
|
* @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>
|
|
101
|
-
* @param {
|
|
101
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
102
102
|
* @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>
|
|
103
103
|
* @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>
|
|
104
104
|
* @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>
|
|
105
105
|
* @param {*} [options] Override http request option.
|
|
106
106
|
* @throws {RequiredError}
|
|
107
107
|
*/
|
|
108
|
-
listPolicies: (authorization?: string, pageSize?:
|
|
108
|
+
listPolicies: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
109
109
|
/**
|
|
110
|
-
* Returns a list of policyholders
|
|
110
|
+
* 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.
|
|
111
111
|
* @summary List policyholders
|
|
112
112
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
113
|
-
* @param {
|
|
114
|
-
* @param {
|
|
113
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
114
|
+
* @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.
|
|
115
115
|
* @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>
|
|
116
|
-
* @param {
|
|
116
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
117
117
|
* @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>
|
|
118
118
|
* @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>
|
|
119
119
|
* @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>
|
|
120
120
|
* @param {*} [options] Override http request option.
|
|
121
121
|
* @throws {RequiredError}
|
|
122
122
|
*/
|
|
123
|
-
listPolicyholders: (authorization?: string, pageSize?:
|
|
123
|
+
listPolicyholders: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
124
124
|
};
|
|
125
125
|
/**
|
|
126
126
|
* IntermediaryApi - functional programming interface
|
|
@@ -128,7 +128,7 @@ export declare const IntermediaryApiAxiosParamCreator: (configuration?: Configur
|
|
|
128
128
|
*/
|
|
129
129
|
export declare const IntermediaryApiFp: (configuration?: Configuration) => {
|
|
130
130
|
/**
|
|
131
|
-
* Retrieves the details of
|
|
131
|
+
* 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.
|
|
132
132
|
* @summary Retrieve the lead
|
|
133
133
|
* @param {string} code Unique identifier for the object.
|
|
134
134
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -137,16 +137,16 @@ export declare const IntermediaryApiFp: (configuration?: Configuration) => {
|
|
|
137
137
|
*/
|
|
138
138
|
getLead(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LeadClass>>;
|
|
139
139
|
/**
|
|
140
|
-
* Retrieves the details of the partner
|
|
140
|
+
* 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.
|
|
141
141
|
* @summary Retrieve the partner
|
|
142
|
-
* @param {string} code
|
|
142
|
+
* @param {string} code The partner code or \"me\" for the currently logged in partner.
|
|
143
143
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
144
144
|
* @param {*} [options] Override http request option.
|
|
145
145
|
* @throws {RequiredError}
|
|
146
146
|
*/
|
|
147
147
|
getPartner(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PartnerClass>>;
|
|
148
148
|
/**
|
|
149
|
-
* Retrieves the details of
|
|
149
|
+
* 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.
|
|
150
150
|
* @summary Retrieve the policy
|
|
151
151
|
* @param {string} code Unique identifier for the object.
|
|
152
152
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -155,7 +155,7 @@ export declare const IntermediaryApiFp: (configuration?: Configuration) => {
|
|
|
155
155
|
*/
|
|
156
156
|
getPolicy(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PolicyClass>>;
|
|
157
157
|
/**
|
|
158
|
-
* Retrieves the details of
|
|
158
|
+
* 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.
|
|
159
159
|
* @summary Retrieve the policyholder
|
|
160
160
|
* @param {string} code Unique identifier for the object.
|
|
161
161
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -164,65 +164,65 @@ export declare const IntermediaryApiFp: (configuration?: Configuration) => {
|
|
|
164
164
|
*/
|
|
165
165
|
getPolicyholder(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountClass>>;
|
|
166
166
|
/**
|
|
167
|
-
* Returns a list of leads
|
|
167
|
+
* 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.
|
|
168
168
|
* @summary List leads
|
|
169
169
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
170
|
-
* @param {
|
|
171
|
-
* @param {
|
|
170
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
171
|
+
* @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.
|
|
172
172
|
* @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>
|
|
173
|
-
* @param {
|
|
173
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
174
174
|
* @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>
|
|
175
175
|
* @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>
|
|
176
176
|
* @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>
|
|
177
177
|
* @param {*} [options] Override http request option.
|
|
178
178
|
* @throws {RequiredError}
|
|
179
179
|
*/
|
|
180
|
-
listLeads(authorization?: string, pageSize?:
|
|
180
|
+
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>>;
|
|
181
181
|
/**
|
|
182
|
-
* Returns a list of partners
|
|
182
|
+
* 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.
|
|
183
183
|
* @summary List partners
|
|
184
184
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
185
|
-
* @param {
|
|
186
|
-
* @param {
|
|
185
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
186
|
+
* @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.
|
|
187
187
|
* @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>
|
|
188
|
-
* @param {
|
|
188
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
189
189
|
* @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>
|
|
190
190
|
* @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>
|
|
191
191
|
* @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>
|
|
192
192
|
* @param {*} [options] Override http request option.
|
|
193
193
|
* @throws {RequiredError}
|
|
194
194
|
*/
|
|
195
|
-
listPartners(authorization?: string, pageSize?:
|
|
195
|
+
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>>;
|
|
196
196
|
/**
|
|
197
|
-
* Returns a list of policies
|
|
197
|
+
* 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.
|
|
198
198
|
* @summary List policies
|
|
199
199
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
200
|
-
* @param {
|
|
201
|
-
* @param {
|
|
200
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
201
|
+
* @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.
|
|
202
202
|
* @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>
|
|
203
|
-
* @param {
|
|
203
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
204
204
|
* @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>
|
|
205
205
|
* @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>
|
|
206
206
|
* @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>
|
|
207
207
|
* @param {*} [options] Override http request option.
|
|
208
208
|
* @throws {RequiredError}
|
|
209
209
|
*/
|
|
210
|
-
listPolicies(authorization?: string, pageSize?:
|
|
210
|
+
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>>;
|
|
211
211
|
/**
|
|
212
|
-
* Returns a list of policyholders
|
|
212
|
+
* 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.
|
|
213
213
|
* @summary List policyholders
|
|
214
214
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
215
|
-
* @param {
|
|
216
|
-
* @param {
|
|
215
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
216
|
+
* @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.
|
|
217
217
|
* @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>
|
|
218
|
-
* @param {
|
|
218
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
219
219
|
* @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>
|
|
220
220
|
* @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>
|
|
221
221
|
* @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>
|
|
222
222
|
* @param {*} [options] Override http request option.
|
|
223
223
|
* @throws {RequiredError}
|
|
224
224
|
*/
|
|
225
|
-
listPolicyholders(authorization?: string, pageSize?:
|
|
225
|
+
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>>;
|
|
226
226
|
};
|
|
227
227
|
/**
|
|
228
228
|
* IntermediaryApi - factory interface
|
|
@@ -230,7 +230,7 @@ export declare const IntermediaryApiFp: (configuration?: Configuration) => {
|
|
|
230
230
|
*/
|
|
231
231
|
export declare const IntermediaryApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
232
232
|
/**
|
|
233
|
-
* Retrieves the details of
|
|
233
|
+
* 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.
|
|
234
234
|
* @summary Retrieve the lead
|
|
235
235
|
* @param {string} code Unique identifier for the object.
|
|
236
236
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -239,16 +239,16 @@ export declare const IntermediaryApiFactory: (configuration?: Configuration, bas
|
|
|
239
239
|
*/
|
|
240
240
|
getLead(code: string, authorization?: string, options?: any): AxiosPromise<LeadClass>;
|
|
241
241
|
/**
|
|
242
|
-
* Retrieves the details of the partner
|
|
242
|
+
* 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.
|
|
243
243
|
* @summary Retrieve the partner
|
|
244
|
-
* @param {string} code
|
|
244
|
+
* @param {string} code The partner code or \"me\" for the currently logged in partner.
|
|
245
245
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
246
246
|
* @param {*} [options] Override http request option.
|
|
247
247
|
* @throws {RequiredError}
|
|
248
248
|
*/
|
|
249
249
|
getPartner(code: string, authorization?: string, options?: any): AxiosPromise<PartnerClass>;
|
|
250
250
|
/**
|
|
251
|
-
* Retrieves the details of
|
|
251
|
+
* 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.
|
|
252
252
|
* @summary Retrieve the policy
|
|
253
253
|
* @param {string} code Unique identifier for the object.
|
|
254
254
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -257,7 +257,7 @@ export declare const IntermediaryApiFactory: (configuration?: Configuration, bas
|
|
|
257
257
|
*/
|
|
258
258
|
getPolicy(code: string, authorization?: string, options?: any): AxiosPromise<PolicyClass>;
|
|
259
259
|
/**
|
|
260
|
-
* Retrieves the details of
|
|
260
|
+
* 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.
|
|
261
261
|
* @summary Retrieve the policyholder
|
|
262
262
|
* @param {string} code Unique identifier for the object.
|
|
263
263
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -266,65 +266,65 @@ export declare const IntermediaryApiFactory: (configuration?: Configuration, bas
|
|
|
266
266
|
*/
|
|
267
267
|
getPolicyholder(code: string, authorization?: string, options?: any): AxiosPromise<AccountClass>;
|
|
268
268
|
/**
|
|
269
|
-
* Returns a list of leads
|
|
269
|
+
* 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.
|
|
270
270
|
* @summary List leads
|
|
271
271
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
272
|
-
* @param {
|
|
273
|
-
* @param {
|
|
272
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
273
|
+
* @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.
|
|
274
274
|
* @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>
|
|
275
|
-
* @param {
|
|
275
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
276
276
|
* @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>
|
|
277
277
|
* @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>
|
|
278
278
|
* @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>
|
|
279
279
|
* @param {*} [options] Override http request option.
|
|
280
280
|
* @throws {RequiredError}
|
|
281
281
|
*/
|
|
282
|
-
listLeads(authorization?: string, pageSize?:
|
|
282
|
+
listLeads(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListLeadsResponseClass>;
|
|
283
283
|
/**
|
|
284
|
-
* Returns a list of partners
|
|
284
|
+
* 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.
|
|
285
285
|
* @summary List partners
|
|
286
286
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
287
|
-
* @param {
|
|
288
|
-
* @param {
|
|
287
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
288
|
+
* @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.
|
|
289
289
|
* @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>
|
|
290
|
-
* @param {
|
|
290
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
291
291
|
* @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>
|
|
292
292
|
* @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>
|
|
293
293
|
* @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>
|
|
294
294
|
* @param {*} [options] Override http request option.
|
|
295
295
|
* @throws {RequiredError}
|
|
296
296
|
*/
|
|
297
|
-
listPartners(authorization?: string, pageSize?:
|
|
297
|
+
listPartners(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnersResponseClass>;
|
|
298
298
|
/**
|
|
299
|
-
* Returns a list of policies
|
|
299
|
+
* 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.
|
|
300
300
|
* @summary List policies
|
|
301
301
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
302
|
-
* @param {
|
|
303
|
-
* @param {
|
|
302
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
303
|
+
* @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.
|
|
304
304
|
* @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>
|
|
305
|
-
* @param {
|
|
305
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
306
306
|
* @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>
|
|
307
307
|
* @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>
|
|
308
308
|
* @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>
|
|
309
309
|
* @param {*} [options] Override http request option.
|
|
310
310
|
* @throws {RequiredError}
|
|
311
311
|
*/
|
|
312
|
-
listPolicies(authorization?: string, pageSize?:
|
|
312
|
+
listPolicies(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPoliciesResponseClass>;
|
|
313
313
|
/**
|
|
314
|
-
* Returns a list of policyholders
|
|
314
|
+
* 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.
|
|
315
315
|
* @summary List policyholders
|
|
316
316
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
317
|
-
* @param {
|
|
318
|
-
* @param {
|
|
317
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
318
|
+
* @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.
|
|
319
319
|
* @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>
|
|
320
|
-
* @param {
|
|
320
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
321
321
|
* @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>
|
|
322
322
|
* @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>
|
|
323
323
|
* @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>
|
|
324
324
|
* @param {*} [options] Override http request option.
|
|
325
325
|
* @throws {RequiredError}
|
|
326
326
|
*/
|
|
327
|
-
listPolicyholders(authorization?: string, pageSize?:
|
|
327
|
+
listPolicyholders(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListAccountsResponseClass>;
|
|
328
328
|
};
|
|
329
329
|
/**
|
|
330
330
|
* Request parameters for getLead operation in IntermediaryApi.
|
|
@@ -352,7 +352,7 @@ export interface IntermediaryApiGetLeadRequest {
|
|
|
352
352
|
*/
|
|
353
353
|
export interface IntermediaryApiGetPartnerRequest {
|
|
354
354
|
/**
|
|
355
|
-
*
|
|
355
|
+
* The partner code or \"me\" for the currently logged in partner.
|
|
356
356
|
* @type {string}
|
|
357
357
|
* @memberof IntermediaryApiGetPartner
|
|
358
358
|
*/
|
|
@@ -416,16 +416,16 @@ export interface IntermediaryApiListLeadsRequest {
|
|
|
416
416
|
readonly authorization?: string;
|
|
417
417
|
/**
|
|
418
418
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
419
|
-
* @type {
|
|
419
|
+
* @type {number}
|
|
420
420
|
* @memberof IntermediaryApiListLeads
|
|
421
421
|
*/
|
|
422
|
-
readonly pageSize?:
|
|
422
|
+
readonly pageSize?: number;
|
|
423
423
|
/**
|
|
424
|
-
* 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,
|
|
425
|
-
* @type {
|
|
424
|
+
* 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.
|
|
425
|
+
* @type {string}
|
|
426
426
|
* @memberof IntermediaryApiListLeads
|
|
427
427
|
*/
|
|
428
|
-
readonly pageToken?:
|
|
428
|
+
readonly pageToken?: string;
|
|
429
429
|
/**
|
|
430
430
|
* 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>
|
|
431
431
|
* @type {string}
|
|
@@ -434,10 +434,10 @@ export interface IntermediaryApiListLeadsRequest {
|
|
|
434
434
|
readonly filter?: string;
|
|
435
435
|
/**
|
|
436
436
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
437
|
-
* @type {
|
|
437
|
+
* @type {string}
|
|
438
438
|
* @memberof IntermediaryApiListLeads
|
|
439
439
|
*/
|
|
440
|
-
readonly search?:
|
|
440
|
+
readonly search?: string;
|
|
441
441
|
/**
|
|
442
442
|
* 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>
|
|
443
443
|
* @type {string}
|
|
@@ -471,16 +471,16 @@ export interface IntermediaryApiListPartnersRequest {
|
|
|
471
471
|
readonly authorization?: string;
|
|
472
472
|
/**
|
|
473
473
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
474
|
-
* @type {
|
|
474
|
+
* @type {number}
|
|
475
475
|
* @memberof IntermediaryApiListPartners
|
|
476
476
|
*/
|
|
477
|
-
readonly pageSize?:
|
|
477
|
+
readonly pageSize?: number;
|
|
478
478
|
/**
|
|
479
|
-
* 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,
|
|
480
|
-
* @type {
|
|
479
|
+
* 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.
|
|
480
|
+
* @type {string}
|
|
481
481
|
* @memberof IntermediaryApiListPartners
|
|
482
482
|
*/
|
|
483
|
-
readonly pageToken?:
|
|
483
|
+
readonly pageToken?: string;
|
|
484
484
|
/**
|
|
485
485
|
* 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>
|
|
486
486
|
* @type {string}
|
|
@@ -489,10 +489,10 @@ export interface IntermediaryApiListPartnersRequest {
|
|
|
489
489
|
readonly filter?: string;
|
|
490
490
|
/**
|
|
491
491
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
492
|
-
* @type {
|
|
492
|
+
* @type {string}
|
|
493
493
|
* @memberof IntermediaryApiListPartners
|
|
494
494
|
*/
|
|
495
|
-
readonly search?:
|
|
495
|
+
readonly search?: string;
|
|
496
496
|
/**
|
|
497
497
|
* 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>
|
|
498
498
|
* @type {string}
|
|
@@ -526,16 +526,16 @@ export interface IntermediaryApiListPoliciesRequest {
|
|
|
526
526
|
readonly authorization?: string;
|
|
527
527
|
/**
|
|
528
528
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
529
|
-
* @type {
|
|
529
|
+
* @type {number}
|
|
530
530
|
* @memberof IntermediaryApiListPolicies
|
|
531
531
|
*/
|
|
532
|
-
readonly pageSize?:
|
|
532
|
+
readonly pageSize?: number;
|
|
533
533
|
/**
|
|
534
|
-
* 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,
|
|
535
|
-
* @type {
|
|
534
|
+
* 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.
|
|
535
|
+
* @type {string}
|
|
536
536
|
* @memberof IntermediaryApiListPolicies
|
|
537
537
|
*/
|
|
538
|
-
readonly pageToken?:
|
|
538
|
+
readonly pageToken?: string;
|
|
539
539
|
/**
|
|
540
540
|
* 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>
|
|
541
541
|
* @type {string}
|
|
@@ -544,10 +544,10 @@ export interface IntermediaryApiListPoliciesRequest {
|
|
|
544
544
|
readonly filter?: string;
|
|
545
545
|
/**
|
|
546
546
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
547
|
-
* @type {
|
|
547
|
+
* @type {string}
|
|
548
548
|
* @memberof IntermediaryApiListPolicies
|
|
549
549
|
*/
|
|
550
|
-
readonly search?:
|
|
550
|
+
readonly search?: string;
|
|
551
551
|
/**
|
|
552
552
|
* 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>
|
|
553
553
|
* @type {string}
|
|
@@ -581,16 +581,16 @@ export interface IntermediaryApiListPolicyholdersRequest {
|
|
|
581
581
|
readonly authorization?: string;
|
|
582
582
|
/**
|
|
583
583
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
584
|
-
* @type {
|
|
584
|
+
* @type {number}
|
|
585
585
|
* @memberof IntermediaryApiListPolicyholders
|
|
586
586
|
*/
|
|
587
|
-
readonly pageSize?:
|
|
587
|
+
readonly pageSize?: number;
|
|
588
588
|
/**
|
|
589
|
-
* 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,
|
|
590
|
-
* @type {
|
|
589
|
+
* 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.
|
|
590
|
+
* @type {string}
|
|
591
591
|
* @memberof IntermediaryApiListPolicyholders
|
|
592
592
|
*/
|
|
593
|
-
readonly pageToken?:
|
|
593
|
+
readonly pageToken?: string;
|
|
594
594
|
/**
|
|
595
595
|
* 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>
|
|
596
596
|
* @type {string}
|
|
@@ -599,10 +599,10 @@ export interface IntermediaryApiListPolicyholdersRequest {
|
|
|
599
599
|
readonly filter?: string;
|
|
600
600
|
/**
|
|
601
601
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
602
|
-
* @type {
|
|
602
|
+
* @type {string}
|
|
603
603
|
* @memberof IntermediaryApiListPolicyholders
|
|
604
604
|
*/
|
|
605
|
-
readonly search?:
|
|
605
|
+
readonly search?: string;
|
|
606
606
|
/**
|
|
607
607
|
* 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>
|
|
608
608
|
* @type {string}
|
|
@@ -630,7 +630,7 @@ export interface IntermediaryApiListPolicyholdersRequest {
|
|
|
630
630
|
*/
|
|
631
631
|
export declare class IntermediaryApi extends BaseAPI {
|
|
632
632
|
/**
|
|
633
|
-
* Retrieves the details of
|
|
633
|
+
* 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.
|
|
634
634
|
* @summary Retrieve the lead
|
|
635
635
|
* @param {IntermediaryApiGetLeadRequest} requestParameters Request parameters.
|
|
636
636
|
* @param {*} [options] Override http request option.
|
|
@@ -639,7 +639,7 @@ export declare class IntermediaryApi extends BaseAPI {
|
|
|
639
639
|
*/
|
|
640
640
|
getLead(requestParameters: IntermediaryApiGetLeadRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LeadClass, any>>;
|
|
641
641
|
/**
|
|
642
|
-
* Retrieves the details of the partner
|
|
642
|
+
* 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.
|
|
643
643
|
* @summary Retrieve the partner
|
|
644
644
|
* @param {IntermediaryApiGetPartnerRequest} requestParameters Request parameters.
|
|
645
645
|
* @param {*} [options] Override http request option.
|
|
@@ -648,7 +648,7 @@ export declare class IntermediaryApi extends BaseAPI {
|
|
|
648
648
|
*/
|
|
649
649
|
getPartner(requestParameters: IntermediaryApiGetPartnerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PartnerClass, any>>;
|
|
650
650
|
/**
|
|
651
|
-
* Retrieves the details of
|
|
651
|
+
* 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.
|
|
652
652
|
* @summary Retrieve the policy
|
|
653
653
|
* @param {IntermediaryApiGetPolicyRequest} requestParameters Request parameters.
|
|
654
654
|
* @param {*} [options] Override http request option.
|
|
@@ -657,7 +657,7 @@ export declare class IntermediaryApi extends BaseAPI {
|
|
|
657
657
|
*/
|
|
658
658
|
getPolicy(requestParameters: IntermediaryApiGetPolicyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PolicyClass, any>>;
|
|
659
659
|
/**
|
|
660
|
-
* Retrieves the details of
|
|
660
|
+
* 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.
|
|
661
661
|
* @summary Retrieve the policyholder
|
|
662
662
|
* @param {IntermediaryApiGetPolicyholderRequest} requestParameters Request parameters.
|
|
663
663
|
* @param {*} [options] Override http request option.
|
|
@@ -666,7 +666,7 @@ export declare class IntermediaryApi extends BaseAPI {
|
|
|
666
666
|
*/
|
|
667
667
|
getPolicyholder(requestParameters: IntermediaryApiGetPolicyholderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountClass, any>>;
|
|
668
668
|
/**
|
|
669
|
-
* Returns a list of leads
|
|
669
|
+
* 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.
|
|
670
670
|
* @summary List leads
|
|
671
671
|
* @param {IntermediaryApiListLeadsRequest} requestParameters Request parameters.
|
|
672
672
|
* @param {*} [options] Override http request option.
|
|
@@ -675,7 +675,7 @@ export declare class IntermediaryApi extends BaseAPI {
|
|
|
675
675
|
*/
|
|
676
676
|
listLeads(requestParameters?: IntermediaryApiListLeadsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListLeadsResponseClass, any>>;
|
|
677
677
|
/**
|
|
678
|
-
* Returns a list of partners
|
|
678
|
+
* 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.
|
|
679
679
|
* @summary List partners
|
|
680
680
|
* @param {IntermediaryApiListPartnersRequest} requestParameters Request parameters.
|
|
681
681
|
* @param {*} [options] Override http request option.
|
|
@@ -684,7 +684,7 @@ export declare class IntermediaryApi extends BaseAPI {
|
|
|
684
684
|
*/
|
|
685
685
|
listPartners(requestParameters?: IntermediaryApiListPartnersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPartnersResponseClass, any>>;
|
|
686
686
|
/**
|
|
687
|
-
* Returns a list of policies
|
|
687
|
+
* 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.
|
|
688
688
|
* @summary List policies
|
|
689
689
|
* @param {IntermediaryApiListPoliciesRequest} requestParameters Request parameters.
|
|
690
690
|
* @param {*} [options] Override http request option.
|
|
@@ -693,7 +693,7 @@ export declare class IntermediaryApi extends BaseAPI {
|
|
|
693
693
|
*/
|
|
694
694
|
listPolicies(requestParameters?: IntermediaryApiListPoliciesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPoliciesResponseClass, any>>;
|
|
695
695
|
/**
|
|
696
|
-
* Returns a list of policyholders
|
|
696
|
+
* 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.
|
|
697
697
|
* @summary List policyholders
|
|
698
698
|
* @param {IntermediaryApiListPolicyholdersRequest} requestParameters Request parameters.
|
|
699
699
|
* @param {*} [options] Override http request option.
|