@emilgroup/commission-sdk-node 1.0.0-beta.9 → 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/.openapi-generator/FILES +40 -0
- package/README.md +2 -2
- package/api/commission-agreement-products-api.ts +59 -17
- package/api/commission-agreement-rules-api.ts +804 -0
- package/api/commission-agreement-versions-api.ts +8 -8
- package/api/commission-agreements-api.ts +160 -27
- package/api/commission-candidates-api.ts +697 -0
- package/api/commission-recipients-api.ts +12 -12
- package/api/commission-settlements-api.ts +804 -0
- package/api/commissions-api.ts +125 -18
- package/api.ts +6 -0
- package/dist/api/commission-agreement-products-api.d.ts +39 -12
- package/dist/api/commission-agreement-products-api.js +32 -14
- package/dist/api/commission-agreement-rules-api.d.ts +450 -0
- package/dist/api/commission-agreement-rules-api.js +741 -0
- 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 +98 -23
- package/dist/api/commission-agreements-api.js +127 -22
- package/dist/api/commission-candidates-api.d.ts +393 -0
- package/dist/api/commission-candidates-api.js +648 -0
- package/dist/api/commission-recipients-api.d.ts +12 -12
- package/dist/api/commission-recipients-api.js +9 -9
- package/dist/api/commission-settlements-api.d.ts +450 -0
- package/dist/api/commission-settlements-api.js +741 -0
- package/dist/api/commissions-api.d.ts +75 -18
- package/dist/api/commissions-api.js +102 -9
- package/dist/api.d.ts +3 -0
- package/dist/api.js +3 -0
- package/dist/models/commission-agreement-class.d.ts +27 -3
- package/dist/models/commission-agreement-class.js +5 -1
- package/dist/models/commission-agreement-metadata-dto.d.ts +25 -0
- package/dist/models/commission-agreement-metadata-dto.js +15 -0
- package/dist/models/commission-agreement-metadata-partner-dto.d.ts +30 -0
- package/dist/models/commission-agreement-metadata-partner-dto.js +15 -0
- package/dist/models/commission-agreement-product-class.d.ts +6 -7
- package/dist/models/commission-agreement-rule-class.d.ts +99 -0
- package/dist/models/commission-agreement-rule-class.js +21 -0
- package/dist/models/commission-agreement-rule-config-dto.d.ts +25 -0
- package/dist/models/commission-agreement-rule-config-dto.js +15 -0
- package/dist/models/commission-agreement-rule-evaluation-class.d.ts +31 -0
- package/dist/models/commission-agreement-rule-evaluation-class.js +15 -0
- package/dist/models/commission-agreement-version-class.d.ts +7 -0
- package/dist/models/commission-candidate-class.d.ts +95 -0
- package/dist/models/commission-candidate-class.js +20 -0
- package/dist/models/commission-class.d.ts +37 -6
- package/dist/models/commission-conditions-dto.d.ts +24 -0
- package/dist/models/commission-conditions-dto.js +15 -0
- package/dist/models/commission-config-dto.d.ts +63 -0
- package/dist/models/commission-config-dto.js +34 -0
- package/dist/models/commission-estimate-class.d.ts +59 -0
- package/dist/models/commission-estimate-class.js +25 -0
- package/dist/models/commission-recipient-class.d.ts +6 -6
- package/dist/models/commission-settlement-class.d.ts +124 -0
- package/dist/models/commission-settlement-class.js +35 -0
- package/dist/models/create-commission-agreement-request-dto.d.ts +14 -3
- package/dist/models/create-commission-agreement-request-dto.js +5 -1
- package/dist/models/create-commission-agreement-rule-request-dto.d.ts +37 -0
- package/dist/models/create-commission-agreement-rule-request-dto.js +15 -0
- package/dist/models/create-commission-agreement-rule-response-class.d.ts +25 -0
- package/dist/models/create-commission-agreement-rule-response-class.js +15 -0
- package/dist/models/create-commission-agreement-version-request-dto.d.ts +1 -1
- package/dist/models/create-commission-candidate-request-dto.d.ts +65 -0
- package/dist/models/create-commission-candidate-request-dto.js +25 -0
- package/dist/models/create-commission-candidate-response-class.d.ts +25 -0
- package/dist/models/create-commission-candidate-response-class.js +15 -0
- package/dist/models/create-commission-recipient-request-dto.d.ts +2 -2
- package/dist/models/create-commission-request-dto.d.ts +3 -9
- package/dist/models/create-commission-settlement-request-dto.d.ts +57 -0
- package/dist/models/create-commission-settlement-request-dto.js +35 -0
- package/dist/models/create-commission-settlement-response-class.d.ts +25 -0
- package/dist/models/create-commission-settlement-response-class.js +15 -0
- package/dist/models/estimate-commissions-request-dto.d.ts +30 -0
- package/dist/models/estimate-commissions-request-dto.js +15 -0
- package/dist/models/estimate-commissions-response-class.d.ts +73 -0
- package/dist/models/estimate-commissions-response-class.js +15 -0
- package/dist/models/evaluate-commission-agreement-rule-request-dto.d.ts +31 -0
- package/dist/models/evaluate-commission-agreement-rule-request-dto.js +15 -0
- package/dist/models/evaluate-commission-agreement-rule-response-class.d.ts +25 -0
- package/dist/models/evaluate-commission-agreement-rule-response-class.js +15 -0
- package/dist/models/evaluated-commission-class.d.ts +54 -0
- package/dist/models/evaluated-commission-class.js +21 -0
- package/dist/models/get-commission-agreement-rule-response-class.d.ts +25 -0
- package/dist/models/get-commission-agreement-rule-response-class.js +15 -0
- package/dist/models/get-commission-candidate-response-class.d.ts +25 -0
- package/dist/models/get-commission-candidate-response-class.js +15 -0
- package/dist/models/get-commission-settlement-response-class.d.ts +25 -0
- package/dist/models/get-commission-settlement-response-class.js +15 -0
- package/dist/models/index.d.ts +37 -0
- package/dist/models/index.js +37 -0
- package/dist/models/list-commission-agreement-rules-response-class.d.ts +43 -0
- package/dist/models/list-commission-agreement-rules-response-class.js +15 -0
- package/dist/models/list-commission-candidates-response-class.d.ts +43 -0
- package/dist/models/list-commission-candidates-response-class.js +15 -0
- package/dist/models/list-commission-settlements-response-class.d.ts +43 -0
- package/dist/models/list-commission-settlements-response-class.js +15 -0
- package/dist/models/patch-commission-agreement-status-request-dto.d.ts +37 -0
- package/dist/models/patch-commission-agreement-status-request-dto.js +22 -0
- package/dist/models/patch-commission-agreement-status-response-class.d.ts +25 -0
- package/dist/models/patch-commission-agreement-status-response-class.js +15 -0
- package/dist/models/publish-commission-settlements-request-dto.d.ts +24 -0
- package/dist/models/publish-commission-settlements-request-dto.js +15 -0
- package/dist/models/publish-commission-settlements-response-class.d.ts +25 -0
- package/dist/models/publish-commission-settlements-response-class.js +15 -0
- package/dist/models/update-commission-agreement-request-dto.d.ts +3 -1
- package/dist/models/update-commission-agreement-request-dto.js +2 -0
- package/dist/models/update-commission-agreement-rule-request-dto.d.ts +49 -0
- package/dist/models/update-commission-agreement-rule-request-dto.js +21 -0
- package/dist/models/update-commission-agreement-rule-response-class.d.ts +25 -0
- package/dist/models/update-commission-agreement-rule-response-class.js +15 -0
- package/dist/models/update-commission-candidate-request-dto.d.ts +71 -0
- package/dist/models/update-commission-candidate-request-dto.js +25 -0
- package/dist/models/update-commission-candidate-response-class.d.ts +25 -0
- package/dist/models/update-commission-candidate-response-class.js +15 -0
- package/dist/models/update-commission-request-dto.d.ts +5 -3
- package/dist/models/update-commission-request-dto.js +4 -2
- package/dist/models/update-commission-settlement-request-dto.d.ts +43 -0
- package/dist/models/update-commission-settlement-request-dto.js +22 -0
- package/dist/models/update-commission-settlement-response-class.d.ts +25 -0
- package/dist/models/update-commission-settlement-response-class.js +15 -0
- package/models/commission-agreement-class.ts +27 -3
- package/models/commission-agreement-metadata-dto.ts +31 -0
- package/models/commission-agreement-metadata-partner-dto.ts +36 -0
- package/models/commission-agreement-product-class.ts +6 -7
- package/models/commission-agreement-rule-class.ts +108 -0
- package/models/commission-agreement-rule-config-dto.ts +31 -0
- package/models/commission-agreement-rule-evaluation-class.ts +37 -0
- package/models/commission-agreement-version-class.ts +7 -0
- package/models/commission-candidate-class.ts +104 -0
- package/models/commission-class.ts +37 -6
- package/models/commission-conditions-dto.ts +30 -0
- package/models/commission-config-dto.ts +73 -0
- package/models/commission-estimate-class.ts +69 -0
- package/models/commission-recipient-class.ts +6 -6
- package/models/commission-settlement-class.ts +134 -0
- package/models/create-commission-agreement-request-dto.ts +14 -3
- package/models/create-commission-agreement-rule-request-dto.ts +43 -0
- package/models/create-commission-agreement-rule-response-class.ts +31 -0
- package/models/create-commission-agreement-version-request-dto.ts +1 -1
- package/models/create-commission-candidate-request-dto.ts +75 -0
- package/models/create-commission-candidate-response-class.ts +31 -0
- package/models/create-commission-recipient-request-dto.ts +2 -2
- package/models/create-commission-request-dto.ts +3 -9
- package/models/create-commission-settlement-request-dto.ts +67 -0
- package/models/create-commission-settlement-response-class.ts +31 -0
- package/models/estimate-commissions-request-dto.ts +36 -0
- package/models/estimate-commissions-response-class.ts +79 -0
- package/models/evaluate-commission-agreement-rule-request-dto.ts +37 -0
- package/models/evaluate-commission-agreement-rule-response-class.ts +31 -0
- package/models/evaluated-commission-class.ts +63 -0
- package/models/get-commission-agreement-rule-response-class.ts +31 -0
- package/models/get-commission-candidate-response-class.ts +31 -0
- package/models/get-commission-settlement-response-class.ts +31 -0
- package/models/index.ts +37 -0
- package/models/list-commission-agreement-rules-response-class.ts +49 -0
- package/models/list-commission-candidates-response-class.ts +49 -0
- package/models/list-commission-settlements-response-class.ts +49 -0
- package/models/patch-commission-agreement-status-request-dto.ts +46 -0
- package/models/patch-commission-agreement-status-response-class.ts +31 -0
- package/models/publish-commission-settlements-request-dto.ts +30 -0
- package/models/publish-commission-settlements-response-class.ts +31 -0
- package/models/update-commission-agreement-request-dto.ts +3 -1
- package/models/update-commission-agreement-rule-request-dto.ts +58 -0
- package/models/update-commission-agreement-rule-response-class.ts +31 -0
- package/models/update-commission-candidate-request-dto.ts +81 -0
- package/models/update-commission-candidate-response-class.ts +31 -0
- package/models/update-commission-request-dto.ts +5 -3
- package/models/update-commission-settlement-request-dto.ts +52 -0
- package/models/update-commission-settlement-response-class.ts +31 -0
- package/package.json +2 -2
|
@@ -55,11 +55,11 @@ export declare const CommissionAgreementVersionsApiAxiosParamCreator: (configura
|
|
|
55
55
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
56
56
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
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
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
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, createdAt</i>
|
|
59
59
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
60
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</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
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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, createdAt</i>
|
|
63
63
|
* @param {*} [options] Override http request option.
|
|
64
64
|
* @throws {RequiredError}
|
|
65
65
|
*/
|
|
@@ -104,11 +104,11 @@ export declare const CommissionAgreementVersionsApiFp: (configuration?: Configur
|
|
|
104
104
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
105
105
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
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
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
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, createdAt</i>
|
|
108
108
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
109
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</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
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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, createdAt</i>
|
|
112
112
|
* @param {*} [options] Override http request option.
|
|
113
113
|
* @throws {RequiredError}
|
|
114
114
|
*/
|
|
@@ -153,11 +153,11 @@ export declare const CommissionAgreementVersionsApiFactory: (configuration?: Con
|
|
|
153
153
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
154
154
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
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
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
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, createdAt</i>
|
|
157
157
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
158
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</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
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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, createdAt</i>
|
|
161
161
|
* @param {*} [options] Override http request option.
|
|
162
162
|
* @throws {RequiredError}
|
|
163
163
|
*/
|
|
@@ -251,7 +251,7 @@ export interface CommissionAgreementVersionsApiListCommissionAgreementVersionsRe
|
|
|
251
251
|
*/
|
|
252
252
|
readonly pageToken?: string;
|
|
253
253
|
/**
|
|
254
|
-
* Filter the response by one or multiple fields.
|
|
254
|
+
* 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>
|
|
255
255
|
* @type {string}
|
|
256
256
|
* @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
|
|
257
257
|
*/
|
|
@@ -275,7 +275,7 @@ export interface CommissionAgreementVersionsApiListCommissionAgreementVersionsRe
|
|
|
275
275
|
*/
|
|
276
276
|
readonly expand?: string;
|
|
277
277
|
/**
|
|
278
|
-
* Filters the response by one or multiple fields.
|
|
278
|
+
* 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>
|
|
279
279
|
* @type {string}
|
|
280
280
|
* @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
|
|
281
281
|
*/
|
|
@@ -253,11 +253,11 @@ var CommissionAgreementVersionsApiAxiosParamCreator = function (configuration) {
|
|
|
253
253
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
254
254
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
255
255
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
256
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
256
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, agreementCode, startDate, endDate, createdAt</i>
|
|
257
257
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
258
258
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: code, createdAt, startDate, endDate</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
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
260
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, agreementCode, startDate, endDate, createdAt</i>
|
|
261
261
|
* @param {*} [options] Override http request option.
|
|
262
262
|
* @throws {RequiredError}
|
|
263
263
|
*/
|
|
@@ -399,11 +399,11 @@ var CommissionAgreementVersionsApiFp = function (configuration) {
|
|
|
399
399
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
400
400
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
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
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
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, createdAt</i>
|
|
403
403
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
404
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</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
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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, createdAt</i>
|
|
407
407
|
* @param {*} [options] Override http request option.
|
|
408
408
|
* @throws {RequiredError}
|
|
409
409
|
*/
|
|
@@ -470,11 +470,11 @@ var CommissionAgreementVersionsApiFactory = function (configuration, basePath, a
|
|
|
470
470
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
471
471
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
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
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
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, createdAt</i>
|
|
474
474
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
475
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</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
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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, createdAt</i>
|
|
478
478
|
* @param {*} [options] Override http request option.
|
|
479
479
|
* @throws {RequiredError}
|
|
480
480
|
*/
|
|
@@ -16,6 +16,8 @@ import { CreateCommissionAgreementRequestDto } from '../models';
|
|
|
16
16
|
import { CreateCommissionAgreementResponseClass } from '../models';
|
|
17
17
|
import { GetCommissionAgreementResponseClass } from '../models';
|
|
18
18
|
import { ListCommissionAgreementsResponseClass } from '../models';
|
|
19
|
+
import { PatchCommissionAgreementStatusRequestDto } from '../models';
|
|
20
|
+
import { PatchCommissionAgreementStatusResponseClass } from '../models';
|
|
19
21
|
import { UpdateCommissionAgreementRequestDto } from '../models';
|
|
20
22
|
import { UpdateCommissionAgreementResponseClass } from '../models';
|
|
21
23
|
/**
|
|
@@ -57,24 +59,35 @@ export declare const CommissionAgreementsApiAxiosParamCreator: (configuration?:
|
|
|
57
59
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
58
60
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
59
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.
|
|
60
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
61
|
-
* @param {string} [search]
|
|
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</i>
|
|
63
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
64
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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
|
+
* @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>
|
|
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
|
+
* @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>
|
|
65
67
|
* @param {*} [options] Override http request option.
|
|
66
68
|
* @throws {RequiredError}
|
|
67
69
|
*/
|
|
68
70
|
listCommissionAgreements: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
71
|
+
/**
|
|
72
|
+
* This will patch commission agreement status.
|
|
73
|
+
* @summary Update the commission agreement status
|
|
74
|
+
* @param {string} code Unique identifier for the object.
|
|
75
|
+
* @param {PatchCommissionAgreementStatusRequestDto} patchCommissionAgreementStatusRequestDto
|
|
76
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
77
|
+
* @param {*} [options] Override http request option.
|
|
78
|
+
* @throws {RequiredError}
|
|
79
|
+
*/
|
|
80
|
+
patchCommissionAgreementStatus: (code: string, patchCommissionAgreementStatusRequestDto: PatchCommissionAgreementStatusRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
69
81
|
/**
|
|
70
82
|
* This will update commission agreement.
|
|
71
83
|
* @summary Update the commission agreement
|
|
84
|
+
* @param {string} code
|
|
72
85
|
* @param {UpdateCommissionAgreementRequestDto} updateCommissionAgreementRequestDto
|
|
73
86
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
74
87
|
* @param {*} [options] Override http request option.
|
|
75
88
|
* @throws {RequiredError}
|
|
76
89
|
*/
|
|
77
|
-
updateCommissionAgreement: (updateCommissionAgreementRequestDto: UpdateCommissionAgreementRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
90
|
+
updateCommissionAgreement: (code: string, updateCommissionAgreementRequestDto: UpdateCommissionAgreementRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
78
91
|
};
|
|
79
92
|
/**
|
|
80
93
|
* CommissionAgreementsApi - functional programming interface
|
|
@@ -115,24 +128,35 @@ export declare const CommissionAgreementsApiFp: (configuration?: Configuration)
|
|
|
115
128
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
116
129
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
117
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.
|
|
118
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
119
|
-
* @param {string} [search]
|
|
120
|
-
* @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>
|
|
121
|
-
* @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/>
|
|
122
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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
|
+
* @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>
|
|
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
|
+
* @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>
|
|
123
136
|
* @param {*} [options] Override http request option.
|
|
124
137
|
* @throws {RequiredError}
|
|
125
138
|
*/
|
|
126
139
|
listCommissionAgreements(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionAgreementsResponseClass>>;
|
|
140
|
+
/**
|
|
141
|
+
* This will patch commission agreement status.
|
|
142
|
+
* @summary Update the commission agreement status
|
|
143
|
+
* @param {string} code Unique identifier for the object.
|
|
144
|
+
* @param {PatchCommissionAgreementStatusRequestDto} patchCommissionAgreementStatusRequestDto
|
|
145
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
146
|
+
* @param {*} [options] Override http request option.
|
|
147
|
+
* @throws {RequiredError}
|
|
148
|
+
*/
|
|
149
|
+
patchCommissionAgreementStatus(code: string, patchCommissionAgreementStatusRequestDto: PatchCommissionAgreementStatusRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PatchCommissionAgreementStatusResponseClass>>;
|
|
127
150
|
/**
|
|
128
151
|
* This will update commission agreement.
|
|
129
152
|
* @summary Update the commission agreement
|
|
153
|
+
* @param {string} code
|
|
130
154
|
* @param {UpdateCommissionAgreementRequestDto} updateCommissionAgreementRequestDto
|
|
131
155
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
132
156
|
* @param {*} [options] Override http request option.
|
|
133
157
|
* @throws {RequiredError}
|
|
134
158
|
*/
|
|
135
|
-
updateCommissionAgreement(updateCommissionAgreementRequestDto: UpdateCommissionAgreementRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateCommissionAgreementResponseClass>>;
|
|
159
|
+
updateCommissionAgreement(code: string, updateCommissionAgreementRequestDto: UpdateCommissionAgreementRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateCommissionAgreementResponseClass>>;
|
|
136
160
|
};
|
|
137
161
|
/**
|
|
138
162
|
* CommissionAgreementsApi - factory interface
|
|
@@ -173,24 +197,35 @@ export declare const CommissionAgreementsApiFactory: (configuration?: Configurat
|
|
|
173
197
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
174
198
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
175
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.
|
|
176
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
177
|
-
* @param {string} [search]
|
|
178
|
-
* @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>
|
|
179
|
-
* @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/>
|
|
180
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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
|
+
* @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>
|
|
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
|
+
* @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>
|
|
181
205
|
* @param {*} [options] Override http request option.
|
|
182
206
|
* @throws {RequiredError}
|
|
183
207
|
*/
|
|
184
208
|
listCommissionAgreements(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListCommissionAgreementsResponseClass>;
|
|
209
|
+
/**
|
|
210
|
+
* This will patch commission agreement status.
|
|
211
|
+
* @summary Update the commission agreement status
|
|
212
|
+
* @param {string} code Unique identifier for the object.
|
|
213
|
+
* @param {PatchCommissionAgreementStatusRequestDto} patchCommissionAgreementStatusRequestDto
|
|
214
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
215
|
+
* @param {*} [options] Override http request option.
|
|
216
|
+
* @throws {RequiredError}
|
|
217
|
+
*/
|
|
218
|
+
patchCommissionAgreementStatus(code: string, patchCommissionAgreementStatusRequestDto: PatchCommissionAgreementStatusRequestDto, authorization?: string, options?: any): AxiosPromise<PatchCommissionAgreementStatusResponseClass>;
|
|
185
219
|
/**
|
|
186
220
|
* This will update commission agreement.
|
|
187
221
|
* @summary Update the commission agreement
|
|
222
|
+
* @param {string} code
|
|
188
223
|
* @param {UpdateCommissionAgreementRequestDto} updateCommissionAgreementRequestDto
|
|
189
224
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
190
225
|
* @param {*} [options] Override http request option.
|
|
191
226
|
* @throws {RequiredError}
|
|
192
227
|
*/
|
|
193
|
-
updateCommissionAgreement(updateCommissionAgreementRequestDto: UpdateCommissionAgreementRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateCommissionAgreementResponseClass>;
|
|
228
|
+
updateCommissionAgreement(code: string, updateCommissionAgreementRequestDto: UpdateCommissionAgreementRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateCommissionAgreementResponseClass>;
|
|
194
229
|
};
|
|
195
230
|
/**
|
|
196
231
|
* Request parameters for createCommissionAgreement operation in CommissionAgreementsApi.
|
|
@@ -280,42 +315,73 @@ export interface CommissionAgreementsApiListCommissionAgreementsRequest {
|
|
|
280
315
|
*/
|
|
281
316
|
readonly pageToken?: string;
|
|
282
317
|
/**
|
|
283
|
-
* Filter the response by one or multiple fields.
|
|
318
|
+
* 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>
|
|
284
319
|
* @type {string}
|
|
285
320
|
* @memberof CommissionAgreementsApiListCommissionAgreements
|
|
286
321
|
*/
|
|
287
322
|
readonly filter?: string;
|
|
288
323
|
/**
|
|
289
|
-
*
|
|
324
|
+
* 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>
|
|
290
325
|
* @type {string}
|
|
291
326
|
* @memberof CommissionAgreementsApiListCommissionAgreements
|
|
292
327
|
*/
|
|
293
328
|
readonly search?: string;
|
|
294
329
|
/**
|
|
295
|
-
* 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>
|
|
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>
|
|
296
331
|
* @type {string}
|
|
297
332
|
* @memberof CommissionAgreementsApiListCommissionAgreements
|
|
298
333
|
*/
|
|
299
334
|
readonly order?: string;
|
|
300
335
|
/**
|
|
301
|
-
* 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/>
|
|
336
|
+
* 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>
|
|
302
337
|
* @type {string}
|
|
303
338
|
* @memberof CommissionAgreementsApiListCommissionAgreements
|
|
304
339
|
*/
|
|
305
340
|
readonly expand?: string;
|
|
306
341
|
/**
|
|
307
|
-
* Filters the response by one or multiple fields.
|
|
342
|
+
* 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>
|
|
308
343
|
* @type {string}
|
|
309
344
|
* @memberof CommissionAgreementsApiListCommissionAgreements
|
|
310
345
|
*/
|
|
311
346
|
readonly filters?: string;
|
|
312
347
|
}
|
|
348
|
+
/**
|
|
349
|
+
* Request parameters for patchCommissionAgreementStatus operation in CommissionAgreementsApi.
|
|
350
|
+
* @export
|
|
351
|
+
* @interface CommissionAgreementsApiPatchCommissionAgreementStatusRequest
|
|
352
|
+
*/
|
|
353
|
+
export interface CommissionAgreementsApiPatchCommissionAgreementStatusRequest {
|
|
354
|
+
/**
|
|
355
|
+
* Unique identifier for the object.
|
|
356
|
+
* @type {string}
|
|
357
|
+
* @memberof CommissionAgreementsApiPatchCommissionAgreementStatus
|
|
358
|
+
*/
|
|
359
|
+
readonly code: string;
|
|
360
|
+
/**
|
|
361
|
+
*
|
|
362
|
+
* @type {PatchCommissionAgreementStatusRequestDto}
|
|
363
|
+
* @memberof CommissionAgreementsApiPatchCommissionAgreementStatus
|
|
364
|
+
*/
|
|
365
|
+
readonly patchCommissionAgreementStatusRequestDto: PatchCommissionAgreementStatusRequestDto;
|
|
366
|
+
/**
|
|
367
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
368
|
+
* @type {string}
|
|
369
|
+
* @memberof CommissionAgreementsApiPatchCommissionAgreementStatus
|
|
370
|
+
*/
|
|
371
|
+
readonly authorization?: string;
|
|
372
|
+
}
|
|
313
373
|
/**
|
|
314
374
|
* Request parameters for updateCommissionAgreement operation in CommissionAgreementsApi.
|
|
315
375
|
* @export
|
|
316
376
|
* @interface CommissionAgreementsApiUpdateCommissionAgreementRequest
|
|
317
377
|
*/
|
|
318
378
|
export interface CommissionAgreementsApiUpdateCommissionAgreementRequest {
|
|
379
|
+
/**
|
|
380
|
+
*
|
|
381
|
+
* @type {string}
|
|
382
|
+
* @memberof CommissionAgreementsApiUpdateCommissionAgreement
|
|
383
|
+
*/
|
|
384
|
+
readonly code: string;
|
|
319
385
|
/**
|
|
320
386
|
*
|
|
321
387
|
* @type {UpdateCommissionAgreementRequestDto}
|
|
@@ -372,6 +438,15 @@ export declare class CommissionAgreementsApi extends BaseAPI {
|
|
|
372
438
|
* @memberof CommissionAgreementsApi
|
|
373
439
|
*/
|
|
374
440
|
listCommissionAgreements(requestParameters?: CommissionAgreementsApiListCommissionAgreementsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCommissionAgreementsResponseClass, any, {}>>;
|
|
441
|
+
/**
|
|
442
|
+
* This will patch commission agreement status.
|
|
443
|
+
* @summary Update the commission agreement status
|
|
444
|
+
* @param {CommissionAgreementsApiPatchCommissionAgreementStatusRequest} requestParameters Request parameters.
|
|
445
|
+
* @param {*} [options] Override http request option.
|
|
446
|
+
* @throws {RequiredError}
|
|
447
|
+
* @memberof CommissionAgreementsApi
|
|
448
|
+
*/
|
|
449
|
+
patchCommissionAgreementStatus(requestParameters: CommissionAgreementsApiPatchCommissionAgreementStatusRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PatchCommissionAgreementStatusResponseClass, any, {}>>;
|
|
375
450
|
/**
|
|
376
451
|
* This will update commission agreement.
|
|
377
452
|
* @summary Update the commission agreement
|