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

package/dist/api/commissions-api.d.ts

@@ -55,13 +55,17 @@ export declare const CommissionsApiAxiosParamCreator: (configuration?: Configura
      * Retrieves a list of commissions.
      * @summary List commissions
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
-     * @param {'createdAt'} [order]
-     * @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter]
-     * @param {'items'} [expand]
+     * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @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.
+     * @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.
+     * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
+     * @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.
+     * @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.
+     * @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.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listCommissions: (authorization?: string, order?: 'createdAt', filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', expand?: 'items', options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    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<RequestArgs>;
     /**
      * This will update commission.
      * @summary Update the commission
@@ -110,13 +114,17 @@ export declare const CommissionsApiFp: (configuration?: Configuration) => {
      * Retrieves a list of commissions.
      * @summary List commissions
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
-     * @param {'createdAt'} [order]
-     * @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter]
-     * @param {'items'} [expand]
+     * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @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.
+     * @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.
+     * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @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.
+     * @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.
+     * @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.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    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>>;
+    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>>;
     /**
      * This will update commission.
      * @summary Update the commission
@@ -165,13 +173,17 @@ export declare const CommissionsApiFactory: (configuration?: Configuration, base
      * Retrieves a list of commissions.
      * @summary List commissions
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
-     * @param {'createdAt'} [order]
-     * @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter]
-     * @param {'items'} [expand]
+     * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @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.
+     * @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.
+     * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @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.
+     * @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.
+     * @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.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    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>;
+    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>;
     /**
      * This will update commission.
      * @summary Update the commission
@@ -259,23 +271,47 @@ export interface CommissionsApiListCommissionsRequest {
      */
     readonly authorization?: string;
     /**
-     *
-     * @type {'createdAt'}
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @type {number}
      * @memberof CommissionsApiListCommissions
      */
-    readonly order?: 'createdAt';
+    readonly pageSize?: number;
     /**
-     *
+     * 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.
+     * @type {string}
+     * @memberof CommissionsApiListCommissions
+     */
+    readonly pageToken?: string;
+    /**
+     * Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
      * @type {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'}
      * @memberof CommissionsApiListCommissions
      */
     readonly filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt';
     /**
-     *
+     * To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @type {string}
+     * @memberof CommissionsApiListCommissions
+     */
+    readonly search?: string;
+    /**
+     * 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.
+     * @type {'createdAt'}
+     * @memberof CommissionsApiListCommissions
+     */
+    readonly order?: 'createdAt';
+    /**
+     * 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.
      * @type {'items'}
      * @memberof CommissionsApiListCommissions
      */
     readonly expand?: 'items';
+    /**
+     * 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.
+     * @type {string}
+     * @memberof CommissionsApiListCommissions
+     */
+    readonly filters?: string;
 }
 /**
  * Request parameters for updateCommission operation in CommissionsApi.

package/dist/api/commissions-api.js

@@ -251,13 +251,17 @@ var CommissionsApiAxiosParamCreator = function (configuration) {
          * Retrieves a list of commissions.
          * @summary List commissions
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
-         * @param {'createdAt'} [order]
-         * @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter]
-         * @param {'items'} [expand]
+         * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+         * @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.
+         * @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.
+         * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
+         * @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.
+         * @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.
+         * @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.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listCommissions: function (authorization, order, filter, expand, options) {
+        listCommissions: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
             if (options === void 0) { options = {}; }
             return __awaiter(_this, void 0, void 0, function () {
                 var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -280,15 +284,27 @@ var CommissionsApiAxiosParamCreator = function (configuration) {
                             // authentication bearer required
                             // http bearer authentication required
                             _a.sent();
-                            if (order !== undefined) {
-                                localVarQueryParameter['order'] = order;
+                            if (pageSize !== undefined) {
+                                localVarQueryParameter['pageSize'] = pageSize;
+                            }
+                            if (pageToken !== undefined) {
+                                localVarQueryParameter['pageToken'] = pageToken;
                             }
                             if (filter !== undefined) {
                                 localVarQueryParameter['filter'] = filter;
                             }
+                            if (search !== undefined) {
+                                localVarQueryParameter['search'] = search;
+                            }
+                            if (order !== undefined) {
+                                localVarQueryParameter['order'] = order;
+                            }
                             if (expand !== undefined) {
                                 localVarQueryParameter['expand'] = expand;
                             }
+                            if (filters !== undefined) {
+                                localVarQueryParameter['filters'] = filters;
+                            }
                             if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
                                 localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
                             }
@@ -434,18 +450,22 @@ var CommissionsApiFp = function (configuration) {
          * Retrieves a list of commissions.
          * @summary List commissions
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
-         * @param {'createdAt'} [order]
-         * @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter]
-         * @param {'items'} [expand]
+         * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+         * @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.
+         * @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.
+         * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
+         * @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.
+         * @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.
+         * @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.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listCommissions: function (authorization, order, filter, expand, options) {
+        listCommissions: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
             return __awaiter(this, void 0, void 0, function () {
                 var localVarAxiosArgs;
                 return __generator(this, function (_a) {
                     switch (_a.label) {
-                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.listCommissions(authorization, order, filter, expand, options)];
+                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
                         case 1:
                             localVarAxiosArgs = _a.sent();
                             return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -523,14 +543,18 @@ var CommissionsApiFactory = function (configuration, basePath, axios) {
          * Retrieves a list of commissions.
          * @summary List commissions
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
-         * @param {'createdAt'} [order]
-         * @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter]
-         * @param {'items'} [expand]
+         * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+         * @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.
+         * @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.
+         * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
+         * @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.
+         * @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.
+         * @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.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listCommissions: function (authorization, order, filter, expand, options) {
-            return localVarFp.listCommissions(authorization, order, filter, expand, options).then(function (request) { return request(axios, basePath); });
+        listCommissions: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
+            return localVarFp.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
         },
         /**
          * This will update commission.
@@ -605,7 +629,7 @@ var CommissionsApi = /** @class */ (function (_super) {
     CommissionsApi.prototype.listCommissions = function (requestParameters, options) {
         var _this = this;
         if (requestParameters === void 0) { requestParameters = {}; }
-        return (0, exports.CommissionsApiFp)(this.configuration).listCommissions(requestParameters.authorization, requestParameters.order, requestParameters.filter, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
+        return (0, exports.CommissionsApiFp)(this.configuration).listCommissions(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     /**
      * This will update commission.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@emilgroup/commission-sdk-node",
-  "version": "1.0.0-beta.1",
+  "version": "1.0.0-beta.3",
   "description": "OpenAPI client for @emilgroup/commission-sdk-node",
   "author": "OpenAPI-Generator Contributors",
   "keywords": [