@emilgroup/commission-sdk-node 2.9.1-beta.13 → 2.9.1-beta.130
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +11 -0
- package/README.md +2 -2
- package/api/commission-agreement-products-api.ts +4 -4
- package/api/commission-agreement-rules-api.ts +24 -10
- package/api/commission-agreement-versions-api.ts +4 -4
- package/api/commission-agreements-api.ts +4 -4
- package/api/commission-candidates-api.ts +4 -4
- package/api/commission-recipients-api.ts +4 -4
- package/api/commission-settlements-api.ts +13 -13
- package/api/commissions-api.ts +196 -8
- package/dist/api/commission-agreement-products-api.d.ts +4 -4
- package/dist/api/commission-agreement-products-api.js +3 -3
- package/dist/api/commission-agreement-rules-api.d.ts +16 -7
- package/dist/api/commission-agreement-rules-api.js +15 -9
- package/dist/api/commission-agreement-versions-api.d.ts +4 -4
- package/dist/api/commission-agreement-versions-api.js +3 -3
- package/dist/api/commission-agreements-api.d.ts +4 -4
- package/dist/api/commission-agreements-api.js +3 -3
- package/dist/api/commission-candidates-api.d.ts +4 -4
- package/dist/api/commission-candidates-api.js +3 -3
- package/dist/api/commission-recipients-api.d.ts +4 -4
- package/dist/api/commission-recipients-api.js +3 -3
- package/dist/api/commission-settlements-api.d.ts +13 -13
- package/dist/api/commission-settlements-api.js +6 -6
- package/dist/api/commissions-api.d.ts +118 -8
- package/dist/api/commissions-api.js +132 -3
- package/dist/models/clawback-config-class.d.ts +6 -0
- package/dist/models/clawback-config-dto.d.ts +6 -0
- package/dist/models/commission-agreement-class.d.ts +2 -2
- package/dist/models/commission-agreement-class.js +1 -1
- package/dist/models/commission-agreement-rule-config-dto.d.ts +7 -0
- package/dist/models/commission-agreement-version-class.d.ts +4 -4
- package/dist/models/commission-agreement-version-config-class.d.ts +32 -0
- package/dist/models/commission-agreement-version-config-class.js +15 -0
- package/dist/models/commission-agreement-version-config-dto.d.ts +32 -0
- package/dist/models/commission-agreement-version-config-dto.js +15 -0
- package/dist/models/commission-class.d.ts +15 -7
- package/dist/models/commission-class.js +3 -1
- package/dist/models/commission-creation-config-class.d.ts +43 -0
- package/dist/models/commission-creation-config-class.js +20 -0
- package/dist/models/commission-creation-config-dto.d.ts +43 -0
- package/dist/models/commission-creation-config-dto.js +20 -0
- package/dist/models/commission-creation-invoice-config-class.d.ts +24 -0
- package/dist/models/commission-creation-invoice-config-class.js +15 -0
- package/dist/models/commission-creation-invoice-config-dto.d.ts +24 -0
- package/dist/models/commission-creation-invoice-config-dto.js +15 -0
- package/dist/models/commission-creation-renewal-config-class.d.ts +29 -0
- package/dist/models/commission-creation-renewal-config-class.js +20 -0
- package/dist/models/commission-creation-renewal-config-dto.d.ts +29 -0
- package/dist/models/commission-creation-renewal-config-dto.js +20 -0
- package/dist/models/commission-estimate-class.d.ts +24 -0
- package/dist/models/commission-item-class.d.ts +18 -0
- package/dist/models/commission-paid-invoice-entry-class.d.ts +115 -0
- package/dist/models/commission-paid-invoice-entry-class.js +22 -0
- package/dist/models/commission-payout-config-dto.d.ts +29 -0
- package/dist/models/commission-payout-config-dto.js +20 -0
- package/dist/models/create-commission-agreement-request-dto.d.ts +5 -5
- package/dist/models/create-commission-agreement-request-dto.js +1 -1
- package/dist/models/create-commission-agreement-version-request-dto.d.ts +4 -4
- package/dist/models/create-commission-item-request-dto.d.ts +24 -0
- package/dist/models/estimate-commissions-request-dto.d.ts +6 -0
- package/dist/models/index.d.ts +11 -0
- package/dist/models/index.js +11 -0
- package/dist/models/list-commission-agreement-versions-response-class.d.ts +10 -10
- package/dist/models/list-commission-agreements-response-class.d.ts +10 -10
- package/dist/models/list-commission-paid-invoice-entries-response-class.d.ts +43 -0
- package/dist/models/list-commission-paid-invoice-entries-response-class.js +15 -0
- package/dist/models/scheduled-commission-clawback-trigger-class.d.ts +1 -0
- package/dist/models/scheduled-commission-clawback-trigger-class.js +2 -1
- package/dist/models/update-commission-agreement-request-dto.d.ts +2 -2
- package/dist/models/update-commission-agreement-request-dto.js +1 -1
- package/dist/models/update-commission-request-dto.d.ts +1 -1
- package/models/clawback-config-class.ts +6 -0
- package/models/clawback-config-dto.ts +6 -0
- package/models/commission-agreement-class.ts +2 -2
- package/models/commission-agreement-rule-config-dto.ts +7 -0
- package/models/commission-agreement-version-class.ts +4 -4
- package/models/commission-agreement-version-config-class.ts +38 -0
- package/models/commission-agreement-version-config-dto.ts +38 -0
- package/models/commission-class.ts +16 -8
- package/models/commission-creation-config-class.ts +52 -0
- package/models/commission-creation-config-dto.ts +52 -0
- package/models/commission-creation-invoice-config-class.ts +30 -0
- package/models/commission-creation-invoice-config-dto.ts +30 -0
- package/models/commission-creation-renewal-config-class.ts +38 -0
- package/models/commission-creation-renewal-config-dto.ts +38 -0
- package/models/commission-estimate-class.ts +24 -0
- package/models/commission-item-class.ts +18 -0
- package/models/commission-paid-invoice-entry-class.ts +124 -0
- package/models/commission-payout-config-dto.ts +38 -0
- package/models/create-commission-agreement-request-dto.ts +5 -5
- package/models/create-commission-agreement-version-request-dto.ts +4 -4
- package/models/create-commission-item-request-dto.ts +24 -0
- package/models/estimate-commissions-request-dto.ts +6 -0
- package/models/index.ts +11 -0
- package/models/list-commission-agreement-versions-response-class.ts +10 -10
- package/models/list-commission-agreements-response-class.ts +10 -10
- package/models/list-commission-paid-invoice-entries-response-class.ts +49 -0
- package/models/scheduled-commission-clawback-trigger-class.ts +2 -1
- package/models/update-commission-agreement-request-dto.ts +2 -2
- package/models/update-commission-request-dto.ts +1 -1
- package/package.json +1 -1
|
@@ -57,7 +57,7 @@ export declare const CommissionAgreementVersionsApiAxiosParamCreator: (configura
|
|
|
57
57
|
* @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.
|
|
58
58
|
* @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, settlementCreationDate, createdAt</i>
|
|
59
59
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
60
|
-
* @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, settlementCreationDate</i>
|
|
60
|
+
* @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, settlementCreationDate, id</i>
|
|
61
61
|
* @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>
|
|
62
62
|
* @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, settlementCreationDate, createdAt</i>
|
|
63
63
|
* @param {*} [options] Override http request option.
|
|
@@ -106,7 +106,7 @@ export declare const CommissionAgreementVersionsApiFp: (configuration?: Configur
|
|
|
106
106
|
* @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.
|
|
107
107
|
* @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, settlementCreationDate, createdAt</i>
|
|
108
108
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
109
|
-
* @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, settlementCreationDate</i>
|
|
109
|
+
* @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, settlementCreationDate, id</i>
|
|
110
110
|
* @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>
|
|
111
111
|
* @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, settlementCreationDate, createdAt</i>
|
|
112
112
|
* @param {*} [options] Override http request option.
|
|
@@ -155,7 +155,7 @@ export declare const CommissionAgreementVersionsApiFactory: (configuration?: Con
|
|
|
155
155
|
* @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.
|
|
156
156
|
* @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, settlementCreationDate, createdAt</i>
|
|
157
157
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
158
|
-
* @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, settlementCreationDate</i>
|
|
158
|
+
* @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, settlementCreationDate, id</i>
|
|
159
159
|
* @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>
|
|
160
160
|
* @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, settlementCreationDate, createdAt</i>
|
|
161
161
|
* @param {*} [options] Override http request option.
|
|
@@ -263,7 +263,7 @@ export interface CommissionAgreementVersionsApiListCommissionAgreementVersionsRe
|
|
|
263
263
|
*/
|
|
264
264
|
readonly search?: string;
|
|
265
265
|
/**
|
|
266
|
-
* 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, settlementCreationDate</i>
|
|
266
|
+
* 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, settlementCreationDate, id</i>
|
|
267
267
|
* @type {string}
|
|
268
268
|
* @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
|
|
269
269
|
*/
|
|
@@ -255,7 +255,7 @@ var CommissionAgreementVersionsApiAxiosParamCreator = function (configuration) {
|
|
|
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
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, agreementCode, startDate, endDate, settlementCreationDate, createdAt</i>
|
|
257
257
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
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: code, createdAt, startDate, endDate, settlementCreationDate</i>
|
|
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: code, createdAt, startDate, endDate, settlementCreationDate, id</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: agreements<i>
|
|
260
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, agreementCode, startDate, endDate, settlementCreationDate, createdAt</i>
|
|
261
261
|
* @param {*} [options] Override http request option.
|
|
@@ -401,7 +401,7 @@ var CommissionAgreementVersionsApiFp = function (configuration) {
|
|
|
401
401
|
* @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.
|
|
402
402
|
* @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, settlementCreationDate, createdAt</i>
|
|
403
403
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
404
|
-
* @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, settlementCreationDate</i>
|
|
404
|
+
* @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, settlementCreationDate, id</i>
|
|
405
405
|
* @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>
|
|
406
406
|
* @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, settlementCreationDate, createdAt</i>
|
|
407
407
|
* @param {*} [options] Override http request option.
|
|
@@ -472,7 +472,7 @@ var CommissionAgreementVersionsApiFactory = function (configuration, basePath, a
|
|
|
472
472
|
* @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.
|
|
473
473
|
* @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, settlementCreationDate, createdAt</i>
|
|
474
474
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
475
|
-
* @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, settlementCreationDate</i>
|
|
475
|
+
* @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, settlementCreationDate, id</i>
|
|
476
476
|
* @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>
|
|
477
477
|
* @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, settlementCreationDate, createdAt</i>
|
|
478
478
|
* @param {*} [options] Override http request option.
|
|
@@ -61,7 +61,7 @@ export declare const CommissionAgreementsApiAxiosParamCreator: (configuration?:
|
|
|
61
61
|
* @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.
|
|
62
62
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, createdAt, partnerCode, productSlug, endDate</i>
|
|
63
63
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, commissionAgreementNumber, name, description</i>
|
|
64
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: commissionAgreementNumber, status, createdAt, updatedAt, billingFrequency</i>
|
|
64
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: commissionAgreementNumber, status, createdAt, updatedAt, billingFrequency, id</i>
|
|
65
65
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: versions, products<i>
|
|
66
66
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, createdAt, partnerCode, productSlug, endDate</i>
|
|
67
67
|
* @param {*} [options] Override http request option.
|
|
@@ -130,7 +130,7 @@ export declare const CommissionAgreementsApiFp: (configuration?: Configuration)
|
|
|
130
130
|
* @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.
|
|
131
131
|
* @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>
|
|
132
132
|
* @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>
|
|
133
|
-
* @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>
|
|
133
|
+
* @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, id</i>
|
|
134
134
|
* @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>
|
|
135
135
|
* @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>
|
|
136
136
|
* @param {*} [options] Override http request option.
|
|
@@ -199,7 +199,7 @@ export declare const CommissionAgreementsApiFactory: (configuration?: Configurat
|
|
|
199
199
|
* @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.
|
|
200
200
|
* @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>
|
|
201
201
|
* @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>
|
|
202
|
-
* @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
|
+
* @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, id</i>
|
|
203
203
|
* @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>
|
|
204
204
|
* @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>
|
|
205
205
|
* @param {*} [options] Override http request option.
|
|
@@ -327,7 +327,7 @@ export interface CommissionAgreementsApiListCommissionAgreementsRequest {
|
|
|
327
327
|
*/
|
|
328
328
|
readonly search?: string;
|
|
329
329
|
/**
|
|
330
|
-
* 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>
|
|
330
|
+
* 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, id</i>
|
|
331
331
|
* @type {string}
|
|
332
332
|
* @memberof CommissionAgreementsApiListCommissionAgreements
|
|
333
333
|
*/
|
|
@@ -255,7 +255,7 @@ var CommissionAgreementsApiAxiosParamCreator = function (configuration) {
|
|
|
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
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, createdAt, partnerCode, productSlug, endDate</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, commissionAgreementNumber, name, description</i>
|
|
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: commissionAgreementNumber, status, createdAt, updatedAt, billingFrequency</i>
|
|
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: commissionAgreementNumber, status, createdAt, updatedAt, billingFrequency, id</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: versions, products<i>
|
|
260
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, createdAt, partnerCode, productSlug, endDate</i>
|
|
261
261
|
* @param {*} [options] Override http request option.
|
|
@@ -507,7 +507,7 @@ var CommissionAgreementsApiFp = function (configuration) {
|
|
|
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
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
|
-
* @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>
|
|
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, id</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
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.
|
|
@@ -622,7 +622,7 @@ var CommissionAgreementsApiFactory = function (configuration, basePath, axios) {
|
|
|
622
622
|
* @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.
|
|
623
623
|
* @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>
|
|
624
624
|
* @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>
|
|
625
|
-
* @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>
|
|
625
|
+
* @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, id</i>
|
|
626
626
|
* @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>
|
|
627
627
|
* @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>
|
|
628
628
|
* @param {*} [options] Override http request option.
|
|
@@ -59,7 +59,7 @@ export declare const CommissionCandidatesApiAxiosParamCreator: (configuration?:
|
|
|
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
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, policyCode, invoiceCode, commissionCode, candidateType, status, policyRenewalDate, 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, policyCode, invoiceCode</i>
|
|
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, policyRenewalDate</i>
|
|
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, policyRenewalDate, id</i>
|
|
63
63
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
64
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, policyCode, invoiceCode, commissionCode, candidateType, status, policyRenewalDate, createdAt</i>
|
|
65
65
|
* @param {*} [options] Override http request option.
|
|
@@ -118,7 +118,7 @@ export declare const CommissionCandidatesApiFp: (configuration?: Configuration)
|
|
|
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
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, policyCode, invoiceCode, commissionCode, candidateType, status, policyRenewalDate, 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, policyCode, invoiceCode</i>
|
|
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, policyRenewalDate</i>
|
|
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, policyRenewalDate, id</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/>
|
|
123
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, policyCode, invoiceCode, commissionCode, candidateType, status, policyRenewalDate, createdAt</i>
|
|
124
124
|
* @param {*} [options] Override http request option.
|
|
@@ -177,7 +177,7 @@ export declare const CommissionCandidatesApiFactory: (configuration?: Configurat
|
|
|
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
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, policyCode, invoiceCode, commissionCode, candidateType, status, policyRenewalDate, 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, policyCode, invoiceCode</i>
|
|
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, policyRenewalDate</i>
|
|
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, policyRenewalDate, id</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/>
|
|
182
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, policyCode, invoiceCode, commissionCode, candidateType, status, policyRenewalDate, createdAt</i>
|
|
183
183
|
* @param {*} [options] Override http request option.
|
|
@@ -295,7 +295,7 @@ export interface CommissionCandidatesApiListCommissionCandidatesRequest {
|
|
|
295
295
|
*/
|
|
296
296
|
readonly search?: string;
|
|
297
297
|
/**
|
|
298
|
-
* 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>
|
|
298
|
+
* 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, id</i>
|
|
299
299
|
* @type {string}
|
|
300
300
|
* @memberof CommissionCandidatesApiListCommissionCandidates
|
|
301
301
|
*/
|
|
@@ -255,7 +255,7 @@ var CommissionCandidatesApiAxiosParamCreator = function (configuration) {
|
|
|
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
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, policyCode, invoiceCode, commissionCode, candidateType, status, policyRenewalDate, 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, policyCode, invoiceCode</i>
|
|
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, policyRenewalDate</i>
|
|
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, policyRenewalDate, id</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/>
|
|
260
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, policyCode, invoiceCode, commissionCode, candidateType, status, policyRenewalDate, createdAt</i>
|
|
261
261
|
* @param {*} [options] Override http request option.
|
|
@@ -454,7 +454,7 @@ var CommissionCandidatesApiFp = function (configuration) {
|
|
|
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
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, policyCode, invoiceCode, commissionCode, candidateType, status, policyRenewalDate, 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, policyCode, invoiceCode</i>
|
|
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, policyRenewalDate</i>
|
|
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, policyRenewalDate, id</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/>
|
|
459
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, policyCode, invoiceCode, commissionCode, candidateType, status, policyRenewalDate, createdAt</i>
|
|
460
460
|
* @param {*} [options] Override http request option.
|
|
@@ -547,7 +547,7 @@ var CommissionCandidatesApiFactory = function (configuration, basePath, axios) {
|
|
|
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
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, policyCode, invoiceCode, commissionCode, candidateType, status, policyRenewalDate, 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, policyCode, invoiceCode</i>
|
|
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, policyRenewalDate</i>
|
|
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, policyRenewalDate, id</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/>
|
|
552
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, policyCode, invoiceCode, commissionCode, candidateType, status, policyRenewalDate, createdAt</i>
|
|
553
553
|
* @param {*} [options] Override http request option.
|
|
@@ -70,7 +70,7 @@ export declare const CommissionRecipientsApiAxiosParamCreator: (configuration?:
|
|
|
70
70
|
* @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.
|
|
71
71
|
* @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>
|
|
72
72
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
73
|
-
* @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>
|
|
73
|
+
* @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, id</i>
|
|
74
74
|
* @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>
|
|
75
75
|
* @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>
|
|
76
76
|
* @param {*} [options] Override http request option.
|
|
@@ -138,7 +138,7 @@ export declare const CommissionRecipientsApiFp: (configuration?: Configuration)
|
|
|
138
138
|
* @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.
|
|
139
139
|
* @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>
|
|
140
140
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
141
|
-
* @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>
|
|
141
|
+
* @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, id</i>
|
|
142
142
|
* @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>
|
|
143
143
|
* @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>
|
|
144
144
|
* @param {*} [options] Override http request option.
|
|
@@ -206,7 +206,7 @@ export declare const CommissionRecipientsApiFactory: (configuration?: Configurat
|
|
|
206
206
|
* @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.
|
|
207
207
|
* @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>
|
|
208
208
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
209
|
-
* @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>
|
|
209
|
+
* @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, id</i>
|
|
210
210
|
* @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>
|
|
211
211
|
* @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>
|
|
212
212
|
* @param {*} [options] Override http request option.
|
|
@@ -343,7 +343,7 @@ export interface CommissionRecipientsApiListCommissionRecipientsRequest {
|
|
|
343
343
|
*/
|
|
344
344
|
readonly search?: string;
|
|
345
345
|
/**
|
|
346
|
-
* 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>
|
|
346
|
+
* 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, id</i>
|
|
347
347
|
* @type {string}
|
|
348
348
|
* @memberof CommissionRecipientsApiListCommissionRecipients
|
|
349
349
|
*/
|
|
@@ -304,7 +304,7 @@ var CommissionRecipientsApiAxiosParamCreator = function (configuration) {
|
|
|
304
304
|
* @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.
|
|
305
305
|
* @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>
|
|
306
306
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
307
|
-
* @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>
|
|
307
|
+
* @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, id</i>
|
|
308
308
|
* @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>
|
|
309
309
|
* @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>
|
|
310
310
|
* @param {*} [options] Override http request option.
|
|
@@ -524,7 +524,7 @@ var CommissionRecipientsApiFp = function (configuration) {
|
|
|
524
524
|
* @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.
|
|
525
525
|
* @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>
|
|
526
526
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
527
|
-
* @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>
|
|
527
|
+
* @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, id</i>
|
|
528
528
|
* @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>
|
|
529
529
|
* @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>
|
|
530
530
|
* @param {*} [options] Override http request option.
|
|
@@ -628,7 +628,7 @@ var CommissionRecipientsApiFactory = function (configuration, basePath, axios) {
|
|
|
628
628
|
* @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.
|
|
629
629
|
* @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>
|
|
630
630
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
631
|
-
* @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>
|
|
631
|
+
* @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, id</i>
|
|
632
632
|
* @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>
|
|
633
633
|
* @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>
|
|
634
634
|
* @param {*} [options] Override http request option.
|
|
@@ -61,15 +61,15 @@ export declare const CommissionSettlementsApiAxiosParamCreator: (configuration?:
|
|
|
61
61
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
62
62
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
63
63
|
* @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.
|
|
64
|
-
* @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
64
|
+
* @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
65
65
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
66
|
-
* @param {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
66
|
+
* @param {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt' | 'id'} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
67
67
|
* @param {'commissions'} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
68
68
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
69
69
|
* @param {*} [options] Override http request option.
|
|
70
70
|
* @throws {RequiredError}
|
|
71
71
|
*/
|
|
72
|
-
listCommissionSettlements: (authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', search?: string, order?: 'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt', expand?: 'commissions', filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
72
|
+
listCommissionSettlements: (authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode', search?: string, order?: 'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt' | 'id', expand?: 'commissions', filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
73
73
|
/**
|
|
74
74
|
* This will publish multiple commission settlements.
|
|
75
75
|
* @summary Create the commission settlement publish
|
|
@@ -138,15 +138,15 @@ export declare const CommissionSettlementsApiFp: (configuration?: Configuration)
|
|
|
138
138
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
139
139
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
140
140
|
* @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.
|
|
141
|
-
* @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
141
|
+
* @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
142
142
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
143
|
-
* @param {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
143
|
+
* @param {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt' | 'id'} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
144
144
|
* @param {'commissions'} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
145
145
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
146
146
|
* @param {*} [options] Override http request option.
|
|
147
147
|
* @throws {RequiredError}
|
|
148
148
|
*/
|
|
149
|
-
listCommissionSettlements(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', search?: string, order?: 'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt', expand?: 'commissions', filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionSettlementsResponseClass>>;
|
|
149
|
+
listCommissionSettlements(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode', search?: string, order?: 'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt' | 'id', expand?: 'commissions', filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionSettlementsResponseClass>>;
|
|
150
150
|
/**
|
|
151
151
|
* This will publish multiple commission settlements.
|
|
152
152
|
* @summary Create the commission settlement publish
|
|
@@ -215,15 +215,15 @@ export declare const CommissionSettlementsApiFactory: (configuration?: Configura
|
|
|
215
215
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
216
216
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
217
217
|
* @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.
|
|
218
|
-
* @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
218
|
+
* @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
219
219
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
220
|
-
* @param {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
220
|
+
* @param {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt' | 'id'} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
221
221
|
* @param {'commissions'} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
222
222
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
223
223
|
* @param {*} [options] Override http request option.
|
|
224
224
|
* @throws {RequiredError}
|
|
225
225
|
*/
|
|
226
|
-
listCommissionSettlements(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', search?: string, order?: 'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt', expand?: 'commissions', filters?: string, options?: any): AxiosPromise<ListCommissionSettlementsResponseClass>;
|
|
226
|
+
listCommissionSettlements(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode', search?: string, order?: 'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt' | 'id', expand?: 'commissions', filters?: string, options?: any): AxiosPromise<ListCommissionSettlementsResponseClass>;
|
|
227
227
|
/**
|
|
228
228
|
* This will publish multiple commission settlements.
|
|
229
229
|
* @summary Create the commission settlement publish
|
|
@@ -342,10 +342,10 @@ export interface CommissionSettlementsApiListCommissionSettlementsRequest {
|
|
|
342
342
|
readonly pageToken?: string;
|
|
343
343
|
/**
|
|
344
344
|
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
345
|
-
* @type {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'}
|
|
345
|
+
* @type {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode'}
|
|
346
346
|
* @memberof CommissionSettlementsApiListCommissionSettlements
|
|
347
347
|
*/
|
|
348
|
-
readonly filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt';
|
|
348
|
+
readonly filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode';
|
|
349
349
|
/**
|
|
350
350
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
351
351
|
* @type {string}
|
|
@@ -354,10 +354,10 @@ export interface CommissionSettlementsApiListCommissionSettlementsRequest {
|
|
|
354
354
|
readonly search?: string;
|
|
355
355
|
/**
|
|
356
356
|
* The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
357
|
-
* @type {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'}
|
|
357
|
+
* @type {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt' | 'id'}
|
|
358
358
|
* @memberof CommissionSettlementsApiListCommissionSettlements
|
|
359
359
|
*/
|
|
360
|
-
readonly order?: 'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt';
|
|
360
|
+
readonly order?: 'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt' | 'id';
|
|
361
361
|
/**
|
|
362
362
|
* Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
363
363
|
* @type {'commissions'}
|
|
@@ -253,9 +253,9 @@ var CommissionSettlementsApiAxiosParamCreator = 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 {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
256
|
+
* @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
257
257
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
258
|
-
* @param {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
258
|
+
* @param {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt' | 'id'} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
259
259
|
* @param {'commissions'} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
260
260
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
261
261
|
* @param {*} [options] Override http request option.
|
|
@@ -550,9 +550,9 @@ var CommissionSettlementsApiFp = function (configuration) {
|
|
|
550
550
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
551
551
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
552
552
|
* @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.
|
|
553
|
-
* @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
553
|
+
* @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
554
554
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
555
|
-
* @param {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
555
|
+
* @param {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt' | 'id'} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
556
556
|
* @param {'commissions'} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
557
557
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
558
558
|
* @param {*} [options] Override http request option.
|
|
@@ -685,9 +685,9 @@ var CommissionSettlementsApiFactory = function (configuration, basePath, axios)
|
|
|
685
685
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
686
686
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
687
687
|
* @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.
|
|
688
|
-
* @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
688
|
+
* @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
689
689
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
690
|
-
* @param {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
690
|
+
* @param {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt' | 'id'} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
691
691
|
* @param {'commissions'} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
692
692
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
693
693
|
* @param {*} [options] Override http request option.
|