@emilgroup/commission-sdk-node 1.0.0-beta.83 → 1.0.0-beta.84
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/commission-agreement-products-api.ts +8 -8
- package/api/commission-agreement-rules-api.ts +8 -8
- package/api/commission-agreement-versions-api.ts +8 -8
- package/api/commission-agreements-api.ts +8 -8
- package/api/commission-candidates-api.ts +8 -8
- package/api/commission-recipients-api.ts +8 -8
- package/dist/api/commission-agreement-products-api.d.ts +8 -8
- package/dist/api/commission-agreement-products-api.js +6 -6
- package/dist/api/commission-agreement-rules-api.d.ts +8 -8
- package/dist/api/commission-agreement-rules-api.js +6 -6
- package/dist/api/commission-agreement-versions-api.d.ts +8 -8
- package/dist/api/commission-agreement-versions-api.js +6 -6
- package/dist/api/commission-agreements-api.d.ts +8 -8
- package/dist/api/commission-agreements-api.js +6 -6
- package/dist/api/commission-candidates-api.d.ts +8 -8
- package/dist/api/commission-candidates-api.js +6 -6
- package/dist/api/commission-recipients-api.d.ts +8 -8
- package/dist/api/commission-recipients-api.js +6 -6
- package/package.json +1 -1
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/commission-sdk-node@1.0.0-beta.
|
|
20
|
+
npm install @emilgroup/commission-sdk-node@1.0.0-beta.84 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/commission-sdk-node@1.0.0-beta.
|
|
24
|
+
yarn add @emilgroup/commission-sdk-node@1.0.0-beta.84
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `CommissionApi`.
|
|
@@ -192,11 +192,11 @@ export const CommissionAgreementProductsApiAxiosParamCreator = function (configu
|
|
|
192
192
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
193
193
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
194
194
|
* @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.
|
|
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: id, code, commissionAgreementVersionId, productSlug, status, createdAt</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: code, productSlug</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: createdAt, updatedAt, productSlug, status</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: version<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: id, code, commissionAgreementVersionId, productSlug, status, createdAt</i>
|
|
200
200
|
* @param {*} [options] Override http request option.
|
|
201
201
|
* @throws {RequiredError}
|
|
202
202
|
*/
|
|
@@ -366,11 +366,11 @@ export const CommissionAgreementProductsApiFp = function(configuration?: Configu
|
|
|
366
366
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
367
367
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
368
368
|
* @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.
|
|
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: id, code, commissionAgreementVersionId, productSlug, status, createdAt</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: code, productSlug</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: createdAt, updatedAt, productSlug, status</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: version<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: id, code, commissionAgreementVersionId, productSlug, status, createdAt</i>
|
|
374
374
|
* @param {*} [options] Override http request option.
|
|
375
375
|
* @throws {RequiredError}
|
|
376
376
|
*/
|
|
@@ -441,11 +441,11 @@ export const CommissionAgreementProductsApiFactory = function (configuration?: C
|
|
|
441
441
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
442
442
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
443
443
|
* @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.
|
|
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: id, code, commissionAgreementVersionId, productSlug, status, createdAt</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: code, productSlug</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: createdAt, updatedAt, productSlug, status</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: version<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: id, code, commissionAgreementVersionId, productSlug, status, createdAt</i>
|
|
449
449
|
* @param {*} [options] Override http request option.
|
|
450
450
|
* @throws {RequiredError}
|
|
451
451
|
*/
|
|
@@ -565,7 +565,7 @@ export interface CommissionAgreementProductsApiListCommissionAgreementProductsRe
|
|
|
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: id, code, commissionAgreementVersionId, productSlug, status, createdAt</i>
|
|
569
569
|
* @type {string}
|
|
570
570
|
* @memberof CommissionAgreementProductsApiListCommissionAgreementProducts
|
|
571
571
|
*/
|
|
@@ -593,7 +593,7 @@ export interface CommissionAgreementProductsApiListCommissionAgreementProductsRe
|
|
|
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: id, code, commissionAgreementVersionId, productSlug, status, createdAt</i>
|
|
597
597
|
* @type {string}
|
|
598
598
|
* @memberof CommissionAgreementProductsApiListCommissionAgreementProducts
|
|
599
599
|
*/
|
|
@@ -243,11 +243,11 @@ export const CommissionAgreementRulesApiAxiosParamCreator = function (configurat
|
|
|
243
243
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
244
244
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
245
245
|
* @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.
|
|
246
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
246
|
+
* @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, commissionAgreementVersionId, commissionAgreementProductCode, status, createdAt</i>
|
|
247
247
|
* @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: code, commissionAgreementProductCode</i>
|
|
248
248
|
* @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: code, createdAt, updatedAt, status</i>
|
|
249
249
|
* @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: version, commissionAgreementProduct<i>
|
|
250
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
250
|
+
* @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, commissionAgreementVersionId, commissionAgreementProductCode, status, createdAt</i>
|
|
251
251
|
* @param {*} [options] Override http request option.
|
|
252
252
|
* @throws {RequiredError}
|
|
253
253
|
*/
|
|
@@ -429,11 +429,11 @@ export const CommissionAgreementRulesApiFp = function(configuration?: Configurat
|
|
|
429
429
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
430
430
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
431
431
|
* @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.
|
|
432
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
432
|
+
* @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, commissionAgreementVersionId, commissionAgreementProductCode, status, createdAt</i>
|
|
433
433
|
* @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: code, commissionAgreementProductCode</i>
|
|
434
434
|
* @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: code, createdAt, updatedAt, status</i>
|
|
435
435
|
* @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: version, commissionAgreementProduct<i>
|
|
436
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
436
|
+
* @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, commissionAgreementVersionId, commissionAgreementProductCode, status, createdAt</i>
|
|
437
437
|
* @param {*} [options] Override http request option.
|
|
438
438
|
* @throws {RequiredError}
|
|
439
439
|
*/
|
|
@@ -515,11 +515,11 @@ export const CommissionAgreementRulesApiFactory = function (configuration?: Conf
|
|
|
515
515
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
516
516
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
517
517
|
* @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.
|
|
518
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
518
|
+
* @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, commissionAgreementVersionId, commissionAgreementProductCode, status, createdAt</i>
|
|
519
519
|
* @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: code, commissionAgreementProductCode</i>
|
|
520
520
|
* @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: code, createdAt, updatedAt, status</i>
|
|
521
521
|
* @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: version, commissionAgreementProduct<i>
|
|
522
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
522
|
+
* @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, commissionAgreementVersionId, commissionAgreementProductCode, status, createdAt</i>
|
|
523
523
|
* @param {*} [options] Override http request option.
|
|
524
524
|
* @throws {RequiredError}
|
|
525
525
|
*/
|
|
@@ -660,7 +660,7 @@ export interface CommissionAgreementRulesApiListCommissionAgreementRulesRequest
|
|
|
660
660
|
readonly pageToken?: string
|
|
661
661
|
|
|
662
662
|
/**
|
|
663
|
-
* Filter the response by one or multiple fields.
|
|
663
|
+
* 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, commissionAgreementVersionId, commissionAgreementProductCode, status, createdAt</i>
|
|
664
664
|
* @type {string}
|
|
665
665
|
* @memberof CommissionAgreementRulesApiListCommissionAgreementRules
|
|
666
666
|
*/
|
|
@@ -688,7 +688,7 @@ export interface CommissionAgreementRulesApiListCommissionAgreementRulesRequest
|
|
|
688
688
|
readonly expand?: string
|
|
689
689
|
|
|
690
690
|
/**
|
|
691
|
-
* Filters the response by one or multiple fields.
|
|
691
|
+
* 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, commissionAgreementVersionId, commissionAgreementProductCode, status, createdAt</i>
|
|
692
692
|
* @type {string}
|
|
693
693
|
* @memberof CommissionAgreementRulesApiListCommissionAgreementRules
|
|
694
694
|
*/
|
|
@@ -188,11 +188,11 @@ export const CommissionAgreementVersionsApiAxiosParamCreator = function (configu
|
|
|
188
188
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
189
189
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
190
190
|
* @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.
|
|
191
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
191
|
+
* @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, agreementCode, startDate, endDate, createdAt</i>
|
|
192
192
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
193
193
|
* @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: code, createdAt, startDate, endDate</i>
|
|
194
194
|
* @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: agreements<i>
|
|
195
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
195
|
+
* @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, agreementCode, startDate, endDate, createdAt</i>
|
|
196
196
|
* @param {*} [options] Override http request option.
|
|
197
197
|
* @throws {RequiredError}
|
|
198
198
|
*/
|
|
@@ -311,11 +311,11 @@ export const CommissionAgreementVersionsApiFp = function(configuration?: Configu
|
|
|
311
311
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
312
312
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
313
313
|
* @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.
|
|
314
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
314
|
+
* @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, agreementCode, startDate, endDate, createdAt</i>
|
|
315
315
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
316
316
|
* @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: code, createdAt, startDate, endDate</i>
|
|
317
317
|
* @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: agreements<i>
|
|
318
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
318
|
+
* @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, agreementCode, startDate, endDate, createdAt</i>
|
|
319
319
|
* @param {*} [options] Override http request option.
|
|
320
320
|
* @throws {RequiredError}
|
|
321
321
|
*/
|
|
@@ -373,11 +373,11 @@ export const CommissionAgreementVersionsApiFactory = function (configuration?: C
|
|
|
373
373
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
374
374
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
375
375
|
* @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.
|
|
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: id, code, agreementCode, startDate, endDate, createdAt</i>
|
|
377
377
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
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: code, createdAt, startDate, endDate</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/> <i>Allowed values: agreements<i>
|
|
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: id, code, agreementCode, startDate, endDate, createdAt</i>
|
|
381
381
|
* @param {*} [options] Override http request option.
|
|
382
382
|
* @throws {RequiredError}
|
|
383
383
|
*/
|
|
@@ -485,7 +485,7 @@ export interface CommissionAgreementVersionsApiListCommissionAgreementVersionsRe
|
|
|
485
485
|
readonly pageToken?: string
|
|
486
486
|
|
|
487
487
|
/**
|
|
488
|
-
* Filter the response by one or multiple fields.
|
|
488
|
+
* 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, agreementCode, startDate, endDate, createdAt</i>
|
|
489
489
|
* @type {string}
|
|
490
490
|
* @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
|
|
491
491
|
*/
|
|
@@ -513,7 +513,7 @@ export interface CommissionAgreementVersionsApiListCommissionAgreementVersionsRe
|
|
|
513
513
|
readonly expand?: string
|
|
514
514
|
|
|
515
515
|
/**
|
|
516
|
-
* Filters the response by one or multiple fields.
|
|
516
|
+
* 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, agreementCode, startDate, endDate, createdAt</i>
|
|
517
517
|
* @type {string}
|
|
518
518
|
* @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
|
|
519
519
|
*/
|
|
@@ -196,11 +196,11 @@ export const CommissionAgreementsApiAxiosParamCreator = function (configuration?
|
|
|
196
196
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
197
197
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
198
198
|
* @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.
|
|
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: id, code, createdAt, partnerCode, productSlug, endDate</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: code, commissionAgreementNumber, name, description</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: commissionAgreementNumber, status, createdAt, updatedAt, billingFrequency</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: versions, products<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: id, code, createdAt, partnerCode, productSlug, endDate</i>
|
|
204
204
|
* @param {*} [options] Override http request option.
|
|
205
205
|
* @throws {RequiredError}
|
|
206
206
|
*/
|
|
@@ -421,11 +421,11 @@ export const CommissionAgreementsApiFp = function(configuration?: Configuration)
|
|
|
421
421
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
422
422
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
423
423
|
* @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.
|
|
424
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
424
|
+
* @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, createdAt, partnerCode, productSlug, endDate</i>
|
|
425
425
|
* @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: code, commissionAgreementNumber, name, description</i>
|
|
426
426
|
* @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: commissionAgreementNumber, status, createdAt, updatedAt, billingFrequency</i>
|
|
427
427
|
* @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<i>
|
|
428
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
428
|
+
* @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, createdAt, partnerCode, productSlug, endDate</i>
|
|
429
429
|
* @param {*} [options] Override http request option.
|
|
430
430
|
* @throws {RequiredError}
|
|
431
431
|
*/
|
|
@@ -509,11 +509,11 @@ export const CommissionAgreementsApiFactory = function (configuration?: Configur
|
|
|
509
509
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
510
510
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
511
511
|
* @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.
|
|
512
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
512
|
+
* @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, createdAt, partnerCode, productSlug, endDate</i>
|
|
513
513
|
* @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: code, commissionAgreementNumber, name, description</i>
|
|
514
514
|
* @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: commissionAgreementNumber, status, createdAt, updatedAt, billingFrequency</i>
|
|
515
515
|
* @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<i>
|
|
516
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
516
|
+
* @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, createdAt, partnerCode, productSlug, endDate</i>
|
|
517
517
|
* @param {*} [options] Override http request option.
|
|
518
518
|
* @throws {RequiredError}
|
|
519
519
|
*/
|
|
@@ -645,7 +645,7 @@ export interface CommissionAgreementsApiListCommissionAgreementsRequest {
|
|
|
645
645
|
readonly pageToken?: string
|
|
646
646
|
|
|
647
647
|
/**
|
|
648
|
-
* Filter the response by one or multiple fields.
|
|
648
|
+
* 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, createdAt, partnerCode, productSlug, endDate</i>
|
|
649
649
|
* @type {string}
|
|
650
650
|
* @memberof CommissionAgreementsApiListCommissionAgreements
|
|
651
651
|
*/
|
|
@@ -673,7 +673,7 @@ export interface CommissionAgreementsApiListCommissionAgreementsRequest {
|
|
|
673
673
|
readonly expand?: string
|
|
674
674
|
|
|
675
675
|
/**
|
|
676
|
-
* Filters the response by one or multiple fields.
|
|
676
|
+
* 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, createdAt, partnerCode, productSlug, endDate</i>
|
|
677
677
|
* @type {string}
|
|
678
678
|
* @memberof CommissionAgreementsApiListCommissionAgreements
|
|
679
679
|
*/
|
|
@@ -192,11 +192,11 @@ export const CommissionCandidatesApiAxiosParamCreator = function (configuration?
|
|
|
192
192
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
193
193
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
194
194
|
* @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.
|
|
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: id, code, policyCode, invoiceCode, commissionCode, candidateType, status, policyRenewalDate, createdAt</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: code, policyCode, invoiceCode</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: createdAt, updatedAt, policyRenewalDate</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/>
|
|
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: id, code, policyCode, invoiceCode, commissionCode, candidateType, status, policyRenewalDate, createdAt</i>
|
|
200
200
|
* @param {*} [options] Override http request option.
|
|
201
201
|
* @throws {RequiredError}
|
|
202
202
|
*/
|
|
@@ -366,11 +366,11 @@ export const CommissionCandidatesApiFp = function(configuration?: Configuration)
|
|
|
366
366
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
367
367
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
368
368
|
* @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.
|
|
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: id, code, policyCode, invoiceCode, commissionCode, candidateType, status, policyRenewalDate, createdAt</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: code, policyCode, invoiceCode</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: createdAt, updatedAt, policyRenewalDate</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/>
|
|
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: id, code, policyCode, invoiceCode, commissionCode, candidateType, status, policyRenewalDate, createdAt</i>
|
|
374
374
|
* @param {*} [options] Override http request option.
|
|
375
375
|
* @throws {RequiredError}
|
|
376
376
|
*/
|
|
@@ -441,11 +441,11 @@ export const CommissionCandidatesApiFactory = function (configuration?: Configur
|
|
|
441
441
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
442
442
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
443
443
|
* @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.
|
|
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: id, code, policyCode, invoiceCode, commissionCode, candidateType, status, policyRenewalDate, createdAt</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: code, policyCode, invoiceCode</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: createdAt, updatedAt, policyRenewalDate</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/>
|
|
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: id, code, policyCode, invoiceCode, commissionCode, candidateType, status, policyRenewalDate, createdAt</i>
|
|
449
449
|
* @param {*} [options] Override http request option.
|
|
450
450
|
* @throws {RequiredError}
|
|
451
451
|
*/
|
|
@@ -565,7 +565,7 @@ export interface CommissionCandidatesApiListCommissionCandidatesRequest {
|
|
|
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: id, code, policyCode, invoiceCode, commissionCode, candidateType, status, policyRenewalDate, createdAt</i>
|
|
569
569
|
* @type {string}
|
|
570
570
|
* @memberof CommissionCandidatesApiListCommissionCandidates
|
|
571
571
|
*/
|
|
@@ -593,7 +593,7 @@ export interface CommissionCandidatesApiListCommissionCandidatesRequest {
|
|
|
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: id, code, policyCode, invoiceCode, commissionCode, candidateType, status, policyRenewalDate, createdAt</i>
|
|
597
597
|
* @type {string}
|
|
598
598
|
* @memberof CommissionCandidatesApiListCommissionCandidates
|
|
599
599
|
*/
|
|
@@ -243,11 +243,11 @@ export const CommissionRecipientsApiAxiosParamCreator = function (configuration?
|
|
|
243
243
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
244
244
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
245
245
|
* @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.
|
|
246
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
246
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, partnerCode, status, createdAt, commissionAgreementProductCode, commissionAgreementVersionCode</i>
|
|
247
247
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
248
248
|
* @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: createdAt</i>
|
|
249
249
|
* @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: commissionAgreementProduct<i>
|
|
250
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
250
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, displayName, partnerCode, status, createdAt, commissionAgreementProductCode, commissionAgreementVersionCode</i>
|
|
251
251
|
* @param {*} [options] Override http request option.
|
|
252
252
|
* @throws {RequiredError}
|
|
253
253
|
*/
|
|
@@ -429,11 +429,11 @@ export const CommissionRecipientsApiFp = function(configuration?: Configuration)
|
|
|
429
429
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
430
430
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
431
431
|
* @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.
|
|
432
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
432
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, partnerCode, status, createdAt, commissionAgreementProductCode, commissionAgreementVersionCode</i>
|
|
433
433
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
434
434
|
* @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: createdAt</i>
|
|
435
435
|
* @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: commissionAgreementProduct<i>
|
|
436
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
436
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, displayName, partnerCode, status, createdAt, commissionAgreementProductCode, commissionAgreementVersionCode</i>
|
|
437
437
|
* @param {*} [options] Override http request option.
|
|
438
438
|
* @throws {RequiredError}
|
|
439
439
|
*/
|
|
@@ -515,11 +515,11 @@ export const CommissionRecipientsApiFactory = function (configuration?: Configur
|
|
|
515
515
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
516
516
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
517
517
|
* @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.
|
|
518
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
518
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, partnerCode, status, createdAt, commissionAgreementProductCode, commissionAgreementVersionCode</i>
|
|
519
519
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
520
520
|
* @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: createdAt</i>
|
|
521
521
|
* @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: commissionAgreementProduct<i>
|
|
522
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
522
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, displayName, partnerCode, status, createdAt, commissionAgreementProductCode, commissionAgreementVersionCode</i>
|
|
523
523
|
* @param {*} [options] Override http request option.
|
|
524
524
|
* @throws {RequiredError}
|
|
525
525
|
*/
|
|
@@ -660,7 +660,7 @@ export interface CommissionRecipientsApiListCommissionRecipientsRequest {
|
|
|
660
660
|
readonly pageToken?: string
|
|
661
661
|
|
|
662
662
|
/**
|
|
663
|
-
* Filter the response by one or multiple fields.
|
|
663
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, partnerCode, status, createdAt, commissionAgreementProductCode, commissionAgreementVersionCode</i>
|
|
664
664
|
* @type {string}
|
|
665
665
|
* @memberof CommissionRecipientsApiListCommissionRecipients
|
|
666
666
|
*/
|
|
@@ -688,7 +688,7 @@ export interface CommissionRecipientsApiListCommissionRecipientsRequest {
|
|
|
688
688
|
readonly expand?: string
|
|
689
689
|
|
|
690
690
|
/**
|
|
691
|
-
* Filters the response by one or multiple fields.
|
|
691
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, displayName, partnerCode, status, createdAt, commissionAgreementProductCode, commissionAgreementVersionCode</i>
|
|
692
692
|
* @type {string}
|
|
693
693
|
* @memberof CommissionRecipientsApiListCommissionRecipients
|
|
694
694
|
*/
|
|
@@ -57,11 +57,11 @@ export declare const CommissionAgreementProductsApiAxiosParamCreator: (configura
|
|
|
57
57
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
58
58
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
59
59
|
* @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.
|
|
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: id, code, commissionAgreementVersionId, productSlug, status, createdAt</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: code, productSlug</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: createdAt, updatedAt, productSlug, status</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/> <i>Allowed values: version<i>
|
|
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: id, code, commissionAgreementVersionId, productSlug, status, createdAt</i>
|
|
65
65
|
* @param {*} [options] Override http request option.
|
|
66
66
|
* @throws {RequiredError}
|
|
67
67
|
*/
|
|
@@ -116,11 +116,11 @@ export declare const CommissionAgreementProductsApiFp: (configuration?: Configur
|
|
|
116
116
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
117
117
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
118
118
|
* @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.
|
|
119
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
119
|
+
* @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, commissionAgreementVersionId, productSlug, status, createdAt</i>
|
|
120
120
|
* @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: code, productSlug</i>
|
|
121
121
|
* @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: createdAt, updatedAt, productSlug, status</i>
|
|
122
122
|
* @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: version<i>
|
|
123
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
123
|
+
* @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, commissionAgreementVersionId, productSlug, status, createdAt</i>
|
|
124
124
|
* @param {*} [options] Override http request option.
|
|
125
125
|
* @throws {RequiredError}
|
|
126
126
|
*/
|
|
@@ -175,11 +175,11 @@ export declare const CommissionAgreementProductsApiFactory: (configuration?: Con
|
|
|
175
175
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
176
176
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
177
177
|
* @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.
|
|
178
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
178
|
+
* @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, commissionAgreementVersionId, productSlug, status, createdAt</i>
|
|
179
179
|
* @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: code, productSlug</i>
|
|
180
180
|
* @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: createdAt, updatedAt, productSlug, status</i>
|
|
181
181
|
* @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: version<i>
|
|
182
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
182
|
+
* @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, commissionAgreementVersionId, productSlug, status, createdAt</i>
|
|
183
183
|
* @param {*} [options] Override http request option.
|
|
184
184
|
* @throws {RequiredError}
|
|
185
185
|
*/
|
|
@@ -283,7 +283,7 @@ export interface CommissionAgreementProductsApiListCommissionAgreementProductsRe
|
|
|
283
283
|
*/
|
|
284
284
|
readonly pageToken?: string;
|
|
285
285
|
/**
|
|
286
|
-
* Filter the response by one or multiple fields.
|
|
286
|
+
* 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, commissionAgreementVersionId, productSlug, status, createdAt</i>
|
|
287
287
|
* @type {string}
|
|
288
288
|
* @memberof CommissionAgreementProductsApiListCommissionAgreementProducts
|
|
289
289
|
*/
|
|
@@ -307,7 +307,7 @@ export interface CommissionAgreementProductsApiListCommissionAgreementProductsRe
|
|
|
307
307
|
*/
|
|
308
308
|
readonly expand?: string;
|
|
309
309
|
/**
|
|
310
|
-
* Filters the response by one or multiple fields.
|
|
310
|
+
* 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, commissionAgreementVersionId, productSlug, status, createdAt</i>
|
|
311
311
|
* @type {string}
|
|
312
312
|
* @memberof CommissionAgreementProductsApiListCommissionAgreementProducts
|
|
313
313
|
*/
|
|
@@ -253,11 +253,11 @@ var CommissionAgreementProductsApiAxiosParamCreator = function (configuration) {
|
|
|
253
253
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
254
254
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
255
255
|
* @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.
|
|
256
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
256
|
+
* @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, commissionAgreementVersionId, productSlug, status, createdAt</i>
|
|
257
257
|
* @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: code, productSlug</i>
|
|
258
258
|
* @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: createdAt, updatedAt, productSlug, status</i>
|
|
259
259
|
* @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: version<i>
|
|
260
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
260
|
+
* @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, commissionAgreementVersionId, productSlug, status, createdAt</i>
|
|
261
261
|
* @param {*} [options] Override http request option.
|
|
262
262
|
* @throws {RequiredError}
|
|
263
263
|
*/
|
|
@@ -452,11 +452,11 @@ var CommissionAgreementProductsApiFp = function (configuration) {
|
|
|
452
452
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
453
453
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
454
454
|
* @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.
|
|
455
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
455
|
+
* @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, commissionAgreementVersionId, productSlug, status, createdAt</i>
|
|
456
456
|
* @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: code, productSlug</i>
|
|
457
457
|
* @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: createdAt, updatedAt, productSlug, status</i>
|
|
458
458
|
* @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: version<i>
|
|
459
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
459
|
+
* @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, commissionAgreementVersionId, productSlug, status, createdAt</i>
|
|
460
460
|
* @param {*} [options] Override http request option.
|
|
461
461
|
* @throws {RequiredError}
|
|
462
462
|
*/
|
|
@@ -545,11 +545,11 @@ var CommissionAgreementProductsApiFactory = function (configuration, basePath, a
|
|
|
545
545
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
546
546
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
547
547
|
* @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.
|
|
548
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
548
|
+
* @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, commissionAgreementVersionId, productSlug, status, createdAt</i>
|
|
549
549
|
* @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: code, productSlug</i>
|
|
550
550
|
* @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: createdAt, updatedAt, productSlug, status</i>
|
|
551
551
|
* @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: version<i>
|
|
552
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
552
|
+
* @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, commissionAgreementVersionId, productSlug, status, createdAt</i>
|
|
553
553
|
* @param {*} [options] Override http request option.
|
|
554
554
|
* @throws {RequiredError}
|
|
555
555
|
*/
|