@emilgroup/insurance-sdk-node 1.94.1-beta.0 → 1.94.1-beta.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/api/booking-funnels-api.ts +12 -12
- package/api/commission-agreement-items-api.ts +12 -12
- package/api/commission-agreement-products-api.ts +12 -12
- package/api/commission-agreement-versions-api.ts +12 -12
- package/api/commission-agreements-api.ts +12 -12
- package/api/commission-recipients-api.ts +12 -12
- package/api/partner-links-api.ts +12 -12
- package/api/policies-api.ts +36 -36
- package/api/product-configs-api.ts +8 -8
- package/dist/api/booking-funnels-api.d.ts +12 -12
- package/dist/api/booking-funnels-api.js +10 -10
- package/dist/api/commission-agreement-items-api.d.ts +12 -12
- package/dist/api/commission-agreement-items-api.js +10 -10
- package/dist/api/commission-agreement-products-api.d.ts +12 -12
- package/dist/api/commission-agreement-products-api.js +10 -10
- package/dist/api/commission-agreement-versions-api.d.ts +12 -12
- package/dist/api/commission-agreement-versions-api.js +10 -10
- package/dist/api/commission-agreements-api.d.ts +12 -12
- package/dist/api/commission-agreements-api.js +10 -10
- package/dist/api/commission-recipients-api.d.ts +12 -12
- package/dist/api/commission-recipients-api.js +10 -10
- package/dist/api/partner-links-api.d.ts +12 -12
- package/dist/api/partner-links-api.js +10 -10
- package/dist/api/policies-api.d.ts +36 -36
- package/dist/api/policies-api.js +30 -30
- package/dist/api/product-configs-api.d.ts +8 -8
- package/dist/api/product-configs-api.js +6 -6
- package/dist/models/product-version-class.d.ts +6 -0
- package/models/product-version-class.ts +6 -0
- package/package.json +1 -1
|
@@ -52,16 +52,16 @@ export declare const CommissionAgreementVersionsApiAxiosParamCreator: (configura
|
|
|
52
52
|
*/
|
|
53
53
|
getCommissionAgreementVersion: (code: string, expand: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
54
54
|
/**
|
|
55
|
-
* Returns a list of commission agreement versions you have previously created.
|
|
55
|
+
* Returns a list of commission agreement versions you have previously created. The commission agreement versions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"commission-management.agreements.view\"
|
|
56
56
|
* @summary List commission agreement versions
|
|
57
57
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
58
58
|
* @param {number} [pageSize] Page size.
|
|
59
59
|
* @param {string} [pageToken] Page token.
|
|
60
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
60
|
+
* @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, description, commissionAgreementId</i>
|
|
61
61
|
* @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: versionDescription, code</i>
|
|
62
62
|
* @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, versionDescription, code, createdAt, updatedAt</i>
|
|
63
63
|
* @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/>
|
|
64
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
64
|
+
* @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, description, commissionAgreementId</i>
|
|
65
65
|
* @param {*} [options] Override http request option.
|
|
66
66
|
* @throws {RequiredError}
|
|
67
67
|
*/
|
|
@@ -102,16 +102,16 @@ export declare const CommissionAgreementVersionsApiFp: (configuration?: Configur
|
|
|
102
102
|
*/
|
|
103
103
|
getCommissionAgreementVersion(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCommissionAgreementVersionResponseClass>>;
|
|
104
104
|
/**
|
|
105
|
-
* Returns a list of commission agreement versions you have previously created.
|
|
105
|
+
* Returns a list of commission agreement versions you have previously created. The commission agreement versions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"commission-management.agreements.view\"
|
|
106
106
|
* @summary List commission agreement versions
|
|
107
107
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
108
108
|
* @param {number} [pageSize] Page size.
|
|
109
109
|
* @param {string} [pageToken] Page token.
|
|
110
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
110
|
+
* @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, description, commissionAgreementId</i>
|
|
111
111
|
* @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: versionDescription, code</i>
|
|
112
112
|
* @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, versionDescription, code, createdAt, updatedAt</i>
|
|
113
113
|
* @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/>
|
|
114
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
114
|
+
* @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, description, commissionAgreementId</i>
|
|
115
115
|
* @param {*} [options] Override http request option.
|
|
116
116
|
* @throws {RequiredError}
|
|
117
117
|
*/
|
|
@@ -152,16 +152,16 @@ export declare const CommissionAgreementVersionsApiFactory: (configuration?: Con
|
|
|
152
152
|
*/
|
|
153
153
|
getCommissionAgreementVersion(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetCommissionAgreementVersionResponseClass>;
|
|
154
154
|
/**
|
|
155
|
-
* Returns a list of commission agreement versions you have previously created.
|
|
155
|
+
* Returns a list of commission agreement versions you have previously created. The commission agreement versions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"commission-management.agreements.view\"
|
|
156
156
|
* @summary List commission agreement versions
|
|
157
157
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
158
158
|
* @param {number} [pageSize] Page size.
|
|
159
159
|
* @param {string} [pageToken] Page token.
|
|
160
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
160
|
+
* @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, description, commissionAgreementId</i>
|
|
161
161
|
* @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: versionDescription, code</i>
|
|
162
162
|
* @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, versionDescription, code, createdAt, updatedAt</i>
|
|
163
163
|
* @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/>
|
|
164
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
164
|
+
* @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, description, commissionAgreementId</i>
|
|
165
165
|
* @param {*} [options] Override http request option.
|
|
166
166
|
* @throws {RequiredError}
|
|
167
167
|
*/
|
|
@@ -261,7 +261,7 @@ export interface CommissionAgreementVersionsApiListCommissionAgreementVersionsRe
|
|
|
261
261
|
*/
|
|
262
262
|
readonly pageToken?: string;
|
|
263
263
|
/**
|
|
264
|
-
* Filter the response by one or multiple fields.
|
|
264
|
+
* 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, description, commissionAgreementId</i>
|
|
265
265
|
* @type {string}
|
|
266
266
|
* @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
|
|
267
267
|
*/
|
|
@@ -285,7 +285,7 @@ export interface CommissionAgreementVersionsApiListCommissionAgreementVersionsRe
|
|
|
285
285
|
*/
|
|
286
286
|
readonly expand?: string;
|
|
287
287
|
/**
|
|
288
|
-
* Filters the response by one or multiple fields.
|
|
288
|
+
* 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, description, commissionAgreementId</i>
|
|
289
289
|
* @type {string}
|
|
290
290
|
* @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
|
|
291
291
|
*/
|
|
@@ -326,7 +326,7 @@ export declare class CommissionAgreementVersionsApi extends BaseAPI {
|
|
|
326
326
|
*/
|
|
327
327
|
getCommissionAgreementVersion(requestParameters: CommissionAgreementVersionsApiGetCommissionAgreementVersionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCommissionAgreementVersionResponseClass, any, {}>>;
|
|
328
328
|
/**
|
|
329
|
-
* Returns a list of commission agreement versions you have previously created.
|
|
329
|
+
* Returns a list of commission agreement versions you have previously created. The commission agreement versions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"commission-management.agreements.view\"
|
|
330
330
|
* @summary List commission agreement versions
|
|
331
331
|
* @param {CommissionAgreementVersionsApiListCommissionAgreementVersionsRequest} requestParameters Request parameters.
|
|
332
332
|
* @param {*} [options] Override http request option.
|
|
@@ -252,16 +252,16 @@ var CommissionAgreementVersionsApiAxiosParamCreator = function (configuration) {
|
|
|
252
252
|
});
|
|
253
253
|
},
|
|
254
254
|
/**
|
|
255
|
-
* Returns a list of commission agreement versions you have previously created.
|
|
255
|
+
* Returns a list of commission agreement versions you have previously created. The commission agreement versions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"commission-management.agreements.view\"
|
|
256
256
|
* @summary List commission agreement versions
|
|
257
257
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
258
258
|
* @param {number} [pageSize] Page size.
|
|
259
259
|
* @param {string} [pageToken] Page token.
|
|
260
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
260
|
+
* @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, description, commissionAgreementId</i>
|
|
261
261
|
* @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: versionDescription, code</i>
|
|
262
262
|
* @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, versionDescription, code, createdAt, updatedAt</i>
|
|
263
263
|
* @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/>
|
|
264
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
264
|
+
* @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, description, commissionAgreementId</i>
|
|
265
265
|
* @param {*} [options] Override http request option.
|
|
266
266
|
* @throws {RequiredError}
|
|
267
267
|
*/
|
|
@@ -399,16 +399,16 @@ var CommissionAgreementVersionsApiFp = function (configuration) {
|
|
|
399
399
|
});
|
|
400
400
|
},
|
|
401
401
|
/**
|
|
402
|
-
* Returns a list of commission agreement versions you have previously created.
|
|
402
|
+
* Returns a list of commission agreement versions you have previously created. The commission agreement versions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"commission-management.agreements.view\"
|
|
403
403
|
* @summary List commission agreement versions
|
|
404
404
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
405
405
|
* @param {number} [pageSize] Page size.
|
|
406
406
|
* @param {string} [pageToken] Page token.
|
|
407
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
407
|
+
* @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, description, commissionAgreementId</i>
|
|
408
408
|
* @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: versionDescription, code</i>
|
|
409
409
|
* @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, versionDescription, code, createdAt, updatedAt</i>
|
|
410
410
|
* @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/>
|
|
411
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
411
|
+
* @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, description, commissionAgreementId</i>
|
|
412
412
|
* @param {*} [options] Override http request option.
|
|
413
413
|
* @throws {RequiredError}
|
|
414
414
|
*/
|
|
@@ -471,16 +471,16 @@ var CommissionAgreementVersionsApiFactory = function (configuration, basePath, a
|
|
|
471
471
|
return localVarFp.getCommissionAgreementVersion(code, expand, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
472
472
|
},
|
|
473
473
|
/**
|
|
474
|
-
* Returns a list of commission agreement versions you have previously created.
|
|
474
|
+
* Returns a list of commission agreement versions you have previously created. The commission agreement versions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"commission-management.agreements.view\"
|
|
475
475
|
* @summary List commission agreement versions
|
|
476
476
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
477
477
|
* @param {number} [pageSize] Page size.
|
|
478
478
|
* @param {string} [pageToken] Page token.
|
|
479
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
479
|
+
* @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, description, commissionAgreementId</i>
|
|
480
480
|
* @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: versionDescription, code</i>
|
|
481
481
|
* @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, versionDescription, code, createdAt, updatedAt</i>
|
|
482
482
|
* @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/>
|
|
483
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
483
|
+
* @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, description, commissionAgreementId</i>
|
|
484
484
|
* @param {*} [options] Override http request option.
|
|
485
485
|
* @throws {RequiredError}
|
|
486
486
|
*/
|
|
@@ -538,7 +538,7 @@ var CommissionAgreementVersionsApi = /** @class */ (function (_super) {
|
|
|
538
538
|
return (0, exports.CommissionAgreementVersionsApiFp)(this.configuration).getCommissionAgreementVersion(requestParameters.code, requestParameters.expand, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
539
539
|
};
|
|
540
540
|
/**
|
|
541
|
-
* Returns a list of commission agreement versions you have previously created.
|
|
541
|
+
* Returns a list of commission agreement versions you have previously created. The commission agreement versions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"commission-management.agreements.view\"
|
|
542
542
|
* @summary List commission agreement versions
|
|
543
543
|
* @param {CommissionAgreementVersionsApiListCommissionAgreementVersionsRequest} requestParameters Request parameters.
|
|
544
544
|
* @param {*} [options] Override http request option.
|
|
@@ -53,16 +53,16 @@ export declare const CommissionAgreementsApiAxiosParamCreator: (configuration?:
|
|
|
53
53
|
*/
|
|
54
54
|
getCommissionAgreement: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55
55
|
/**
|
|
56
|
-
* Returns a list of commission agreements you have previously created.
|
|
56
|
+
* Returns a list of commission agreements you have previously created. The commission agreements are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"commission-management.agreements.view\"
|
|
57
57
|
* @summary List commission agreements
|
|
58
58
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
59
59
|
* @param {number} [pageSize] Page size.
|
|
60
60
|
* @param {string} [pageToken] Page token.
|
|
61
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
61
|
+
* @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, name, description</i>
|
|
62
62
|
* @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: name, code, description</i>
|
|
63
63
|
* @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, name, code, description, type, createdAt, updatedAt</i>
|
|
64
64
|
* @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, products, recipients<i>
|
|
65
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
65
|
+
* @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, name, description</i>
|
|
66
66
|
* @param {*} [options] Override http request option.
|
|
67
67
|
* @throws {RequiredError}
|
|
68
68
|
*/
|
|
@@ -112,16 +112,16 @@ export declare const CommissionAgreementsApiFp: (configuration?: Configuration)
|
|
|
112
112
|
*/
|
|
113
113
|
getCommissionAgreement(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCommissionAgreementResponseClass>>;
|
|
114
114
|
/**
|
|
115
|
-
* Returns a list of commission agreements you have previously created.
|
|
115
|
+
* Returns a list of commission agreements you have previously created. The commission agreements are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"commission-management.agreements.view\"
|
|
116
116
|
* @summary List commission agreements
|
|
117
117
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
118
118
|
* @param {number} [pageSize] Page size.
|
|
119
119
|
* @param {string} [pageToken] Page token.
|
|
120
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
120
|
+
* @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, name, description</i>
|
|
121
121
|
* @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: name, code, description</i>
|
|
122
122
|
* @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, name, code, description, type, createdAt, updatedAt</i>
|
|
123
123
|
* @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, products, recipients<i>
|
|
124
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
124
|
+
* @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, name, description</i>
|
|
125
125
|
* @param {*} [options] Override http request option.
|
|
126
126
|
* @throws {RequiredError}
|
|
127
127
|
*/
|
|
@@ -171,16 +171,16 @@ export declare const CommissionAgreementsApiFactory: (configuration?: Configurat
|
|
|
171
171
|
*/
|
|
172
172
|
getCommissionAgreement(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetCommissionAgreementResponseClass>;
|
|
173
173
|
/**
|
|
174
|
-
* Returns a list of commission agreements you have previously created.
|
|
174
|
+
* Returns a list of commission agreements you have previously created. The commission agreements are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"commission-management.agreements.view\"
|
|
175
175
|
* @summary List commission agreements
|
|
176
176
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
177
177
|
* @param {number} [pageSize] Page size.
|
|
178
178
|
* @param {string} [pageToken] Page token.
|
|
179
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
179
|
+
* @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, name, description</i>
|
|
180
180
|
* @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: name, code, description</i>
|
|
181
181
|
* @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, name, code, description, type, createdAt, updatedAt</i>
|
|
182
182
|
* @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, products, recipients<i>
|
|
183
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
183
|
+
* @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, name, description</i>
|
|
184
184
|
* @param {*} [options] Override http request option.
|
|
185
185
|
* @throws {RequiredError}
|
|
186
186
|
*/
|
|
@@ -284,7 +284,7 @@ export interface CommissionAgreementsApiListCommissionAgreementsRequest {
|
|
|
284
284
|
*/
|
|
285
285
|
readonly pageToken?: string;
|
|
286
286
|
/**
|
|
287
|
-
* Filter the response by one or multiple fields.
|
|
287
|
+
* 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, name, description</i>
|
|
288
288
|
* @type {string}
|
|
289
289
|
* @memberof CommissionAgreementsApiListCommissionAgreements
|
|
290
290
|
*/
|
|
@@ -308,7 +308,7 @@ export interface CommissionAgreementsApiListCommissionAgreementsRequest {
|
|
|
308
308
|
*/
|
|
309
309
|
readonly expand?: string;
|
|
310
310
|
/**
|
|
311
|
-
* Filters the response by one or multiple fields.
|
|
311
|
+
* 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, name, description</i>
|
|
312
312
|
* @type {string}
|
|
313
313
|
* @memberof CommissionAgreementsApiListCommissionAgreements
|
|
314
314
|
*/
|
|
@@ -374,7 +374,7 @@ export declare class CommissionAgreementsApi extends BaseAPI {
|
|
|
374
374
|
*/
|
|
375
375
|
getCommissionAgreement(requestParameters: CommissionAgreementsApiGetCommissionAgreementRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCommissionAgreementResponseClass, any, {}>>;
|
|
376
376
|
/**
|
|
377
|
-
* Returns a list of commission agreements you have previously created.
|
|
377
|
+
* Returns a list of commission agreements you have previously created. The commission agreements are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"commission-management.agreements.view\"
|
|
378
378
|
* @summary List commission agreements
|
|
379
379
|
* @param {CommissionAgreementsApiListCommissionAgreementsRequest} requestParameters Request parameters.
|
|
380
380
|
* @param {*} [options] Override http request option.
|
|
@@ -246,16 +246,16 @@ var CommissionAgreementsApiAxiosParamCreator = function (configuration) {
|
|
|
246
246
|
});
|
|
247
247
|
},
|
|
248
248
|
/**
|
|
249
|
-
* Returns a list of commission agreements you have previously created.
|
|
249
|
+
* Returns a list of commission agreements you have previously created. The commission agreements are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"commission-management.agreements.view\"
|
|
250
250
|
* @summary List commission agreements
|
|
251
251
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
252
252
|
* @param {number} [pageSize] Page size.
|
|
253
253
|
* @param {string} [pageToken] Page token.
|
|
254
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
254
|
+
* @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, name, description</i>
|
|
255
255
|
* @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: name, code, description</i>
|
|
256
256
|
* @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, name, code, description, type, createdAt, updatedAt</i>
|
|
257
257
|
* @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, products, recipients<i>
|
|
258
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
258
|
+
* @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, name, description</i>
|
|
259
259
|
* @param {*} [options] Override http request option.
|
|
260
260
|
* @throws {RequiredError}
|
|
261
261
|
*/
|
|
@@ -445,16 +445,16 @@ var CommissionAgreementsApiFp = function (configuration) {
|
|
|
445
445
|
});
|
|
446
446
|
},
|
|
447
447
|
/**
|
|
448
|
-
* Returns a list of commission agreements you have previously created.
|
|
448
|
+
* Returns a list of commission agreements you have previously created. The commission agreements are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"commission-management.agreements.view\"
|
|
449
449
|
* @summary List commission agreements
|
|
450
450
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
451
451
|
* @param {number} [pageSize] Page size.
|
|
452
452
|
* @param {string} [pageToken] Page token.
|
|
453
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
453
|
+
* @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, name, description</i>
|
|
454
454
|
* @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: name, code, description</i>
|
|
455
455
|
* @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, name, code, description, type, createdAt, updatedAt</i>
|
|
456
456
|
* @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, products, recipients<i>
|
|
457
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
457
|
+
* @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, name, description</i>
|
|
458
458
|
* @param {*} [options] Override http request option.
|
|
459
459
|
* @throws {RequiredError}
|
|
460
460
|
*/
|
|
@@ -538,16 +538,16 @@ var CommissionAgreementsApiFactory = function (configuration, basePath, axios) {
|
|
|
538
538
|
return localVarFp.getCommissionAgreement(code, authorization, expand, options).then(function (request) { return request(axios, basePath); });
|
|
539
539
|
},
|
|
540
540
|
/**
|
|
541
|
-
* Returns a list of commission agreements you have previously created.
|
|
541
|
+
* Returns a list of commission agreements you have previously created. The commission agreements are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"commission-management.agreements.view\"
|
|
542
542
|
* @summary List commission agreements
|
|
543
543
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
544
544
|
* @param {number} [pageSize] Page size.
|
|
545
545
|
* @param {string} [pageToken] Page token.
|
|
546
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
546
|
+
* @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, name, description</i>
|
|
547
547
|
* @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: name, code, description</i>
|
|
548
548
|
* @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, name, code, description, type, createdAt, updatedAt</i>
|
|
549
549
|
* @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, products, recipients<i>
|
|
550
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
550
|
+
* @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, name, description</i>
|
|
551
551
|
* @param {*} [options] Override http request option.
|
|
552
552
|
* @throws {RequiredError}
|
|
553
553
|
*/
|
|
@@ -617,7 +617,7 @@ var CommissionAgreementsApi = /** @class */ (function (_super) {
|
|
|
617
617
|
return (0, exports.CommissionAgreementsApiFp)(this.configuration).getCommissionAgreement(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
618
618
|
};
|
|
619
619
|
/**
|
|
620
|
-
* Returns a list of commission agreements you have previously created.
|
|
620
|
+
* Returns a list of commission agreements you have previously created. The commission agreements are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"commission-management.agreements.view\"
|
|
621
621
|
* @summary List commission agreements
|
|
622
622
|
* @param {CommissionAgreementsApiListCommissionAgreementsRequest} requestParameters Request parameters.
|
|
623
623
|
* @param {*} [options] Override http request option.
|
|
@@ -53,16 +53,16 @@ export declare const CommissionRecipientsApiAxiosParamCreator: (configuration?:
|
|
|
53
53
|
*/
|
|
54
54
|
getCommissionRecipient: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55
55
|
/**
|
|
56
|
-
* Returns a list of commission recipients you have previously created.
|
|
56
|
+
* Returns a list of commission recipients you have previously created. The commission recipients are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"commission-management.agreements.view\"
|
|
57
57
|
* @summary List commission recipients
|
|
58
58
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
59
59
|
* @param {number} [pageSize] Page size.
|
|
60
60
|
* @param {string} [pageToken] Page token.
|
|
61
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
61
|
+
* @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, partnerCode, displayName, commissionAgreementId</i>
|
|
62
62
|
* @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: displayName, partnerCode, code</i>
|
|
63
63
|
* @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, displayName, partnerCode, code, createdAt, updatedAt</i>
|
|
64
64
|
* @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/>
|
|
65
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
65
|
+
* @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, partnerCode, displayName, commissionAgreementId</i>
|
|
66
66
|
* @param {*} [options] Override http request option.
|
|
67
67
|
* @throws {RequiredError}
|
|
68
68
|
*/
|
|
@@ -112,16 +112,16 @@ export declare const CommissionRecipientsApiFp: (configuration?: Configuration)
|
|
|
112
112
|
*/
|
|
113
113
|
getCommissionRecipient(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCommissionRecipientResponseClass>>;
|
|
114
114
|
/**
|
|
115
|
-
* Returns a list of commission recipients you have previously created.
|
|
115
|
+
* Returns a list of commission recipients you have previously created. The commission recipients are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"commission-management.agreements.view\"
|
|
116
116
|
* @summary List commission recipients
|
|
117
117
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
118
118
|
* @param {number} [pageSize] Page size.
|
|
119
119
|
* @param {string} [pageToken] Page token.
|
|
120
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
120
|
+
* @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, partnerCode, displayName, commissionAgreementId</i>
|
|
121
121
|
* @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: displayName, partnerCode, code</i>
|
|
122
122
|
* @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, displayName, partnerCode, code, createdAt, updatedAt</i>
|
|
123
123
|
* @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/>
|
|
124
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
124
|
+
* @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, partnerCode, displayName, commissionAgreementId</i>
|
|
125
125
|
* @param {*} [options] Override http request option.
|
|
126
126
|
* @throws {RequiredError}
|
|
127
127
|
*/
|
|
@@ -171,16 +171,16 @@ export declare const CommissionRecipientsApiFactory: (configuration?: Configurat
|
|
|
171
171
|
*/
|
|
172
172
|
getCommissionRecipient(code: string, authorization?: string, options?: any): AxiosPromise<GetCommissionRecipientResponseClass>;
|
|
173
173
|
/**
|
|
174
|
-
* Returns a list of commission recipients you have previously created.
|
|
174
|
+
* Returns a list of commission recipients you have previously created. The commission recipients are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"commission-management.agreements.view\"
|
|
175
175
|
* @summary List commission recipients
|
|
176
176
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
177
177
|
* @param {number} [pageSize] Page size.
|
|
178
178
|
* @param {string} [pageToken] Page token.
|
|
179
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
179
|
+
* @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, partnerCode, displayName, commissionAgreementId</i>
|
|
180
180
|
* @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: displayName, partnerCode, code</i>
|
|
181
181
|
* @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, displayName, partnerCode, code, createdAt, updatedAt</i>
|
|
182
182
|
* @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/>
|
|
183
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
183
|
+
* @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, partnerCode, displayName, commissionAgreementId</i>
|
|
184
184
|
* @param {*} [options] Override http request option.
|
|
185
185
|
* @throws {RequiredError}
|
|
186
186
|
*/
|
|
@@ -284,7 +284,7 @@ export interface CommissionRecipientsApiListCommissionRecipientsRequest {
|
|
|
284
284
|
*/
|
|
285
285
|
readonly pageToken?: string;
|
|
286
286
|
/**
|
|
287
|
-
* Filter the response by one or multiple fields.
|
|
287
|
+
* 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, partnerCode, displayName, commissionAgreementId</i>
|
|
288
288
|
* @type {string}
|
|
289
289
|
* @memberof CommissionRecipientsApiListCommissionRecipients
|
|
290
290
|
*/
|
|
@@ -308,7 +308,7 @@ export interface CommissionRecipientsApiListCommissionRecipientsRequest {
|
|
|
308
308
|
*/
|
|
309
309
|
readonly expand?: string;
|
|
310
310
|
/**
|
|
311
|
-
* Filters the response by one or multiple fields.
|
|
311
|
+
* 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, partnerCode, displayName, commissionAgreementId</i>
|
|
312
312
|
* @type {string}
|
|
313
313
|
* @memberof CommissionRecipientsApiListCommissionRecipients
|
|
314
314
|
*/
|
|
@@ -374,7 +374,7 @@ export declare class CommissionRecipientsApi extends BaseAPI {
|
|
|
374
374
|
*/
|
|
375
375
|
getCommissionRecipient(requestParameters: CommissionRecipientsApiGetCommissionRecipientRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCommissionRecipientResponseClass, any, {}>>;
|
|
376
376
|
/**
|
|
377
|
-
* Returns a list of commission recipients you have previously created.
|
|
377
|
+
* Returns a list of commission recipients you have previously created. The commission recipients are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"commission-management.agreements.view\"
|
|
378
378
|
* @summary List commission recipients
|
|
379
379
|
* @param {CommissionRecipientsApiListCommissionRecipientsRequest} requestParameters Request parameters.
|
|
380
380
|
* @param {*} [options] Override http request option.
|
|
@@ -246,16 +246,16 @@ var CommissionRecipientsApiAxiosParamCreator = function (configuration) {
|
|
|
246
246
|
});
|
|
247
247
|
},
|
|
248
248
|
/**
|
|
249
|
-
* Returns a list of commission recipients you have previously created.
|
|
249
|
+
* Returns a list of commission recipients you have previously created. The commission recipients are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"commission-management.agreements.view\"
|
|
250
250
|
* @summary List commission recipients
|
|
251
251
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
252
252
|
* @param {number} [pageSize] Page size.
|
|
253
253
|
* @param {string} [pageToken] Page token.
|
|
254
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
254
|
+
* @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, partnerCode, displayName, commissionAgreementId</i>
|
|
255
255
|
* @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: displayName, partnerCode, code</i>
|
|
256
256
|
* @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, displayName, partnerCode, code, createdAt, updatedAt</i>
|
|
257
257
|
* @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/>
|
|
258
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
258
|
+
* @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, partnerCode, displayName, commissionAgreementId</i>
|
|
259
259
|
* @param {*} [options] Override http request option.
|
|
260
260
|
* @throws {RequiredError}
|
|
261
261
|
*/
|
|
@@ -445,16 +445,16 @@ var CommissionRecipientsApiFp = function (configuration) {
|
|
|
445
445
|
});
|
|
446
446
|
},
|
|
447
447
|
/**
|
|
448
|
-
* Returns a list of commission recipients you have previously created.
|
|
448
|
+
* Returns a list of commission recipients you have previously created. The commission recipients are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"commission-management.agreements.view\"
|
|
449
449
|
* @summary List commission recipients
|
|
450
450
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
451
451
|
* @param {number} [pageSize] Page size.
|
|
452
452
|
* @param {string} [pageToken] Page token.
|
|
453
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
453
|
+
* @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, partnerCode, displayName, commissionAgreementId</i>
|
|
454
454
|
* @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: displayName, partnerCode, code</i>
|
|
455
455
|
* @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, displayName, partnerCode, code, createdAt, updatedAt</i>
|
|
456
456
|
* @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/>
|
|
457
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
457
|
+
* @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, partnerCode, displayName, commissionAgreementId</i>
|
|
458
458
|
* @param {*} [options] Override http request option.
|
|
459
459
|
* @throws {RequiredError}
|
|
460
460
|
*/
|
|
@@ -538,16 +538,16 @@ var CommissionRecipientsApiFactory = function (configuration, basePath, axios) {
|
|
|
538
538
|
return localVarFp.getCommissionRecipient(code, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
539
539
|
},
|
|
540
540
|
/**
|
|
541
|
-
* Returns a list of commission recipients you have previously created.
|
|
541
|
+
* Returns a list of commission recipients you have previously created. The commission recipients are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"commission-management.agreements.view\"
|
|
542
542
|
* @summary List commission recipients
|
|
543
543
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
544
544
|
* @param {number} [pageSize] Page size.
|
|
545
545
|
* @param {string} [pageToken] Page token.
|
|
546
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
546
|
+
* @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, partnerCode, displayName, commissionAgreementId</i>
|
|
547
547
|
* @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: displayName, partnerCode, code</i>
|
|
548
548
|
* @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, displayName, partnerCode, code, createdAt, updatedAt</i>
|
|
549
549
|
* @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/>
|
|
550
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
550
|
+
* @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, partnerCode, displayName, commissionAgreementId</i>
|
|
551
551
|
* @param {*} [options] Override http request option.
|
|
552
552
|
* @throws {RequiredError}
|
|
553
553
|
*/
|
|
@@ -617,7 +617,7 @@ var CommissionRecipientsApi = /** @class */ (function (_super) {
|
|
|
617
617
|
return (0, exports.CommissionRecipientsApiFp)(this.configuration).getCommissionRecipient(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
618
618
|
};
|
|
619
619
|
/**
|
|
620
|
-
* Returns a list of commission recipients you have previously created.
|
|
620
|
+
* Returns a list of commission recipients you have previously created. The commission recipients are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"commission-management.agreements.view\"
|
|
621
621
|
* @summary List commission recipients
|
|
622
622
|
* @param {CommissionRecipientsApiListCommissionRecipientsRequest} requestParameters Request parameters.
|
|
623
623
|
* @param {*} [options] Override http request option.
|