@emilgroup/commission-sdk-node 1.0.0-beta.4 → 1.0.0-beta.40

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 (155) hide show
  1. package/.openapi-generator/FILES +39 -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 +160 -27
  6. package/api/commission-recipients-api.ts +92 -37
  7. package/api/commission-settlements-api.ts +804 -0
  8. package/api/commissions-api.ts +121 -18
  9. package/api.ts +6 -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 +98 -23
  15. package/dist/api/commission-agreements-api.js +127 -22
  16. package/dist/api/commission-recipients-api.d.ts +63 -27
  17. package/dist/api/commission-recipients-api.js +53 -29
  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 +74 -18
  21. package/dist/api/commissions-api.js +101 -9
  22. package/dist/api.d.ts +3 -0
  23. package/dist/api.js +3 -0
  24. package/dist/models/commission-agreement-class.d.ts +27 -3
  25. package/dist/models/commission-agreement-class.js +5 -1
  26. package/dist/models/commission-agreement-metadata-dto.d.ts +25 -0
  27. package/dist/models/commission-agreement-metadata-dto.js +15 -0
  28. package/dist/models/commission-agreement-metadata-partner-dto.d.ts +30 -0
  29. package/dist/models/commission-agreement-metadata-partner-dto.js +15 -0
  30. package/dist/models/commission-agreement-product-class.d.ts +77 -0
  31. package/dist/models/commission-agreement-product-class.js +20 -0
  32. package/dist/models/commission-agreement-rule-class.d.ts +93 -0
  33. package/dist/models/commission-agreement-rule-class.js +21 -0
  34. package/dist/models/commission-agreement-rule-config-dto.d.ts +25 -0
  35. package/dist/models/commission-agreement-rule-config-dto.js +15 -0
  36. package/dist/models/commission-agreement-rule-evaluation-class.d.ts +31 -0
  37. package/dist/models/commission-agreement-rule-evaluation-class.js +15 -0
  38. package/dist/models/commission-agreement-version-class.d.ts +7 -0
  39. package/dist/models/commission-class.d.ts +37 -6
  40. package/dist/models/commission-conditions-dto.d.ts +24 -0
  41. package/dist/models/commission-conditions-dto.js +15 -0
  42. package/dist/models/commission-config-dto.d.ts +63 -0
  43. package/dist/models/commission-config-dto.js +34 -0
  44. package/dist/models/commission-estimate-class.d.ts +59 -0
  45. package/dist/models/commission-estimate-class.js +25 -0
  46. package/dist/models/commission-settlement-class.d.ts +124 -0
  47. package/dist/models/commission-settlement-class.js +35 -0
  48. package/dist/models/create-commission-agreement-product-request-dto.d.ts +30 -0
  49. package/dist/models/create-commission-agreement-product-request-dto.js +15 -0
  50. package/dist/models/create-commission-agreement-product-response-class.d.ts +25 -0
  51. package/dist/models/create-commission-agreement-product-response-class.js +15 -0
  52. package/dist/models/create-commission-agreement-request-dto.d.ts +14 -3
  53. package/dist/models/create-commission-agreement-request-dto.js +5 -1
  54. package/dist/models/create-commission-agreement-rule-request-dto.d.ts +37 -0
  55. package/dist/models/create-commission-agreement-rule-request-dto.js +15 -0
  56. package/dist/models/create-commission-agreement-rule-response-class.d.ts +25 -0
  57. package/dist/models/create-commission-agreement-rule-response-class.js +15 -0
  58. package/dist/models/create-commission-agreement-version-request-dto.d.ts +1 -1
  59. package/dist/models/create-commission-request-dto.d.ts +3 -9
  60. package/dist/models/create-commission-settlement-request-dto.d.ts +57 -0
  61. package/dist/models/create-commission-settlement-request-dto.js +35 -0
  62. package/dist/models/create-commission-settlement-response-class.d.ts +25 -0
  63. package/dist/models/create-commission-settlement-response-class.js +15 -0
  64. package/dist/models/estimate-commissions-response-class.d.ts +73 -0
  65. package/dist/models/estimate-commissions-response-class.js +15 -0
  66. package/dist/models/evaluate-commission-agreement-rule-request-dto.d.ts +31 -0
  67. package/dist/models/evaluate-commission-agreement-rule-request-dto.js +15 -0
  68. package/dist/models/evaluate-commission-agreement-rule-response-class.d.ts +25 -0
  69. package/dist/models/evaluate-commission-agreement-rule-response-class.js +15 -0
  70. package/dist/models/evaluated-commission-class.d.ts +54 -0
  71. package/dist/models/evaluated-commission-class.js +21 -0
  72. package/dist/models/get-commission-agreement-product-response-class.d.ts +25 -0
  73. package/dist/models/get-commission-agreement-product-response-class.js +15 -0
  74. package/dist/models/get-commission-agreement-rule-response-class.d.ts +25 -0
  75. package/dist/models/get-commission-agreement-rule-response-class.js +15 -0
  76. package/dist/models/get-commission-settlement-response-class.d.ts +25 -0
  77. package/dist/models/get-commission-settlement-response-class.js +15 -0
  78. package/dist/models/index.d.ts +36 -0
  79. package/dist/models/index.js +36 -0
  80. package/dist/models/list-commission-agreement-products-response-class.d.ts +43 -0
  81. package/dist/models/list-commission-agreement-products-response-class.js +15 -0
  82. package/dist/models/list-commission-agreement-rules-response-class.d.ts +43 -0
  83. package/dist/models/list-commission-agreement-rules-response-class.js +15 -0
  84. package/dist/models/list-commission-settlements-response-class.d.ts +43 -0
  85. package/dist/models/list-commission-settlements-response-class.js +15 -0
  86. package/dist/models/patch-commission-agreement-status-request-dto.d.ts +37 -0
  87. package/dist/models/patch-commission-agreement-status-request-dto.js +22 -0
  88. package/dist/models/patch-commission-agreement-status-response-class.d.ts +25 -0
  89. package/dist/models/patch-commission-agreement-status-response-class.js +15 -0
  90. package/dist/models/publish-commission-settlements-request-dto.d.ts +24 -0
  91. package/dist/models/publish-commission-settlements-request-dto.js +15 -0
  92. package/dist/models/publish-commission-settlements-response-class.d.ts +25 -0
  93. package/dist/models/publish-commission-settlements-response-class.js +15 -0
  94. package/dist/models/update-commission-agreement-product-request-dto.d.ts +41 -0
  95. package/dist/models/update-commission-agreement-product-request-dto.js +20 -0
  96. package/dist/models/update-commission-agreement-product-response-class.d.ts +25 -0
  97. package/dist/models/update-commission-agreement-product-response-class.js +15 -0
  98. package/dist/models/update-commission-agreement-request-dto.d.ts +3 -1
  99. package/dist/models/update-commission-agreement-request-dto.js +2 -0
  100. package/dist/models/update-commission-agreement-rule-request-dto.d.ts +49 -0
  101. package/dist/models/update-commission-agreement-rule-request-dto.js +21 -0
  102. package/dist/models/update-commission-agreement-rule-response-class.d.ts +25 -0
  103. package/dist/models/update-commission-agreement-rule-response-class.js +15 -0
  104. package/dist/models/update-commission-request-dto.d.ts +5 -3
  105. package/dist/models/update-commission-request-dto.js +4 -2
  106. package/dist/models/update-commission-settlement-request-dto.d.ts +43 -0
  107. package/dist/models/update-commission-settlement-request-dto.js +22 -0
  108. package/dist/models/update-commission-settlement-response-class.d.ts +25 -0
  109. package/dist/models/update-commission-settlement-response-class.js +15 -0
  110. package/models/commission-agreement-class.ts +27 -3
  111. package/models/commission-agreement-metadata-dto.ts +31 -0
  112. package/models/commission-agreement-metadata-partner-dto.ts +36 -0
  113. package/models/commission-agreement-product-class.ts +86 -0
  114. package/models/commission-agreement-rule-class.ts +102 -0
  115. package/models/commission-agreement-rule-config-dto.ts +31 -0
  116. package/models/commission-agreement-rule-evaluation-class.ts +37 -0
  117. package/models/commission-agreement-version-class.ts +7 -0
  118. package/models/commission-class.ts +37 -6
  119. package/models/commission-conditions-dto.ts +30 -0
  120. package/models/commission-config-dto.ts +73 -0
  121. package/models/commission-estimate-class.ts +69 -0
  122. package/models/commission-settlement-class.ts +134 -0
  123. package/models/create-commission-agreement-product-request-dto.ts +36 -0
  124. package/models/create-commission-agreement-product-response-class.ts +31 -0
  125. package/models/create-commission-agreement-request-dto.ts +14 -3
  126. package/models/create-commission-agreement-rule-request-dto.ts +43 -0
  127. package/models/create-commission-agreement-rule-response-class.ts +31 -0
  128. package/models/create-commission-agreement-version-request-dto.ts +1 -1
  129. package/models/create-commission-request-dto.ts +3 -9
  130. package/models/create-commission-settlement-request-dto.ts +67 -0
  131. package/models/create-commission-settlement-response-class.ts +31 -0
  132. package/models/estimate-commissions-response-class.ts +79 -0
  133. package/models/evaluate-commission-agreement-rule-request-dto.ts +37 -0
  134. package/models/evaluate-commission-agreement-rule-response-class.ts +31 -0
  135. package/models/evaluated-commission-class.ts +63 -0
  136. package/models/get-commission-agreement-product-response-class.ts +31 -0
  137. package/models/get-commission-agreement-rule-response-class.ts +31 -0
  138. package/models/get-commission-settlement-response-class.ts +31 -0
  139. package/models/index.ts +36 -0
  140. package/models/list-commission-agreement-products-response-class.ts +49 -0
  141. package/models/list-commission-agreement-rules-response-class.ts +49 -0
  142. package/models/list-commission-settlements-response-class.ts +49 -0
  143. package/models/patch-commission-agreement-status-request-dto.ts +46 -0
  144. package/models/patch-commission-agreement-status-response-class.ts +31 -0
  145. package/models/publish-commission-settlements-request-dto.ts +30 -0
  146. package/models/publish-commission-settlements-response-class.ts +31 -0
  147. package/models/update-commission-agreement-product-request-dto.ts +50 -0
  148. package/models/update-commission-agreement-product-response-class.ts +31 -0
  149. package/models/update-commission-agreement-request-dto.ts +3 -1
  150. package/models/update-commission-agreement-rule-request-dto.ts +58 -0
  151. package/models/update-commission-agreement-rule-response-class.ts +31 -0
  152. package/models/update-commission-request-dto.ts +5 -3
  153. package/models/update-commission-settlement-request-dto.ts +52 -0
  154. package/models/update-commission-settlement-response-class.ts +31 -0
  155. package/package.json +1 -1
