@emilgroup/insurance-sdk-node 1.49.1 → 1.50.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 +18 -8
- package/README.md +2 -2
- package/api/partner-links-api.ts +800 -0
- package/api/partner-roles-api.ts +683 -0
- package/api/policies-api.ts +13 -13
- package/api.ts +4 -2
- package/dist/api/partner-links-api.d.ts +450 -0
- package/dist/api/partner-links-api.js +738 -0
- package/dist/api/partner-roles-api.d.ts +385 -0
- package/dist/api/{policy-partner-roles-api.js → partner-roles-api.js} +136 -136
- package/dist/api/policies-api.d.ts +13 -13
- package/dist/api/policies-api.js +6 -6
- package/dist/api.d.ts +2 -1
- package/dist/api.js +2 -1
- package/dist/models/create-account-request-dto.d.ts +1 -1
- package/dist/models/create-account-request-dto.js +1 -1
- package/dist/models/create-lead-request-dto.d.ts +12 -0
- package/dist/models/{update-policy-partner-role-request-dto.d.ts → create-partner-role-request-dto.d.ts} +5 -5
- package/dist/models/{get-policy-partner-role-response-class.d.ts → create-partner-role-response-class.d.ts} +7 -7
- package/dist/models/{update-policy-partner-role-response-class.d.ts → get-partner-link-response-class.d.ts} +7 -7
- package/dist/models/{create-policy-partner-role-response-class.d.ts → get-partner-role-response-class.d.ts} +7 -7
- package/dist/models/index.d.ts +16 -7
- package/dist/models/index.js +16 -7
- package/dist/models/lead-class.d.ts +7 -0
- package/dist/models/link-partner-request-dto.d.ts +54 -0
- package/dist/models/link-partner-response-class.d.ts +25 -0
- package/dist/models/{list-policy-partner-roles-response-class.d.ts → list-partner-links-response-class.d.ts} +8 -8
- package/dist/models/list-partner-roles-response-class.d.ts +31 -0
- package/dist/models/list-partner-roles-response-class.js +15 -0
- package/dist/models/partner-class.d.ts +60 -0
- package/dist/models/partner-class.js +15 -0
- package/dist/models/partner-link-class.d.ts +86 -0
- package/dist/models/partner-link-class.js +15 -0
- package/dist/models/{policy-partner-role-class.d.ts → partner-role-class.d.ts} +9 -9
- package/dist/models/partner-role-class.js +15 -0
- package/dist/models/policy-class.d.ts +7 -0
- package/dist/models/unlink-partner-response-class.d.ts +25 -0
- package/dist/models/unlink-partner-response-class.js +15 -0
- package/dist/models/update-partner-link-request-dto.d.ts +30 -0
- package/dist/models/update-partner-link-request-dto.js +15 -0
- package/dist/models/update-partner-link-response-class.d.ts +25 -0
- package/dist/models/update-partner-link-response-class.js +15 -0
- package/dist/models/{create-policy-partner-role-request-dto.d.ts → update-partner-role-request-dto.d.ts} +5 -5
- package/dist/models/update-partner-role-request-dto.js +15 -0
- package/dist/models/update-partner-role-response-class.d.ts +25 -0
- package/dist/models/update-partner-role-response-class.js +15 -0
- package/models/create-account-request-dto.ts +1 -1
- package/models/create-lead-request-dto.ts +12 -0
- package/models/{update-policy-partner-role-request-dto.ts → create-partner-role-request-dto.ts} +5 -5
- package/models/{get-policy-partner-role-response-class.ts → create-partner-role-response-class.ts} +7 -7
- package/models/{create-policy-partner-role-response-class.ts → get-partner-link-response-class.ts} +7 -7
- package/models/{update-policy-partner-role-response-class.ts → get-partner-role-response-class.ts} +7 -7
- package/models/index.ts +16 -7
- package/models/lead-class.ts +7 -0
- package/models/link-partner-request-dto.ts +60 -0
- package/models/link-partner-response-class.ts +31 -0
- package/models/{list-policy-partner-roles-response-class.ts → list-partner-links-response-class.ts} +8 -8
- package/models/list-partner-roles-response-class.ts +37 -0
- package/models/partner-class.ts +66 -0
- package/models/partner-link-class.ts +92 -0
- package/models/{policy-partner-role-class.ts → partner-role-class.ts} +9 -9
- package/models/policy-class.ts +7 -0
- package/models/unlink-partner-response-class.ts +31 -0
- package/models/update-partner-link-request-dto.ts +36 -0
- package/models/update-partner-link-response-class.ts +31 -0
- package/models/{create-policy-partner-role-request-dto.ts → update-partner-role-request-dto.ts} +5 -5
- package/models/update-partner-role-response-class.ts +31 -0
- package/package.json +1 -1
- package/api/policy-partner-roles-api.ts +0 -683
- package/dist/api/policy-partner-roles-api.d.ts +0 -385
- /package/dist/models/{create-policy-partner-role-request-dto.js → create-partner-role-request-dto.js} +0 -0
- /package/dist/models/{create-policy-partner-role-response-class.js → create-partner-role-response-class.js} +0 -0
- /package/dist/models/{get-policy-partner-role-response-class.js → get-partner-link-response-class.js} +0 -0
- /package/dist/models/{list-policy-partner-roles-response-class.js → get-partner-role-response-class.js} +0 -0
- /package/dist/models/{policy-partner-role-class.js → link-partner-request-dto.js} +0 -0
- /package/dist/models/{update-policy-partner-role-request-dto.js → link-partner-response-class.js} +0 -0
- /package/dist/models/{update-policy-partner-role-response-class.js → list-partner-links-response-class.js} +0 -0
package/api/policies-api.ts
CHANGED
|
@@ -333,11 +333,11 @@ export const PoliciesApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
333
333
|
* @summary Retrieve the policy
|
|
334
334
|
* @param {string} code Unique identifier for the object.
|
|
335
335
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
336
|
-
* @param {'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas'} [expand] You can expand policy in this endpoint. By default, versions will be an empty array.
|
|
336
|
+
* @param {'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas' | 'partnerLinks'} [expand] You can expand policy in this endpoint. \' + \'By default, versions and partnerLinks will be an empty array. Allowed values: versions, product, timelines, premiums, premiumItems, premiumFormulas, currentVersion, currentTimelines, currentPremiums, currentPremiumItems, currentPremiumFormulas, partnerLinks.
|
|
337
337
|
* @param {*} [options] Override http request option.
|
|
338
338
|
* @throws {RequiredError}
|
|
339
339
|
*/
|
|
340
|
-
getPolicy: async (code: string, authorization?: string, expand?: 'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas', options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
340
|
+
getPolicy: async (code: string, authorization?: string, expand?: 'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas' | 'partnerLinks', options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
341
341
|
// verify required parameter 'code' is not null or undefined
|
|
342
342
|
assertParamExists('getPolicy', 'code', code)
|
|
343
343
|
const localVarPath = `/insuranceservice/v1/policies/{code}`
|
|
@@ -437,7 +437,7 @@ export const PoliciesApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
437
437
|
* @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</i>
|
|
438
438
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
439
439
|
* @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>
|
|
440
|
-
* @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: versions, product, timelines, premiums, premiumItems, premiumFormulas, currentVersion, currentTimelines, currentPremiums, currentPremiumItems, currentPremiumFormulas.<i>
|
|
440
|
+
* @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: versions, product, timelines, premiums, premiumItems, premiumFormulas, currentVersion, currentTimelines, currentPremiums, currentPremiumItems, currentPremiumFormulas, partnerLinks.<i>
|
|
441
441
|
* @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</i>
|
|
442
442
|
* @param {*} [options] Override http request option.
|
|
443
443
|
* @throws {RequiredError}
|
|
@@ -1050,11 +1050,11 @@ export const PoliciesApiFp = function(configuration?: Configuration) {
|
|
|
1050
1050
|
* @summary Retrieve the policy
|
|
1051
1051
|
* @param {string} code Unique identifier for the object.
|
|
1052
1052
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1053
|
-
* @param {'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas'} [expand] You can expand policy in this endpoint. By default, versions will be an empty array.
|
|
1053
|
+
* @param {'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas' | 'partnerLinks'} [expand] You can expand policy in this endpoint. \' + \'By default, versions and partnerLinks will be an empty array. Allowed values: versions, product, timelines, premiums, premiumItems, premiumFormulas, currentVersion, currentTimelines, currentPremiums, currentPremiumItems, currentPremiumFormulas, partnerLinks.
|
|
1054
1054
|
* @param {*} [options] Override http request option.
|
|
1055
1055
|
* @throws {RequiredError}
|
|
1056
1056
|
*/
|
|
1057
|
-
async getPolicy(code: string, authorization?: string, expand?: 'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPolicyResponseClass>> {
|
|
1057
|
+
async getPolicy(code: string, authorization?: string, expand?: 'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas' | 'partnerLinks', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPolicyResponseClass>> {
|
|
1058
1058
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getPolicy(code, authorization, expand, options);
|
|
1059
1059
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1060
1060
|
},
|
|
@@ -1080,7 +1080,7 @@ export const PoliciesApiFp = function(configuration?: Configuration) {
|
|
|
1080
1080
|
* @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</i>
|
|
1081
1081
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
1082
1082
|
* @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>
|
|
1083
|
-
* @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: versions, product, timelines, premiums, premiumItems, premiumFormulas, currentVersion, currentTimelines, currentPremiums, currentPremiumItems, currentPremiumFormulas.<i>
|
|
1083
|
+
* @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: versions, product, timelines, premiums, premiumItems, premiumFormulas, currentVersion, currentTimelines, currentPremiums, currentPremiumItems, currentPremiumFormulas, partnerLinks.<i>
|
|
1084
1084
|
* @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</i>
|
|
1085
1085
|
* @param {*} [options] Override http request option.
|
|
1086
1086
|
* @throws {RequiredError}
|
|
@@ -1280,11 +1280,11 @@ export const PoliciesApiFactory = function (configuration?: Configuration, baseP
|
|
|
1280
1280
|
* @summary Retrieve the policy
|
|
1281
1281
|
* @param {string} code Unique identifier for the object.
|
|
1282
1282
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1283
|
-
* @param {'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas'} [expand] You can expand policy in this endpoint. By default, versions will be an empty array.
|
|
1283
|
+
* @param {'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas' | 'partnerLinks'} [expand] You can expand policy in this endpoint. \' + \'By default, versions and partnerLinks will be an empty array. Allowed values: versions, product, timelines, premiums, premiumItems, premiumFormulas, currentVersion, currentTimelines, currentPremiums, currentPremiumItems, currentPremiumFormulas, partnerLinks.
|
|
1284
1284
|
* @param {*} [options] Override http request option.
|
|
1285
1285
|
* @throws {RequiredError}
|
|
1286
1286
|
*/
|
|
1287
|
-
getPolicy(code: string, authorization?: string, expand?: 'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas', options?: any): AxiosPromise<GetPolicyResponseClass> {
|
|
1287
|
+
getPolicy(code: string, authorization?: string, expand?: 'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas' | 'partnerLinks', options?: any): AxiosPromise<GetPolicyResponseClass> {
|
|
1288
1288
|
return localVarFp.getPolicy(code, authorization, expand, options).then((request) => request(axios, basePath));
|
|
1289
1289
|
},
|
|
1290
1290
|
/**
|
|
@@ -1308,7 +1308,7 @@ export const PoliciesApiFactory = function (configuration?: Configuration, baseP
|
|
|
1308
1308
|
* @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</i>
|
|
1309
1309
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
1310
1310
|
* @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>
|
|
1311
|
-
* @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: versions, product, timelines, premiums, premiumItems, premiumFormulas, currentVersion, currentTimelines, currentPremiums, currentPremiumItems, currentPremiumFormulas.<i>
|
|
1311
|
+
* @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: versions, product, timelines, premiums, premiumItems, premiumFormulas, currentVersion, currentTimelines, currentPremiums, currentPremiumItems, currentPremiumFormulas, partnerLinks.<i>
|
|
1312
1312
|
* @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</i>
|
|
1313
1313
|
* @param {*} [options] Override http request option.
|
|
1314
1314
|
* @throws {RequiredError}
|
|
@@ -1588,11 +1588,11 @@ export interface PoliciesApiGetPolicyRequest {
|
|
|
1588
1588
|
readonly authorization?: string
|
|
1589
1589
|
|
|
1590
1590
|
/**
|
|
1591
|
-
* You can expand policy in this endpoint. By default, versions will be an empty array.
|
|
1592
|
-
* @type {'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas'}
|
|
1591
|
+
* You can expand policy in this endpoint. \' + \'By default, versions and partnerLinks will be an empty array. Allowed values: versions, product, timelines, premiums, premiumItems, premiumFormulas, currentVersion, currentTimelines, currentPremiums, currentPremiumItems, currentPremiumFormulas, partnerLinks.
|
|
1592
|
+
* @type {'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas' | 'partnerLinks'}
|
|
1593
1593
|
* @memberof PoliciesApiGetPolicy
|
|
1594
1594
|
*/
|
|
1595
|
-
readonly expand?: 'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas'
|
|
1595
|
+
readonly expand?: 'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas' | 'partnerLinks'
|
|
1596
1596
|
}
|
|
1597
1597
|
|
|
1598
1598
|
/**
|
|
@@ -1672,7 +1672,7 @@ export interface PoliciesApiListPoliciesRequest {
|
|
|
1672
1672
|
readonly order?: string
|
|
1673
1673
|
|
|
1674
1674
|
/**
|
|
1675
|
-
* 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: versions, product, timelines, premiums, premiumItems, premiumFormulas, currentVersion, currentTimelines, currentPremiums, currentPremiumItems, currentPremiumFormulas.<i>
|
|
1675
|
+
* 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: versions, product, timelines, premiums, premiumItems, premiumFormulas, currentVersion, currentTimelines, currentPremiums, currentPremiumItems, currentPremiumFormulas, partnerLinks.<i>
|
|
1676
1676
|
* @type {string}
|
|
1677
1677
|
* @memberof PoliciesApiListPolicies
|
|
1678
1678
|
*/
|
package/api.ts
CHANGED
|
@@ -34,8 +34,9 @@ import { LeadStatusesApi } from './api';
|
|
|
34
34
|
import { LeadVersionsApi } from './api';
|
|
35
35
|
import { LeadsApi } from './api';
|
|
36
36
|
import { NamedRangesApi } from './api';
|
|
37
|
+
import { PartnerLinksApi } from './api';
|
|
38
|
+
import { PartnerRolesApi } from './api';
|
|
37
39
|
import { PoliciesApi } from './api';
|
|
38
|
-
import { PolicyPartnerRolesApi } from './api';
|
|
39
40
|
import { PremiumFormulasApi } from './api';
|
|
40
41
|
import { ProductFactorsApi } from './api';
|
|
41
42
|
import { ProductFieldsApi } from './api';
|
|
@@ -54,8 +55,9 @@ export * from './api/lead-statuses-api';
|
|
|
54
55
|
export * from './api/lead-versions-api';
|
|
55
56
|
export * from './api/leads-api';
|
|
56
57
|
export * from './api/named-ranges-api';
|
|
58
|
+
export * from './api/partner-links-api';
|
|
59
|
+
export * from './api/partner-roles-api';
|
|
57
60
|
export * from './api/policies-api';
|
|
58
|
-
export * from './api/policy-partner-roles-api';
|
|
59
61
|
export * from './api/premium-formulas-api';
|
|
60
62
|
export * from './api/product-factors-api';
|
|
61
63
|
export * from './api/product-fields-api';
|
|
@@ -0,0 +1,450 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* EMIL InsuranceService
|
|
3
|
+
* The EMIL InsuranceService 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 { DeleteResponseClass } from '../models';
|
|
16
|
+
import { GetPartnerLinkResponseClass } from '../models';
|
|
17
|
+
import { LinkPartnerRequestDto } from '../models';
|
|
18
|
+
import { LinkPartnerResponseClass } from '../models';
|
|
19
|
+
import { ListPartnerLinksResponseClass } from '../models';
|
|
20
|
+
import { UnlinkPartnerResponseClass } from '../models';
|
|
21
|
+
import { UpdatePartnerLinkRequestDto } from '../models';
|
|
22
|
+
import { UpdatePartnerLinkResponseClass } from '../models';
|
|
23
|
+
/**
|
|
24
|
+
* PartnerLinksApi - axios parameter creator
|
|
25
|
+
* @export
|
|
26
|
+
*/
|
|
27
|
+
export declare const PartnerLinksApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
28
|
+
/**
|
|
29
|
+
* Permanently deletes the partner link. Supply the unique id that was returned when you created the partner link and this will delete it.
|
|
30
|
+
* @summary Delete the partner link
|
|
31
|
+
* @param {number} id
|
|
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
|
+
deletePartnerLink: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37
|
+
/**
|
|
38
|
+
* Retrieves the details of the partner link that was previously created. Supply the unique partner link id that was returned when you created it and Emil Api will return the corresponding partner link information.
|
|
39
|
+
* @summary Retrieve the partner link
|
|
40
|
+
* @param {number} id
|
|
41
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
42
|
+
* @param {string} [expand] You can expand partner link in this endpoint. \' + \'Allowed values: role, partner.
|
|
43
|
+
* @param {*} [options] Override http request option.
|
|
44
|
+
* @throws {RequiredError}
|
|
45
|
+
*/
|
|
46
|
+
getPartnerLink: (id: number, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
47
|
+
/**
|
|
48
|
+
* This will create a partner link.
|
|
49
|
+
* @summary Create the partner link
|
|
50
|
+
* @param {LinkPartnerRequestDto} linkPartnerRequestDto
|
|
51
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
52
|
+
* @param {*} [options] Override http request option.
|
|
53
|
+
* @throws {RequiredError}
|
|
54
|
+
*/
|
|
55
|
+
linkPartner: (linkPartnerRequestDto: LinkPartnerRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
56
|
+
/**
|
|
57
|
+
* Returns a list of partner links you have previously created. The partner links are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
58
|
+
* @summary List partner links
|
|
59
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
60
|
+
* @param {number} [pageSize] Page size.
|
|
61
|
+
* @param {string} [pageToken] Page token.
|
|
62
|
+
* @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: partnerCode, partnerRoleCode, policyCode, leadCode</i>
|
|
63
|
+
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: partnerCode, partnerRoleCode, policyCode, leadCode</i>
|
|
64
|
+
* @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, updatedAt</i>
|
|
65
|
+
* @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: role.<i>
|
|
66
|
+
* @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: partnerCode, partnerRoleCode, policyCode, leadCode</i>
|
|
67
|
+
* @param {*} [options] Override http request option.
|
|
68
|
+
* @throws {RequiredError}
|
|
69
|
+
*/
|
|
70
|
+
listPartnerLinks: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
71
|
+
/**
|
|
72
|
+
* Ends the partner link setting the end date of the specified partner link to today.
|
|
73
|
+
* @summary Ends the partner link
|
|
74
|
+
* @param {number} id
|
|
75
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
76
|
+
* @param {*} [options] Override http request option.
|
|
77
|
+
* @throws {RequiredError}
|
|
78
|
+
*/
|
|
79
|
+
unlinkPartner: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
80
|
+
/**
|
|
81
|
+
* Updates the specified partner link by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
82
|
+
* @summary Update the partner link
|
|
83
|
+
* @param {number} id
|
|
84
|
+
* @param {UpdatePartnerLinkRequestDto} updatePartnerLinkRequestDto
|
|
85
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
86
|
+
* @param {*} [options] Override http request option.
|
|
87
|
+
* @throws {RequiredError}
|
|
88
|
+
*/
|
|
89
|
+
updatePartnerLink: (id: number, updatePartnerLinkRequestDto: UpdatePartnerLinkRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
90
|
+
};
|
|
91
|
+
/**
|
|
92
|
+
* PartnerLinksApi - functional programming interface
|
|
93
|
+
* @export
|
|
94
|
+
*/
|
|
95
|
+
export declare const PartnerLinksApiFp: (configuration?: Configuration) => {
|
|
96
|
+
/**
|
|
97
|
+
* Permanently deletes the partner link. Supply the unique id that was returned when you created the partner link and this will delete it.
|
|
98
|
+
* @summary Delete the partner link
|
|
99
|
+
* @param {number} id
|
|
100
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
101
|
+
* @param {*} [options] Override http request option.
|
|
102
|
+
* @throws {RequiredError}
|
|
103
|
+
*/
|
|
104
|
+
deletePartnerLink(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
|
|
105
|
+
/**
|
|
106
|
+
* Retrieves the details of the partner link that was previously created. Supply the unique partner link id that was returned when you created it and Emil Api will return the corresponding partner link information.
|
|
107
|
+
* @summary Retrieve the partner link
|
|
108
|
+
* @param {number} id
|
|
109
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
110
|
+
* @param {string} [expand] You can expand partner link in this endpoint. \' + \'Allowed values: role, partner.
|
|
111
|
+
* @param {*} [options] Override http request option.
|
|
112
|
+
* @throws {RequiredError}
|
|
113
|
+
*/
|
|
114
|
+
getPartnerLink(id: number, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPartnerLinkResponseClass>>;
|
|
115
|
+
/**
|
|
116
|
+
* This will create a partner link.
|
|
117
|
+
* @summary Create the partner link
|
|
118
|
+
* @param {LinkPartnerRequestDto} linkPartnerRequestDto
|
|
119
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
120
|
+
* @param {*} [options] Override http request option.
|
|
121
|
+
* @throws {RequiredError}
|
|
122
|
+
*/
|
|
123
|
+
linkPartner(linkPartnerRequestDto: LinkPartnerRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LinkPartnerResponseClass>>;
|
|
124
|
+
/**
|
|
125
|
+
* Returns a list of partner links you have previously created. The partner links are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
126
|
+
* @summary List partner links
|
|
127
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
128
|
+
* @param {number} [pageSize] Page size.
|
|
129
|
+
* @param {string} [pageToken] Page token.
|
|
130
|
+
* @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: partnerCode, partnerRoleCode, policyCode, leadCode</i>
|
|
131
|
+
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: partnerCode, partnerRoleCode, policyCode, leadCode</i>
|
|
132
|
+
* @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, updatedAt</i>
|
|
133
|
+
* @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: role.<i>
|
|
134
|
+
* @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: partnerCode, partnerRoleCode, policyCode, leadCode</i>
|
|
135
|
+
* @param {*} [options] Override http request option.
|
|
136
|
+
* @throws {RequiredError}
|
|
137
|
+
*/
|
|
138
|
+
listPartnerLinks(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPartnerLinksResponseClass>>;
|
|
139
|
+
/**
|
|
140
|
+
* Ends the partner link setting the end date of the specified partner link to today.
|
|
141
|
+
* @summary Ends the partner link
|
|
142
|
+
* @param {number} id
|
|
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
|
+
unlinkPartner(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UnlinkPartnerResponseClass>>;
|
|
148
|
+
/**
|
|
149
|
+
* Updates the specified partner link by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
150
|
+
* @summary Update the partner link
|
|
151
|
+
* @param {number} id
|
|
152
|
+
* @param {UpdatePartnerLinkRequestDto} updatePartnerLinkRequestDto
|
|
153
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
154
|
+
* @param {*} [options] Override http request option.
|
|
155
|
+
* @throws {RequiredError}
|
|
156
|
+
*/
|
|
157
|
+
updatePartnerLink(id: number, updatePartnerLinkRequestDto: UpdatePartnerLinkRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdatePartnerLinkResponseClass>>;
|
|
158
|
+
};
|
|
159
|
+
/**
|
|
160
|
+
* PartnerLinksApi - factory interface
|
|
161
|
+
* @export
|
|
162
|
+
*/
|
|
163
|
+
export declare const PartnerLinksApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
164
|
+
/**
|
|
165
|
+
* Permanently deletes the partner link. Supply the unique id that was returned when you created the partner link and this will delete it.
|
|
166
|
+
* @summary Delete the partner link
|
|
167
|
+
* @param {number} id
|
|
168
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
169
|
+
* @param {*} [options] Override http request option.
|
|
170
|
+
* @throws {RequiredError}
|
|
171
|
+
*/
|
|
172
|
+
deletePartnerLink(id: number, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
|
|
173
|
+
/**
|
|
174
|
+
* Retrieves the details of the partner link that was previously created. Supply the unique partner link id that was returned when you created it and Emil Api will return the corresponding partner link information.
|
|
175
|
+
* @summary Retrieve the partner link
|
|
176
|
+
* @param {number} id
|
|
177
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
178
|
+
* @param {string} [expand] You can expand partner link in this endpoint. \' + \'Allowed values: role, partner.
|
|
179
|
+
* @param {*} [options] Override http request option.
|
|
180
|
+
* @throws {RequiredError}
|
|
181
|
+
*/
|
|
182
|
+
getPartnerLink(id: number, authorization?: string, expand?: string, options?: any): AxiosPromise<GetPartnerLinkResponseClass>;
|
|
183
|
+
/**
|
|
184
|
+
* This will create a partner link.
|
|
185
|
+
* @summary Create the partner link
|
|
186
|
+
* @param {LinkPartnerRequestDto} linkPartnerRequestDto
|
|
187
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
188
|
+
* @param {*} [options] Override http request option.
|
|
189
|
+
* @throws {RequiredError}
|
|
190
|
+
*/
|
|
191
|
+
linkPartner(linkPartnerRequestDto: LinkPartnerRequestDto, authorization?: string, options?: any): AxiosPromise<LinkPartnerResponseClass>;
|
|
192
|
+
/**
|
|
193
|
+
* Returns a list of partner links you have previously created. The partner links are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
194
|
+
* @summary List partner links
|
|
195
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
196
|
+
* @param {number} [pageSize] Page size.
|
|
197
|
+
* @param {string} [pageToken] Page token.
|
|
198
|
+
* @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: partnerCode, partnerRoleCode, policyCode, leadCode</i>
|
|
199
|
+
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: partnerCode, partnerRoleCode, policyCode, leadCode</i>
|
|
200
|
+
* @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, updatedAt</i>
|
|
201
|
+
* @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: role.<i>
|
|
202
|
+
* @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: partnerCode, partnerRoleCode, policyCode, leadCode</i>
|
|
203
|
+
* @param {*} [options] Override http request option.
|
|
204
|
+
* @throws {RequiredError}
|
|
205
|
+
*/
|
|
206
|
+
listPartnerLinks(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnerLinksResponseClass>;
|
|
207
|
+
/**
|
|
208
|
+
* Ends the partner link setting the end date of the specified partner link to today.
|
|
209
|
+
* @summary Ends the partner link
|
|
210
|
+
* @param {number} id
|
|
211
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
212
|
+
* @param {*} [options] Override http request option.
|
|
213
|
+
* @throws {RequiredError}
|
|
214
|
+
*/
|
|
215
|
+
unlinkPartner(id: number, authorization?: string, options?: any): AxiosPromise<UnlinkPartnerResponseClass>;
|
|
216
|
+
/**
|
|
217
|
+
* Updates the specified partner link by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
218
|
+
* @summary Update the partner link
|
|
219
|
+
* @param {number} id
|
|
220
|
+
* @param {UpdatePartnerLinkRequestDto} updatePartnerLinkRequestDto
|
|
221
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
222
|
+
* @param {*} [options] Override http request option.
|
|
223
|
+
* @throws {RequiredError}
|
|
224
|
+
*/
|
|
225
|
+
updatePartnerLink(id: number, updatePartnerLinkRequestDto: UpdatePartnerLinkRequestDto, authorization?: string, options?: any): AxiosPromise<UpdatePartnerLinkResponseClass>;
|
|
226
|
+
};
|
|
227
|
+
/**
|
|
228
|
+
* Request parameters for deletePartnerLink operation in PartnerLinksApi.
|
|
229
|
+
* @export
|
|
230
|
+
* @interface PartnerLinksApiDeletePartnerLinkRequest
|
|
231
|
+
*/
|
|
232
|
+
export interface PartnerLinksApiDeletePartnerLinkRequest {
|
|
233
|
+
/**
|
|
234
|
+
*
|
|
235
|
+
* @type {number}
|
|
236
|
+
* @memberof PartnerLinksApiDeletePartnerLink
|
|
237
|
+
*/
|
|
238
|
+
readonly id: number;
|
|
239
|
+
/**
|
|
240
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
241
|
+
* @type {string}
|
|
242
|
+
* @memberof PartnerLinksApiDeletePartnerLink
|
|
243
|
+
*/
|
|
244
|
+
readonly authorization?: string;
|
|
245
|
+
}
|
|
246
|
+
/**
|
|
247
|
+
* Request parameters for getPartnerLink operation in PartnerLinksApi.
|
|
248
|
+
* @export
|
|
249
|
+
* @interface PartnerLinksApiGetPartnerLinkRequest
|
|
250
|
+
*/
|
|
251
|
+
export interface PartnerLinksApiGetPartnerLinkRequest {
|
|
252
|
+
/**
|
|
253
|
+
*
|
|
254
|
+
* @type {number}
|
|
255
|
+
* @memberof PartnerLinksApiGetPartnerLink
|
|
256
|
+
*/
|
|
257
|
+
readonly id: number;
|
|
258
|
+
/**
|
|
259
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
260
|
+
* @type {string}
|
|
261
|
+
* @memberof PartnerLinksApiGetPartnerLink
|
|
262
|
+
*/
|
|
263
|
+
readonly authorization?: string;
|
|
264
|
+
/**
|
|
265
|
+
* You can expand partner link in this endpoint. \' + \'Allowed values: role, partner.
|
|
266
|
+
* @type {string}
|
|
267
|
+
* @memberof PartnerLinksApiGetPartnerLink
|
|
268
|
+
*/
|
|
269
|
+
readonly expand?: string;
|
|
270
|
+
}
|
|
271
|
+
/**
|
|
272
|
+
* Request parameters for linkPartner operation in PartnerLinksApi.
|
|
273
|
+
* @export
|
|
274
|
+
* @interface PartnerLinksApiLinkPartnerRequest
|
|
275
|
+
*/
|
|
276
|
+
export interface PartnerLinksApiLinkPartnerRequest {
|
|
277
|
+
/**
|
|
278
|
+
*
|
|
279
|
+
* @type {LinkPartnerRequestDto}
|
|
280
|
+
* @memberof PartnerLinksApiLinkPartner
|
|
281
|
+
*/
|
|
282
|
+
readonly linkPartnerRequestDto: LinkPartnerRequestDto;
|
|
283
|
+
/**
|
|
284
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
285
|
+
* @type {string}
|
|
286
|
+
* @memberof PartnerLinksApiLinkPartner
|
|
287
|
+
*/
|
|
288
|
+
readonly authorization?: string;
|
|
289
|
+
}
|
|
290
|
+
/**
|
|
291
|
+
* Request parameters for listPartnerLinks operation in PartnerLinksApi.
|
|
292
|
+
* @export
|
|
293
|
+
* @interface PartnerLinksApiListPartnerLinksRequest
|
|
294
|
+
*/
|
|
295
|
+
export interface PartnerLinksApiListPartnerLinksRequest {
|
|
296
|
+
/**
|
|
297
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
298
|
+
* @type {string}
|
|
299
|
+
* @memberof PartnerLinksApiListPartnerLinks
|
|
300
|
+
*/
|
|
301
|
+
readonly authorization?: string;
|
|
302
|
+
/**
|
|
303
|
+
* Page size.
|
|
304
|
+
* @type {number}
|
|
305
|
+
* @memberof PartnerLinksApiListPartnerLinks
|
|
306
|
+
*/
|
|
307
|
+
readonly pageSize?: number;
|
|
308
|
+
/**
|
|
309
|
+
* Page token.
|
|
310
|
+
* @type {string}
|
|
311
|
+
* @memberof PartnerLinksApiListPartnerLinks
|
|
312
|
+
*/
|
|
313
|
+
readonly pageToken?: string;
|
|
314
|
+
/**
|
|
315
|
+
* 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: partnerCode, partnerRoleCode, policyCode, leadCode</i>
|
|
316
|
+
* @type {string}
|
|
317
|
+
* @memberof PartnerLinksApiListPartnerLinks
|
|
318
|
+
*/
|
|
319
|
+
readonly filter?: string;
|
|
320
|
+
/**
|
|
321
|
+
* Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: partnerCode, partnerRoleCode, policyCode, leadCode</i>
|
|
322
|
+
* @type {string}
|
|
323
|
+
* @memberof PartnerLinksApiListPartnerLinks
|
|
324
|
+
*/
|
|
325
|
+
readonly search?: string;
|
|
326
|
+
/**
|
|
327
|
+
* 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, updatedAt</i>
|
|
328
|
+
* @type {string}
|
|
329
|
+
* @memberof PartnerLinksApiListPartnerLinks
|
|
330
|
+
*/
|
|
331
|
+
readonly order?: string;
|
|
332
|
+
/**
|
|
333
|
+
* 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: role.<i>
|
|
334
|
+
* @type {string}
|
|
335
|
+
* @memberof PartnerLinksApiListPartnerLinks
|
|
336
|
+
*/
|
|
337
|
+
readonly expand?: string;
|
|
338
|
+
/**
|
|
339
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: partnerCode, partnerRoleCode, policyCode, leadCode</i>
|
|
340
|
+
* @type {string}
|
|
341
|
+
* @memberof PartnerLinksApiListPartnerLinks
|
|
342
|
+
*/
|
|
343
|
+
readonly filters?: string;
|
|
344
|
+
}
|
|
345
|
+
/**
|
|
346
|
+
* Request parameters for unlinkPartner operation in PartnerLinksApi.
|
|
347
|
+
* @export
|
|
348
|
+
* @interface PartnerLinksApiUnlinkPartnerRequest
|
|
349
|
+
*/
|
|
350
|
+
export interface PartnerLinksApiUnlinkPartnerRequest {
|
|
351
|
+
/**
|
|
352
|
+
*
|
|
353
|
+
* @type {number}
|
|
354
|
+
* @memberof PartnerLinksApiUnlinkPartner
|
|
355
|
+
*/
|
|
356
|
+
readonly id: number;
|
|
357
|
+
/**
|
|
358
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
359
|
+
* @type {string}
|
|
360
|
+
* @memberof PartnerLinksApiUnlinkPartner
|
|
361
|
+
*/
|
|
362
|
+
readonly authorization?: string;
|
|
363
|
+
}
|
|
364
|
+
/**
|
|
365
|
+
* Request parameters for updatePartnerLink operation in PartnerLinksApi.
|
|
366
|
+
* @export
|
|
367
|
+
* @interface PartnerLinksApiUpdatePartnerLinkRequest
|
|
368
|
+
*/
|
|
369
|
+
export interface PartnerLinksApiUpdatePartnerLinkRequest {
|
|
370
|
+
/**
|
|
371
|
+
*
|
|
372
|
+
* @type {number}
|
|
373
|
+
* @memberof PartnerLinksApiUpdatePartnerLink
|
|
374
|
+
*/
|
|
375
|
+
readonly id: number;
|
|
376
|
+
/**
|
|
377
|
+
*
|
|
378
|
+
* @type {UpdatePartnerLinkRequestDto}
|
|
379
|
+
* @memberof PartnerLinksApiUpdatePartnerLink
|
|
380
|
+
*/
|
|
381
|
+
readonly updatePartnerLinkRequestDto: UpdatePartnerLinkRequestDto;
|
|
382
|
+
/**
|
|
383
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
384
|
+
* @type {string}
|
|
385
|
+
* @memberof PartnerLinksApiUpdatePartnerLink
|
|
386
|
+
*/
|
|
387
|
+
readonly authorization?: string;
|
|
388
|
+
}
|
|
389
|
+
/**
|
|
390
|
+
* PartnerLinksApi - object-oriented interface
|
|
391
|
+
* @export
|
|
392
|
+
* @class PartnerLinksApi
|
|
393
|
+
* @extends {BaseAPI}
|
|
394
|
+
*/
|
|
395
|
+
export declare class PartnerLinksApi extends BaseAPI {
|
|
396
|
+
/**
|
|
397
|
+
* Permanently deletes the partner link. Supply the unique id that was returned when you created the partner link and this will delete it.
|
|
398
|
+
* @summary Delete the partner link
|
|
399
|
+
* @param {PartnerLinksApiDeletePartnerLinkRequest} requestParameters Request parameters.
|
|
400
|
+
* @param {*} [options] Override http request option.
|
|
401
|
+
* @throws {RequiredError}
|
|
402
|
+
* @memberof PartnerLinksApi
|
|
403
|
+
*/
|
|
404
|
+
deletePartnerLink(requestParameters: PartnerLinksApiDeletePartnerLinkRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any>>;
|
|
405
|
+
/**
|
|
406
|
+
* Retrieves the details of the partner link that was previously created. Supply the unique partner link id that was returned when you created it and Emil Api will return the corresponding partner link information.
|
|
407
|
+
* @summary Retrieve the partner link
|
|
408
|
+
* @param {PartnerLinksApiGetPartnerLinkRequest} requestParameters Request parameters.
|
|
409
|
+
* @param {*} [options] Override http request option.
|
|
410
|
+
* @throws {RequiredError}
|
|
411
|
+
* @memberof PartnerLinksApi
|
|
412
|
+
*/
|
|
413
|
+
getPartnerLink(requestParameters: PartnerLinksApiGetPartnerLinkRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPartnerLinkResponseClass, any>>;
|
|
414
|
+
/**
|
|
415
|
+
* This will create a partner link.
|
|
416
|
+
* @summary Create the partner link
|
|
417
|
+
* @param {PartnerLinksApiLinkPartnerRequest} requestParameters Request parameters.
|
|
418
|
+
* @param {*} [options] Override http request option.
|
|
419
|
+
* @throws {RequiredError}
|
|
420
|
+
* @memberof PartnerLinksApi
|
|
421
|
+
*/
|
|
422
|
+
linkPartner(requestParameters: PartnerLinksApiLinkPartnerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LinkPartnerResponseClass, any>>;
|
|
423
|
+
/**
|
|
424
|
+
* Returns a list of partner links you have previously created. The partner links are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
425
|
+
* @summary List partner links
|
|
426
|
+
* @param {PartnerLinksApiListPartnerLinksRequest} requestParameters Request parameters.
|
|
427
|
+
* @param {*} [options] Override http request option.
|
|
428
|
+
* @throws {RequiredError}
|
|
429
|
+
* @memberof PartnerLinksApi
|
|
430
|
+
*/
|
|
431
|
+
listPartnerLinks(requestParameters?: PartnerLinksApiListPartnerLinksRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPartnerLinksResponseClass, any>>;
|
|
432
|
+
/**
|
|
433
|
+
* Ends the partner link setting the end date of the specified partner link to today.
|
|
434
|
+
* @summary Ends the partner link
|
|
435
|
+
* @param {PartnerLinksApiUnlinkPartnerRequest} requestParameters Request parameters.
|
|
436
|
+
* @param {*} [options] Override http request option.
|
|
437
|
+
* @throws {RequiredError}
|
|
438
|
+
* @memberof PartnerLinksApi
|
|
439
|
+
*/
|
|
440
|
+
unlinkPartner(requestParameters: PartnerLinksApiUnlinkPartnerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UnlinkPartnerResponseClass, any>>;
|
|
441
|
+
/**
|
|
442
|
+
* Updates the specified partner link by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
443
|
+
* @summary Update the partner link
|
|
444
|
+
* @param {PartnerLinksApiUpdatePartnerLinkRequest} requestParameters Request parameters.
|
|
445
|
+
* @param {*} [options] Override http request option.
|
|
446
|
+
* @throws {RequiredError}
|
|
447
|
+
* @memberof PartnerLinksApi
|
|
448
|
+
*/
|
|
449
|
+
updatePartnerLink(requestParameters: PartnerLinksApiUpdatePartnerLinkRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdatePartnerLinkResponseClass, any>>;
|
|
450
|
+
}
|