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

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 (39) hide show
  1. package/.openapi-generator/FILES +8 -0
  2. package/README.md +2 -2
  3. package/api/commission-agreement-versions-api.ts +67 -25
  4. package/api/commission-agreements-api.ts +55 -13
  5. package/api/commission-recipients-api.ts +642 -0
  6. package/api.ts +2 -0
  7. package/dist/api/commission-agreement-versions-api.d.ts +47 -20
  8. package/dist/api/commission-agreement-versions-api.js +38 -20
  9. package/dist/api/commission-agreements-api.d.ts +35 -8
  10. package/dist/api/commission-agreements-api.js +29 -11
  11. package/dist/api/commission-recipients-api.d.ts +357 -0
  12. package/dist/api/commission-recipients-api.js +624 -0
  13. package/dist/api.d.ts +1 -0
  14. package/dist/api.js +1 -0
  15. package/dist/models/commission-recipient-class.d.ts +90 -0
  16. package/dist/models/commission-recipient-class.js +20 -0
  17. package/dist/models/create-commission-recipient-request-dto.d.ts +36 -0
  18. package/dist/models/create-commission-recipient-request-dto.js +15 -0
  19. package/dist/models/create-commission-recipient-response-class.d.ts +25 -0
  20. package/dist/models/create-commission-recipient-response-class.js +15 -0
  21. package/dist/models/get-commission-recipient-response-class.d.ts +25 -0
  22. package/dist/models/get-commission-recipient-response-class.js +15 -0
  23. package/dist/models/index.d.ts +7 -0
  24. package/dist/models/index.js +7 -0
  25. package/dist/models/list-commission-recipients-response-class.d.ts +43 -0
  26. package/dist/models/list-commission-recipients-response-class.js +15 -0
  27. package/dist/models/update-commission-recipient-request-dto.d.ts +42 -0
  28. package/dist/models/update-commission-recipient-request-dto.js +15 -0
  29. package/dist/models/update-commission-recipient-response-class.d.ts +25 -0
  30. package/dist/models/update-commission-recipient-response-class.js +15 -0
  31. package/models/commission-recipient-class.ts +99 -0
  32. package/models/create-commission-recipient-request-dto.ts +42 -0
  33. package/models/create-commission-recipient-response-class.ts +31 -0
  34. package/models/get-commission-recipient-response-class.ts +31 -0
  35. package/models/index.ts +7 -0
  36. package/models/list-commission-recipients-response-class.ts +49 -0
  37. package/models/update-commission-recipient-request-dto.ts +48 -0
  38. package/models/update-commission-recipient-response-class.ts +31 -0
  39. package/package.json +1 -1
@@ -5,6 +5,7 @@ README.md
5
5
  api.ts
6
6
  api/commission-agreement-versions-api.ts
7
7
  api/commission-agreements-api.ts
8
+ api/commission-recipients-api.ts
8
9
  api/commissions-api.ts
9
10
  api/default-api.ts
10
11
  base.ts
@@ -16,24 +17,31 @@ models/commission-agreement-class.ts
16
17
  models/commission-agreement-version-class.ts
17
18
  models/commission-class.ts
18
19
  models/commission-item-class.ts
20
+ models/commission-recipient-class.ts
19
21
  models/create-commission-agreement-request-dto.ts
20
22
  models/create-commission-agreement-response-class.ts
21
23
  models/create-commission-agreement-version-request-dto.ts
22
24
  models/create-commission-agreement-version-response-class.ts
23
25
  models/create-commission-item-request-dto.ts
26
+ models/create-commission-recipient-request-dto.ts
27
+ models/create-commission-recipient-response-class.ts
24
28
  models/create-commission-request-dto.ts
25
29
  models/create-commission-response-class.ts
26
30
  models/get-commission-agreement-response-class.ts
27
31
  models/get-commission-agreement-version-response-class.ts
32
+ models/get-commission-recipient-response-class.ts
28
33
  models/get-commission-response-class.ts
29
34
  models/index.ts
30
35
  models/inline-response200.ts
31
36
  models/inline-response503.ts
32
37
  models/list-commission-agreement-versions-response-class.ts
33
38
  models/list-commission-agreements-response-class.ts
39
+ models/list-commission-recipients-response-class.ts
34
40
  models/list-commissions-response-class.ts
35
41
  models/update-commission-agreement-request-dto.ts
36
42
  models/update-commission-agreement-response-class.ts
43
+ models/update-commission-recipient-request-dto.ts
44
+ models/update-commission-recipient-response-class.ts
37
45
  models/update-commission-request-dto.ts
38
46
  models/update-commission-response-class.ts