@@ -29,6 +29,10 @@ import { GetCommissionAgreementResponseClass } from '../models';
29
29
  // @ts-ignore
30
30
  import { ListCommissionAgreementsResponseClass } from '../models';
31
31
  // @ts-ignore
32
+ import { PatchCommissionAgreementStatusRequestDto } from '../models';
33
+ // @ts-ignore
34
+ import { PatchCommissionAgreementStatusResponseClass } from '../models';
35
+ // @ts-ignore
32
36
  import { UpdateCommissionAgreementRequestDto } from '../models';
33
37
  // @ts-ignore
34
38
  import { UpdateCommissionAgreementResponseClass } from '../models';
@@ -192,11 +196,11 @@ export const CommissionAgreementsApiAxiosParamCreator = function (configuration?
192
196
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
193
197
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
194
198
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
195
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, createdAt</i>
196
- * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
197
- * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt</i>
198
- * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
199
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, createdAt</i>
199
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, createdAt, partnerCode, productSlug, endDate</i>
200
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, commissionAgreementNumber, name, description</i>
201
+ * @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>
202
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: versions, products<i>
203
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, createdAt, partnerCode, productSlug, endDate</i>
200
204
  * @param {*} [options] Override http request option.
201
205
  * @throws {RequiredError}
202
206
  */
@@ -262,18 +266,73 @@ export const CommissionAgreementsApiAxiosParamCreator = function (configuration?
262
266
  options: localVarRequestOptions,
263
267
  };
264
268
  },
