@emilgroup/commission-sdk-node 1.0.0-beta.3 → 1.0.0-beta.30

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.
Files changed (157) hide show
  1. package/.openapi-generator/FILES +43 -0
  2. package/README.md +2 -2
  3. package/api/commission-agreement-products-api.ts +655 -0
  4. package/api/commission-agreement-rules-api.ts +762 -0
  5. package/api/commission-agreements-api.ts +40 -27
  6. package/api/commission-recipients-api.ts +697 -0
  7. package/api/commission-settlements-api.ts +804 -0
  8. package/api/commissions-api.ts +18 -18
  9. package/api.ts +8 -0
  10. package/dist/api/commission-agreement-products-api.d.ts +366 -0
  11. package/dist/api/commission-agreement-products-api.js +630 -0
  12. package/dist/api/commission-agreement-rules-api.d.ts +423 -0
  13. package/dist/api/commission-agreement-rules-api.js +723 -0
  14. package/dist/api/commission-agreements-api.d.ts +32 -23
  15. package/dist/api/commission-agreements-api.js +28 -22
  16. package/dist/api/commission-recipients-api.d.ts +393 -0
  17. package/dist/api/commission-recipients-api.js +648 -0
  18. package/dist/api/commission-settlements-api.d.ts +450 -0
  19. package/dist/api/commission-settlements-api.js +741 -0
  20. package/dist/api/commissions-api.d.ts +18 -18
  21. package/dist/api/commissions-api.js +9 -9
  22. package/dist/api.d.ts +4 -0
  23. package/dist/api.js +4 -0
  24. package/dist/models/commission-agreement-class.d.ts +20 -0
  25. package/dist/models/commission-agreement-metadata-dto.d.ts +25 -0
  26. package/dist/models/commission-agreement-metadata-dto.js +15 -0
  27. package/dist/models/commission-agreement-metadata-partner-dto.d.ts +30 -0
  28. package/dist/models/commission-agreement-metadata-partner-dto.js +15 -0
  29. package/dist/models/commission-agreement-product-class.d.ts +77 -0
  30. package/dist/models/commission-agreement-product-class.js +20 -0
  31. package/dist/models/commission-agreement-rule-class.d.ts +80 -0
  32. package/dist/models/commission-agreement-rule-class.js +21 -0
  33. package/dist/models/commission-agreement-rule-config-dto.d.ts +25 -0
  34. package/dist/models/commission-agreement-rule-config-dto.js +15 -0
  35. package/dist/models/commission-agreement-rule-evaluation-class.d.ts +31 -0
  36. package/dist/models/commission-agreement-rule-evaluation-class.js +15 -0
  37. package/dist/models/commission-agreement-version-class.d.ts +7 -0
  38. package/dist/models/commission-class.d.ts +29 -4
  39. package/dist/models/commission-conditions-dto.d.ts +24 -0
  40. package/dist/models/commission-conditions-dto.js +15 -0
  41. package/dist/models/commission-config-dto.d.ts +63 -0
  42. package/dist/models/commission-config-dto.js +34 -0
  43. package/dist/models/commission-recipient-class.d.ts +90 -0
  44. package/dist/models/commission-recipient-class.js +20 -0
  45. package/dist/models/commission-settlement-class.d.ts +124 -0
  46. package/dist/models/commission-settlement-class.js +35 -0
  47. package/dist/models/create-commission-agreement-product-request-dto.d.ts +30 -0
  48. package/dist/models/create-commission-agreement-product-request-dto.js +15 -0
  49. package/dist/models/create-commission-agreement-product-response-class.d.ts +25 -0
  50. package/dist/models/create-commission-agreement-product-response-class.js +15 -0
  51. package/dist/models/create-commission-agreement-request-dto.d.ts +8 -1
  52. package/dist/models/create-commission-agreement-rule-request-dto.d.ts +31 -0
  53. package/dist/models/create-commission-agreement-rule-request-dto.js +15 -0
  54. package/dist/models/create-commission-agreement-rule-response-class.d.ts +25 -0
  55. package/dist/models/create-commission-agreement-rule-response-class.js +15 -0
  56. package/dist/models/create-commission-agreement-version-request-dto.d.ts +1 -1
  57. package/dist/models/create-commission-recipient-request-dto.d.ts +36 -0
  58. package/dist/models/create-commission-recipient-request-dto.js +15 -0
  59. package/dist/models/create-commission-recipient-response-class.d.ts +25 -0
  60. package/dist/models/create-commission-recipient-response-class.js +15 -0
  61. package/dist/models/create-commission-settlement-request-dto.d.ts +37 -0
  62. package/dist/models/create-commission-settlement-request-dto.js +22 -0
  63. package/dist/models/create-commission-settlement-response-class.d.ts +25 -0
  64. package/dist/models/create-commission-settlement-response-class.js +15 -0
  65. package/dist/models/evaluate-commission-agreement-rule-request-dto.d.ts +31 -0
  66. package/dist/models/evaluate-commission-agreement-rule-request-dto.js +15 -0
  67. package/dist/models/evaluate-commission-agreement-rule-response-class.d.ts +25 -0
  68. package/dist/models/evaluate-commission-agreement-rule-response-class.js +15 -0
  69. package/dist/models/evaluated-commission-class.d.ts +54 -0
  70. package/dist/models/evaluated-commission-class.js +21 -0
  71. package/dist/models/get-commission-agreement-product-response-class.d.ts +25 -0
  72. package/dist/models/get-commission-agreement-product-response-class.js +15 -0
  73. package/dist/models/get-commission-agreement-rule-response-class.d.ts +25 -0
  74. package/dist/models/get-commission-agreement-rule-response-class.js +15 -0
  75. package/dist/models/get-commission-recipient-response-class.d.ts +25 -0
  76. package/dist/models/get-commission-recipient-response-class.js +15 -0
  77. package/dist/models/get-commission-settlement-response-class.d.ts +25 -0
  78. package/dist/models/get-commission-settlement-response-class.js +15 -0
  79. package/dist/models/index.d.ts +39 -0
  80. package/dist/models/index.js +39 -0
  81. package/dist/models/list-commission-agreement-products-response-class.d.ts +43 -0
  82. package/dist/models/list-commission-agreement-products-response-class.js +15 -0
  83. package/dist/models/list-commission-agreement-rules-response-class.d.ts +43 -0
  84. package/dist/models/list-commission-agreement-rules-response-class.js +15 -0
  85. package/dist/models/list-commission-recipients-response-class.d.ts +43 -0
  86. package/dist/models/list-commission-recipients-response-class.js +15 -0
  87. package/dist/models/list-commission-settlements-response-class.d.ts +43 -0
  88. package/dist/models/list-commission-settlements-response-class.js +15 -0
  89. package/dist/models/publish-commission-settlements-request-dto.d.ts +24 -0
  90. package/dist/models/publish-commission-settlements-request-dto.js +15 -0
  91. package/dist/models/publish-commission-settlements-response-class.d.ts +25 -0
  92. package/dist/models/publish-commission-settlements-response-class.js +15 -0
  93. package/dist/models/update-commission-agreement-product-request-dto.d.ts +41 -0
  94. package/dist/models/update-commission-agreement-product-request-dto.js +20 -0
  95. package/dist/models/update-commission-agreement-product-response-class.d.ts +25 -0
  96. package/dist/models/update-commission-agreement-product-response-class.js +15 -0
  97. package/dist/models/update-commission-agreement-rule-request-dto.d.ts +43 -0
  98. package/dist/models/update-commission-agreement-rule-request-dto.js +21 -0
  99. package/dist/models/update-commission-agreement-rule-response-class.d.ts +25 -0
  100. package/dist/models/update-commission-agreement-rule-response-class.js +15 -0
  101. package/dist/models/update-commission-recipient-request-dto.d.ts +42 -0
  102. package/dist/models/update-commission-recipient-request-dto.js +15 -0
  103. package/dist/models/update-commission-recipient-response-class.d.ts +25 -0
  104. package/dist/models/update-commission-recipient-response-class.js +15 -0
  105. package/dist/models/update-commission-request-dto.d.ts +5 -3
  106. package/dist/models/update-commission-request-dto.js +4 -2
  107. package/dist/models/update-commission-settlement-request-dto.d.ts +43 -0
  108. package/dist/models/update-commission-settlement-request-dto.js +22 -0
  109. package/dist/models/update-commission-settlement-response-class.d.ts +25 -0
  110. package/dist/models/update-commission-settlement-response-class.js +15 -0
  111. package/models/commission-agreement-class.ts +20 -0
  112. package/models/commission-agreement-metadata-dto.ts +31 -0
  113. package/models/commission-agreement-metadata-partner-dto.ts +36 -0
  114. package/models/commission-agreement-product-class.ts +86 -0
  115. package/models/commission-agreement-rule-class.ts +89 -0
  116. package/models/commission-agreement-rule-config-dto.ts +31 -0
  117. package/models/commission-agreement-rule-evaluation-class.ts +37 -0
  118. package/models/commission-agreement-version-class.ts +7 -0
  119. package/models/commission-class.ts +29 -4
  120. package/models/commission-conditions-dto.ts +30 -0
  121. package/models/commission-config-dto.ts +73 -0
  122. package/models/commission-recipient-class.ts +99 -0
  123. package/models/commission-settlement-class.ts +134 -0
  124. package/models/create-commission-agreement-product-request-dto.ts +36 -0
  125. package/models/create-commission-agreement-product-response-class.ts +31 -0
  126. package/models/create-commission-agreement-request-dto.ts +8 -1
  127. package/models/create-commission-agreement-rule-request-dto.ts +37 -0
  128. package/models/create-commission-agreement-rule-response-class.ts +31 -0
  129. package/models/create-commission-agreement-version-request-dto.ts +1 -1
  130. package/models/create-commission-recipient-request-dto.ts +42 -0
  131. package/models/create-commission-recipient-response-class.ts +31 -0
  132. package/models/create-commission-settlement-request-dto.ts +46 -0
  133. package/models/create-commission-settlement-response-class.ts +31 -0
  134. package/models/evaluate-commission-agreement-rule-request-dto.ts +37 -0
  135. package/models/evaluate-commission-agreement-rule-response-class.ts +31 -0
  136. package/models/evaluated-commission-class.ts +63 -0
  137. package/models/get-commission-agreement-product-response-class.ts +31 -0
  138. package/models/get-commission-agreement-rule-response-class.ts +31 -0
  139. package/models/get-commission-recipient-response-class.ts +31 -0
  140. package/models/get-commission-settlement-response-class.ts +31 -0
  141. package/models/index.ts +39 -0
  142. package/models/list-commission-agreement-products-response-class.ts +49 -0
  143. package/models/list-commission-agreement-rules-response-class.ts +49 -0
  144. package/models/list-commission-recipients-response-class.ts +49 -0
  145. package/models/list-commission-settlements-response-class.ts +49 -0
  146. package/models/publish-commission-settlements-request-dto.ts +30 -0
  147. package/models/publish-commission-settlements-response-class.ts +31 -0
  148. package/models/update-commission-agreement-product-request-dto.ts +50 -0
  149. package/models/update-commission-agreement-product-response-class.ts +31 -0
  150. package/models/update-commission-agreement-rule-request-dto.ts +52 -0
  151. package/models/update-commission-agreement-rule-response-class.ts +31 -0
  152. package/models/update-commission-recipient-request-dto.ts +48 -0
  153. package/models/update-commission-recipient-response-class.ts +31 -0
  154. package/models/update-commission-request-dto.ts +5 -3
  155. package/models/update-commission-settlement-request-dto.ts +52 -0
  156. package/models/update-commission-settlement-response-class.ts +31 -0
  157. package/package.json +1 -1
