@emilgroup/insurance-sdk-node 1.93.1-beta.8 → 1.94.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 +0 -20
- 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.ts +0 -2
- 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.d.ts +0 -1
- package/dist/api.js +0 -1
- package/dist/models/index.d.ts +0 -19
- package/dist/models/index.js +0 -19
- package/models/index.ts +0 -19
- package/package.json +1 -1
- package/api/product-configs-api.ts +0 -242
- package/dist/api/product-configs-api.d.ts +0 -134
- package/dist/api/product-configs-api.js +0 -309
- package/dist/models/amount-with-limit-class.d.ts +0 -30
- package/dist/models/amount-with-limit-class.js +0 -15
- package/dist/models/category-class.d.ts +0 -57
- package/dist/models/category-class.js +0 -15
- package/dist/models/claim-config-class.d.ts +0 -39
- package/dist/models/claim-config-class.js +0 -15
- package/dist/models/claim-position-fields-class.d.ts +0 -31
- package/dist/models/claim-position-fields-class.js +0 -15
- package/dist/models/coverage-class.d.ts +0 -43
- package/dist/models/coverage-class.js +0 -15
- package/dist/models/coverage-term-class.d.ts +0 -54
- package/dist/models/coverage-term-class.js +0 -25
- package/dist/models/custom-field-class.d.ts +0 -50
- package/dist/models/custom-field-class.js +0 -23
- package/dist/models/deductible-class.d.ts +0 -60
- package/dist/models/deductible-class.js +0 -25
- package/dist/models/general-setting-class.d.ts +0 -56
- package/dist/models/general-setting-class.js +0 -33
- package/dist/models/product-field-override-class.d.ts +0 -48
- package/dist/models/product-field-override-class.js +0 -15
- package/dist/models/product-version-config-class.d.ts +0 -32
- package/dist/models/product-version-config-class.js +0 -15
- package/dist/models/rest-create-product-config-response-class.d.ts +0 -25
- package/dist/models/rest-create-product-config-response-class.js +0 -15
- package/dist/models/rest-create-product-config-version-response-class.d.ts +0 -25
- package/dist/models/rest-create-product-config-version-response-class.js +0 -15
- package/dist/models/shared-product-config-class.d.ts +0 -79
- package/dist/models/shared-product-config-class.js +0 -15
- package/dist/models/shared-product-config-version-class.d.ts +0 -85
- package/dist/models/shared-product-config-version-class.js +0 -21
- package/dist/models/tariff-coverage-term-class.d.ts +0 -72
- package/dist/models/tariff-coverage-term-class.js +0 -30
- package/dist/models/tariff-variation-class.d.ts +0 -64
- package/dist/models/tariff-variation-class.js +0 -15
- package/dist/models/waiting-period-class.d.ts +0 -41
- package/dist/models/waiting-period-class.js +0 -20
- package/dist/models/warning-class.d.ts +0 -47
- package/dist/models/warning-class.js +0 -20
- package/models/amount-with-limit-class.ts +0 -36
- package/models/category-class.ts +0 -63
- package/models/claim-config-class.ts +0 -45
- package/models/claim-position-fields-class.ts +0 -37
- package/models/coverage-class.ts +0 -49
- package/models/coverage-term-class.ts +0 -64
- package/models/custom-field-class.ts +0 -59
- package/models/deductible-class.ts +0 -70
- package/models/general-setting-class.ts +0 -66
- package/models/product-field-override-class.ts +0 -54
- package/models/product-version-config-class.ts +0 -38
- package/models/rest-create-product-config-response-class.ts +0 -31
- package/models/rest-create-product-config-version-response-class.ts +0 -31
- package/models/shared-product-config-class.ts +0 -85
- package/models/shared-product-config-version-class.ts +0 -94
- package/models/tariff-coverage-term-class.ts +0 -83
- package/models/tariff-variation-class.ts +0 -70
- package/models/waiting-period-class.ts +0 -50
- package/models/warning-class.ts +0 -56
package/.openapi-generator/FILES
CHANGED
|
@@ -22,7 +22,6 @@ api/partner-links-api.ts
|
|
|
22
22
|
api/partner-roles-api.ts
|
|
23
23
|
api/policies-api.ts
|
|
24
24
|
api/premium-formulas-api.ts
|
|
25
|
-
api/product-configs-api.ts
|
|
26
25
|
api/product-factors-api.ts
|
|
27
26
|
api/product-fields-api.ts
|
|
28
27
|
api/product-versions-api.ts
|
|
@@ -35,16 +34,12 @@ git_push.sh
|
|
|
35
34
|
index.ts
|
|
36
35
|
models/activate-policy-request-dto.ts
|
|
37
36
|
models/activate-policy-response-class.ts
|
|
38
|
-
models/amount-with-limit-class.ts
|
|
39
37
|
models/bank-transfer-dto.ts
|
|
40
38
|
models/billing-address-dto.ts
|
|
41
39
|
models/booking-funnel-class.ts
|
|
42
40
|
models/calculate-custom-premium-request-dto.ts
|
|
43
41
|
models/calculate-premium-request-dto.ts
|
|
44
42
|
models/calculate-product-fields-request-dto.ts
|
|
45
|
-
models/category-class.ts
|
|
46
|
-
models/claim-config-class.ts
|
|
47
|
-
models/claim-position-fields-class.ts
|
|
48
43
|
models/clone-lead-request-dto.ts
|
|
49
44
|
models/clone-product-version-request-dto.ts
|
|
50
45
|
models/commission-agreement-class.ts
|
|
@@ -52,8 +47,6 @@ models/commission-agreement-item-class.ts
|
|
|
52
47
|
models/commission-agreement-product-class.ts
|
|
53
48
|
models/commission-agreement-version-class.ts
|
|
54
49
|
models/commission-recipient-class.ts
|
|
55
|
-
models/coverage-class.ts
|
|
56
|
-
models/coverage-term-class.ts
|
|
57
50
|
models/create-account-request-dto.ts
|
|
58
51
|
models/create-bank-account-request-dto.ts
|
|
59
52
|
models/create-booking-funnel-request-dto.ts
|
|
@@ -99,8 +92,6 @@ models/create-product-version-request-dto.ts
|
|
|
99
92
|
models/create-status-transition-rule-request-dto.ts
|
|
100
93
|
models/create-status-transition-rule-response-class.ts
|
|
101
94
|
models/csv-product-factor-dto.ts
|
|
102
|
-
models/custom-field-class.ts
|
|
103
|
-
models/deductible-class.ts
|
|
104
95
|
models/delete-draft-policy-request-dto.ts
|
|
105
96
|
models/delete-response-class.ts
|
|
106
97
|
models/emil-function-class.ts
|
|
@@ -109,7 +100,6 @@ models/empty-response-class.ts
|
|
|
109
100
|
models/execute-emil-function-request-dto.ts
|
|
110
101
|
models/filter-named-range-request-dto.ts
|
|
111
102
|
models/filter-named-range-response-class.ts
|
|
112
|
-
models/general-setting-class.ts
|
|
113
103
|
models/get-booking-funnel-response-class.ts
|
|
114
104
|
models/get-booking-funnel-version-request-dto.ts
|
|
115
105
|
models/get-commission-agreement-item-response-class.ts
|
|
@@ -219,13 +209,9 @@ models/product-factor-for-version-class.ts
|
|
|
219
209
|
models/product-factor-value-class.ts
|
|
220
210
|
models/product-factor-value-for-version-class.ts
|
|
221
211
|
models/product-field-class.ts
|
|
222
|
-
models/product-field-override-class.ts
|
|
223
212
|
models/product-field-type-class.ts
|
|
224
213
|
models/product-version-class.ts
|
|
225
|
-
models/product-version-config-class.ts
|
|
226
214
|
models/rest-clone-lead-account-request-dto.ts
|
|
227
|
-
models/rest-create-product-config-response-class.ts
|
|
228
|
-
models/rest-create-product-config-version-response-class.ts
|
|
229
215
|
models/restore-policy-version-request-dto.ts
|
|
230
216
|
models/restore-policy-version-response-class.ts
|
|
231
217
|
models/sepa-dto.ts
|
|
@@ -241,8 +227,6 @@ models/shared-mandate-hash-data-dto.ts
|
|
|
241
227
|
models/shared-mandate-hash-data-response-class.ts
|
|
242
228
|
models/shared-mandate-response-class.ts
|
|
243
229
|
models/shared-payment-method-response-class.ts
|
|
244
|
-
models/shared-product-config-class.ts
|
|
245
|
-
models/shared-product-config-version-class.ts
|
|
246
230
|
models/shared-product-field-class.ts
|
|
247
231
|
models/shared-sepa-response-class.ts
|
|
248
232
|
models/shared-update-named-range-request-dto.ts
|
|
@@ -255,8 +239,6 @@ models/suspend-policy-response-class.ts
|
|
|
255
239
|
models/swap-premium-formulas-order-request-dto.ts
|
|
256
240
|
models/swap-product-fields-order-request-dto.ts
|
|
257
241
|
models/tag-class.ts
|
|
258
|
-
models/tariff-coverage-term-class.ts
|
|
259
|
-
models/tariff-variation-class.ts
|
|
260
242
|
models/terminate-policy-request-dto.ts
|
|
261
243
|
models/terminate-policy-response-class.ts
|
|
262
244
|
models/timeslice-class.ts
|
|
@@ -298,8 +280,6 @@ models/update-status-transition-rule-request-dto.ts
|
|
|
298
280
|
models/update-status-transition-rule-response-class.ts
|
|
299
281
|
models/uploaded-document-dto.ts
|
|
300
282
|
models/validate-product-factors-request-dto.ts
|
|
301
|
-
models/waiting-period-class.ts
|
|
302
|
-
models/warning-class.ts
|
|
303
283
|
models/withdraw-policy-response-class.ts
|
|
304
284
|
package.json
|
|
305
285
|
tsconfig.json
|
package/README.md
CHANGED
|
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
|
|
|
17
17
|
Navigate to the folder of your consuming project and run one of the following commands:
|
|
18
18
|
|
|
19
19
|
```
|
|
20
|
-
npm install @emilgroup/insurance-sdk-node@1.
|
|
20
|
+
npm install @emilgroup/insurance-sdk-node@1.94.0 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/insurance-sdk-node@1.
|
|
24
|
+
yarn add @emilgroup/insurance-sdk-node@1.94.0
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `PoliciesApi`.
|
|
@@ -186,16 +186,16 @@ export const BookingFunnelsApiAxiosParamCreator = function (configuration?: Conf
|
|
|
186
186
|
};
|
|
187
187
|
},
|
|
188
188
|
/**
|
|
189
|
-
* Returns a list of booking funnels you have previously created.
|
|
189
|
+
* Returns a list of booking funnels you have previously created. The booking funnels are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"policy-management.products.view\"
|
|
190
190
|
* @summary List booking funnels
|
|
191
191
|
* @param {string} [authorization] Bearer Token
|
|
192
192
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
193
193
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
194
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
194
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, productSlug, productVersionId, tenantHierarchy, createdAt, updatedAt, version, shouldShowOnApplicationsPage</i>
|
|
195
195
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
196
196
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, name, createdAt, updatedAt</i>
|
|
197
197
|
* @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: stepsConfig<i>
|
|
198
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
198
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, productSlug, productVersionId, tenantHierarchy, createdAt, updatedAt, version, shouldShowOnApplicationsPage</i>
|
|
199
199
|
* @param {*} [options] Override http request option.
|
|
200
200
|
* @throws {RequiredError}
|
|
201
201
|
*/
|
|
@@ -409,16 +409,16 @@ export const BookingFunnelsApiFp = function(configuration?: Configuration) {
|
|
|
409
409
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
410
410
|
},
|
|
411
411
|
/**
|
|
412
|
-
* Returns a list of booking funnels you have previously created.
|
|
412
|
+
* Returns a list of booking funnels you have previously created. The booking funnels are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"policy-management.products.view\"
|
|
413
413
|
* @summary List booking funnels
|
|
414
414
|
* @param {string} [authorization] Bearer Token
|
|
415
415
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
416
416
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
417
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
417
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, productSlug, productVersionId, tenantHierarchy, createdAt, updatedAt, version, shouldShowOnApplicationsPage</i>
|
|
418
418
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
419
419
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, name, createdAt, updatedAt</i>
|
|
420
420
|
* @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: stepsConfig<i>
|
|
421
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
421
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, productSlug, productVersionId, tenantHierarchy, createdAt, updatedAt, version, shouldShowOnApplicationsPage</i>
|
|
422
422
|
* @param {*} [options] Override http request option.
|
|
423
423
|
* @throws {RequiredError}
|
|
424
424
|
*/
|
|
@@ -495,16 +495,16 @@ export const BookingFunnelsApiFactory = function (configuration?: Configuration,
|
|
|
495
495
|
return localVarFp.getBookingFunnel(code, authorization, options).then((request) => request(axios, basePath));
|
|
496
496
|
},
|
|
497
497
|
/**
|
|
498
|
-
* Returns a list of booking funnels you have previously created.
|
|
498
|
+
* Returns a list of booking funnels you have previously created. The booking funnels are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"policy-management.products.view\"
|
|
499
499
|
* @summary List booking funnels
|
|
500
500
|
* @param {string} [authorization] Bearer Token
|
|
501
501
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
502
502
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
503
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
503
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, productSlug, productVersionId, tenantHierarchy, createdAt, updatedAt, version, shouldShowOnApplicationsPage</i>
|
|
504
504
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
505
505
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, name, createdAt, updatedAt</i>
|
|
506
506
|
* @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: stepsConfig<i>
|
|
507
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
507
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, productSlug, productVersionId, tenantHierarchy, createdAt, updatedAt, version, shouldShowOnApplicationsPage</i>
|
|
508
508
|
* @param {*} [options] Override http request option.
|
|
509
509
|
* @throws {RequiredError}
|
|
510
510
|
*/
|
|
@@ -628,7 +628,7 @@ export interface BookingFunnelsApiListBookingFunnelsRequest {
|
|
|
628
628
|
readonly pageToken?: string
|
|
629
629
|
|
|
630
630
|
/**
|
|
631
|
-
* Filter the response by one or multiple fields.
|
|
631
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, productSlug, productVersionId, tenantHierarchy, createdAt, updatedAt, version, shouldShowOnApplicationsPage</i>
|
|
632
632
|
* @type {string}
|
|
633
633
|
* @memberof BookingFunnelsApiListBookingFunnels
|
|
634
634
|
*/
|
|
@@ -656,7 +656,7 @@ export interface BookingFunnelsApiListBookingFunnelsRequest {
|
|
|
656
656
|
readonly expand?: string
|
|
657
657
|
|
|
658
658
|
/**
|
|
659
|
-
* Filters the response by one or multiple fields.
|
|
659
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, productSlug, productVersionId, tenantHierarchy, createdAt, updatedAt, version, shouldShowOnApplicationsPage</i>
|
|
660
660
|
* @type {string}
|
|
661
661
|
* @memberof BookingFunnelsApiListBookingFunnels
|
|
662
662
|
*/
|
|
@@ -763,7 +763,7 @@ export class BookingFunnelsApi extends BaseAPI {
|
|
|
763
763
|
}
|
|
764
764
|
|
|
765
765
|
/**
|
|
766
|
-
* Returns a list of booking funnels you have previously created.
|
|
766
|
+
* Returns a list of booking funnels you have previously created. The booking funnels are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"policy-management.products.view\"
|
|
767
767
|
* @summary List booking funnels
|
|
768
768
|
* @param {BookingFunnelsApiListBookingFunnelsRequest} requestParameters Request parameters.
|
|
769
769
|
* @param {*} [options] Override http request option.
|
|
@@ -193,16 +193,16 @@ export const CommissionAgreementItemsApiAxiosParamCreator = function (configurat
|
|
|
193
193
|
};
|
|
194
194
|
},
|
|
195
195
|
/**
|
|
196
|
-
* Returns a list of commission agreement items you have previously created.
|
|
196
|
+
* Returns a list of commission agreement items you have previously created. The commission agreement items 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\"
|
|
197
197
|
* @summary List commission agreement items
|
|
198
198
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
199
199
|
* @param {number} [pageSize] Page size.
|
|
200
200
|
* @param {string} [pageToken] Page token.
|
|
201
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
201
|
+
* @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, itemName, itemDescription, commissionFormula, commissionAgreementVersionId</i>
|
|
202
202
|
* @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: itemName, itemDescription, commissionFormula, code</i>
|
|
203
203
|
* @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, itemName, itemDescription, commissionFormula, code, , createdAt, updatedAt</i>
|
|
204
204
|
* @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/>
|
|
205
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
205
|
+
* @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, itemName, itemDescription, commissionFormula, commissionAgreementVersionId</i>
|
|
206
206
|
* @param {*} [options] Override http request option.
|
|
207
207
|
* @throws {RequiredError}
|
|
208
208
|
*/
|
|
@@ -368,16 +368,16 @@ export const CommissionAgreementItemsApiFp = function(configuration?: Configurat
|
|
|
368
368
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
369
369
|
},
|
|
370
370
|
/**
|
|
371
|
-
* Returns a list of commission agreement items you have previously created.
|
|
371
|
+
* Returns a list of commission agreement items you have previously created. The commission agreement items 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\"
|
|
372
372
|
* @summary List commission agreement items
|
|
373
373
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
374
374
|
* @param {number} [pageSize] Page size.
|
|
375
375
|
* @param {string} [pageToken] Page token.
|
|
376
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
376
|
+
* @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, itemName, itemDescription, commissionFormula, commissionAgreementVersionId</i>
|
|
377
377
|
* @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: itemName, itemDescription, commissionFormula, code</i>
|
|
378
378
|
* @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, itemName, itemDescription, commissionFormula, code, , createdAt, updatedAt</i>
|
|
379
379
|
* @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/>
|
|
380
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
380
|
+
* @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, itemName, itemDescription, commissionFormula, commissionAgreementVersionId</i>
|
|
381
381
|
* @param {*} [options] Override http request option.
|
|
382
382
|
* @throws {RequiredError}
|
|
383
383
|
*/
|
|
@@ -444,16 +444,16 @@ export const CommissionAgreementItemsApiFactory = function (configuration?: Conf
|
|
|
444
444
|
return localVarFp.getCommissionAgreementItem(code, expand, authorization, options).then((request) => request(axios, basePath));
|
|
445
445
|
},
|
|
446
446
|
/**
|
|
447
|
-
* Returns a list of commission agreement items you have previously created.
|
|
447
|
+
* Returns a list of commission agreement items you have previously created. The commission agreement items 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\"
|
|
448
448
|
* @summary List commission agreement items
|
|
449
449
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
450
450
|
* @param {number} [pageSize] Page size.
|
|
451
451
|
* @param {string} [pageToken] Page token.
|
|
452
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
452
|
+
* @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, itemName, itemDescription, commissionFormula, commissionAgreementVersionId</i>
|
|
453
453
|
* @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: itemName, itemDescription, commissionFormula, code</i>
|
|
454
454
|
* @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, itemName, itemDescription, commissionFormula, code, , createdAt, updatedAt</i>
|
|
455
455
|
* @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/>
|
|
456
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
456
|
+
* @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, itemName, itemDescription, commissionFormula, commissionAgreementVersionId</i>
|
|
457
457
|
* @param {*} [options] Override http request option.
|
|
458
458
|
* @throws {RequiredError}
|
|
459
459
|
*/
|
|
@@ -580,7 +580,7 @@ export interface CommissionAgreementItemsApiListCommissionAgreementItemsRequest
|
|
|
580
580
|
readonly pageToken?: string
|
|
581
581
|
|
|
582
582
|
/**
|
|
583
|
-
* Filter the response by one or multiple fields.
|
|
583
|
+
* 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, itemName, itemDescription, commissionFormula, commissionAgreementVersionId</i>
|
|
584
584
|
* @type {string}
|
|
585
585
|
* @memberof CommissionAgreementItemsApiListCommissionAgreementItems
|
|
586
586
|
*/
|
|
@@ -608,7 +608,7 @@ export interface CommissionAgreementItemsApiListCommissionAgreementItemsRequest
|
|
|
608
608
|
readonly expand?: string
|
|
609
609
|
|
|
610
610
|
/**
|
|
611
|
-
* Filters the response by one or multiple fields.
|
|
611
|
+
* 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, itemName, itemDescription, commissionFormula, commissionAgreementVersionId</i>
|
|
612
612
|
* @type {string}
|
|
613
613
|
* @memberof CommissionAgreementItemsApiListCommissionAgreementItems
|
|
614
614
|
*/
|
|
@@ -687,7 +687,7 @@ export class CommissionAgreementItemsApi extends BaseAPI {
|
|
|
687
687
|
}
|
|
688
688
|
|
|
689
689
|
/**
|
|
690
|
-
* Returns a list of commission agreement items you have previously created.
|
|
690
|
+
* Returns a list of commission agreement items you have previously created. The commission agreement items 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\"
|
|
691
691
|
* @summary List commission agreement items
|
|
692
692
|
* @param {CommissionAgreementItemsApiListCommissionAgreementItemsRequest} requestParameters Request parameters.
|
|
693
693
|
* @param {*} [options] Override http request option.
|
|
@@ -191,16 +191,16 @@ export const CommissionAgreementProductsApiAxiosParamCreator = function (configu
|
|
|
191
191
|
};
|
|
192
192
|
},
|
|
193
193
|
/**
|
|
194
|
-
* Returns a list of commission agreement products you have previously created.
|
|
194
|
+
* 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. **Required Permissions** \"commission-management.agreements.view\"
|
|
195
195
|
* @summary List commission agreement products
|
|
196
196
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
197
197
|
* @param {number} [pageSize] Page size.
|
|
198
198
|
* @param {string} [pageToken] Page token.
|
|
199
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
199
|
+
* @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>
|
|
200
200
|
* @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>
|
|
201
201
|
* @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, productId, code, createdAt, updatedAt</i>
|
|
202
202
|
* @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>
|
|
203
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
203
|
+
* @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>
|
|
204
204
|
* @param {*} [options] Override http request option.
|
|
205
205
|
* @throws {RequiredError}
|
|
206
206
|
*/
|
|
@@ -366,16 +366,16 @@ export const CommissionAgreementProductsApiFp = function(configuration?: Configu
|
|
|
366
366
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
367
367
|
},
|
|
368
368
|
/**
|
|
369
|
-
* Returns a list of commission agreement products you have previously created.
|
|
369
|
+
* 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. **Required Permissions** \"commission-management.agreements.view\"
|
|
370
370
|
* @summary List commission agreement products
|
|
371
371
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
372
372
|
* @param {number} [pageSize] Page size.
|
|
373
373
|
* @param {string} [pageToken] Page token.
|
|
374
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
374
|
+
* @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>
|
|
375
375
|
* @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>
|
|
376
376
|
* @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, productId, code, createdAt, updatedAt</i>
|
|
377
377
|
* @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>
|
|
378
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
378
|
+
* @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>
|
|
379
379
|
* @param {*} [options] Override http request option.
|
|
380
380
|
* @throws {RequiredError}
|
|
381
381
|
*/
|
|
@@ -442,16 +442,16 @@ export const CommissionAgreementProductsApiFactory = function (configuration?: C
|
|
|
442
442
|
return localVarFp.getCommissionAgreementProduct(code, authorization, expand, options).then((request) => request(axios, basePath));
|
|
443
443
|
},
|
|
444
444
|
/**
|
|
445
|
-
* Returns a list of commission agreement products you have previously created.
|
|
445
|
+
* 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. **Required Permissions** \"commission-management.agreements.view\"
|
|
446
446
|
* @summary List commission agreement products
|
|
447
447
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
448
448
|
* @param {number} [pageSize] Page size.
|
|
449
449
|
* @param {string} [pageToken] Page token.
|
|
450
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
450
|
+
* @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>
|
|
451
451
|
* @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>
|
|
452
452
|
* @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, productId, code, createdAt, updatedAt</i>
|
|
453
453
|
* @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>
|
|
454
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
454
|
+
* @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>
|
|
455
455
|
* @param {*} [options] Override http request option.
|
|
456
456
|
* @throws {RequiredError}
|
|
457
457
|
*/
|
|
@@ -578,7 +578,7 @@ export interface CommissionAgreementProductsApiListCommissionAgreementProductsRe
|
|
|
578
578
|
readonly pageToken?: string
|
|
579
579
|
|
|
580
580
|
/**
|
|
581
|
-
* Filter the response by one or multiple fields.
|
|
581
|
+
* 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>
|
|
582
582
|
* @type {string}
|
|
583
583
|
* @memberof CommissionAgreementProductsApiListCommissionAgreementProducts
|
|
584
584
|
*/
|
|
@@ -606,7 +606,7 @@ export interface CommissionAgreementProductsApiListCommissionAgreementProductsRe
|
|
|
606
606
|
readonly expand?: string
|
|
607
607
|
|
|
608
608
|
/**
|
|
609
|
-
* Filters the response by one or multiple fields.
|
|
609
|
+
* 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>
|
|
610
610
|
* @type {string}
|
|
611
611
|
* @memberof CommissionAgreementProductsApiListCommissionAgreementProducts
|
|
612
612
|
*/
|
|
@@ -685,7 +685,7 @@ export class CommissionAgreementProductsApi extends BaseAPI {
|
|
|
685
685
|
}
|
|
686
686
|
|
|
687
687
|
/**
|
|
688
|
-
* Returns a list of commission agreement products you have previously created.
|
|
688
|
+
* 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. **Required Permissions** \"commission-management.agreements.view\"
|
|
689
689
|
* @summary List commission agreement products
|
|
690
690
|
* @param {CommissionAgreementProductsApiListCommissionAgreementProductsRequest} requestParameters Request parameters.
|
|
691
691
|
* @param {*} [options] Override http request option.
|
|
@@ -189,16 +189,16 @@ export const CommissionAgreementVersionsApiAxiosParamCreator = function (configu
|
|
|
189
189
|
};
|
|
190
190
|
},
|
|
191
191
|
/**
|
|
192
|
-
* Returns a list of commission agreement versions you have previously created.
|
|
192
|
+
* 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\"
|
|
193
193
|
* @summary List commission agreement versions
|
|
194
194
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
195
195
|
* @param {number} [pageSize] Page size.
|
|
196
196
|
* @param {string} [pageToken] Page token.
|
|
197
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
197
|
+
* @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>
|
|
198
198
|
* @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>
|
|
199
199
|
* @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>
|
|
200
200
|
* @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/>
|
|
201
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
201
|
+
* @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>
|
|
202
202
|
* @param {*} [options] Override http request option.
|
|
203
203
|
* @throws {RequiredError}
|
|
204
204
|
*/
|
|
@@ -313,16 +313,16 @@ export const CommissionAgreementVersionsApiFp = function(configuration?: Configu
|
|
|
313
313
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
314
314
|
},
|
|
315
315
|
/**
|
|
316
|
-
* Returns a list of commission agreement versions you have previously created.
|
|
316
|
+
* 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\"
|
|
317
317
|
* @summary List commission agreement versions
|
|
318
318
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
319
319
|
* @param {number} [pageSize] Page size.
|
|
320
320
|
* @param {string} [pageToken] Page token.
|
|
321
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
321
|
+
* @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>
|
|
322
322
|
* @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>
|
|
323
323
|
* @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>
|
|
324
324
|
* @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/>
|
|
325
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
325
|
+
* @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>
|
|
326
326
|
* @param {*} [options] Override http request option.
|
|
327
327
|
* @throws {RequiredError}
|
|
328
328
|
*/
|
|
@@ -376,16 +376,16 @@ export const CommissionAgreementVersionsApiFactory = function (configuration?: C
|
|
|
376
376
|
return localVarFp.getCommissionAgreementVersion(code, expand, authorization, options).then((request) => request(axios, basePath));
|
|
377
377
|
},
|
|
378
378
|
/**
|
|
379
|
-
* Returns a list of commission agreement versions you have previously created.
|
|
379
|
+
* 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\"
|
|
380
380
|
* @summary List commission agreement versions
|
|
381
381
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
382
382
|
* @param {number} [pageSize] Page size.
|
|
383
383
|
* @param {string} [pageToken] Page token.
|
|
384
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
384
|
+
* @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>
|
|
385
385
|
* @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>
|
|
386
386
|
* @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>
|
|
387
387
|
* @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/>
|
|
388
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
388
|
+
* @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>
|
|
389
389
|
* @param {*} [options] Override http request option.
|
|
390
390
|
* @throws {RequiredError}
|
|
391
391
|
*/
|
|
@@ -500,7 +500,7 @@ export interface CommissionAgreementVersionsApiListCommissionAgreementVersionsRe
|
|
|
500
500
|
readonly pageToken?: string
|
|
501
501
|
|
|
502
502
|
/**
|
|
503
|
-
* Filter the response by one or multiple fields.
|
|
503
|
+
* 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>
|
|
504
504
|
* @type {string}
|
|
505
505
|
* @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
|
|
506
506
|
*/
|
|
@@ -528,7 +528,7 @@ export interface CommissionAgreementVersionsApiListCommissionAgreementVersionsRe
|
|
|
528
528
|
readonly expand?: string
|
|
529
529
|
|
|
530
530
|
/**
|
|
531
|
-
* Filters the response by one or multiple fields.
|
|
531
|
+
* 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>
|
|
532
532
|
* @type {string}
|
|
533
533
|
* @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
|
|
534
534
|
*/
|
|
@@ -579,7 +579,7 @@ export class CommissionAgreementVersionsApi extends BaseAPI {
|
|
|
579
579
|
}
|
|
580
580
|
|
|
581
581
|
/**
|
|
582
|
-
* Returns a list of commission agreement versions you have previously created.
|
|
582
|
+
* 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\"
|
|
583
583
|
* @summary List commission agreement versions
|
|
584
584
|
* @param {CommissionAgreementVersionsApiListCommissionAgreementVersionsRequest} requestParameters Request parameters.
|
|
585
585
|
* @param {*} [options] Override http request option.
|
|
@@ -187,16 +187,16 @@ export const CommissionAgreementsApiAxiosParamCreator = function (configuration?
|
|
|
187
187
|
};
|
|
188
188
|
},
|
|
189
189
|
/**
|
|
190
|
-
* Returns a list of commission agreements you have previously created.
|
|
190
|
+
* 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\"
|
|
191
191
|
* @summary List commission agreements
|
|
192
192
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
193
193
|
* @param {number} [pageSize] Page size.
|
|
194
194
|
* @param {string} [pageToken] Page token.
|
|
195
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
195
|
+
* @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>
|
|
196
196
|
* @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>
|
|
197
197
|
* @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>
|
|
198
198
|
* @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>
|
|
199
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
199
|
+
* @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>
|
|
200
200
|
* @param {*} [options] Override http request option.
|
|
201
201
|
* @throws {RequiredError}
|
|
202
202
|
*/
|
|
@@ -361,16 +361,16 @@ export const CommissionAgreementsApiFp = function(configuration?: Configuration)
|
|
|
361
361
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
362
362
|
},
|
|
363
363
|
/**
|
|
364
|
-
* Returns a list of commission agreements you have previously created.
|
|
364
|
+
* 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\"
|
|
365
365
|
* @summary List commission agreements
|
|
366
366
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
367
367
|
* @param {number} [pageSize] Page size.
|
|
368
368
|
* @param {string} [pageToken] Page token.
|
|
369
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
369
|
+
* @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>
|
|
370
370
|
* @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>
|
|
371
371
|
* @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>
|
|
372
372
|
* @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>
|
|
373
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
373
|
+
* @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>
|
|
374
374
|
* @param {*} [options] Override http request option.
|
|
375
375
|
* @throws {RequiredError}
|
|
376
376
|
*/
|
|
@@ -436,16 +436,16 @@ export const CommissionAgreementsApiFactory = function (configuration?: Configur
|
|
|
436
436
|
return localVarFp.getCommissionAgreement(code, authorization, expand, options).then((request) => request(axios, basePath));
|
|
437
437
|
},
|
|
438
438
|
/**
|
|
439
|
-
* Returns a list of commission agreements you have previously created.
|
|
439
|
+
* 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\"
|
|
440
440
|
* @summary List commission agreements
|
|
441
441
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
442
442
|
* @param {number} [pageSize] Page size.
|
|
443
443
|
* @param {string} [pageToken] Page token.
|
|
444
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
444
|
+
* @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>
|
|
445
445
|
* @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>
|
|
446
446
|
* @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>
|
|
447
447
|
* @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>
|
|
448
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
448
|
+
* @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>
|
|
449
449
|
* @param {*} [options] Override http request option.
|
|
450
450
|
* @throws {RequiredError}
|
|
451
451
|
*/
|
|
@@ -565,7 +565,7 @@ export interface CommissionAgreementsApiListCommissionAgreementsRequest {
|
|
|
565
565
|
readonly pageToken?: string
|
|
566
566
|
|
|
567
567
|
/**
|
|
568
|
-
* Filter the response by one or multiple fields.
|
|
568
|
+
* 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>
|
|
569
569
|
* @type {string}
|
|
570
570
|
* @memberof CommissionAgreementsApiListCommissionAgreements
|
|
571
571
|
*/
|
|
@@ -593,7 +593,7 @@ export interface CommissionAgreementsApiListCommissionAgreementsRequest {
|
|
|
593
593
|
readonly expand?: string
|
|
594
594
|
|
|
595
595
|
/**
|
|
596
|
-
* Filters the response by one or multiple fields.
|
|
596
|
+
* 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>
|
|
597
597
|
* @type {string}
|
|
598
598
|
* @memberof CommissionAgreementsApiListCommissionAgreements
|
|
599
599
|
*/
|
|
@@ -672,7 +672,7 @@ export class CommissionAgreementsApi extends BaseAPI {
|
|
|
672
672
|
}
|
|
673
673
|
|
|
674
674
|
/**
|
|
675
|
-
* Returns a list of commission agreements you have previously created.
|
|
675
|
+
* 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\"
|
|
676
676
|
* @summary List commission agreements
|
|
677
677
|
* @param {CommissionAgreementsApiListCommissionAgreementsRequest} requestParameters Request parameters.
|
|
678
678
|
* @param {*} [options] Override http request option.
|