269
+ /**
270
+ * This will patch commission agreement status.
271
+ * @summary Update the commission agreement status
272
+ * @param {string} code Unique identifier for the object.
273
+ * @param {PatchCommissionAgreementStatusRequestDto} patchCommissionAgreementStatusRequestDto
274
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
275
+ * @param {*} [options] Override http request option.
276
+ * @throws {RequiredError}
277
+ */
278
+ patchCommissionAgreementStatus: async (code: string, patchCommissionAgreementStatusRequestDto: PatchCommissionAgreementStatusRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
279
+ // verify required parameter 'code' is not null or undefined
280
+ assertParamExists('patchCommissionAgreementStatus', 'code', code)
281
+ // verify required parameter 'patchCommissionAgreementStatusRequestDto' is not null or undefined
282
+ assertParamExists('patchCommissionAgreementStatus', 'patchCommissionAgreementStatusRequestDto', patchCommissionAgreementStatusRequestDto)
283
+ const localVarPath = `/commissionservice/v1/agreements/{code}/status`
284
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)));
285
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
286
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
287
+ let baseOptions;
288
+ let baseAccessToken;
289
+ if (configuration) {
290
+ baseOptions = configuration.baseOptions;
291
+ baseAccessToken = configuration.accessToken;
292
+ }
293
+
294
+ const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
295
+ const localVarHeaderParameter = {} as any;
296
+ const localVarQueryParameter = {} as any;
297
+
298
+ // authentication bearer required
299
+ // http bearer authentication required
300
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
301
+
302
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
303
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
304
+ }
305
+
306
+
307
+
308
+ localVarHeaderParameter['Content-Type'] = 'application/json';
309
+
310
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
311
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
312
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
313
+ localVarRequestOptions.data = serializeDataIfNeeded(patchCommissionAgreementStatusRequestDto, localVarRequestOptions, configuration)
314
+
315
+ return {
316
+ url: toPathString(localVarUrlObj),
317
+ options: localVarRequestOptions,
318
+ };
319
+ },
265
320
  /**
266
321
  * This will update commission agreement.
267
322
  * @summary Update the commission agreement
323
+ * @param {string} code
268
324
  * @param {UpdateCommissionAgreementRequestDto} updateCommissionAgreementRequestDto
269
325
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
270
326
  * @param {*} [options] Override http request option.
271
327
  * @throws {RequiredError}
272
328
  */