39
47
  package.json
package/README.md CHANGED
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
17
17
  Navigate to the folder of your consuming project and run one of the following commands:
18
18
 
19
19
  ```
20
- npm install @emilgroup/commission-sdk-node@1.0.0-beta.2 --save
20
+ npm install @emilgroup/commission-sdk-node@1.0.0-beta.4 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/commission-sdk-node@1.0.0-beta.2
24
+ yarn add @emilgroup/commission-sdk-node@1.0.0-beta.4
25
25
  ```
26
26
 
27
27
  And then you can import `CommissionApi`.
@@ -186,14 +186,17 @@ export const CommissionAgreementVersionsApiAxiosParamCreator = function (configu
186
186
  * Retrieves a list of commission agreement versions.
187
187
  * @summary List commission agreement versions
188
188
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
189
- * @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, commissionAgreementId, startDate, endDate, createdAt</i>
190
- * @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, commissionAgreementId, startDate, endDate, createdAt</i>
191
- * @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, startDate, endDate</i>
192
- * @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/>
189
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
190
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
191
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, agreementCode, startDate, endDate, createdAt</i>
192
+ * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
193
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: code, createdAt, startDate, endDate</i>
194
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: agreements<i>
195
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, agreementCode, startDate, endDate, createdAt</i>
193
196
  * @param {*} [options] Override http request option.
194
197
  * @throws {RequiredError}
195
198
  */
196
- listCommissionAgreementVersions: async (authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
199
+ listCommissionAgreementVersions: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
197
200
  const localVarPath = `/commissionservice/v1/agreement-versions`;
198
201
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
199
202
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -212,12 +215,20 @@ export const CommissionAgreementVersionsApiAxiosParamCreator = function (configu
212
215
  // http bearer authentication required
213
216
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
214
217
 
218
+ if (pageSize !== undefined) {
219
+ localVarQueryParameter['pageSize'] = pageSize;
220
+ }
221
+
222
+ if (pageToken !== undefined) {
223
+ localVarQueryParameter['pageToken'] = pageToken;
224
+ }
225
+
215
226
  if (filter !== undefined) {
216
227
  localVarQueryParameter['filter'] = filter;
217
228
  }
218
229
 
219
- if (filters !== undefined) {
220
- localVarQueryParameter['filters'] = filters;
230
+ if (search !== undefined) {
231
+ localVarQueryParameter['search'] = search;
221
232
  }
222
233
 
223
234
  if (order !== undefined) {
@@ -228,6 +239,10 @@ export const CommissionAgreementVersionsApiAxiosParamCreator = function (configu
228
239
  localVarQueryParameter['expand'] = expand;
229
240
  }
230
241
 
242
+ if (filters !== undefined) {
243
+ localVarQueryParameter['filters'] = filters;
244
+ }
245
+
231
246
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
232
247
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
233
248
  }
@@ -294,15 +309,18 @@ export const CommissionAgreementVersionsApiFp = function(configuration?: Configu
294
309
  * Retrieves a list of commission agreement versions.
295
310
  * @summary List commission agreement versions
296
311
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
297
- * @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, commissionAgreementId, startDate, endDate, createdAt&lt;/i&gt;
298
- * @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, commissionAgreementId, startDate, endDate, createdAt&lt;/i&gt;
299
- * @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, startDate, endDate&lt;/i&gt;
300
- * @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;
312
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
313
+ * @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.
314
+ * @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, agreementCode, startDate, endDate, createdAt&lt;/i&gt;
315
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
316
+ * @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: code, createdAt, startDate, endDate&lt;/i&gt;
317
+ * @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: agreements&lt;i&gt;
318
+ * @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, agreementCode, startDate, endDate, createdAt&lt;/i&gt;
301
319
  * @param {*} [options] Override http request option.
302
320
  * @throws {RequiredError}
303
321
  */
304
- async listCommissionAgreementVersions(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionAgreementVersionsResponseClass>> {
305
- const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissionAgreementVersions(authorization, filter, filters, order, expand, options);
322
+ async listCommissionAgreementVersions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionAgreementVersionsResponseClass>> {
323
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissionAgreementVersions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
306
324
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
307
325
  },
308
326
  }
@@ -353,15 +371,18 @@ export const CommissionAgreementVersionsApiFactory = function (configuration?: C
353
371
  * Retrieves a list of commission agreement versions.
354
372
  * @summary List commission agreement versions
355
373
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
356
- * @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, commissionAgreementId, startDate, endDate, createdAt&lt;/i&gt;
357
- * @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, commissionAgreementId, startDate, endDate, createdAt&lt;/i&gt;
358
- * @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, startDate, endDate&lt;/i&gt;
359
- * @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;
374
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
375
+ * @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.
376
+ * @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, agreementCode, startDate, endDate, createdAt&lt;/i&gt;
377
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
378
+ * @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: code, createdAt, startDate, endDate&lt;/i&gt;
379
+ * @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: agreements&lt;i&gt;
380
+ * @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, agreementCode, startDate, endDate, createdAt&lt;/i&gt;
360
381
  * @param {*} [options] Override http request option.
361
382
  * @throws {RequiredError}
362
383
  */
363
- listCommissionAgreementVersions(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListCommissionAgreementVersionsResponseClass> {
364
- return localVarFp.listCommissionAgreementVersions(authorization, filter, filters, order, expand, options).then((request) => request(axios, basePath));
384
+ listCommissionAgreementVersions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListCommissionAgreementVersionsResponseClass> {
385
+ return localVarFp.listCommissionAgreementVersions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
365
386
  },
366
387
  };
367
388
  };
@@ -450,32 +471,53 @@ export interface CommissionAgreementVersionsApiListCommissionAgreementVersionsRe
450
471
  readonly authorization?: string
451
472
 
452
473
  /**
453
- * 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, commissionAgreementId, startDate, endDate, createdAt&lt;/i&gt;
474
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
475
+ * @type {number}
476
+ * @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
477
+ */
478
+ readonly pageSize?: number
479
+
480
+ /**
481
+ * 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.
482
+ * @type {string}
483
+ * @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
484
+ */
485
+ readonly pageToken?: string
486
+
487
+ /**
488
+ * 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, agreementCode, startDate, endDate, createdAt&lt;/i&gt;
454
489
  * @type {string}
455
490
  * @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
456
491
  */
457
492
  readonly filter?: string
458
493
 
459
494
  /**
460
- * 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, commissionAgreementId, startDate, endDate, createdAt&lt;/i&gt;
495
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
461
496
  * @type {string}
462
497
  * @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
463
498
  */
464
- readonly filters?: string
499
+ readonly search?: string
465
500
 
466
501
  /**
467
- * 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, startDate, endDate&lt;/i&gt;
502
+ * 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: code, createdAt, startDate, endDate&lt;/i&gt;
468
503
  * @type {string}
469
504
  * @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
470
505
  */
471
506
  readonly order?: string
472
507
 
473
508
  /**
474
- * 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;
509
+ * 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: agreements&lt;i&gt;
475
510
  * @type {string}
476
511
  * @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
477
512
  */
478
513
  readonly expand?: string
514
+
515
+ /**
516
+ * 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, agreementCode, startDate, endDate, createdAt&lt;/i&gt;
517
+ * @type {string}
518
+ * @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
519
+ */
520
+ readonly filters?: string
479
521
  }
480
522
 
481
523
  /**
@@ -530,6 +572,6 @@ export class CommissionAgreementVersionsApi extends BaseAPI {
530
572
  * @memberof CommissionAgreementVersionsApi
531
573
  */
532
574
  public listCommissionAgreementVersions(requestParameters: CommissionAgreementVersionsApiListCommissionAgreementVersionsRequest = {}, options?: AxiosRequestConfig) {
533
- return CommissionAgreementVersionsApiFp(this.configuration).listCommissionAgreementVersions(requestParameters.authorization, requestParameters.filter, requestParameters.filters, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
575
+ return CommissionAgreementVersionsApiFp(this.configuration).listCommissionAgreementVersions(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
534
576
  }
535
577
  }
@@ -190,14 +190,17 @@ export const CommissionAgreementsApiAxiosParamCreator = function (configuration?
190
190
  * Retrieves a list of commission agreements.
191
191
  * @summary List commission agreements
192
192
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
193
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
194
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
193
195
  * @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;
194
- * @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;
196
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
195
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: createdAt&lt;/i&gt;
196
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.&lt;br/&gt; &lt;br/&gt;
199
+ * @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;
197
200
  * @param {*} [options] Override http request option.
198
201
  * @throws {RequiredError}
199
202
  */
200
- listCommissionAgreements: async (authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
203
+ listCommissionAgreements: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
201
204
  const localVarPath = `/commissionservice/v1/agreements`;
202
205
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
203
206
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -216,12 +219,20 @@ export const CommissionAgreementsApiAxiosParamCreator = function (configuration?
216
219
  // http bearer authentication required
217
220
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
218
221
 
222
+ if (pageSize !== undefined) {
223
+ localVarQueryParameter['pageSize'] = pageSize;
224
+ }
225
+
226
+ if (pageToken !== undefined) {
227
+ localVarQueryParameter['pageToken'] = pageToken;
228
+ }
229
+
219
230
  if (filter !== undefined) {
220
231
  localVarQueryParameter['filter'] = filter;
221
232
  }
222
233
 
223
- if (filters !== undefined) {
224
- localVarQueryParameter['filters'] = filters;
234
+ if (search !== undefined) {
235
+ localVarQueryParameter['search'] = search;
225
236
  }
226
237
 
227
238
  if (order !== undefined) {
@@ -232,6 +243,10 @@ export const CommissionAgreementsApiAxiosParamCreator = function (configuration?
232
243
  localVarQueryParameter['expand'] = expand;
233
244
  }
234
245
 
246
+ if (filters !== undefined) {
247
+ localVarQueryParameter['filters'] = filters;
248
+ }
249
+
235
250
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
236
251
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
237
252
  }
@@ -345,15 +360,18 @@ export const CommissionAgreementsApiFp = function(configuration?: Configuration)
345
360
  * Retrieves a list of commission agreements.
346
361
  * @summary List commission agreements
347
362
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
363
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
364
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
348
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;
349
- * @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;
366
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
350
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;
351
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;
352
370
  * @param {*} [options] Override http request option.
353
371
  * @throws {RequiredError}
354
372
  */
355
- async listCommissionAgreements(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionAgreementsResponseClass>> {
356
- const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissionAgreements(authorization, filter, filters, order, expand, options);
373
+ async 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>> {
374
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissionAgreements(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
357
375
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
358
376
  },
359
377
  /**
@@ -416,15 +434,18 @@ export const CommissionAgreementsApiFactory = function (configuration?: Configur
416
434
  * Retrieves a list of commission agreements.
417
435
  * @summary List commission agreements
418
436
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
437
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
438
+ * @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.
419
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;
420
- * @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;
440
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
421
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;
422
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;
423
444
  * @param {*} [options] Override http request option.
424
445
  * @throws {RequiredError}
425
446
  */
426
- listCommissionAgreements(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListCommissionAgreementsResponseClass> {
427
- return localVarFp.listCommissionAgreements(authorization, filter, filters, order, expand, options).then((request) => request(axios, basePath));
447
+ listCommissionAgreements(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListCommissionAgreementsResponseClass> {
448
+ return localVarFp.listCommissionAgreements(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
428
449
  },
429
450
  /**
430
451
  * This will update commission agreement.
@@ -523,6 +544,20 @@ export interface CommissionAgreementsApiListCommissionAgreementsRequest {
523
544
  */
524
545
  readonly authorization?: string
525
546
 
547
+ /**
548
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
549
+ * @type {number}
550
+ * @memberof CommissionAgreementsApiListCommissionAgreements
551
+ */
552
+ readonly pageSize?: number
553
+
554
+ /**
555
+ * 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.
556
+ * @type {string}
557
+ * @memberof CommissionAgreementsApiListCommissionAgreements
558
+ */
559
+ readonly pageToken?: string
560
+
526
561
  /**
527
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;
528
563
  * @type {string}
@@ -531,11 +566,11 @@ export interface CommissionAgreementsApiListCommissionAgreementsRequest {
531
566
  readonly filter?: string
532
567
 
533
568
  /**
534
- * 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;
569
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
535
570
  * @type {string}
536
571
  * @memberof CommissionAgreementsApiListCommissionAgreements
537
572
  */
538
- readonly filters?: string
573
+ readonly search?: string
539
574
 
540
575
  /**
541
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;
@@ -550,6 +585,13 @@ export interface CommissionAgreementsApiListCommissionAgreementsRequest {
550
585
  * @memberof CommissionAgreementsApiListCommissionAgreements
551
586
  */
552
587
  readonly expand?: string
588
+
589
+ /**
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;
591
+ * @type {string}
592
+ * @memberof CommissionAgreementsApiListCommissionAgreements
593
+ */
594
+ readonly filters?: string
553
595
  }
554
596
 
555
597
  /**
@@ -625,7 +667,7 @@ export class CommissionAgreementsApi extends BaseAPI {
625
667
  * @memberof CommissionAgreementsApi
626
668
  */
627
669
  public listCommissionAgreements(requestParameters: CommissionAgreementsApiListCommissionAgreementsRequest = {}, options?: AxiosRequestConfig) {
628
- return CommissionAgreementsApiFp(this.configuration).listCommissionAgreements(requestParameters.authorization, requestParameters.filter, requestParameters.filters, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
670
+ 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));
629
671
  }
630
672
 
631
673
  /**