@emilgroup/commission-sdk 1.0.0-beta.1 → 1.0.0-beta.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/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@1.0.0-beta.1 --save
20
+ npm install @emilgroup/commission-sdk@1.0.0-beta.3 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/commission-sdk@1.0.0-beta.1
24
+ yarn add @emilgroup/commission-sdk@1.0.0-beta.3
25
25
  ```
26
26
 
27
27
  And then you can import `CommissionApi`.
@@ -182,14 +182,17 @@ export const CommissionAgreementVersionsApiAxiosParamCreator = function (configu
182
182
  * Retrieves a list of commission agreement versions.
183
183
  * @summary List commission agreement versions
184
184
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
185
- * @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>
186
- * @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>
187
- * @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>
188
- * @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/>
185
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
186
+ * @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.
187
+ * @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>
188
+ * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
189
+ * @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>
190
+ * @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>
191
+ * @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>
189
192
  * @param {*} [options] Override http request option.
190
193
  * @throws {RequiredError}
191
194
  */
192
- listCommissionAgreementVersions: async (authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
195
+ listCommissionAgreementVersions: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
193
196
  const localVarPath = `/commissionservice/v1/agreement-versions`;
194
197
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
195
198
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -208,12 +211,20 @@ export const CommissionAgreementVersionsApiAxiosParamCreator = function (configu
208
211
  // http bearer authentication required
209
212
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
210
213
 
214
+ if (pageSize !== undefined) {
215
+ localVarQueryParameter['pageSize'] = pageSize;
216
+ }
217
+
218
+ if (pageToken !== undefined) {
219
+ localVarQueryParameter['pageToken'] = pageToken;
220
+ }
221
+
211
222
  if (filter !== undefined) {
212
223
  localVarQueryParameter['filter'] = filter;
213
224
  }
214
225
 
215
- if (filters !== undefined) {
216
- localVarQueryParameter['filters'] = filters;
226
+ if (search !== undefined) {
227
+ localVarQueryParameter['search'] = search;
217
228
  }
218
229
 
219
230
  if (order !== undefined) {
@@ -224,6 +235,10 @@ export const CommissionAgreementVersionsApiAxiosParamCreator = function (configu
224
235
  localVarQueryParameter['expand'] = expand;
225
236
  }
226
237
 
238
+ if (filters !== undefined) {
239
+ localVarQueryParameter['filters'] = filters;
240
+ }
241
+
227
242
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
228
243
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
229
244
  }
@@ -290,15 +305,18 @@ export const CommissionAgreementVersionsApiFp = function(configuration?: Configu
290
305
  * Retrieves a list of commission agreement versions.
291
306
  * @summary List commission agreement versions
292
307
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
293
- * @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;
294
- * @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;
295
- * @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;
296
- * @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;
308
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
309
+ * @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.
310
+ * @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;
311
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
312
+ * @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;
313
+ * @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;
314
+ * @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;
297
315
  * @param {*} [options] Override http request option.
298
316
  * @throws {RequiredError}
299
317
  */
300
- async listCommissionAgreementVersions(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionAgreementVersionsResponseClass>> {
301
- const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissionAgreementVersions(authorization, filter, filters, order, expand, options);
318
+ 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>> {
319
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissionAgreementVersions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
302
320
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
303
321
  },
304
322
  }
@@ -349,15 +367,18 @@ export const CommissionAgreementVersionsApiFactory = function (configuration?: C
349
367
  * Retrieves a list of commission agreement versions.
350
368
  * @summary List commission agreement versions
351
369
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
352
- * @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;
353
- * @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;
354
- * @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;
355
- * @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;
370
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
371
+ * @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.
372
+ * @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;
373
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
374
+ * @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;
375
+ * @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;
376
+ * @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;
356
377
  * @param {*} [options] Override http request option.
357
378
  * @throws {RequiredError}
358
379
  */
359
- listCommissionAgreementVersions(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListCommissionAgreementVersionsResponseClass> {
360
- return localVarFp.listCommissionAgreementVersions(authorization, filter, filters, order, expand, options).then((request) => request(axios, basePath));
380
+ listCommissionAgreementVersions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListCommissionAgreementVersionsResponseClass> {
381
+ return localVarFp.listCommissionAgreementVersions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
361
382
  },
362
383
  };
363
384
  };
@@ -446,32 +467,53 @@ export interface CommissionAgreementVersionsApiListCommissionAgreementVersionsRe
446
467
  readonly authorization?: string
447
468
 
448
469
  /**
449
- * 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;
470
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
471
+ * @type {number}
472
+ * @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
473
+ */
474
+ readonly pageSize?: number
475
+
476
+ /**
477
+ * 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.
478
+ * @type {string}
479
+ * @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
480
+ */
481
+ readonly pageToken?: string
482
+
483
+ /**
484
+ * 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;
450
485
  * @type {string}
451
486
  * @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
452
487
  */
453
488
  readonly filter?: string
454
489
 
455
490
  /**
456
- * 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;
491
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
457
492
  * @type {string}
458
493
  * @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
459
494
  */
460
- readonly filters?: string
495
+ readonly search?: string
461
496
 
462
497
  /**
463
- * 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;
498
+ * 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;
464
499
  * @type {string}
465
500
  * @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
466
501
  */
467
502
  readonly order?: string
468
503
 
469
504
  /**
470
- * 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;
505
+ * 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;
471
506
  * @type {string}
472
507
  * @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
473
508
  */
474
509
  readonly expand?: string
510
+
511
+ /**
512
+ * 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;
513
+ * @type {string}
514
+ * @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
515
+ */
516
+ readonly filters?: string
475
517
  }
476
518
 
477
519
  /**
@@ -526,6 +568,6 @@ export class CommissionAgreementVersionsApi extends BaseAPI {
526
568
  * @memberof CommissionAgreementVersionsApi
527
569
  */
528
570
  public listCommissionAgreementVersions(requestParameters: CommissionAgreementVersionsApiListCommissionAgreementVersionsRequest = {}, options?: AxiosRequestConfig) {
529
- return CommissionAgreementVersionsApiFp(this.configuration).listCommissionAgreementVersions(requestParameters.authorization, requestParameters.filter, requestParameters.filters, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
571
+ 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));
530
572
  }
531
573
  }
@@ -186,14 +186,17 @@ export const CommissionAgreementsApiAxiosParamCreator = function (configuration?
186
186
  * Retrieves a list of commission agreements.
187
187
  * @summary List commission agreements
188
188
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
189
191
  * @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;
190
- * @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;
192
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
191
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: createdAt&lt;/i&gt;
192
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.&lt;br/&gt; &lt;br/&gt;
195
+ * @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;
193
196
  * @param {*} [options] Override http request option.
194
197
  * @throws {RequiredError}
195
198
  */
196
- listCommissionAgreements: async (authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
199
+ listCommissionAgreements: 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/agreements`;
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 CommissionAgreementsApiAxiosParamCreator = function (configuration?
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 CommissionAgreementsApiAxiosParamCreator = function (configuration?
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
  }
@@ -341,15 +356,18 @@ export const CommissionAgreementsApiFp = function(configuration?: Configuration)
341
356
  * Retrieves a list of commission agreements.
342
357
  * @summary List commission agreements
343
358
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
359
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
360
+ * @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.
344
361
  * @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;
345
- * @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;
362
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
346
363
  * @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;
347
364
  * @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;
365
+ * @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;
348
366
  * @param {*} [options] Override http request option.
349
367
  * @throws {RequiredError}
350
368
  */
351
- async listCommissionAgreements(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionAgreementsResponseClass>> {
352
- const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissionAgreements(authorization, filter, filters, order, expand, options);
369
+ 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>> {
370
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissionAgreements(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
353
371
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
354
372
  },
355
373
  /**
@@ -412,15 +430,18 @@ export const CommissionAgreementsApiFactory = function (configuration?: Configur
412
430
  * Retrieves a list of commission agreements.
413
431
  * @summary List commission agreements
414
432
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
433
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
434
+ * @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.
415
435
  * @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;
416
- * @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;
436
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
417
437
  * @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;
418
438
  * @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;
439
+ * @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;
419
440
  * @param {*} [options] Override http request option.
420
441
  * @throws {RequiredError}
421
442
  */
422
- listCommissionAgreements(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListCommissionAgreementsResponseClass> {
423
- return localVarFp.listCommissionAgreements(authorization, filter, filters, order, expand, options).then((request) => request(axios, basePath));
443
+ listCommissionAgreements(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListCommissionAgreementsResponseClass> {
444
+ return localVarFp.listCommissionAgreements(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
424
445
  },
425
446
  /**
426
447
  * This will update commission agreement.
@@ -519,6 +540,20 @@ export interface CommissionAgreementsApiListCommissionAgreementsRequest {
519
540
  */
520
541
  readonly authorization?: string
521
542
 
543
+ /**
544
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
545
+ * @type {number}
546
+ * @memberof CommissionAgreementsApiListCommissionAgreements
547
+ */
548
+ readonly pageSize?: number
549
+
550
+ /**
551
+ * 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.
552
+ * @type {string}
553
+ * @memberof CommissionAgreementsApiListCommissionAgreements
554
+ */
555
+ readonly pageToken?: string
556
+
522
557
  /**
523
558
  * 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;
524
559
  * @type {string}
@@ -527,11 +562,11 @@ export interface CommissionAgreementsApiListCommissionAgreementsRequest {
527
562
  readonly filter?: string
528
563
 
529
564
  /**
530
- * 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;
565
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
531
566
  * @type {string}
532
567
  * @memberof CommissionAgreementsApiListCommissionAgreements
533
568
  */
534
- readonly filters?: string
569
+ readonly search?: string
535
570
 
536
571
  /**
537
572
  * 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,6 +581,13 @@ export interface CommissionAgreementsApiListCommissionAgreementsRequest {
546
581
  * @memberof CommissionAgreementsApiListCommissionAgreements
547
582
  */
548
583
  readonly expand?: string
584
+
585
+ /**
586
+ * 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;
587
+ * @type {string}
588
+ * @memberof CommissionAgreementsApiListCommissionAgreements
589
+ */
590
+ readonly filters?: string
549
591
  }
550
592
 
551
593
  /**
@@ -621,7 +663,7 @@ export class CommissionAgreementsApi extends BaseAPI {
621
663
  * @memberof CommissionAgreementsApi
622
664
  */
623
665
  public listCommissionAgreements(requestParameters: CommissionAgreementsApiListCommissionAgreementsRequest = {}, options?: AxiosRequestConfig) {
624
- return CommissionAgreementsApiFp(this.configuration).listCommissionAgreements(requestParameters.authorization, requestParameters.filter, requestParameters.filters, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
666
+ 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));
625
667
  }
626
668
 
627
669
  /**
@@ -186,13 +186,17 @@ export const CommissionsApiAxiosParamCreator = function (configuration?: Configu
186
186
  * Retrieves a list of commissions.
187
187
  * @summary List commissions
188
188
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
189
- * @param {'createdAt'} [order]
190
- * @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter]
191
- * @param {'items'} [expand]
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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
191
+ * @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
192
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
193
+ * @param {'createdAt'} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
194
+ * @param {'items'} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
195
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
192
196
  * @param {*} [options] Override http request option.
193
197
  * @throws {RequiredError}
194
198
  */
195
- listCommissions: async (authorization?: string, order?: 'createdAt', filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', expand?: 'items', options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
199
+ listCommissions: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', search?: string, order?: 'createdAt', expand?: 'items', filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
196
200
  const localVarPath = `/commissionservice/v1/commissions`;
197
201
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
198
202
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -211,18 +215,34 @@ export const CommissionsApiAxiosParamCreator = function (configuration?: Configu
211
215
  // http bearer authentication required
212
216
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
213
217
 
214
- if (order !== undefined) {
215
- localVarQueryParameter['order'] = order;
218
+ if (pageSize !== undefined) {
219
+ localVarQueryParameter['pageSize'] = pageSize;
220
+ }
221
+
222
+ if (pageToken !== undefined) {
223
+ localVarQueryParameter['pageToken'] = pageToken;
216
224
  }
217
225
 
218
226
  if (filter !== undefined) {
219
227
  localVarQueryParameter['filter'] = filter;
220
228
  }
221
229
 
230
+ if (search !== undefined) {
231
+ localVarQueryParameter['search'] = search;
232
+ }
233
+
234
+ if (order !== undefined) {
235
+ localVarQueryParameter['order'] = order;
236
+ }
237
+
222
238
  if (expand !== undefined) {
223
239
  localVarQueryParameter['expand'] = expand;
224
240
  }
225
241
 
242
+ if (filters !== undefined) {
243
+ localVarQueryParameter['filters'] = filters;
244
+ }
245
+
226
246
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
227
247
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
228
248
  }
@@ -340,14 +360,18 @@ export const CommissionsApiFp = function(configuration?: Configuration) {
340
360
  * Retrieves a list of commissions.
341
361
  * @summary List commissions
342
362
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
343
- * @param {'createdAt'} [order]
344
- * @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter]
345
- * @param {'items'} [expand]
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.
365
+ * @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
366
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
367
+ * @param {'createdAt'} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
368
+ * @param {'items'} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
369
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
346
370
  * @param {*} [options] Override http request option.
347
371
  * @throws {RequiredError}
348
372
  */
349
- async listCommissions(authorization?: string, order?: 'createdAt', filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', expand?: 'items', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionsResponseClass>> {
350
- const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissions(authorization, order, filter, expand, options);
373
+ async listCommissions(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', search?: string, order?: 'createdAt', expand?: 'items', filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionsResponseClass>> {
374
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
351
375
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
352
376
  },
353
377
  /**
@@ -411,14 +435,18 @@ export const CommissionsApiFactory = function (configuration?: Configuration, ba
411
435
  * Retrieves a list of commissions.
412
436
  * @summary List commissions
413
437
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
414
- * @param {'createdAt'} [order]
415
- * @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter]
416
- * @param {'items'} [expand]
438
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
439
+ * @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.
440
+ * @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
441
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
442
+ * @param {'createdAt'} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
443
+ * @param {'items'} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
444
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
417
445
  * @param {*} [options] Override http request option.
418
446
  * @throws {RequiredError}
419
447
  */
420
- listCommissions(authorization?: string, order?: 'createdAt', filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', expand?: 'items', options?: any): AxiosPromise<ListCommissionsResponseClass> {
421
- return localVarFp.listCommissions(authorization, order, filter, expand, options).then((request) => request(axios, basePath));
448
+ listCommissions(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', search?: string, order?: 'createdAt', expand?: 'items', filters?: string, options?: any): AxiosPromise<ListCommissionsResponseClass> {
449
+ return localVarFp.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
422
450
  },
423
451
  /**
424
452
  * This will update commission.
@@ -519,25 +547,53 @@ export interface CommissionsApiListCommissionsRequest {
519
547
  readonly authorization?: string
520
548
 
521
549
  /**
522
- *
523
- * @type {'createdAt'}
550
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
551
+ * @type {number}
524
552
  * @memberof CommissionsApiListCommissions
525
553
  */
526
- readonly order?: 'createdAt'
554
+ readonly pageSize?: number
527
555
 
528
556
  /**
529
- *
557
+ * 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.
558
+ * @type {string}
559
+ * @memberof CommissionsApiListCommissions
560
+ */
561
+ readonly pageToken?: string
562
+
563
+ /**
564
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
530
565
  * @type {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'}
531
566
  * @memberof CommissionsApiListCommissions
532
567
  */
533
568
  readonly filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'
534
569
 
535
570
  /**
536
- *
571
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
572
+ * @type {string}
573
+ * @memberof CommissionsApiListCommissions
574
+ */
575
+ readonly search?: string
576
+
577
+ /**
578
+ * The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
579
+ * @type {'createdAt'}
580
+ * @memberof CommissionsApiListCommissions
581
+ */
582
+ readonly order?: 'createdAt'
583
+
584
+ /**
585
+ * Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
537
586
  * @type {'items'}
538
587
  * @memberof CommissionsApiListCommissions
539
588
  */
540
589
  readonly expand?: 'items'
590
+
591
+ /**
592
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
593
+ * @type {string}
594
+ * @memberof CommissionsApiListCommissions
595
+ */
596
+ readonly filters?: string
541
597
  }
542
598
 
543
599
  /**
@@ -620,7 +676,7 @@ export class CommissionsApi extends BaseAPI {
620
676
  * @memberof CommissionsApi
621
677
  */
622
678
  public listCommissions(requestParameters: CommissionsApiListCommissionsRequest = {}, options?: AxiosRequestConfig) {
623
- return CommissionsApiFp(this.configuration).listCommissions(requestParameters.authorization, requestParameters.order, requestParameters.filter, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
679
+ return CommissionsApiFp(this.configuration).listCommissions(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
624
680
  }
625
681
 
626
682
  /**