273
- updateCommissionAgreement: async (updateCommissionAgreementRequestDto: UpdateCommissionAgreementRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
329
+ updateCommissionAgreement: async (code: string, updateCommissionAgreementRequestDto: UpdateCommissionAgreementRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
330
+ // verify required parameter 'code' is not null or undefined
331
+ assertParamExists('updateCommissionAgreement', 'code', code)
274
332
  // verify required parameter 'updateCommissionAgreementRequestDto' is not null or undefined
275
333
  assertParamExists('updateCommissionAgreement', 'updateCommissionAgreementRequestDto', updateCommissionAgreementRequestDto)
276
- const localVarPath = `/commissionservice/v1/agreements`;
334
+ const localVarPath = `/commissionservice/v1/agreements/{code}`
335
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)));
277
336
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
278
337
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
279
338
  let baseOptions;
@@ -362,11 +421,11 @@ export const CommissionAgreementsApiFp = function(configuration?: Configuration)
362
421
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
363
422
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
364
423
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
365
- * @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;
366
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
367
- * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: createdAt&lt;/i&gt;
368
- * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
369
- * @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;
424
+ * @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;
425
+ * @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;
426
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: commissionAgreementNumber, status, createdAt, billingFrequency&lt;/i&gt;
427
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: versions, products&lt;i&gt;
428
+ * @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;
370
429
  * @param {*} [options] Override http request option.
371
430
  * @throws {RequiredError}
372
431
  */
@@ -374,16 +433,30 @@ export const CommissionAgreementsApiFp = function(configuration?: Configuration)
374
433
  const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissionAgreements(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
375
434
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
376
435
  },