@@ -57,11 +57,11 @@ export declare const CommissionAgreementsApiAxiosParamCreator: (configuration?:
57
57
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
58
58
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
59
59
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
60
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, createdAt</i>
61
- * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
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. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, createdAt</i>
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, createdAt, partnerCode, productSlug, endDate</i>
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, commissionAgreementNumber, name, description</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: commissionAgreementNumber, status, createdAt, billingFrequency</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/> <i>Allowed values: versions, products<i>
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, createdAt, partnerCode, productSlug, endDate</i>
65
65
  * @param {*} [options] Override http request option.
66
66
  * @throws {RequiredError}
67
67
  */
@@ -69,12 +69,13 @@ export declare const CommissionAgreementsApiAxiosParamCreator: (configuration?:
69
69
  /**
70
70
  * This will update commission agreement.
71
71
  * @summary Update the commission agreement
72
+ * @param {string} code
72
73
  * @param {UpdateCommissionAgreementRequestDto} updateCommissionAgreementRequestDto
73
74
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
74
75
  * @param {*} [options] Override http request option.
75
76
  * @throws {RequiredError}
76
77
  */
77
- updateCommissionAgreement: (updateCommissionAgreementRequestDto: UpdateCommissionAgreementRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
78
+ updateCommissionAgreement: (code: string, updateCommissionAgreementRequestDto: UpdateCommissionAgreementRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
78
79
  };
79
80
  /**
80
81
  * CommissionAgreementsApi - functional programming interface
@@ -115,11 +116,11 @@ export declare const CommissionAgreementsApiFp: (configuration?: Configuration)
115
116
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
116
117
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
117
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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
118
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt&lt;/i&gt;
119
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: createdAt&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt;
122
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt&lt;/i&gt;
119
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt, partnerCode, productSlug, endDate&lt;/i&gt;
120
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: code, commissionAgreementNumber, name, description&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: commissionAgreementNumber, status, createdAt, billingFrequency&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: versions, products&lt;i&gt;
123
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt, partnerCode, productSlug, endDate&lt;/i&gt;
123
124
  * @param {*} [options] Override http request option.
124
125
  * @throws {RequiredError}
125
126
  */
@@ -127,12 +128,13 @@ export declare const CommissionAgreementsApiFp: (configuration?: Configuration)
127
128
  /**
128
129
  * This will update commission agreement.
129
130
  * @summary Update the commission agreement
131
+ * @param {string} code
130
132
  * @param {UpdateCommissionAgreementRequestDto} updateCommissionAgreementRequestDto
131
133
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
132
134
  * @param {*} [options] Override http request option.
133
135
  * @throws {RequiredError}
134
136
  */
135
- updateCommissionAgreement(updateCommissionAgreementRequestDto: UpdateCommissionAgreementRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateCommissionAgreementResponseClass>>;
137
+ updateCommissionAgreement(code: string, updateCommissionAgreementRequestDto: UpdateCommissionAgreementRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateCommissionAgreementResponseClass>>;
136
138
  };
137
139
  /**
138
140
  * CommissionAgreementsApi - factory interface
@@ -173,11 +175,11 @@ export declare const CommissionAgreementsApiFactory: (configuration?: Configurat
173
175
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
174
176
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
175
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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
176
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt&lt;/i&gt;
177
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: createdAt&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt;
180
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt&lt;/i&gt;
178
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt, partnerCode, productSlug, endDate&lt;/i&gt;
179
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: code, commissionAgreementNumber, name, description&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: commissionAgreementNumber, status, createdAt, billingFrequency&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: versions, products&lt;i&gt;
182
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt, partnerCode, productSlug, endDate&lt;/i&gt;
181
183
  * @param {*} [options] Override http request option.
182
184
  * @throws {RequiredError}
183
185
  */
@@ -185,12 +187,13 @@ export declare const CommissionAgreementsApiFactory: (configuration?: Configurat
185
187
  /**
186
188
  * This will update commission agreement.
187
189
  * @summary Update the commission agreement
190
+ * @param {string} code
188
191
  * @param {UpdateCommissionAgreementRequestDto} updateCommissionAgreementRequestDto
189
192
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
190
193
  * @param {*} [options] Override http request option.
191
194
  * @throws {RequiredError}
192
195
  */
193
- updateCommissionAgreement(updateCommissionAgreementRequestDto: UpdateCommissionAgreementRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateCommissionAgreementResponseClass>;
196
+ updateCommissionAgreement(code: string, updateCommissionAgreementRequestDto: UpdateCommissionAgreementRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateCommissionAgreementResponseClass>;
194
197
  };
195
198
  /**
196
199
  * Request parameters for createCommissionAgreement operation in CommissionAgreementsApi.
@@ -280,31 +283,31 @@ export interface CommissionAgreementsApiListCommissionAgreementsRequest {
280
283
  */
281
284
  readonly pageToken?: string;
282
285
  /**
283
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt&lt;/i&gt;
286
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt, partnerCode, productSlug, endDate&lt;/i&gt;
284
287
  * @type {string}
285
288
  * @memberof CommissionAgreementsApiListCommissionAgreements
286
289
  */
287
290
  readonly filter?: string;
288
291
  /**
289
- * To search the list by any field, pass search&#x3D;xxx to fetch the result.
292
+ * Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: code, commissionAgreementNumber, name, description&lt;/i&gt;
290
293
  * @type {string}
291
294
  * @memberof CommissionAgreementsApiListCommissionAgreements
292
295
  */
293
296
  readonly search?: string;
294
297
  /**
295
- * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: createdAt&lt;/i&gt;
298
+ * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: commissionAgreementNumber, status, createdAt, billingFrequency&lt;/i&gt;
296
299
  * @type {string}
297
300
  * @memberof CommissionAgreementsApiListCommissionAgreements
298
301
  */
299
302
  readonly order?: string;
300
303
  /**
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.&lt;br/&gt; &lt;br/&gt;
304
+ * 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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: versions, products&lt;i&gt;
302
305
  * @type {string}
303
306
  * @memberof CommissionAgreementsApiListCommissionAgreements
304
307
  */
305
308
  readonly expand?: string;
306
309
  /**
307
- * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt&lt;/i&gt;
310
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt, partnerCode, productSlug, endDate&lt;/i&gt;
308
311
  * @type {string}
309
312
  * @memberof CommissionAgreementsApiListCommissionAgreements
310
313
  */
@@ -316,6 +319,12 @@ export interface CommissionAgreementsApiListCommissionAgreementsRequest {
316
319
  * @interface CommissionAgreementsApiUpdateCommissionAgreementRequest
317
320
  */
318
321
  export interface CommissionAgreementsApiUpdateCommissionAgreementRequest {
322
+ /**
323
+ *
324
+ * @type {string}
325
+ * @memberof CommissionAgreementsApiUpdateCommissionAgreement
326
+ */
327
+ readonly code: string;
319
328
  /**
320
329
  *
321
330
  * @type {UpdateCommissionAgreementRequestDto}
@@ -253,11 +253,11 @@ var CommissionAgreementsApiAxiosParamCreator = 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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
256
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt&lt;/i&gt;
257
- * @param {string} [search] To search the list by any field, pass search&#x3D;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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: createdAt&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt;
260
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt&lt;/i&gt;
256
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt, partnerCode, productSlug, endDate&lt;/i&gt;
257
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: code, commissionAgreementNumber, name, description&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: commissionAgreementNumber, status, createdAt, billingFrequency&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: versions, products&lt;i&gt;
260
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt, partnerCode, productSlug, endDate&lt;/i&gt;
261
261
  * @param {*} [options] Override http request option.
262
262
  * @throws {RequiredError}
263
263
  */
@@ -322,21 +322,25 @@ var CommissionAgreementsApiAxiosParamCreator = function (configuration) {
322
322
  /**
323
323
  * This will update commission agreement.
324
324
  * @summary Update the commission agreement
325
+ * @param {string} code
325
326
  * @param {UpdateCommissionAgreementRequestDto} updateCommissionAgreementRequestDto
326
327
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
327
328
  * @param {*} [options] Override http request option.
328
329
  * @throws {RequiredError}
329
330
  */
330
- updateCommissionAgreement: function (updateCommissionAgreementRequestDto, authorization, options) {
331
+ updateCommissionAgreement: function (code, updateCommissionAgreementRequestDto, authorization, options) {
331
332
  if (options === void 0) { options = {}; }
332
333
  return __awaiter(_this, void 0, void 0, function () {
333
334
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
334
335
  return __generator(this, function (_a) {
335
336
  switch (_a.label) {
336
337
  case 0:
338
+ // verify required parameter 'code' is not null or undefined
339
+ (0, common_1.assertParamExists)('updateCommissionAgreement', 'code', code);
337
340
  // verify required parameter 'updateCommissionAgreementRequestDto' is not null or undefined
338
341
  (0, common_1.assertParamExists)('updateCommissionAgreement', 'updateCommissionAgreementRequestDto', updateCommissionAgreementRequestDto);
339
- localVarPath = "/commissionservice/v1/agreements";
342
+ localVarPath = "/commissionservice/v1/agreements/{code}"
343
+ .replace("{".concat("code", "}"), encodeURIComponent(String(code)));
340
344
  localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
341
345
  if (configuration) {
342
346
  baseOptions = configuration.baseOptions;
@@ -448,11 +452,11 @@ var CommissionAgreementsApiFp = function (configuration) {
448
452
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
449
453
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
450
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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
451
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt&lt;/i&gt;
452
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
453
- * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: createdAt&lt;/i&gt;
454
- * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
455
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt&lt;/i&gt;
455
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt, partnerCode, productSlug, endDate&lt;/i&gt;
456
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: code, commissionAgreementNumber, name, description&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: commissionAgreementNumber, status, createdAt, billingFrequency&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: versions, products&lt;i&gt;
459
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt, partnerCode, productSlug, endDate&lt;/i&gt;
456
460
  * @param {*} [options] Override http request option.
457
461
  * @throws {RequiredError}
458
462
  */
@@ -472,17 +476,18 @@ var CommissionAgreementsApiFp = function (configuration) {
472
476
  /**
473
477
  * This will update commission agreement.
474
478
  * @summary Update the commission agreement
479
+ * @param {string} code
475
480
  * @param {UpdateCommissionAgreementRequestDto} updateCommissionAgreementRequestDto
476
481
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
477
482
  * @param {*} [options] Override http request option.
478
483
  * @throws {RequiredError}
479
484
  */
480
- updateCommissionAgreement: function (updateCommissionAgreementRequestDto, authorization, options) {
485
+ updateCommissionAgreement: function (code, updateCommissionAgreementRequestDto, authorization, options) {
481
486
  return __awaiter(this, void 0, void 0, function () {
482
487
  var localVarAxiosArgs;
483
488
  return __generator(this, function (_a) {
484
489
  switch (_a.label) {
485
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.updateCommissionAgreement(updateCommissionAgreementRequestDto, authorization, options)];
490
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.updateCommissionAgreement(code, updateCommissionAgreementRequestDto, authorization, options)];
486
491
  case 1:
487
492
  localVarAxiosArgs = _a.sent();
488
493
  return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -540,11 +545,11 @@ var CommissionAgreementsApiFactory = function (configuration, basePath, axios) {
540
545
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
541
546
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
542
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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
543
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt&lt;/i&gt;
544
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
545
- * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: createdAt&lt;/i&gt;
546
- * @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.&lt;br/&gt; &lt;br/&gt;
547
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt&lt;/i&gt;
548
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt, partnerCode, productSlug, endDate&lt;/i&gt;
549
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: code, commissionAgreementNumber, name, description&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: commissionAgreementNumber, status, createdAt, billingFrequency&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: versions, products&lt;i&gt;
552
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt, partnerCode, productSlug, endDate&lt;/i&gt;
548
553
  * @param {*} [options] Override http request option.
549
554
  * @throws {RequiredError}
550
555
  */
@@ -554,13 +559,14 @@ var CommissionAgreementsApiFactory = function (configuration, basePath, axios) {
554
559
  /**
555
560
  * This will update commission agreement.
556
561
  * @summary Update the commission agreement
562
+ * @param {string} code
557
563
  * @param {UpdateCommissionAgreementRequestDto} updateCommissionAgreementRequestDto
558
564
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
559
565
  * @param {*} [options] Override http request option.
560
566
  * @throws {RequiredError}
561
567
  */
562
- updateCommissionAgreement: function (updateCommissionAgreementRequestDto, authorization, options) {
563
- return localVarFp.updateCommissionAgreement(updateCommissionAgreementRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
568
+ updateCommissionAgreement: function (code, updateCommissionAgreementRequestDto, authorization, options) {
569
+ return localVarFp.updateCommissionAgreement(code, updateCommissionAgreementRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
564
570
  },
565
571
  };
566
572
  };
@@ -635,7 +641,7 @@ var CommissionAgreementsApi = /** @class */ (function (_super) {
635
641
  */
636
642
  CommissionAgreementsApi.prototype.updateCommissionAgreement = function (requestParameters, options) {
637
643
  var _this = this;
638
- return (0, exports.CommissionAgreementsApiFp)(this.configuration).updateCommissionAgreement(requestParameters.updateCommissionAgreementRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
644
+ return (0, exports.CommissionAgreementsApiFp)(this.configuration).updateCommissionAgreement(requestParameters.code, requestParameters.updateCommissionAgreementRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
639
645
  };
640
646
  return CommissionAgreementsApi;
641
647
  }(base_1.BaseAPI));