@emilgroup/partner-portal-sdk-node 1.0.1-beta.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 +49 -0
- package/.openapi-generator/VERSION +1 -0
- package/.openapi-generator-ignore +23 -0
- package/README.md +84 -0
- package/api/health-check-api.ts +128 -0
- package/api/intermediary-api.ts +1226 -0
- package/api.ts +33 -0
- package/base.ts +286 -0
- package/common.ts +199 -0
- package/configuration.ts +109 -0
- package/dist/api/health-check-api.d.ts +70 -0
- package/dist/api/health-check-api.js +204 -0
- package/dist/api/intermediary-api.d.ts +704 -0
- package/dist/api/intermediary-api.js +1019 -0
- package/dist/api.d.ts +13 -0
- package/dist/api.js +31 -0
- package/dist/base.d.ts +79 -0
- package/dist/base.js +395 -0
- package/dist/common.d.ts +92 -0
- package/dist/common.js +277 -0
- package/dist/configuration.d.ts +90 -0
- package/dist/configuration.js +44 -0
- package/dist/index.d.ts +15 -0
- package/dist/index.js +36 -0
- package/dist/models/account-class.d.ts +176 -0
- package/dist/models/account-class.js +22 -0
- package/dist/models/account-policy-class.d.ts +147 -0
- package/dist/models/account-policy-class.js +15 -0
- package/dist/models/create-payment-method-request-dto.d.ts +31 -0
- package/dist/models/create-payment-method-request-dto.js +15 -0
- package/dist/models/create-policy-request-dto.d.ts +55 -0
- package/dist/models/create-policy-request-dto.js +15 -0
- package/dist/models/index.d.ts +34 -0
- package/dist/models/index.js +50 -0
- package/dist/models/inline-response200.d.ts +54 -0
- package/dist/models/inline-response200.js +15 -0
- package/dist/models/inline-response503.d.ts +54 -0
- package/dist/models/inline-response503.js +15 -0
- package/dist/models/insured-object-type-class.d.ts +60 -0
- package/dist/models/insured-object-type-class.js +15 -0
- package/dist/models/invoice-class.d.ts +150 -0
- package/dist/models/invoice-class.js +30 -0
- package/dist/models/invoice-item-class.d.ts +117 -0
- package/dist/models/invoice-item-class.js +24 -0
- package/dist/models/invoice-status-class.d.ts +47 -0
- package/dist/models/invoice-status-class.js +20 -0
- package/dist/models/lead-bank-account-class.d.ts +30 -0
- package/dist/models/lead-bank-account-class.js +15 -0
- package/dist/models/lead-class.d.ts +157 -0
- package/dist/models/lead-class.js +15 -0
- package/dist/models/list-accounts-response-class.d.ts +31 -0
- package/dist/models/list-accounts-response-class.js +15 -0
- package/dist/models/list-leads-response-class.d.ts +43 -0
- package/dist/models/list-leads-response-class.js +15 -0
- package/dist/models/list-partners-response-class.d.ts +31 -0
- package/dist/models/list-partners-response-class.js +15 -0
- package/dist/models/list-policies-response-class.d.ts +43 -0
- package/dist/models/list-policies-response-class.js +15 -0
- package/dist/models/omit-type-class.d.ts +84 -0
- package/dist/models/omit-type-class.js +15 -0
- package/dist/models/partner-class.d.ts +103 -0
- package/dist/models/partner-class.js +15 -0
- package/dist/models/partner-link-class.d.ts +98 -0
- package/dist/models/partner-link-class.js +15 -0
- package/dist/models/partner-role-class.d.ts +72 -0
- package/dist/models/partner-role-class.js +15 -0
- package/dist/models/policy-class.d.ts +147 -0
- package/dist/models/policy-class.js +15 -0
- package/dist/models/policy-object-class.d.ts +84 -0
- package/dist/models/policy-object-class.js +15 -0
- package/dist/models/policy-premium-class.d.ts +61 -0
- package/dist/models/policy-premium-class.js +15 -0
- package/dist/models/policy-premium-item-class.d.ts +67 -0
- package/dist/models/policy-premium-item-class.js +15 -0
- package/dist/models/policy-version-class.d.ts +79 -0
- package/dist/models/policy-version-class.js +15 -0
- package/dist/models/premium-formula-class.d.ts +108 -0
- package/dist/models/premium-formula-class.js +15 -0
- package/dist/models/premium-override-dto.d.ts +55 -0
- package/dist/models/premium-override-dto.js +27 -0
- package/dist/models/premium-override-request-dto.d.ts +25 -0
- package/dist/models/premium-override-request-dto.js +15 -0
- package/dist/models/product-class.d.ts +92 -0
- package/dist/models/product-class.js +15 -0
- package/dist/models/product-version-class.d.ts +73 -0
- package/dist/models/product-version-class.js +22 -0
- package/dist/models/sepa-dto.d.ts +30 -0
- package/dist/models/sepa-dto.js +15 -0
- package/dist/models/tag-class.d.ts +54 -0
- package/dist/models/tag-class.js +15 -0
- package/dist/models/timeslice-class.d.ts +74 -0
- package/dist/models/timeslice-class.js +15 -0
- package/dist/models/uploaded-document-dto.d.ts +24 -0
- package/dist/models/uploaded-document-dto.js +15 -0
- package/git_push.sh +57 -0
- package/index.ts +19 -0
- package/models/account-class.ts +185 -0
- package/models/account-policy-class.ts +153 -0
- package/models/create-payment-method-request-dto.ts +37 -0
- package/models/create-policy-request-dto.ts +61 -0
- package/models/index.ts +34 -0
- package/models/inline-response200.ts +48 -0
- package/models/inline-response503.ts +48 -0
- package/models/insured-object-type-class.ts +66 -0
- package/models/invoice-class.ts +160 -0
- package/models/invoice-item-class.ts +126 -0
- package/models/invoice-status-class.ts +56 -0
- package/models/lead-bank-account-class.ts +36 -0
- package/models/lead-class.ts +163 -0
- package/models/list-accounts-response-class.ts +37 -0
- package/models/list-leads-response-class.ts +49 -0
- package/models/list-partners-response-class.ts +37 -0
- package/models/list-policies-response-class.ts +49 -0
- package/models/omit-type-class.ts +90 -0
- package/models/partner-class.ts +109 -0
- package/models/partner-link-class.ts +104 -0
- package/models/partner-role-class.ts +78 -0
- package/models/policy-class.ts +153 -0
- package/models/policy-object-class.ts +90 -0
- package/models/policy-premium-class.ts +67 -0
- package/models/policy-premium-item-class.ts +73 -0
- package/models/policy-version-class.ts +85 -0
- package/models/premium-formula-class.ts +114 -0
- package/models/premium-override-dto.ts +65 -0
- package/models/premium-override-request-dto.ts +31 -0
- package/models/product-class.ts +98 -0
- package/models/product-version-class.ts +82 -0
- package/models/sepa-dto.ts +36 -0
- package/models/tag-class.ts +60 -0
- package/models/timeslice-class.ts +80 -0
- package/models/uploaded-document-dto.ts +30 -0
- package/package.json +29 -0
- package/tsconfig.json +22 -0
|
@@ -0,0 +1,704 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* EMIL PartnerPortal
|
|
3
|
+
* The EMIL PartnerPortal API description
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0
|
|
6
|
+
* Contact: kontakt@emil.de
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
13
|
+
import { Configuration } from '../configuration';
|
|
14
|
+
import { RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import { AccountClass } from '../models';
|
|
16
|
+
import { LeadClass } from '../models';
|
|
17
|
+
import { ListAccountsResponseClass } from '../models';
|
|
18
|
+
import { ListLeadsResponseClass } from '../models';
|
|
19
|
+
import { ListPartnersResponseClass } from '../models';
|
|
20
|
+
import { ListPoliciesResponseClass } from '../models';
|
|
21
|
+
import { PartnerClass } from '../models';
|
|
22
|
+
import { PolicyClass } from '../models';
|
|
23
|
+
/**
|
|
24
|
+
* IntermediaryApi - axios parameter creator
|
|
25
|
+
* @export
|
|
26
|
+
*/
|
|
27
|
+
export declare const IntermediaryApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
28
|
+
/**
|
|
29
|
+
* Retrieves the details of the lead that was previously created. Supply the unique lead code that was returned when you created it and Emil Api will return the corresponding lead information.
|
|
30
|
+
* @summary Retrieve the lead
|
|
31
|
+
* @param {string} code Unique identifier for the object.
|
|
32
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
33
|
+
* @param {*} [options] Override http request option.
|
|
34
|
+
* @throws {RequiredError}
|
|
35
|
+
*/
|
|
36
|
+
getLead: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37
|
+
/**
|
|
38
|
+
* Retrieves the details of the partner that was previously created. Supply the unique partner code that was returned when you created it and Emil Api will return the corresponding partner information.
|
|
39
|
+
* @summary Retrieve the partner
|
|
40
|
+
* @param {string} code Unique identifier for the object.
|
|
41
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
42
|
+
* @param {*} [options] Override http request option.
|
|
43
|
+
* @throws {RequiredError}
|
|
44
|
+
*/
|
|
45
|
+
getPartner: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46
|
+
/**
|
|
47
|
+
* Retrieves the details of the policy that was previously created. Supply the unique policy code that was returned when you created it and Emil Api will return the corresponding policy information.
|
|
48
|
+
* @summary Retrieve the policy
|
|
49
|
+
* @param {string} code Unique identifier for the object.
|
|
50
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
51
|
+
* @param {*} [options] Override http request option.
|
|
52
|
+
* @throws {RequiredError}
|
|
53
|
+
*/
|
|
54
|
+
getPolicy: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55
|
+
/**
|
|
56
|
+
* Retrieves the details of the policyholder that was previously created. Supply the unique policyholder code that was returned when you created it and Emil Api will return the corresponding policyholder information.
|
|
57
|
+
* @summary Retrieve the policyholder
|
|
58
|
+
* @param {string} code Unique identifier for the object.
|
|
59
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
60
|
+
* @param {*} [options] Override http request option.
|
|
61
|
+
* @throws {RequiredError}
|
|
62
|
+
*/
|
|
63
|
+
getPolicyholder: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
64
|
+
/**
|
|
65
|
+
* Returns a list of leads you have previously created. The leads are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
66
|
+
* @summary List leads
|
|
67
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
68
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
69
|
+
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
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 {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
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
|
+
* @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
|
+
* @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
|
+
* @param {*} [options] Override http request option.
|
|
76
|
+
* @throws {RequiredError}
|
|
77
|
+
*/
|
|
78
|
+
listLeads: (authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
79
|
+
/**
|
|
80
|
+
* Returns a list of partners you have previously created. The partners are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
81
|
+
* @summary List partners
|
|
82
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
83
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
84
|
+
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
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 {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
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
|
+
* @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
|
+
* @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
|
+
* @param {*} [options] Override http request option.
|
|
91
|
+
* @throws {RequiredError}
|
|
92
|
+
*/
|
|
93
|
+
listPartners: (authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
94
|
+
/**
|
|
95
|
+
* Returns a list of policies you have previously created. The policies are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
96
|
+
* @summary List policies
|
|
97
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
98
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
99
|
+
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
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 {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
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
|
+
* @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
|
+
* @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
|
+
* @param {*} [options] Override http request option.
|
|
106
|
+
* @throws {RequiredError}
|
|
107
|
+
*/
|
|
108
|
+
listPolicies: (authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
109
|
+
/**
|
|
110
|
+
* Returns a list of policyholders you have previously created. The policyholders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
111
|
+
* @summary List policyholders
|
|
112
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
113
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
114
|
+
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
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 {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
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
|
+
* @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
|
+
* @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
|
+
* @param {*} [options] Override http request option.
|
|
121
|
+
* @throws {RequiredError}
|
|
122
|
+
*/
|
|
123
|
+
listPolicyholders: (authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
124
|
+
};
|
|
125
|
+
/**
|
|
126
|
+
* IntermediaryApi - functional programming interface
|
|
127
|
+
* @export
|
|
128
|
+
*/
|
|
129
|
+
export declare const IntermediaryApiFp: (configuration?: Configuration) => {
|
|
130
|
+
/**
|
|
131
|
+
* Retrieves the details of the lead that was previously created. Supply the unique lead code that was returned when you created it and Emil Api will return the corresponding lead information.
|
|
132
|
+
* @summary Retrieve the lead
|
|
133
|
+
* @param {string} code Unique identifier for the object.
|
|
134
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
135
|
+
* @param {*} [options] Override http request option.
|
|
136
|
+
* @throws {RequiredError}
|
|
137
|
+
*/
|
|
138
|
+
getLead(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LeadClass>>;
|
|
139
|
+
/**
|
|
140
|
+
* Retrieves the details of the partner that was previously created. Supply the unique partner code that was returned when you created it and Emil Api will return the corresponding partner information.
|
|
141
|
+
* @summary Retrieve the partner
|
|
142
|
+
* @param {string} code Unique identifier for the object.
|
|
143
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
144
|
+
* @param {*} [options] Override http request option.
|
|
145
|
+
* @throws {RequiredError}
|
|
146
|
+
*/
|
|
147
|
+
getPartner(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PartnerClass>>;
|
|
148
|
+
/**
|
|
149
|
+
* Retrieves the details of the policy that was previously created. Supply the unique policy code that was returned when you created it and Emil Api will return the corresponding policy information.
|
|
150
|
+
* @summary Retrieve the policy
|
|
151
|
+
* @param {string} code Unique identifier for the object.
|
|
152
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
153
|
+
* @param {*} [options] Override http request option.
|
|
154
|
+
* @throws {RequiredError}
|
|
155
|
+
*/
|
|
156
|
+
getPolicy(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PolicyClass>>;
|
|
157
|
+
/**
|
|
158
|
+
* Retrieves the details of the policyholder that was previously created. Supply the unique policyholder code that was returned when you created it and Emil Api will return the corresponding policyholder information.
|
|
159
|
+
* @summary Retrieve the policyholder
|
|
160
|
+
* @param {string} code Unique identifier for the object.
|
|
161
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
162
|
+
* @param {*} [options] Override http request option.
|
|
163
|
+
* @throws {RequiredError}
|
|
164
|
+
*/
|
|
165
|
+
getPolicyholder(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountClass>>;
|
|
166
|
+
/**
|
|
167
|
+
* Returns a list of leads you have previously created. The leads are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
168
|
+
* @summary List leads
|
|
169
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
170
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
171
|
+
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
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 {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
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
|
+
* @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
|
+
* @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
|
+
* @param {*} [options] Override http request option.
|
|
178
|
+
* @throws {RequiredError}
|
|
179
|
+
*/
|
|
180
|
+
listLeads(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListLeadsResponseClass>>;
|
|
181
|
+
/**
|
|
182
|
+
* Returns a list of partners you have previously created. The partners are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
183
|
+
* @summary List partners
|
|
184
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
185
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
186
|
+
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
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 {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
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
|
+
* @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
|
+
* @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
|
+
* @param {*} [options] Override http request option.
|
|
193
|
+
* @throws {RequiredError}
|
|
194
|
+
*/
|
|
195
|
+
listPartners(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPartnersResponseClass>>;
|
|
196
|
+
/**
|
|
197
|
+
* Returns a list of policies you have previously created. The policies are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
198
|
+
* @summary List policies
|
|
199
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
200
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
201
|
+
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
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 {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
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
|
+
* @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
|
+
* @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
|
+
* @param {*} [options] Override http request option.
|
|
208
|
+
* @throws {RequiredError}
|
|
209
|
+
*/
|
|
210
|
+
listPolicies(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPoliciesResponseClass>>;
|
|
211
|
+
/**
|
|
212
|
+
* Returns a list of policyholders you have previously created. The policyholders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
213
|
+
* @summary List policyholders
|
|
214
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
215
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
216
|
+
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
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 {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
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
|
+
* @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
|
+
* @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
|
+
* @param {*} [options] Override http request option.
|
|
223
|
+
* @throws {RequiredError}
|
|
224
|
+
*/
|
|
225
|
+
listPolicyholders(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListAccountsResponseClass>>;
|
|
226
|
+
};
|
|
227
|
+
/**
|
|
228
|
+
* IntermediaryApi - factory interface
|
|
229
|
+
* @export
|
|
230
|
+
*/
|
|
231
|
+
export declare const IntermediaryApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
232
|
+
/**
|
|
233
|
+
* Retrieves the details of the lead that was previously created. Supply the unique lead code that was returned when you created it and Emil Api will return the corresponding lead information.
|
|
234
|
+
* @summary Retrieve the lead
|
|
235
|
+
* @param {string} code Unique identifier for the object.
|
|
236
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
237
|
+
* @param {*} [options] Override http request option.
|
|
238
|
+
* @throws {RequiredError}
|
|
239
|
+
*/
|
|
240
|
+
getLead(code: string, authorization?: string, options?: any): AxiosPromise<LeadClass>;
|
|
241
|
+
/**
|
|
242
|
+
* Retrieves the details of the partner that was previously created. Supply the unique partner code that was returned when you created it and Emil Api will return the corresponding partner information.
|
|
243
|
+
* @summary Retrieve the partner
|
|
244
|
+
* @param {string} code Unique identifier for the object.
|
|
245
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
246
|
+
* @param {*} [options] Override http request option.
|
|
247
|
+
* @throws {RequiredError}
|
|
248
|
+
*/
|
|
249
|
+
getPartner(code: string, authorization?: string, options?: any): AxiosPromise<PartnerClass>;
|
|
250
|
+
/**
|
|
251
|
+
* Retrieves the details of the policy that was previously created. Supply the unique policy code that was returned when you created it and Emil Api will return the corresponding policy information.
|
|
252
|
+
* @summary Retrieve the policy
|
|
253
|
+
* @param {string} code Unique identifier for the object.
|
|
254
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
255
|
+
* @param {*} [options] Override http request option.
|
|
256
|
+
* @throws {RequiredError}
|
|
257
|
+
*/
|
|
258
|
+
getPolicy(code: string, authorization?: string, options?: any): AxiosPromise<PolicyClass>;
|
|
259
|
+
/**
|
|
260
|
+
* Retrieves the details of the policyholder that was previously created. Supply the unique policyholder code that was returned when you created it and Emil Api will return the corresponding policyholder information.
|
|
261
|
+
* @summary Retrieve the policyholder
|
|
262
|
+
* @param {string} code Unique identifier for the object.
|
|
263
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
264
|
+
* @param {*} [options] Override http request option.
|
|
265
|
+
* @throws {RequiredError}
|
|
266
|
+
*/
|
|
267
|
+
getPolicyholder(code: string, authorization?: string, options?: any): AxiosPromise<AccountClass>;
|
|
268
|
+
/**
|
|
269
|
+
* Returns a list of leads you have previously created. The leads are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
270
|
+
* @summary List leads
|
|
271
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
272
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
273
|
+
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
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 {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
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
|
+
* @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
|
+
* @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
|
+
* @param {*} [options] Override http request option.
|
|
280
|
+
* @throws {RequiredError}
|
|
281
|
+
*/
|
|
282
|
+
listLeads(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListLeadsResponseClass>;
|
|
283
|
+
/**
|
|
284
|
+
* Returns a list of partners you have previously created. The partners are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
285
|
+
* @summary List partners
|
|
286
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
287
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
288
|
+
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
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 {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
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
|
+
* @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
|
+
* @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
|
+
* @param {*} [options] Override http request option.
|
|
295
|
+
* @throws {RequiredError}
|
|
296
|
+
*/
|
|
297
|
+
listPartners(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnersResponseClass>;
|
|
298
|
+
/**
|
|
299
|
+
* Returns a list of policies you have previously created. The policies are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
300
|
+
* @summary List policies
|
|
301
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
302
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
303
|
+
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
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 {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
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
|
+
* @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
|
+
* @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
|
+
* @param {*} [options] Override http request option.
|
|
310
|
+
* @throws {RequiredError}
|
|
311
|
+
*/
|
|
312
|
+
listPolicies(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPoliciesResponseClass>;
|
|
313
|
+
/**
|
|
314
|
+
* Returns a list of policyholders you have previously created. The policyholders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
315
|
+
* @summary List policyholders
|
|
316
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
317
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
318
|
+
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
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 {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
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
|
+
* @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
|
+
* @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
|
+
* @param {*} [options] Override http request option.
|
|
325
|
+
* @throws {RequiredError}
|
|
326
|
+
*/
|
|
327
|
+
listPolicyholders(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListAccountsResponseClass>;
|
|
328
|
+
};
|
|
329
|
+
/**
|
|
330
|
+
* Request parameters for getLead operation in IntermediaryApi.
|
|
331
|
+
* @export
|
|
332
|
+
* @interface IntermediaryApiGetLeadRequest
|
|
333
|
+
*/
|
|
334
|
+
export interface IntermediaryApiGetLeadRequest {
|
|
335
|
+
/**
|
|
336
|
+
* Unique identifier for the object.
|
|
337
|
+
* @type {string}
|
|
338
|
+
* @memberof IntermediaryApiGetLead
|
|
339
|
+
*/
|
|
340
|
+
readonly code: string;
|
|
341
|
+
/**
|
|
342
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
343
|
+
* @type {string}
|
|
344
|
+
* @memberof IntermediaryApiGetLead
|
|
345
|
+
*/
|
|
346
|
+
readonly authorization?: string;
|
|
347
|
+
}
|
|
348
|
+
/**
|
|
349
|
+
* Request parameters for getPartner operation in IntermediaryApi.
|
|
350
|
+
* @export
|
|
351
|
+
* @interface IntermediaryApiGetPartnerRequest
|
|
352
|
+
*/
|
|
353
|
+
export interface IntermediaryApiGetPartnerRequest {
|
|
354
|
+
/**
|
|
355
|
+
* Unique identifier for the object.
|
|
356
|
+
* @type {string}
|
|
357
|
+
* @memberof IntermediaryApiGetPartner
|
|
358
|
+
*/
|
|
359
|
+
readonly code: string;
|
|
360
|
+
/**
|
|
361
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
362
|
+
* @type {string}
|
|
363
|
+
* @memberof IntermediaryApiGetPartner
|
|
364
|
+
*/
|
|
365
|
+
readonly authorization?: string;
|
|
366
|
+
}
|
|
367
|
+
/**
|
|
368
|
+
* Request parameters for getPolicy operation in IntermediaryApi.
|
|
369
|
+
* @export
|
|
370
|
+
* @interface IntermediaryApiGetPolicyRequest
|
|
371
|
+
*/
|
|
372
|
+
export interface IntermediaryApiGetPolicyRequest {
|
|
373
|
+
/**
|
|
374
|
+
* Unique identifier for the object.
|
|
375
|
+
* @type {string}
|
|
376
|
+
* @memberof IntermediaryApiGetPolicy
|
|
377
|
+
*/
|
|
378
|
+
readonly code: string;
|
|
379
|
+
/**
|
|
380
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
381
|
+
* @type {string}
|
|
382
|
+
* @memberof IntermediaryApiGetPolicy
|
|
383
|
+
*/
|
|
384
|
+
readonly authorization?: string;
|
|
385
|
+
}
|
|
386
|
+
/**
|
|
387
|
+
* Request parameters for getPolicyholder operation in IntermediaryApi.
|
|
388
|
+
* @export
|
|
389
|
+
* @interface IntermediaryApiGetPolicyholderRequest
|
|
390
|
+
*/
|
|
391
|
+
export interface IntermediaryApiGetPolicyholderRequest {
|
|
392
|
+
/**
|
|
393
|
+
* Unique identifier for the object.
|
|
394
|
+
* @type {string}
|
|
395
|
+
* @memberof IntermediaryApiGetPolicyholder
|
|
396
|
+
*/
|
|
397
|
+
readonly code: string;
|
|
398
|
+
/**
|
|
399
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
400
|
+
* @type {string}
|
|
401
|
+
* @memberof IntermediaryApiGetPolicyholder
|
|
402
|
+
*/
|
|
403
|
+
readonly authorization?: string;
|
|
404
|
+
}
|
|
405
|
+
/**
|
|
406
|
+
* Request parameters for listLeads operation in IntermediaryApi.
|
|
407
|
+
* @export
|
|
408
|
+
* @interface IntermediaryApiListLeadsRequest
|
|
409
|
+
*/
|
|
410
|
+
export interface IntermediaryApiListLeadsRequest {
|
|
411
|
+
/**
|
|
412
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
413
|
+
* @type {string}
|
|
414
|
+
* @memberof IntermediaryApiListLeads
|
|
415
|
+
*/
|
|
416
|
+
readonly authorization?: string;
|
|
417
|
+
/**
|
|
418
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
419
|
+
* @type {any}
|
|
420
|
+
* @memberof IntermediaryApiListLeads
|
|
421
|
+
*/
|
|
422
|
+
readonly pageSize?: any;
|
|
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, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
425
|
+
* @type {any}
|
|
426
|
+
* @memberof IntermediaryApiListLeads
|
|
427
|
+
*/
|
|
428
|
+
readonly pageToken?: any;
|
|
429
|
+
/**
|
|
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
|
+
* @type {string}
|
|
432
|
+
* @memberof IntermediaryApiListLeads
|
|
433
|
+
*/
|
|
434
|
+
readonly filter?: string;
|
|
435
|
+
/**
|
|
436
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
437
|
+
* @type {any}
|
|
438
|
+
* @memberof IntermediaryApiListLeads
|
|
439
|
+
*/
|
|
440
|
+
readonly search?: any;
|
|
441
|
+
/**
|
|
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
|
+
* @type {string}
|
|
444
|
+
* @memberof IntermediaryApiListLeads
|
|
445
|
+
*/
|
|
446
|
+
readonly order?: string;
|
|
447
|
+
/**
|
|
448
|
+
* 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>
|
|
449
|
+
* @type {string}
|
|
450
|
+
* @memberof IntermediaryApiListLeads
|
|
451
|
+
*/
|
|
452
|
+
readonly expand?: string;
|
|
453
|
+
/**
|
|
454
|
+
* 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>
|
|
455
|
+
* @type {string}
|
|
456
|
+
* @memberof IntermediaryApiListLeads
|
|
457
|
+
*/
|
|
458
|
+
readonly filters?: string;
|
|
459
|
+
}
|
|
460
|
+
/**
|
|
461
|
+
* Request parameters for listPartners operation in IntermediaryApi.
|
|
462
|
+
* @export
|
|
463
|
+
* @interface IntermediaryApiListPartnersRequest
|
|
464
|
+
*/
|
|
465
|
+
export interface IntermediaryApiListPartnersRequest {
|
|
466
|
+
/**
|
|
467
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
468
|
+
* @type {string}
|
|
469
|
+
* @memberof IntermediaryApiListPartners
|
|
470
|
+
*/
|
|
471
|
+
readonly authorization?: string;
|
|
472
|
+
/**
|
|
473
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
474
|
+
* @type {any}
|
|
475
|
+
* @memberof IntermediaryApiListPartners
|
|
476
|
+
*/
|
|
477
|
+
readonly pageSize?: any;
|
|
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, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
480
|
+
* @type {any}
|
|
481
|
+
* @memberof IntermediaryApiListPartners
|
|
482
|
+
*/
|
|
483
|
+
readonly pageToken?: any;
|
|
484
|
+
/**
|
|
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
|
+
* @type {string}
|
|
487
|
+
* @memberof IntermediaryApiListPartners
|
|
488
|
+
*/
|
|
489
|
+
readonly filter?: string;
|
|
490
|
+
/**
|
|
491
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
492
|
+
* @type {any}
|
|
493
|
+
* @memberof IntermediaryApiListPartners
|
|
494
|
+
*/
|
|
495
|
+
readonly search?: any;
|
|
496
|
+
/**
|
|
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
|
+
* @type {string}
|
|
499
|
+
* @memberof IntermediaryApiListPartners
|
|
500
|
+
*/
|
|
501
|
+
readonly order?: string;
|
|
502
|
+
/**
|
|
503
|
+
* 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>
|
|
504
|
+
* @type {string}
|
|
505
|
+
* @memberof IntermediaryApiListPartners
|
|
506
|
+
*/
|
|
507
|
+
readonly expand?: string;
|
|
508
|
+
/**
|
|
509
|
+
* 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>
|
|
510
|
+
* @type {string}
|
|
511
|
+
* @memberof IntermediaryApiListPartners
|
|
512
|
+
*/
|
|
513
|
+
readonly filters?: string;
|
|
514
|
+
}
|
|
515
|
+
/**
|
|
516
|
+
* Request parameters for listPolicies operation in IntermediaryApi.
|
|
517
|
+
* @export
|
|
518
|
+
* @interface IntermediaryApiListPoliciesRequest
|
|
519
|
+
*/
|
|
520
|
+
export interface IntermediaryApiListPoliciesRequest {
|
|
521
|
+
/**
|
|
522
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
523
|
+
* @type {string}
|
|
524
|
+
* @memberof IntermediaryApiListPolicies
|
|
525
|
+
*/
|
|
526
|
+
readonly authorization?: string;
|
|
527
|
+
/**
|
|
528
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
529
|
+
* @type {any}
|
|
530
|
+
* @memberof IntermediaryApiListPolicies
|
|
531
|
+
*/
|
|
532
|
+
readonly pageSize?: any;
|
|
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, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
535
|
+
* @type {any}
|
|
536
|
+
* @memberof IntermediaryApiListPolicies
|
|
537
|
+
*/
|
|
538
|
+
readonly pageToken?: any;
|
|
539
|
+
/**
|
|
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
|
+
* @type {string}
|
|
542
|
+
* @memberof IntermediaryApiListPolicies
|
|
543
|
+
*/
|
|
544
|
+
readonly filter?: string;
|
|
545
|
+
/**
|
|
546
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
547
|
+
* @type {any}
|
|
548
|
+
* @memberof IntermediaryApiListPolicies
|
|
549
|
+
*/
|
|
550
|
+
readonly search?: any;
|
|
551
|
+
/**
|
|
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
|
+
* @type {string}
|
|
554
|
+
* @memberof IntermediaryApiListPolicies
|
|
555
|
+
*/
|
|
556
|
+
readonly order?: string;
|
|
557
|
+
/**
|
|
558
|
+
* 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>
|
|
559
|
+
* @type {string}
|
|
560
|
+
* @memberof IntermediaryApiListPolicies
|
|
561
|
+
*/
|
|
562
|
+
readonly expand?: string;
|
|
563
|
+
/**
|
|
564
|
+
* 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>
|
|
565
|
+
* @type {string}
|
|
566
|
+
* @memberof IntermediaryApiListPolicies
|
|
567
|
+
*/
|
|
568
|
+
readonly filters?: string;
|
|
569
|
+
}
|
|
570
|
+
/**
|
|
571
|
+
* Request parameters for listPolicyholders operation in IntermediaryApi.
|
|
572
|
+
* @export
|
|
573
|
+
* @interface IntermediaryApiListPolicyholdersRequest
|
|
574
|
+
*/
|
|
575
|
+
export interface IntermediaryApiListPolicyholdersRequest {
|
|
576
|
+
/**
|
|
577
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
578
|
+
* @type {string}
|
|
579
|
+
* @memberof IntermediaryApiListPolicyholders
|
|
580
|
+
*/
|
|
581
|
+
readonly authorization?: string;
|
|
582
|
+
/**
|
|
583
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
584
|
+
* @type {any}
|
|
585
|
+
* @memberof IntermediaryApiListPolicyholders
|
|
586
|
+
*/
|
|
587
|
+
readonly pageSize?: any;
|
|
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, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
590
|
+
* @type {any}
|
|
591
|
+
* @memberof IntermediaryApiListPolicyholders
|
|
592
|
+
*/
|
|
593
|
+
readonly pageToken?: any;
|
|
594
|
+
/**
|
|
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
|
+
* @type {string}
|
|
597
|
+
* @memberof IntermediaryApiListPolicyholders
|
|
598
|
+
*/
|
|
599
|
+
readonly filter?: string;
|
|
600
|
+
/**
|
|
601
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
602
|
+
* @type {any}
|
|
603
|
+
* @memberof IntermediaryApiListPolicyholders
|
|
604
|
+
*/
|
|
605
|
+
readonly search?: any;
|
|
606
|
+
/**
|
|
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
|
+
* @type {string}
|
|
609
|
+
* @memberof IntermediaryApiListPolicyholders
|
|
610
|
+
*/
|
|
611
|
+
readonly order?: string;
|
|
612
|
+
/**
|
|
613
|
+
* 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>
|
|
614
|
+
* @type {string}
|
|
615
|
+
* @memberof IntermediaryApiListPolicyholders
|
|
616
|
+
*/
|
|
617
|
+
readonly expand?: string;
|
|
618
|
+
/**
|
|
619
|
+
* 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>
|
|
620
|
+
* @type {string}
|
|
621
|
+
* @memberof IntermediaryApiListPolicyholders
|
|
622
|
+
*/
|
|
623
|
+
readonly filters?: string;
|
|
624
|
+
}
|
|
625
|
+
/**
|
|
626
|
+
* IntermediaryApi - object-oriented interface
|
|
627
|
+
* @export
|
|
628
|
+
* @class IntermediaryApi
|
|
629
|
+
* @extends {BaseAPI}
|
|
630
|
+
*/
|
|
631
|
+
export declare class IntermediaryApi extends BaseAPI {
|
|
632
|
+
/**
|
|
633
|
+
* Retrieves the details of the lead that was previously created. Supply the unique lead code that was returned when you created it and Emil Api will return the corresponding lead information.
|
|
634
|
+
* @summary Retrieve the lead
|
|
635
|
+
* @param {IntermediaryApiGetLeadRequest} requestParameters Request parameters.
|
|
636
|
+
* @param {*} [options] Override http request option.
|
|
637
|
+
* @throws {RequiredError}
|
|
638
|
+
* @memberof IntermediaryApi
|
|
639
|
+
*/
|
|
640
|
+
getLead(requestParameters: IntermediaryApiGetLeadRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LeadClass, any>>;
|
|
641
|
+
/**
|
|
642
|
+
* Retrieves the details of the partner that was previously created. Supply the unique partner code that was returned when you created it and Emil Api will return the corresponding partner information.
|
|
643
|
+
* @summary Retrieve the partner
|
|
644
|
+
* @param {IntermediaryApiGetPartnerRequest} requestParameters Request parameters.
|
|
645
|
+
* @param {*} [options] Override http request option.
|
|
646
|
+
* @throws {RequiredError}
|
|
647
|
+
* @memberof IntermediaryApi
|
|
648
|
+
*/
|
|
649
|
+
getPartner(requestParameters: IntermediaryApiGetPartnerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PartnerClass, any>>;
|
|
650
|
+
/**
|
|
651
|
+
* Retrieves the details of the policy that was previously created. Supply the unique policy code that was returned when you created it and Emil Api will return the corresponding policy information.
|
|
652
|
+
* @summary Retrieve the policy
|
|
653
|
+
* @param {IntermediaryApiGetPolicyRequest} requestParameters Request parameters.
|
|
654
|
+
* @param {*} [options] Override http request option.
|
|
655
|
+
* @throws {RequiredError}
|
|
656
|
+
* @memberof IntermediaryApi
|
|
657
|
+
*/
|
|
658
|
+
getPolicy(requestParameters: IntermediaryApiGetPolicyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PolicyClass, any>>;
|
|
659
|
+
/**
|
|
660
|
+
* Retrieves the details of the policyholder that was previously created. Supply the unique policyholder code that was returned when you created it and Emil Api will return the corresponding policyholder information.
|
|
661
|
+
* @summary Retrieve the policyholder
|
|
662
|
+
* @param {IntermediaryApiGetPolicyholderRequest} requestParameters Request parameters.
|
|
663
|
+
* @param {*} [options] Override http request option.
|
|
664
|
+
* @throws {RequiredError}
|
|
665
|
+
* @memberof IntermediaryApi
|
|
666
|
+
*/
|
|
667
|
+
getPolicyholder(requestParameters: IntermediaryApiGetPolicyholderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountClass, any>>;
|
|
668
|
+
/**
|
|
669
|
+
* Returns a list of leads you have previously created. The leads are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
670
|
+
* @summary List leads
|
|
671
|
+
* @param {IntermediaryApiListLeadsRequest} requestParameters Request parameters.
|
|
672
|
+
* @param {*} [options] Override http request option.
|
|
673
|
+
* @throws {RequiredError}
|
|
674
|
+
* @memberof IntermediaryApi
|
|
675
|
+
*/
|
|
676
|
+
listLeads(requestParameters?: IntermediaryApiListLeadsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListLeadsResponseClass, any>>;
|
|
677
|
+
/**
|
|
678
|
+
* Returns a list of partners you have previously created. The partners are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
679
|
+
* @summary List partners
|
|
680
|
+
* @param {IntermediaryApiListPartnersRequest} requestParameters Request parameters.
|
|
681
|
+
* @param {*} [options] Override http request option.
|
|
682
|
+
* @throws {RequiredError}
|
|
683
|
+
* @memberof IntermediaryApi
|
|
684
|
+
*/
|
|
685
|
+
listPartners(requestParameters?: IntermediaryApiListPartnersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPartnersResponseClass, any>>;
|
|
686
|
+
/**
|
|
687
|
+
* Returns a list of policies you have previously created. The policies are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
688
|
+
* @summary List policies
|
|
689
|
+
* @param {IntermediaryApiListPoliciesRequest} requestParameters Request parameters.
|
|
690
|
+
* @param {*} [options] Override http request option.
|
|
691
|
+
* @throws {RequiredError}
|
|
692
|
+
* @memberof IntermediaryApi
|
|
693
|
+
*/
|
|
694
|
+
listPolicies(requestParameters?: IntermediaryApiListPoliciesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPoliciesResponseClass, any>>;
|
|
695
|
+
/**
|
|
696
|
+
* Returns a list of policyholders you have previously created. The policyholders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
697
|
+
* @summary List policyholders
|
|
698
|
+
* @param {IntermediaryApiListPolicyholdersRequest} requestParameters Request parameters.
|
|
699
|
+
* @param {*} [options] Override http request option.
|
|
700
|
+
* @throws {RequiredError}
|
|
701
|
+
* @memberof IntermediaryApi
|
|
702
|
+
*/
|
|
703
|
+
listPolicyholders(requestParameters?: IntermediaryApiListPolicyholdersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListAccountsResponseClass, any>>;
|
|
704
|
+
}
|