436
+ /**
437
+ * This will patch commission agreement status.
438
+ * @summary Update the commission agreement status
439
+ * @param {string} code Unique identifier for the object.
440
+ * @param {PatchCommissionAgreementStatusRequestDto} patchCommissionAgreementStatusRequestDto
441
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
442
+ * @param {*} [options] Override http request option.
443
+ * @throws {RequiredError}
444
+ */
445
+ async patchCommissionAgreementStatus(code: string, patchCommissionAgreementStatusRequestDto: PatchCommissionAgreementStatusRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PatchCommissionAgreementStatusResponseClass>> {
446
+ const localVarAxiosArgs = await localVarAxiosParamCreator.patchCommissionAgreementStatus(code, patchCommissionAgreementStatusRequestDto, authorization, options);
447
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
448
+ },
377
449
  /**
378
450
  * This will update commission agreement.
379
451
  * @summary Update the commission agreement
452
+ * @param {string} code
380
453
  * @param {UpdateCommissionAgreementRequestDto} updateCommissionAgreementRequestDto
381
454
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
382
455
  * @param {*} [options] Override http request option.
383
456
  * @throws {RequiredError}
384
457
  */
385
- async updateCommissionAgreement(updateCommissionAgreementRequestDto: UpdateCommissionAgreementRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateCommissionAgreementResponseClass>> {
386
- const localVarAxiosArgs = await localVarAxiosParamCreator.updateCommissionAgreement(updateCommissionAgreementRequestDto, authorization, options);
458
+ async updateCommissionAgreement(code: string, updateCommissionAgreementRequestDto: UpdateCommissionAgreementRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateCommissionAgreementResponseClass>> {
459
+ const localVarAxiosArgs = await localVarAxiosParamCreator.updateCommissionAgreement(code, updateCommissionAgreementRequestDto, authorization, options);
387
460
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
388
461
  },
389
462
  }
@@ -436,27 +509,40 @@ export const CommissionAgreementsApiFactory = function (configuration?: Configur
436
509
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
437
510
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
438
511
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
439
- * @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;
440
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
441
- * @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;
442
- * @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;
443
- * @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;
512
+ * @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;
513
+ * @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;
514
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: commissionAgreementNumber, status, createdAt, billingFrequency&lt;/i&gt;
515
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: versions, products&lt;i&gt;
516
+ * @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;
444
517
  * @param {*} [options] Override http request option.
445
518
  * @throws {RequiredError}
446
519
  */
447
520
  listCommissionAgreements(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListCommissionAgreementsResponseClass> {
448
521
  return localVarFp.listCommissionAgreements(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
449
522
  },
523
+ /**
524
+ * This will patch commission agreement status.
525
+ * @summary Update the commission agreement status
526
+ * @param {string} code Unique identifier for the object.
527
+ * @param {PatchCommissionAgreementStatusRequestDto} patchCommissionAgreementStatusRequestDto
528
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
529
+ * @param {*} [options] Override http request option.
530
+ * @throws {RequiredError}
531
+ */
532
+ patchCommissionAgreementStatus(code: string, patchCommissionAgreementStatusRequestDto: PatchCommissionAgreementStatusRequestDto, authorization?: string, options?: any): AxiosPromise<PatchCommissionAgreementStatusResponseClass> {
533
+ return localVarFp.patchCommissionAgreementStatus(code, patchCommissionAgreementStatusRequestDto, authorization, options).then((request) => request(axios, basePath));
534
+ },
450
535
  /**
451
536
  * This will update commission agreement.
452
537
  * @summary Update the commission agreement
538
+ * @param {string} code
453
539
  * @param {UpdateCommissionAgreementRequestDto} updateCommissionAgreementRequestDto
454
540
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
455
541
  * @param {*} [options] Override http request option.
456
542
  * @throws {RequiredError}
457
543
  */
458
- updateCommissionAgreement(updateCommissionAgreementRequestDto: UpdateCommissionAgreementRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateCommissionAgreementResponseClass> {
459
- return localVarFp.updateCommissionAgreement(updateCommissionAgreementRequestDto, authorization, options).then((request) => request(axios, basePath));
544
+ updateCommissionAgreement(code: string, updateCommissionAgreementRequestDto: UpdateCommissionAgreementRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateCommissionAgreementResponseClass> {
545
+ return localVarFp.updateCommissionAgreement(code, updateCommissionAgreementRequestDto, authorization, options).then((request) => request(axios, basePath));
460
546
  },
461
547
  };
462
548
  };
@@ -559,47 +645,82 @@ export interface CommissionAgreementsApiListCommissionAgreementsRequest {
559
645
  readonly pageToken?: string
560
646
 
561
647
  /**
562
- * 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;
648
+ * 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;
563
649
  * @type {string}
564
650
  * @memberof CommissionAgreementsApiListCommissionAgreements
565
651
  */
566
652
  readonly filter?: string
567
653
 
568
654
  /**
569
- * To search the list by any field, pass search&#x3D;xxx to fetch the result.
655
+ * 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;
570
656
  * @type {string}
571
657
  * @memberof CommissionAgreementsApiListCommissionAgreements
572
658
  */
573
659
  readonly search?: string
574
660
 
575
661
  /**
576
- * 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;
662
+ * 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;
577
663
  * @type {string}
578
664
  * @memberof CommissionAgreementsApiListCommissionAgreements
579
665
  */
580
666
  readonly order?: string
581
667
 
582
668
  /**
583
- * 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;
669
+ * 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;
584
670
  * @type {string}
585
671
  * @memberof CommissionAgreementsApiListCommissionAgreements
586
672
  */
587
673
  readonly expand?: string
588
674
 
589
675
  /**
590
- * 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;
676
+ * 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;
591
677
  * @type {string}
592
678
  * @memberof CommissionAgreementsApiListCommissionAgreements
593
679
  */
594
680
  readonly filters?: string
595
681
  }
596
682
 
683
+ /**
684
+ * Request parameters for patchCommissionAgreementStatus operation in CommissionAgreementsApi.
685
+ * @export
686
+ * @interface CommissionAgreementsApiPatchCommissionAgreementStatusRequest
687
+ */
688
+ export interface CommissionAgreementsApiPatchCommissionAgreementStatusRequest {
689
+ /**
690
+ * Unique identifier for the object.
691
+ * @type {string}
692
+ * @memberof CommissionAgreementsApiPatchCommissionAgreementStatus
693
+ */
694
+ readonly code: string
695
+
696
+ /**
697
+ *
698
+ * @type {PatchCommissionAgreementStatusRequestDto}
699
+ * @memberof CommissionAgreementsApiPatchCommissionAgreementStatus
700
+ */
701
+ readonly patchCommissionAgreementStatusRequestDto: PatchCommissionAgreementStatusRequestDto
702
+
703
+ /**
704
+ * Bearer Token: provided by the login endpoint under the name accessToken.
705
+ * @type {string}
706
+ * @memberof CommissionAgreementsApiPatchCommissionAgreementStatus
707
+ */
708
+ readonly authorization?: string
709
+ }
710
+
597
711
  /**
598
712
  * Request parameters for updateCommissionAgreement operation in CommissionAgreementsApi.
599
713
  * @export
600
714
  * @interface CommissionAgreementsApiUpdateCommissionAgreementRequest
601
715
  */
602
716
  export interface CommissionAgreementsApiUpdateCommissionAgreementRequest {
717
+ /**
718
+ *
719
+ * @type {string}
720
+ * @memberof CommissionAgreementsApiUpdateCommissionAgreement
721
+ */
722
+ readonly code: string
723
+
603
724
  /**
604
725
  *
605
726
  * @type {UpdateCommissionAgreementRequestDto}
@@ -670,6 +791,18 @@ export class CommissionAgreementsApi extends BaseAPI {
670
791
  return CommissionAgreementsApiFp(this.configuration).listCommissionAgreements(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
671
792
  }
672
793
 
794
+ /**
795
+ * This will patch commission agreement status.
796
+ * @summary Update the commission agreement status
797
+ * @param {CommissionAgreementsApiPatchCommissionAgreementStatusRequest} requestParameters Request parameters.
798
+ * @param {*} [options] Override http request option.
799
+ * @throws {RequiredError}
800
+ * @memberof CommissionAgreementsApi
801
+ */
802
+ public patchCommissionAgreementStatus(requestParameters: CommissionAgreementsApiPatchCommissionAgreementStatusRequest, options?: AxiosRequestConfig) {
803
+ return CommissionAgreementsApiFp(this.configuration).patchCommissionAgreementStatus(requestParameters.code, requestParameters.patchCommissionAgreementStatusRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
804
+ }
805
+
673
806
  /**
674
807
  * This will update commission agreement.
675
808
  * @summary Update the commission agreement
@@ -679,6 +812,6 @@ export class CommissionAgreementsApi extends BaseAPI {
679
812
  * @memberof CommissionAgreementsApi
680
813
  */
681
814
  public updateCommissionAgreement(requestParameters: CommissionAgreementsApiUpdateCommissionAgreementRequest, options?: AxiosRequestConfig) {
682
- return CommissionAgreementsApiFp(this.configuration).updateCommissionAgreement(requestParameters.updateCommissionAgreementRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
815
+ return CommissionAgreementsApiFp(this.configuration).updateCommissionAgreement(requestParameters.code, requestParameters.updateCommissionAgreementRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
683
816
  }
684
817
  }