@emilgroup/commission-sdk 1.1.1-beta.8 → 2.1.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/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/dist/models/commission-agreement-rule-class.d.ts +6 -0
- package/models/commission-agreement-rule-class.ts +6 -0
- 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@
|
|
20
|
+
npm install @emilgroup/commission-sdk@2.1.0 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/commission-sdk@
|
|
24
|
+
yarn add @emilgroup/commission-sdk@2.1.0
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `CommissionApi`.
|
|
@@ -188,11 +188,11 @@ export const CommissionAgreementProductsApiAxiosParamCreator = 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, commissionAgreementVersionId, productSlug, status, createdAt</i>
|
|
192
192
|
* @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>
|
|
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: createdAt, updatedAt, productSlug, status</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: version<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, commissionAgreementVersionId, productSlug, status, createdAt</i>
|
|
196
196
|
* @param {*} [options] Override http request option.
|
|
197
197
|
* @throws {RequiredError}
|
|
198
198
|
*/
|
|
@@ -362,11 +362,11 @@ export const CommissionAgreementProductsApiFp = function(configuration?: Configu
|
|
|
362
362
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
363
363
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
364
364
|
* @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.
|
|
365
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
365
|
+
* @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>
|
|
366
366
|
* @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>
|
|
367
367
|
* @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>
|
|
368
368
|
* @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>
|
|
369
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
369
|
+
* @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>
|
|
370
370
|
* @param {*} [options] Override http request option.
|
|
371
371
|
* @throws {RequiredError}
|
|
372
372
|
*/
|
|
@@ -437,11 +437,11 @@ export const CommissionAgreementProductsApiFactory = function (configuration?: C
|
|
|
437
437
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
438
438
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
439
439
|
* @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.
|
|
440
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
440
|
+
* @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>
|
|
441
441
|
* @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>
|
|
442
442
|
* @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>
|
|
443
443
|
* @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>
|
|
444
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
444
|
+
* @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>
|
|
445
445
|
* @param {*} [options] Override http request option.
|
|
446
446
|
* @throws {RequiredError}
|
|
447
447
|
*/
|
|
@@ -561,7 +561,7 @@ export interface CommissionAgreementProductsApiListCommissionAgreementProductsRe
|
|
|
561
561
|
readonly pageToken?: string
|
|
562
562
|
|
|
563
563
|
/**
|
|
564
|
-
* Filter the response by one or multiple fields.
|
|
564
|
+
* 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>
|
|
565
565
|
* @type {string}
|
|
566
566
|
* @memberof CommissionAgreementProductsApiListCommissionAgreementProducts
|
|
567
567
|
*/
|
|
@@ -589,7 +589,7 @@ export interface CommissionAgreementProductsApiListCommissionAgreementProductsRe
|
|
|
589
589
|
readonly expand?: string
|
|
590
590
|
|
|
591
591
|
/**
|
|
592
|
-
* Filters the response by one or multiple fields.
|
|
592
|
+
* 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>
|
|
593
593
|
* @type {string}
|
|
594
594
|
* @memberof CommissionAgreementProductsApiListCommissionAgreementProducts
|
|
595
595
|
*/
|
|
@@ -239,11 +239,11 @@ export const CommissionAgreementRulesApiAxiosParamCreator = function (configurat
|
|
|
239
239
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
240
240
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
241
241
|
* @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.
|
|
242
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
242
|
+
* @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>
|
|
243
243
|
* @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>
|
|
244
244
|
* @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>
|
|
245
245
|
* @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>
|
|
246
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
246
|
+
* @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>
|
|
247
247
|
* @param {*} [options] Override http request option.
|
|
248
248
|
* @throws {RequiredError}
|
|
249
249
|
*/
|
|
@@ -425,11 +425,11 @@ export const CommissionAgreementRulesApiFp = function(configuration?: Configurat
|
|
|
425
425
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
426
426
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
427
427
|
* @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.
|
|
428
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
428
|
+
* @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>
|
|
429
429
|
* @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>
|
|
430
430
|
* @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>
|
|
431
431
|
* @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>
|
|
432
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
432
|
+
* @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>
|
|
433
433
|
* @param {*} [options] Override http request option.
|
|
434
434
|
* @throws {RequiredError}
|
|
435
435
|
*/
|
|
@@ -511,11 +511,11 @@ export const CommissionAgreementRulesApiFactory = function (configuration?: Conf
|
|
|
511
511
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
512
512
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
513
513
|
* @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.
|
|
514
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
514
|
+
* @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>
|
|
515
515
|
* @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>
|
|
516
516
|
* @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>
|
|
517
517
|
* @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>
|
|
518
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
518
|
+
* @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>
|
|
519
519
|
* @param {*} [options] Override http request option.
|
|
520
520
|
* @throws {RequiredError}
|
|
521
521
|
*/
|
|
@@ -656,7 +656,7 @@ export interface CommissionAgreementRulesApiListCommissionAgreementRulesRequest
|
|
|
656
656
|
readonly pageToken?: string
|
|
657
657
|
|
|
658
658
|
/**
|
|
659
|
-
* Filter the response by one or multiple fields.
|
|
659
|
+
* 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>
|
|
660
660
|
* @type {string}
|
|
661
661
|
* @memberof CommissionAgreementRulesApiListCommissionAgreementRules
|
|
662
662
|
*/
|
|
@@ -684,7 +684,7 @@ export interface CommissionAgreementRulesApiListCommissionAgreementRulesRequest
|
|
|
684
684
|
readonly expand?: string
|
|
685
685
|
|
|
686
686
|
/**
|
|
687
|
-
* Filters the response by one or multiple fields.
|
|
687
|
+
* 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>
|
|
688
688
|
* @type {string}
|
|
689
689
|
* @memberof CommissionAgreementRulesApiListCommissionAgreementRules
|
|
690
690
|
*/
|
|
@@ -184,11 +184,11 @@ export const CommissionAgreementVersionsApiAxiosParamCreator = function (configu
|
|
|
184
184
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
185
185
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
186
186
|
* @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.
|
|
187
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
187
|
+
* @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>
|
|
188
188
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
189
189
|
* @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>
|
|
190
190
|
* @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>
|
|
191
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
191
|
+
* @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>
|
|
192
192
|
* @param {*} [options] Override http request option.
|
|
193
193
|
* @throws {RequiredError}
|
|
194
194
|
*/
|
|
@@ -307,11 +307,11 @@ export const CommissionAgreementVersionsApiFp = function(configuration?: Configu
|
|
|
307
307
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
308
308
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
309
309
|
* @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.
|
|
310
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
310
|
+
* @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>
|
|
311
311
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
312
312
|
* @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>
|
|
313
313
|
* @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>
|
|
314
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
314
|
+
* @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>
|
|
315
315
|
* @param {*} [options] Override http request option.
|
|
316
316
|
* @throws {RequiredError}
|
|
317
317
|
*/
|
|
@@ -369,11 +369,11 @@ export const CommissionAgreementVersionsApiFactory = function (configuration?: C
|
|
|
369
369
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
370
370
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
371
371
|
* @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.
|
|
372
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
372
|
+
* @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>
|
|
373
373
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
374
374
|
* @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>
|
|
375
375
|
* @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>
|
|
376
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
376
|
+
* @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>
|
|
377
377
|
* @param {*} [options] Override http request option.
|
|
378
378
|
* @throws {RequiredError}
|
|
379
379
|
*/
|
|
@@ -481,7 +481,7 @@ export interface CommissionAgreementVersionsApiListCommissionAgreementVersionsRe
|
|
|
481
481
|
readonly pageToken?: string
|
|
482
482
|
|
|
483
483
|
/**
|
|
484
|
-
* Filter the response by one or multiple fields.
|
|
484
|
+
* 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>
|
|
485
485
|
* @type {string}
|
|
486
486
|
* @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
|
|
487
487
|
*/
|
|
@@ -509,7 +509,7 @@ export interface CommissionAgreementVersionsApiListCommissionAgreementVersionsRe
|
|
|
509
509
|
readonly expand?: string
|
|
510
510
|
|
|
511
511
|
/**
|
|
512
|
-
* Filters the response by one or multiple fields.
|
|
512
|
+
* 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>
|
|
513
513
|
* @type {string}
|
|
514
514
|
* @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
|
|
515
515
|
*/
|
|
@@ -192,11 +192,11 @@ export const CommissionAgreementsApiAxiosParamCreator = 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, createdAt, partnerCode, productSlug, endDate</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, commissionAgreementNumber, name, 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: commissionAgreementNumber, status, createdAt, updatedAt, billingFrequency</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<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, createdAt, partnerCode, productSlug, endDate</i>
|
|
200
200
|
* @param {*} [options] Override http request option.
|
|
201
201
|
* @throws {RequiredError}
|
|
202
202
|
*/
|
|
@@ -417,11 +417,11 @@ export const CommissionAgreementsApiFp = function(configuration?: Configuration)
|
|
|
417
417
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
418
418
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
419
419
|
* @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.
|
|
420
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
420
|
+
* @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>
|
|
421
421
|
* @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>
|
|
422
422
|
* @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>
|
|
423
423
|
* @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>
|
|
424
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
424
|
+
* @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>
|
|
425
425
|
* @param {*} [options] Override http request option.
|
|
426
426
|
* @throws {RequiredError}
|
|
427
427
|
*/
|
|
@@ -505,11 +505,11 @@ export const CommissionAgreementsApiFactory = function (configuration?: Configur
|
|
|
505
505
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
506
506
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
507
507
|
* @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.
|
|
508
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
508
|
+
* @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>
|
|
509
509
|
* @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>
|
|
510
510
|
* @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>
|
|
511
511
|
* @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>
|
|
512
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
512
|
+
* @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>
|
|
513
513
|
* @param {*} [options] Override http request option.
|
|
514
514
|
* @throws {RequiredError}
|
|
515
515
|
*/
|
|
@@ -641,7 +641,7 @@ export interface CommissionAgreementsApiListCommissionAgreementsRequest {
|
|
|
641
641
|
readonly pageToken?: string
|
|
642
642
|
|
|
643
643
|
/**
|
|
644
|
-
* Filter the response by one or multiple fields.
|
|
644
|
+
* 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>
|
|
645
645
|
* @type {string}
|
|
646
646
|
* @memberof CommissionAgreementsApiListCommissionAgreements
|
|
647
647
|
*/
|
|
@@ -669,7 +669,7 @@ export interface CommissionAgreementsApiListCommissionAgreementsRequest {
|
|
|
669
669
|
readonly expand?: string
|
|
670
670
|
|
|
671
671
|
/**
|
|
672
|
-
* Filters the response by one or multiple fields.
|
|
672
|
+
* 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>
|
|
673
673
|
* @type {string}
|
|
674
674
|
* @memberof CommissionAgreementsApiListCommissionAgreements
|
|
675
675
|
*/
|
|
@@ -188,11 +188,11 @@ export const CommissionCandidatesApiAxiosParamCreator = function (configuration?
|
|
|
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, policyCode, invoiceCode, commissionCode, candidateType, status, policyRenewalDate, createdAt</i>
|
|
192
192
|
* @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>
|
|
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: createdAt, updatedAt, policyRenewalDate</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/>
|
|
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, policyCode, invoiceCode, commissionCode, candidateType, status, policyRenewalDate, createdAt</i>
|
|
196
196
|
* @param {*} [options] Override http request option.
|
|
197
197
|
* @throws {RequiredError}
|
|
198
198
|
*/
|
|
@@ -362,11 +362,11 @@ export const CommissionCandidatesApiFp = function(configuration?: Configuration)
|
|
|
362
362
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
363
363
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
364
364
|
* @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.
|
|
365
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
365
|
+
* @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>
|
|
366
366
|
* @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>
|
|
367
367
|
* @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>
|
|
368
368
|
* @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/>
|
|
369
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
369
|
+
* @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>
|
|
370
370
|
* @param {*} [options] Override http request option.
|
|
371
371
|
* @throws {RequiredError}
|
|
372
372
|
*/
|
|
@@ -437,11 +437,11 @@ export const CommissionCandidatesApiFactory = function (configuration?: Configur
|
|
|
437
437
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
438
438
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
439
439
|
* @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.
|
|
440
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
440
|
+
* @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>
|
|
441
441
|
* @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>
|
|
442
442
|
* @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>
|
|
443
443
|
* @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/>
|
|
444
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
444
|
+
* @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>
|
|
445
445
|
* @param {*} [options] Override http request option.
|
|
446
446
|
* @throws {RequiredError}
|
|
447
447
|
*/
|
|
@@ -561,7 +561,7 @@ export interface CommissionCandidatesApiListCommissionCandidatesRequest {
|
|
|
561
561
|
readonly pageToken?: string
|
|
562
562
|
|
|
563
563
|
/**
|
|
564
|
-
* Filter the response by one or multiple fields.
|
|
564
|
+
* 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>
|
|
565
565
|
* @type {string}
|
|
566
566
|
* @memberof CommissionCandidatesApiListCommissionCandidates
|
|
567
567
|
*/
|
|
@@ -589,7 +589,7 @@ export interface CommissionCandidatesApiListCommissionCandidatesRequest {
|
|
|
589
589
|
readonly expand?: string
|
|
590
590
|
|
|
591
591
|
/**
|
|
592
|
-
* Filters the response by one or multiple fields.
|
|
592
|
+
* 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>
|
|
593
593
|
* @type {string}
|
|
594
594
|
* @memberof CommissionCandidatesApiListCommissionCandidates
|
|
595
595
|
*/
|
|
@@ -188,11 +188,11 @@ export const CommissionRecipientsApiAxiosParamCreator = function (configuration?
|
|
|
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, displayName, partnerCode, status, createdAt, commissionAgreementProductCode, commissionAgreementVersionCode</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: createdAt</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: commissionAgreementProduct<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, displayName, partnerCode, status, createdAt, commissionAgreementProductCode, commissionAgreementVersionCode</i>
|
|
196
196
|
* @param {*} [options] Override http request option.
|
|
197
197
|
* @throws {RequiredError}
|
|
198
198
|
*/
|
|
@@ -362,11 +362,11 @@ export const CommissionRecipientsApiFp = function(configuration?: Configuration)
|
|
|
362
362
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
363
363
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
364
364
|
* @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.
|
|
365
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
365
|
+
* @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>
|
|
366
366
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
367
367
|
* @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>
|
|
368
368
|
* @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>
|
|
369
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
369
|
+
* @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>
|
|
370
370
|
* @param {*} [options] Override http request option.
|
|
371
371
|
* @throws {RequiredError}
|
|
372
372
|
*/
|
|
@@ -437,11 +437,11 @@ export const CommissionRecipientsApiFactory = function (configuration?: Configur
|
|
|
437
437
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
438
438
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
439
439
|
* @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.
|
|
440
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
440
|
+
* @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>
|
|
441
441
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
442
442
|
* @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>
|
|
443
443
|
* @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>
|
|
444
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
444
|
+
* @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>
|
|
445
445
|
* @param {*} [options] Override http request option.
|
|
446
446
|
* @throws {RequiredError}
|
|
447
447
|
*/
|
|
@@ -561,7 +561,7 @@ export interface CommissionRecipientsApiListCommissionRecipientsRequest {
|
|
|
561
561
|
readonly pageToken?: string
|
|
562
562
|
|
|
563
563
|
/**
|
|
564
|
-
* Filter the response by one or multiple fields.
|
|
564
|
+
* 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>
|
|
565
565
|
* @type {string}
|
|
566
566
|
* @memberof CommissionRecipientsApiListCommissionRecipients
|
|
567
567
|
*/
|
|
@@ -589,7 +589,7 @@ export interface CommissionRecipientsApiListCommissionRecipientsRequest {
|
|
|
589
589
|
readonly expand?: string
|
|
590
590
|
|
|
591
591
|
/**
|
|
592
|
-
* Filters the response by one or multiple fields.
|
|
592
|
+
* 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>
|
|
593
593
|
* @type {string}
|
|
594
594
|
* @memberof CommissionRecipientsApiListCommissionRecipients
|
|
595
595
|
*/
|
|
@@ -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
|
*/
|
|
@@ -249,11 +249,11 @@ var CommissionAgreementProductsApiAxiosParamCreator = function (configuration) {
|
|
|
249
249
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
250
250
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
251
251
|
* @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.
|
|
252
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
252
|
+
* @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>
|
|
253
253
|
* @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>
|
|
254
254
|
* @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>
|
|
255
255
|
* @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>
|
|
256
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
256
|
+
* @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>
|
|
257
257
|
* @param {*} [options] Override http request option.
|
|
258
258
|
* @throws {RequiredError}
|
|
259
259
|
*/
|
|
@@ -448,11 +448,11 @@ var CommissionAgreementProductsApiFp = function (configuration) {
|
|
|
448
448
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
449
449
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
450
450
|
* @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.
|
|
451
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
451
|
+
* @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>
|
|
452
452
|
* @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>
|
|
453
453
|
* @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>
|
|
454
454
|
* @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>
|
|
455
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
455
|
+
* @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>
|
|
456
456
|
* @param {*} [options] Override http request option.
|
|
457
457
|
* @throws {RequiredError}
|
|
458
458
|
*/
|
|
@@ -541,11 +541,11 @@ var CommissionAgreementProductsApiFactory = function (configuration, basePath, a
|
|
|
541
541
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
542
542
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
543
543
|
* @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.
|
|
544
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
544
|
+
* @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>
|
|
545
545
|
* @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>
|
|
546
546
|
* @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>
|
|
547
547
|
* @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>
|
|
548
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
548
|
+
* @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>
|
|
549
549
|
* @param {*} [options] Override http request option.
|
|
550
550
|
* @throws {RequiredError}
|
|
551
551
|
*/
|