@emilgroup/insurance-sdk-node 1.52.0 → 1.53.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 +33 -1
- package/README.md +2 -2
- package/api/commission-agreement-products-api.ts +710 -0
- package/api/commission-agreement-versions-api.ts +592 -0
- package/api/commission-agreements-api.ts +697 -0
- package/api/commission-recipients-api.ts +696 -0
- package/api/{default-api.ts → health-check-api.ts} +21 -17
- package/api/insured-objects-api.ts +5 -2
- package/api/policies-api.ts +176 -221
- package/api.ts +10 -2
- package/dist/api/commission-agreement-products-api.d.ts +403 -0
- package/dist/api/commission-agreement-products-api.js +652 -0
- package/dist/api/commission-agreement-versions-api.d.ts +337 -0
- package/dist/api/commission-agreement-versions-api.js +555 -0
- package/dist/api/commission-agreements-api.d.ts +394 -0
- package/dist/api/commission-agreements-api.js +646 -0
- package/dist/api/commission-recipients-api.d.ts +394 -0
- package/dist/api/commission-recipients-api.js +646 -0
- package/dist/api/health-check-api.d.ts +70 -0
- package/dist/api/{default-api.js → health-check-api.js} +30 -26
- package/dist/api/insured-objects-api.js +4 -2
- package/dist/api/policies-api.d.ts +134 -161
- package/dist/api/policies-api.js +129 -151
- package/dist/api.d.ts +5 -1
- package/dist/api.js +5 -1
- package/dist/models/commission-agreement-class.d.ts +89 -0
- package/dist/models/commission-agreement-class.js +23 -0
- package/dist/models/commission-agreement-item-class.d.ts +66 -0
- package/dist/models/commission-agreement-item-class.js +15 -0
- package/dist/models/commission-agreement-product-class.d.ts +72 -0
- package/dist/models/commission-agreement-product-class.js +15 -0
- package/dist/models/commission-agreement-version-class.d.ts +79 -0
- package/dist/models/commission-agreement-version-class.js +15 -0
- package/dist/models/commission-recipient-class.d.ts +78 -0
- package/dist/models/commission-recipient-class.js +15 -0
- package/dist/models/create-commission-agreement-item-dto.d.ts +36 -0
- package/dist/models/create-commission-agreement-item-dto.js +15 -0
- package/dist/models/create-commission-agreement-product-request-dto.d.ts +42 -0
- package/dist/models/create-commission-agreement-product-request-dto.js +15 -0
- package/dist/models/create-commission-agreement-product-response-class.d.ts +25 -0
- package/dist/models/create-commission-agreement-product-response-class.js +15 -0
- package/dist/models/create-commission-agreement-request-dto.d.ts +75 -0
- package/dist/models/create-commission-agreement-request-dto.js +23 -0
- package/dist/models/create-commission-agreement-response-class.d.ts +25 -0
- package/dist/models/create-commission-agreement-response-class.js +15 -0
- package/dist/models/create-commission-agreement-version-request-dto.d.ts +49 -0
- package/dist/models/create-commission-agreement-version-request-dto.js +15 -0
- package/dist/models/create-commission-agreement-version-response-class.d.ts +25 -0
- package/dist/models/create-commission-agreement-version-response-class.js +15 -0
- package/dist/models/create-commission-recipient-request-dto.d.ts +48 -0
- package/dist/models/create-commission-recipient-request-dto.js +15 -0
- package/dist/models/create-commission-recipient-response-class.d.ts +25 -0
- package/dist/models/create-commission-recipient-response-class.js +15 -0
- package/dist/models/get-commission-agreement-product-response-class.d.ts +25 -0
- package/dist/models/get-commission-agreement-product-response-class.js +15 -0
- package/dist/models/get-commission-agreement-response-class.d.ts +25 -0
- package/dist/models/get-commission-agreement-response-class.js +15 -0
- package/dist/models/get-commission-agreement-version-response-class.d.ts +25 -0
- package/dist/models/get-commission-agreement-version-response-class.js +15 -0
- package/dist/models/get-commission-recipient-response-class.d.ts +25 -0
- package/dist/models/get-commission-recipient-response-class.js +15 -0
- package/dist/models/index.d.ts +28 -0
- package/dist/models/index.js +28 -0
- package/dist/models/list-commission-agreement-products-response-class.d.ts +31 -0
- package/dist/models/list-commission-agreement-products-response-class.js +15 -0
- package/dist/models/list-commission-agreement-versions-response-class.d.ts +31 -0
- package/dist/models/list-commission-agreement-versions-response-class.js +15 -0
- package/dist/models/list-commission-agreements-response-class.d.ts +31 -0
- package/dist/models/list-commission-agreements-response-class.js +15 -0
- package/dist/models/list-commission-recipients-response-class.d.ts +31 -0
- package/dist/models/list-commission-recipients-response-class.js +15 -0
- package/dist/models/update-commission-agreement-product-request-dto.d.ts +42 -0
- package/dist/models/update-commission-agreement-product-request-dto.js +15 -0
- package/dist/models/update-commission-agreement-product-response-class.d.ts +25 -0
- package/dist/models/update-commission-agreement-product-response-class.js +15 -0
- package/dist/models/update-commission-agreement-request-dto.d.ts +44 -0
- package/dist/models/update-commission-agreement-request-dto.js +23 -0
- package/dist/models/update-commission-agreement-response-class.d.ts +25 -0
- package/dist/models/update-commission-agreement-response-class.js +15 -0
- package/dist/models/update-commission-recipient-request-dto.d.ts +48 -0
- package/dist/models/update-commission-recipient-request-dto.js +15 -0
- package/dist/models/update-commission-recipient-response-class.d.ts +25 -0
- package/dist/models/update-commission-recipient-response-class.js +15 -0
- package/models/commission-agreement-class.ts +98 -0
- package/models/commission-agreement-item-class.ts +72 -0
- package/models/commission-agreement-product-class.ts +78 -0
- package/models/commission-agreement-version-class.ts +85 -0
- package/models/commission-recipient-class.ts +84 -0
- package/models/create-commission-agreement-item-dto.ts +42 -0
- package/models/create-commission-agreement-product-request-dto.ts +48 -0
- package/models/create-commission-agreement-product-response-class.ts +31 -0
- package/models/create-commission-agreement-request-dto.ts +84 -0
- package/models/create-commission-agreement-response-class.ts +31 -0
- package/models/create-commission-agreement-version-request-dto.ts +55 -0
- package/models/create-commission-agreement-version-response-class.ts +31 -0
- package/models/create-commission-recipient-request-dto.ts +54 -0
- package/models/create-commission-recipient-response-class.ts +31 -0
- package/models/get-commission-agreement-product-response-class.ts +31 -0
- package/models/get-commission-agreement-response-class.ts +31 -0
- package/models/get-commission-agreement-version-response-class.ts +31 -0
- package/models/get-commission-recipient-response-class.ts +31 -0
- package/models/index.ts +28 -0
- package/models/list-commission-agreement-products-response-class.ts +37 -0
- package/models/list-commission-agreement-versions-response-class.ts +37 -0
- package/models/list-commission-agreements-response-class.ts +37 -0
- package/models/list-commission-recipients-response-class.ts +37 -0
- package/models/update-commission-agreement-product-request-dto.ts +48 -0
- package/models/update-commission-agreement-product-response-class.ts +31 -0
- package/models/update-commission-agreement-request-dto.ts +53 -0
- package/models/update-commission-agreement-response-class.ts +31 -0
- package/models/update-commission-recipient-request-dto.ts +54 -0
- package/models/update-commission-recipient-response-class.ts +31 -0
- package/package.json +1 -1
- package/dist/api/default-api.d.ts +0 -66
package/api.ts
CHANGED
|
@@ -26,8 +26,12 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
|
|
|
26
26
|
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base';
|
|
27
27
|
import { BookingFunnelVersionsApi } from './api';
|
|
28
28
|
import { BookingFunnelsApi } from './api';
|
|
29
|
-
import {
|
|
29
|
+
import { CommissionAgreementProductsApi } from './api';
|
|
30
|
+
import { CommissionAgreementVersionsApi } from './api';
|
|
31
|
+
import { CommissionAgreementsApi } from './api';
|
|
32
|
+
import { CommissionRecipientsApi } from './api';
|
|
30
33
|
import { EmilFunctionsApi } from './api';
|
|
34
|
+
import { HealthCheckApi } from './api';
|
|
31
35
|
import { InsuredObjectTypesApi } from './api';
|
|
32
36
|
import { InsuredObjectsApi } from './api';
|
|
33
37
|
import { LeadStatusesApi } from './api';
|
|
@@ -47,8 +51,12 @@ import { StatusTransitionRulesApi } from './api';
|
|
|
47
51
|
|
|
48
52
|
export * from './api/booking-funnel-versions-api';
|
|
49
53
|
export * from './api/booking-funnels-api';
|
|
50
|
-
export * from './api/
|
|
54
|
+
export * from './api/commission-agreement-products-api';
|
|
55
|
+
export * from './api/commission-agreement-versions-api';
|
|
56
|
+
export * from './api/commission-agreements-api';
|
|
57
|
+
export * from './api/commission-recipients-api';
|
|
51
58
|
export * from './api/emil-functions-api';
|
|
59
|
+
export * from './api/health-check-api';
|
|
52
60
|
export * from './api/insured-object-types-api';
|
|
53
61
|
export * from './api/insured-objects-api';
|
|
54
62
|
export * from './api/lead-statuses-api';
|
|
@@ -0,0 +1,403 @@
|
|
|
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 { CreateCommissionAgreementProductRequestDto } from '../models';
|
|
16
|
+
import { CreateCommissionAgreementProductResponseClass } from '../models';
|
|
17
|
+
import { DeleteResponseClass } from '../models';
|
|
18
|
+
import { GetCommissionAgreementProductResponseClass } from '../models';
|
|
19
|
+
import { ListCommissionAgreementProductsResponseClass } from '../models';
|
|
20
|
+
import { UpdateCommissionAgreementProductRequestDto } from '../models';
|
|
21
|
+
import { UpdateCommissionAgreementProductResponseClass } from '../models';
|
|
22
|
+
/**
|
|
23
|
+
* CommissionAgreementProductsApi - axios parameter creator
|
|
24
|
+
* @export
|
|
25
|
+
*/
|
|
26
|
+
export declare const CommissionAgreementProductsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
27
|
+
/**
|
|
28
|
+
* This will create the commission agreement product.
|
|
29
|
+
* @summary Create the Commission agreement product
|
|
30
|
+
* @param {string} code
|
|
31
|
+
* @param {CreateCommissionAgreementProductRequestDto} createCommissionAgreementProductRequestDto
|
|
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
|
+
createCommissionAgreementProduct: (code: string, createCommissionAgreementProductRequestDto: CreateCommissionAgreementProductRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37
|
+
/**
|
|
38
|
+
* Permanently deletes the commission agreement product. Supply the unique code that was returned when you created the commission agreement product and this will delete it.
|
|
39
|
+
* @summary Delete the commission agreement product
|
|
40
|
+
* @param {string} code
|
|
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
|
+
deleteCommissionAgreementProduct: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46
|
+
/**
|
|
47
|
+
* Retrieves the details of the commission agreement product that was previously created. Supply the unique commission agreement product code that was returned when you created it and Emil Api will return the corresponding commission agreement product information.
|
|
48
|
+
* @summary Retrieve the commission agreement product
|
|
49
|
+
* @param {string} code
|
|
50
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
51
|
+
* @param {string} [expand] You can expand commission agreement product in this endpoint. \' + \'Allowed values: product.
|
|
52
|
+
* @param {*} [options] Override http request option.
|
|
53
|
+
* @throws {RequiredError}
|
|
54
|
+
*/
|
|
55
|
+
getCommissionAgreementProduct: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
56
|
+
/**
|
|
57
|
+
* Returns a list of commission agreement products you have previously created. The commission agreement products are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
58
|
+
* @summary List commission agreement products
|
|
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: code, productId, commissionAgreementId</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: productId, code</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: product.<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: code, productId, commissionAgreementId</i>
|
|
67
|
+
* @param {*} [options] Override http request option.
|
|
68
|
+
* @throws {RequiredError}
|
|
69
|
+
*/
|
|
70
|
+
listCommissionAgreementProducts: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
71
|
+
/**
|
|
72
|
+
* Updates the specified commission agreement product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
73
|
+
* @summary Update the commission agreement product
|
|
74
|
+
* @param {string} code
|
|
75
|
+
* @param {UpdateCommissionAgreementProductRequestDto} updateCommissionAgreementProductRequestDto
|
|
76
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
77
|
+
* @param {*} [options] Override http request option.
|
|
78
|
+
* @throws {RequiredError}
|
|
79
|
+
*/
|
|
80
|
+
updateCommissionAgreementProduct: (code: string, updateCommissionAgreementProductRequestDto: UpdateCommissionAgreementProductRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
81
|
+
};
|
|
82
|
+
/**
|
|
83
|
+
* CommissionAgreementProductsApi - functional programming interface
|
|
84
|
+
* @export
|
|
85
|
+
*/
|
|
86
|
+
export declare const CommissionAgreementProductsApiFp: (configuration?: Configuration) => {
|
|
87
|
+
/**
|
|
88
|
+
* This will create the commission agreement product.
|
|
89
|
+
* @summary Create the Commission agreement product
|
|
90
|
+
* @param {string} code
|
|
91
|
+
* @param {CreateCommissionAgreementProductRequestDto} createCommissionAgreementProductRequestDto
|
|
92
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
93
|
+
* @param {*} [options] Override http request option.
|
|
94
|
+
* @throws {RequiredError}
|
|
95
|
+
*/
|
|
96
|
+
createCommissionAgreementProduct(code: string, createCommissionAgreementProductRequestDto: CreateCommissionAgreementProductRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCommissionAgreementProductResponseClass>>;
|
|
97
|
+
/**
|
|
98
|
+
* Permanently deletes the commission agreement product. Supply the unique code that was returned when you created the commission agreement product and this will delete it.
|
|
99
|
+
* @summary Delete the commission agreement product
|
|
100
|
+
* @param {string} code
|
|
101
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
102
|
+
* @param {*} [options] Override http request option.
|
|
103
|
+
* @throws {RequiredError}
|
|
104
|
+
*/
|
|
105
|
+
deleteCommissionAgreementProduct(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
|
|
106
|
+
/**
|
|
107
|
+
* Retrieves the details of the commission agreement product that was previously created. Supply the unique commission agreement product code that was returned when you created it and Emil Api will return the corresponding commission agreement product information.
|
|
108
|
+
* @summary Retrieve the commission agreement product
|
|
109
|
+
* @param {string} code
|
|
110
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
111
|
+
* @param {string} [expand] You can expand commission agreement product in this endpoint. \' + \'Allowed values: product.
|
|
112
|
+
* @param {*} [options] Override http request option.
|
|
113
|
+
* @throws {RequiredError}
|
|
114
|
+
*/
|
|
115
|
+
getCommissionAgreementProduct(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCommissionAgreementProductResponseClass>>;
|
|
116
|
+
/**
|
|
117
|
+
* Returns a list of commission agreement products you have previously created. The commission agreement products are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
118
|
+
* @summary List commission agreement products
|
|
119
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
120
|
+
* @param {number} [pageSize] Page size.
|
|
121
|
+
* @param {string} [pageToken] Page token.
|
|
122
|
+
* @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: code, productId, commissionAgreementId</i>
|
|
123
|
+
* @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: productId, code</i>
|
|
124
|
+
* @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>
|
|
125
|
+
* @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: product.<i>
|
|
126
|
+
* @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: code, productId, commissionAgreementId</i>
|
|
127
|
+
* @param {*} [options] Override http request option.
|
|
128
|
+
* @throws {RequiredError}
|
|
129
|
+
*/
|
|
130
|
+
listCommissionAgreementProducts(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionAgreementProductsResponseClass>>;
|
|
131
|
+
/**
|
|
132
|
+
* Updates the specified commission agreement product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
133
|
+
* @summary Update the commission agreement product
|
|
134
|
+
* @param {string} code
|
|
135
|
+
* @param {UpdateCommissionAgreementProductRequestDto} updateCommissionAgreementProductRequestDto
|
|
136
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
137
|
+
* @param {*} [options] Override http request option.
|
|
138
|
+
* @throws {RequiredError}
|
|
139
|
+
*/
|
|
140
|
+
updateCommissionAgreementProduct(code: string, updateCommissionAgreementProductRequestDto: UpdateCommissionAgreementProductRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateCommissionAgreementProductResponseClass>>;
|
|
141
|
+
};
|
|
142
|
+
/**
|
|
143
|
+
* CommissionAgreementProductsApi - factory interface
|
|
144
|
+
* @export
|
|
145
|
+
*/
|
|
146
|
+
export declare const CommissionAgreementProductsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
147
|
+
/**
|
|
148
|
+
* This will create the commission agreement product.
|
|
149
|
+
* @summary Create the Commission agreement product
|
|
150
|
+
* @param {string} code
|
|
151
|
+
* @param {CreateCommissionAgreementProductRequestDto} createCommissionAgreementProductRequestDto
|
|
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
|
+
createCommissionAgreementProduct(code: string, createCommissionAgreementProductRequestDto: CreateCommissionAgreementProductRequestDto, authorization?: string, options?: any): AxiosPromise<CreateCommissionAgreementProductResponseClass>;
|
|
157
|
+
/**
|
|
158
|
+
* Permanently deletes the commission agreement product. Supply the unique code that was returned when you created the commission agreement product and this will delete it.
|
|
159
|
+
* @summary Delete the commission agreement product
|
|
160
|
+
* @param {string} code
|
|
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
|
+
deleteCommissionAgreementProduct(code: string, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
|
|
166
|
+
/**
|
|
167
|
+
* Retrieves the details of the commission agreement product that was previously created. Supply the unique commission agreement product code that was returned when you created it and Emil Api will return the corresponding commission agreement product information.
|
|
168
|
+
* @summary Retrieve the commission agreement product
|
|
169
|
+
* @param {string} code
|
|
170
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
171
|
+
* @param {string} [expand] You can expand commission agreement product in this endpoint. \' + \'Allowed values: product.
|
|
172
|
+
* @param {*} [options] Override http request option.
|
|
173
|
+
* @throws {RequiredError}
|
|
174
|
+
*/
|
|
175
|
+
getCommissionAgreementProduct(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetCommissionAgreementProductResponseClass>;
|
|
176
|
+
/**
|
|
177
|
+
* Returns a list of commission agreement products you have previously created. The commission agreement products are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
178
|
+
* @summary List commission agreement products
|
|
179
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
180
|
+
* @param {number} [pageSize] Page size.
|
|
181
|
+
* @param {string} [pageToken] Page token.
|
|
182
|
+
* @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: code, productId, commissionAgreementId</i>
|
|
183
|
+
* @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: productId, code</i>
|
|
184
|
+
* @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>
|
|
185
|
+
* @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: product.<i>
|
|
186
|
+
* @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: code, productId, commissionAgreementId</i>
|
|
187
|
+
* @param {*} [options] Override http request option.
|
|
188
|
+
* @throws {RequiredError}
|
|
189
|
+
*/
|
|
190
|
+
listCommissionAgreementProducts(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListCommissionAgreementProductsResponseClass>;
|
|
191
|
+
/**
|
|
192
|
+
* Updates the specified commission agreement product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
193
|
+
* @summary Update the commission agreement product
|
|
194
|
+
* @param {string} code
|
|
195
|
+
* @param {UpdateCommissionAgreementProductRequestDto} updateCommissionAgreementProductRequestDto
|
|
196
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
197
|
+
* @param {*} [options] Override http request option.
|
|
198
|
+
* @throws {RequiredError}
|
|
199
|
+
*/
|
|
200
|
+
updateCommissionAgreementProduct(code: string, updateCommissionAgreementProductRequestDto: UpdateCommissionAgreementProductRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateCommissionAgreementProductResponseClass>;
|
|
201
|
+
};
|
|
202
|
+
/**
|
|
203
|
+
* Request parameters for createCommissionAgreementProduct operation in CommissionAgreementProductsApi.
|
|
204
|
+
* @export
|
|
205
|
+
* @interface CommissionAgreementProductsApiCreateCommissionAgreementProductRequest
|
|
206
|
+
*/
|
|
207
|
+
export interface CommissionAgreementProductsApiCreateCommissionAgreementProductRequest {
|
|
208
|
+
/**
|
|
209
|
+
*
|
|
210
|
+
* @type {string}
|
|
211
|
+
* @memberof CommissionAgreementProductsApiCreateCommissionAgreementProduct
|
|
212
|
+
*/
|
|
213
|
+
readonly code: string;
|
|
214
|
+
/**
|
|
215
|
+
*
|
|
216
|
+
* @type {CreateCommissionAgreementProductRequestDto}
|
|
217
|
+
* @memberof CommissionAgreementProductsApiCreateCommissionAgreementProduct
|
|
218
|
+
*/
|
|
219
|
+
readonly createCommissionAgreementProductRequestDto: CreateCommissionAgreementProductRequestDto;
|
|
220
|
+
/**
|
|
221
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
222
|
+
* @type {string}
|
|
223
|
+
* @memberof CommissionAgreementProductsApiCreateCommissionAgreementProduct
|
|
224
|
+
*/
|
|
225
|
+
readonly authorization?: string;
|
|
226
|
+
}
|
|
227
|
+
/**
|
|
228
|
+
* Request parameters for deleteCommissionAgreementProduct operation in CommissionAgreementProductsApi.
|
|
229
|
+
* @export
|
|
230
|
+
* @interface CommissionAgreementProductsApiDeleteCommissionAgreementProductRequest
|
|
231
|
+
*/
|
|
232
|
+
export interface CommissionAgreementProductsApiDeleteCommissionAgreementProductRequest {
|
|
233
|
+
/**
|
|
234
|
+
*
|
|
235
|
+
* @type {string}
|
|
236
|
+
* @memberof CommissionAgreementProductsApiDeleteCommissionAgreementProduct
|
|
237
|
+
*/
|
|
238
|
+
readonly code: string;
|
|
239
|
+
/**
|
|
240
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
241
|
+
* @type {string}
|
|
242
|
+
* @memberof CommissionAgreementProductsApiDeleteCommissionAgreementProduct
|
|
243
|
+
*/
|
|
244
|
+
readonly authorization?: string;
|
|
245
|
+
}
|
|
246
|
+
/**
|
|
247
|
+
* Request parameters for getCommissionAgreementProduct operation in CommissionAgreementProductsApi.
|
|
248
|
+
* @export
|
|
249
|
+
* @interface CommissionAgreementProductsApiGetCommissionAgreementProductRequest
|
|
250
|
+
*/
|
|
251
|
+
export interface CommissionAgreementProductsApiGetCommissionAgreementProductRequest {
|
|
252
|
+
/**
|
|
253
|
+
*
|
|
254
|
+
* @type {string}
|
|
255
|
+
* @memberof CommissionAgreementProductsApiGetCommissionAgreementProduct
|
|
256
|
+
*/
|
|
257
|
+
readonly code: string;
|
|
258
|
+
/**
|
|
259
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
260
|
+
* @type {string}
|
|
261
|
+
* @memberof CommissionAgreementProductsApiGetCommissionAgreementProduct
|
|
262
|
+
*/
|
|
263
|
+
readonly authorization?: string;
|
|
264
|
+
/**
|
|
265
|
+
* You can expand commission agreement product in this endpoint. \' + \'Allowed values: product.
|
|
266
|
+
* @type {string}
|
|
267
|
+
* @memberof CommissionAgreementProductsApiGetCommissionAgreementProduct
|
|
268
|
+
*/
|
|
269
|
+
readonly expand?: string;
|
|
270
|
+
}
|
|
271
|
+
/**
|
|
272
|
+
* Request parameters for listCommissionAgreementProducts operation in CommissionAgreementProductsApi.
|
|
273
|
+
* @export
|
|
274
|
+
* @interface CommissionAgreementProductsApiListCommissionAgreementProductsRequest
|
|
275
|
+
*/
|
|
276
|
+
export interface CommissionAgreementProductsApiListCommissionAgreementProductsRequest {
|
|
277
|
+
/**
|
|
278
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
279
|
+
* @type {string}
|
|
280
|
+
* @memberof CommissionAgreementProductsApiListCommissionAgreementProducts
|
|
281
|
+
*/
|
|
282
|
+
readonly authorization?: string;
|
|
283
|
+
/**
|
|
284
|
+
* Page size.
|
|
285
|
+
* @type {number}
|
|
286
|
+
* @memberof CommissionAgreementProductsApiListCommissionAgreementProducts
|
|
287
|
+
*/
|
|
288
|
+
readonly pageSize?: number;
|
|
289
|
+
/**
|
|
290
|
+
* Page token.
|
|
291
|
+
* @type {string}
|
|
292
|
+
* @memberof CommissionAgreementProductsApiListCommissionAgreementProducts
|
|
293
|
+
*/
|
|
294
|
+
readonly pageToken?: string;
|
|
295
|
+
/**
|
|
296
|
+
* 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: code, productId, commissionAgreementId</i>
|
|
297
|
+
* @type {string}
|
|
298
|
+
* @memberof CommissionAgreementProductsApiListCommissionAgreementProducts
|
|
299
|
+
*/
|
|
300
|
+
readonly filter?: string;
|
|
301
|
+
/**
|
|
302
|
+
* Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: productId, code</i>
|
|
303
|
+
* @type {string}
|
|
304
|
+
* @memberof CommissionAgreementProductsApiListCommissionAgreementProducts
|
|
305
|
+
*/
|
|
306
|
+
readonly search?: string;
|
|
307
|
+
/**
|
|
308
|
+
* 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>
|
|
309
|
+
* @type {string}
|
|
310
|
+
* @memberof CommissionAgreementProductsApiListCommissionAgreementProducts
|
|
311
|
+
*/
|
|
312
|
+
readonly order?: string;
|
|
313
|
+
/**
|
|
314
|
+
* 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: product.<i>
|
|
315
|
+
* @type {string}
|
|
316
|
+
* @memberof CommissionAgreementProductsApiListCommissionAgreementProducts
|
|
317
|
+
*/
|
|
318
|
+
readonly expand?: string;
|
|
319
|
+
/**
|
|
320
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, productId, commissionAgreementId</i>
|
|
321
|
+
* @type {string}
|
|
322
|
+
* @memberof CommissionAgreementProductsApiListCommissionAgreementProducts
|
|
323
|
+
*/
|
|
324
|
+
readonly filters?: string;
|
|
325
|
+
}
|
|
326
|
+
/**
|
|
327
|
+
* Request parameters for updateCommissionAgreementProduct operation in CommissionAgreementProductsApi.
|
|
328
|
+
* @export
|
|
329
|
+
* @interface CommissionAgreementProductsApiUpdateCommissionAgreementProductRequest
|
|
330
|
+
*/
|
|
331
|
+
export interface CommissionAgreementProductsApiUpdateCommissionAgreementProductRequest {
|
|
332
|
+
/**
|
|
333
|
+
*
|
|
334
|
+
* @type {string}
|
|
335
|
+
* @memberof CommissionAgreementProductsApiUpdateCommissionAgreementProduct
|
|
336
|
+
*/
|
|
337
|
+
readonly code: string;
|
|
338
|
+
/**
|
|
339
|
+
*
|
|
340
|
+
* @type {UpdateCommissionAgreementProductRequestDto}
|
|
341
|
+
* @memberof CommissionAgreementProductsApiUpdateCommissionAgreementProduct
|
|
342
|
+
*/
|
|
343
|
+
readonly updateCommissionAgreementProductRequestDto: UpdateCommissionAgreementProductRequestDto;
|
|
344
|
+
/**
|
|
345
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
346
|
+
* @type {string}
|
|
347
|
+
* @memberof CommissionAgreementProductsApiUpdateCommissionAgreementProduct
|
|
348
|
+
*/
|
|
349
|
+
readonly authorization?: string;
|
|
350
|
+
}
|
|
351
|
+
/**
|
|
352
|
+
* CommissionAgreementProductsApi - object-oriented interface
|
|
353
|
+
* @export
|
|
354
|
+
* @class CommissionAgreementProductsApi
|
|
355
|
+
* @extends {BaseAPI}
|
|
356
|
+
*/
|
|
357
|
+
export declare class CommissionAgreementProductsApi extends BaseAPI {
|
|
358
|
+
/**
|
|
359
|
+
* This will create the commission agreement product.
|
|
360
|
+
* @summary Create the Commission agreement product
|
|
361
|
+
* @param {CommissionAgreementProductsApiCreateCommissionAgreementProductRequest} requestParameters Request parameters.
|
|
362
|
+
* @param {*} [options] Override http request option.
|
|
363
|
+
* @throws {RequiredError}
|
|
364
|
+
* @memberof CommissionAgreementProductsApi
|
|
365
|
+
*/
|
|
366
|
+
createCommissionAgreementProduct(requestParameters: CommissionAgreementProductsApiCreateCommissionAgreementProductRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCommissionAgreementProductResponseClass, any>>;
|
|
367
|
+
/**
|
|
368
|
+
* Permanently deletes the commission agreement product. Supply the unique code that was returned when you created the commission agreement product and this will delete it.
|
|
369
|
+
* @summary Delete the commission agreement product
|
|
370
|
+
* @param {CommissionAgreementProductsApiDeleteCommissionAgreementProductRequest} requestParameters Request parameters.
|
|
371
|
+
* @param {*} [options] Override http request option.
|
|
372
|
+
* @throws {RequiredError}
|
|
373
|
+
* @memberof CommissionAgreementProductsApi
|
|
374
|
+
*/
|
|
375
|
+
deleteCommissionAgreementProduct(requestParameters: CommissionAgreementProductsApiDeleteCommissionAgreementProductRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any>>;
|
|
376
|
+
/**
|
|
377
|
+
* Retrieves the details of the commission agreement product that was previously created. Supply the unique commission agreement product code that was returned when you created it and Emil Api will return the corresponding commission agreement product information.
|
|
378
|
+
* @summary Retrieve the commission agreement product
|
|
379
|
+
* @param {CommissionAgreementProductsApiGetCommissionAgreementProductRequest} requestParameters Request parameters.
|
|
380
|
+
* @param {*} [options] Override http request option.
|
|
381
|
+
* @throws {RequiredError}
|
|
382
|
+
* @memberof CommissionAgreementProductsApi
|
|
383
|
+
*/
|
|
384
|
+
getCommissionAgreementProduct(requestParameters: CommissionAgreementProductsApiGetCommissionAgreementProductRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCommissionAgreementProductResponseClass, any>>;
|
|
385
|
+
/**
|
|
386
|
+
* Returns a list of commission agreement products you have previously created. The commission agreement products are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
387
|
+
* @summary List commission agreement products
|
|
388
|
+
* @param {CommissionAgreementProductsApiListCommissionAgreementProductsRequest} requestParameters Request parameters.
|
|
389
|
+
* @param {*} [options] Override http request option.
|
|
390
|
+
* @throws {RequiredError}
|
|
391
|
+
* @memberof CommissionAgreementProductsApi
|
|
392
|
+
*/
|
|
393
|
+
listCommissionAgreementProducts(requestParameters?: CommissionAgreementProductsApiListCommissionAgreementProductsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCommissionAgreementProductsResponseClass, any>>;
|
|
394
|
+
/**
|
|
395
|
+
* Updates the specified commission agreement product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
396
|
+
* @summary Update the commission agreement product
|
|
397
|
+
* @param {CommissionAgreementProductsApiUpdateCommissionAgreementProductRequest} requestParameters Request parameters.
|
|
398
|
+
* @param {*} [options] Override http request option.
|
|
399
|
+
* @throws {RequiredError}
|
|
400
|
+
* @memberof CommissionAgreementProductsApi
|
|
401
|
+
*/
|
|
402
|
+
updateCommissionAgreementProduct(requestParameters: CommissionAgreementProductsApiUpdateCommissionAgreementProductRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateCommissionAgreementProductResponseClass, any>>;
|
|
403
|
+
}
|