@emilgroup/payment-sdk-node 1.21.1-beta.2 → 1.21.1-beta.20

package/dist/api/payment-setup-api.d.ts

@@ -22,7 +22,7 @@ import { InitiatePaymentSetupResponseClass } from '../models';
  */
 export declare const PaymentSetupApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
-     * This endpoint is used to save user-provided payment information.       The service will send a request to the configured PSP to securely store the payment data.
+     * This endpoint is used to save user-provided payment information.       The service will send a request to the configured PSP to securely store the payment data.  **Required Permissions**  \"payment-management.payments.create\"
      * @summary Complete a payment setup
      * @param {CompletePaymentSetupRequestDto} completePaymentSetupRequestDto
      * @param {string} [authorization] Bearer Token
@@ -31,7 +31,7 @@ export declare const PaymentSetupApiAxiosParamCreator: (configuration?: Configur
      */
     completePaymentSetup: (completePaymentSetupRequestDto: CompletePaymentSetupRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
+     * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.  **Required Permissions**  \"payment-management.payments.create\"
      * @summary Initiate a payment setup
      * @param {InitiatePaymentSetupRequestDto} initiatePaymentSetupRequestDto
      * @param {string} [authorization] Bearer Token
@@ -46,7 +46,7 @@ export declare const PaymentSetupApiAxiosParamCreator: (configuration?: Configur
  */
 export declare const PaymentSetupApiFp: (configuration?: Configuration) => {
     /**
-     * This endpoint is used to save user-provided payment information.       The service will send a request to the configured PSP to securely store the payment data.
+     * This endpoint is used to save user-provided payment information.       The service will send a request to the configured PSP to securely store the payment data.  **Required Permissions**  \"payment-management.payments.create\"
      * @summary Complete a payment setup
      * @param {CompletePaymentSetupRequestDto} completePaymentSetupRequestDto
      * @param {string} [authorization] Bearer Token
@@ -55,7 +55,7 @@ export declare const PaymentSetupApiFp: (configuration?: Configuration) => {
      */
     completePaymentSetup(completePaymentSetupRequestDto: CompletePaymentSetupRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CompletePaymentSetupResponseClass>>;
     /**
-     * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
+     * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.  **Required Permissions**  \"payment-management.payments.create\"
      * @summary Initiate a payment setup
      * @param {InitiatePaymentSetupRequestDto} initiatePaymentSetupRequestDto
      * @param {string} [authorization] Bearer Token
@@ -70,7 +70,7 @@ export declare const PaymentSetupApiFp: (configuration?: Configuration) => {
  */
 export declare const PaymentSetupApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
-     * This endpoint is used to save user-provided payment information.       The service will send a request to the configured PSP to securely store the payment data.
+     * This endpoint is used to save user-provided payment information.       The service will send a request to the configured PSP to securely store the payment data.  **Required Permissions**  \"payment-management.payments.create\"
      * @summary Complete a payment setup
      * @param {CompletePaymentSetupRequestDto} completePaymentSetupRequestDto
      * @param {string} [authorization] Bearer Token
@@ -79,7 +79,7 @@ export declare const PaymentSetupApiFactory: (configuration?: Configuration, bas
      */
     completePaymentSetup(completePaymentSetupRequestDto: CompletePaymentSetupRequestDto, authorization?: string, options?: any): AxiosPromise<CompletePaymentSetupResponseClass>;
     /**
-     * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
+     * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.  **Required Permissions**  \"payment-management.payments.create\"
      * @summary Initiate a payment setup
      * @param {InitiatePaymentSetupRequestDto} initiatePaymentSetupRequestDto
      * @param {string} [authorization] Bearer Token
@@ -134,7 +134,7 @@ export interface PaymentSetupApiInitiatePaymentSetupRequest {
  */
 export declare class PaymentSetupApi extends BaseAPI {
     /**
-     * This endpoint is used to save user-provided payment information.       The service will send a request to the configured PSP to securely store the payment data.
+     * This endpoint is used to save user-provided payment information.       The service will send a request to the configured PSP to securely store the payment data.  **Required Permissions**  \"payment-management.payments.create\"
      * @summary Complete a payment setup
      * @param {PaymentSetupApiCompletePaymentSetupRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -143,7 +143,7 @@ export declare class PaymentSetupApi extends BaseAPI {
      */
     completePaymentSetup(requestParameters: PaymentSetupApiCompletePaymentSetupRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CompletePaymentSetupResponseClass, any>>;
     /**
-     * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
+     * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.  **Required Permissions**  \"payment-management.payments.create\"
      * @summary Initiate a payment setup
      * @param {PaymentSetupApiInitiatePaymentSetupRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.

package/dist/api/payment-setup-api.js

@@ -97,7 +97,7 @@ var PaymentSetupApiAxiosParamCreator = function (configuration) {
     var _this = this;
     return {
         /**
-         * This endpoint is used to save user-provided payment information.       The service will send a request to the configured PSP to securely store the payment data.
+         * This endpoint is used to save user-provided payment information.       The service will send a request to the configured PSP to securely store the payment data.  **Required Permissions**  \"payment-management.payments.create\"
          * @summary Complete a payment setup
          * @param {CompletePaymentSetupRequestDto} completePaymentSetupRequestDto
          * @param {string} [authorization] Bearer Token
@@ -146,7 +146,7 @@ var PaymentSetupApiAxiosParamCreator = function (configuration) {
             });
         },
         /**
-         * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
+         * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.  **Required Permissions**  \"payment-management.payments.create\"
          * @summary Initiate a payment setup
          * @param {InitiatePaymentSetupRequestDto} initiatePaymentSetupRequestDto
          * @param {string} [authorization] Bearer Token
@@ -205,7 +205,7 @@ var PaymentSetupApiFp = function (configuration) {
     var localVarAxiosParamCreator = (0, exports.PaymentSetupApiAxiosParamCreator)(configuration);
     return {
         /**
-         * This endpoint is used to save user-provided payment information.       The service will send a request to the configured PSP to securely store the payment data.
+         * This endpoint is used to save user-provided payment information.       The service will send a request to the configured PSP to securely store the payment data.  **Required Permissions**  \"payment-management.payments.create\"
          * @summary Complete a payment setup
          * @param {CompletePaymentSetupRequestDto} completePaymentSetupRequestDto
          * @param {string} [authorization] Bearer Token
@@ -226,7 +226,7 @@ var PaymentSetupApiFp = function (configuration) {
             });
         },
         /**
-         * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
+         * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.  **Required Permissions**  \"payment-management.payments.create\"
          * @summary Initiate a payment setup
          * @param {InitiatePaymentSetupRequestDto} initiatePaymentSetupRequestDto
          * @param {string} [authorization] Bearer Token
@@ -257,7 +257,7 @@ var PaymentSetupApiFactory = function (configuration, basePath, axios) {
     var localVarFp = (0, exports.PaymentSetupApiFp)(configuration);
     return {
         /**
-         * This endpoint is used to save user-provided payment information.       The service will send a request to the configured PSP to securely store the payment data.
+         * This endpoint is used to save user-provided payment information.       The service will send a request to the configured PSP to securely store the payment data.  **Required Permissions**  \"payment-management.payments.create\"
          * @summary Complete a payment setup
          * @param {CompletePaymentSetupRequestDto} completePaymentSetupRequestDto
          * @param {string} [authorization] Bearer Token
@@ -268,7 +268,7 @@ var PaymentSetupApiFactory = function (configuration, basePath, axios) {
             return localVarFp.completePaymentSetup(completePaymentSetupRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
         },
         /**
-         * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
+         * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.  **Required Permissions**  \"payment-management.payments.create\"
          * @summary Initiate a payment setup
          * @param {InitiatePaymentSetupRequestDto} initiatePaymentSetupRequestDto
          * @param {string} [authorization] Bearer Token
@@ -293,7 +293,7 @@ var PaymentSetupApi = /** @class */ (function (_super) {
         return _super !== null && _super.apply(this, arguments) || this;
     }
     /**
-     * This endpoint is used to save user-provided payment information.       The service will send a request to the configured PSP to securely store the payment data.
+     * This endpoint is used to save user-provided payment information.       The service will send a request to the configured PSP to securely store the payment data.  **Required Permissions**  \"payment-management.payments.create\"
      * @summary Complete a payment setup
      * @param {PaymentSetupApiCompletePaymentSetupRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -305,7 +305,7 @@ var PaymentSetupApi = /** @class */ (function (_super) {
         return (0, exports.PaymentSetupApiFp)(this.configuration).completePaymentSetup(requestParameters.completePaymentSetupRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     /**
-     * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
+     * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.  **Required Permissions**  \"payment-management.payments.create\"
      * @summary Initiate a payment setup
      * @param {PaymentSetupApiInitiatePaymentSetupRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.

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

@@ -22,7 +22,7 @@ import { ListPaymentsResponseClass } from '../models';
  */
 export declare const PaymentsApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
-     * This will create a payment for a specified account. This function is idempotent.
+     * This will create a payment for a specified account. This function is idempotent.  **Required Permissions**  \"payment-management.payments.create\"
      * @summary Create the payment
      * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique.      Usually, a generated v4 UUID is enough.
      * @param {CreatePaymentRequestDto} createPaymentRequestDto
@@ -32,7 +32,7 @@ export declare const PaymentsApiAxiosParamCreator: (configuration?: Configuratio
      */
     createPayment: (idempotencyKey: string, createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Retrieves the details of the payment that was previously created. Supply the unique payment code      that was returned when you created it and Emil Api will return the corresponding payment information.
+     * Retrieves the details of the payment that was previously created. Supply the unique payment code      that was returned when you created it and Emil Api will return the corresponding payment information.  **Required Permissions**  \"payment-management.payments.view\"
      * @summary Retrieve the payment
      * @param {string} code
      * @param {string} [authorization] Bearer Token
@@ -42,17 +42,20 @@ export declare const PaymentsApiAxiosParamCreator: (configuration?: Configuratio
      */
     getPayment: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Returns a list of payments you have previously created.          The payments are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
+     * Returns a list of payments you have previously created.          The payments are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.  **Required Permissions**  \"payment-management.payments.view\"
      * @summary List payments
      * @param {string} [authorization] Bearer Token
+     * @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 {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: code, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug&lt;/i&gt;
-     * @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: code, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug&lt;/i&gt;
+     * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
      * @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: id, createdAt, code, amount&lt;/i&gt;
      * @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: transactions&lt;i&gt;
+     * @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: code, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug&lt;/i&gt;
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listPayments: (authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    listPayments: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * PaymentsApi - functional programming interface
@@ -60,7 +63,7 @@ export declare const PaymentsApiAxiosParamCreator: (configuration?: Configuratio
  */
 export declare const PaymentsApiFp: (configuration?: Configuration) => {
     /**
-     * This will create a payment for a specified account. This function is idempotent.
+     * This will create a payment for a specified account. This function is idempotent.  **Required Permissions**  \"payment-management.payments.create\"
      * @summary Create the payment
      * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique.      Usually, a generated v4 UUID is enough.
      * @param {CreatePaymentRequestDto} createPaymentRequestDto
@@ -70,7 +73,7 @@ export declare const PaymentsApiFp: (configuration?: Configuration) => {
      */
     createPayment(idempotencyKey: string, createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePaymentResponseClass>>;
     /**
-     * Retrieves the details of the payment that was previously created. Supply the unique payment code      that was returned when you created it and Emil Api will return the corresponding payment information.
+     * Retrieves the details of the payment that was previously created. Supply the unique payment code      that was returned when you created it and Emil Api will return the corresponding payment information.  **Required Permissions**  \"payment-management.payments.view\"
      * @summary Retrieve the payment
      * @param {string} code
      * @param {string} [authorization] Bearer Token
@@ -80,17 +83,20 @@ export declare const PaymentsApiFp: (configuration?: Configuration) => {
      */
     getPayment(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPaymentResponseClass>>;
     /**
-     * Returns a list of payments you have previously created.          The payments are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
+     * Returns a list of payments you have previously created.          The payments are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.  **Required Permissions**  \"payment-management.payments.view\"
      * @summary List payments
      * @param {string} [authorization] Bearer Token
+     * @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 {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: code, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug&lt;/i&gt;
-     * @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: code, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug&lt;/i&gt;
+     * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
      * @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: id, createdAt, code, amount&lt;/i&gt;
      * @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: transactions&lt;i&gt;
+     * @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: code, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug&lt;/i&gt;
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listPayments(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPaymentsResponseClass>>;
+    listPayments(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPaymentsResponseClass>>;
 };
 /**
  * PaymentsApi - factory interface
@@ -98,7 +104,7 @@ export declare const PaymentsApiFp: (configuration?: Configuration) => {
  */
 export declare const PaymentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
-     * This will create a payment for a specified account. This function is idempotent.
+     * This will create a payment for a specified account. This function is idempotent.  **Required Permissions**  \"payment-management.payments.create\"
      * @summary Create the payment
      * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique.      Usually, a generated v4 UUID is enough.
      * @param {CreatePaymentRequestDto} createPaymentRequestDto
@@ -108,7 +114,7 @@ export declare const PaymentsApiFactory: (configuration?: Configuration, basePat
      */
     createPayment(idempotencyKey: string, createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePaymentResponseClass>;
     /**
-     * Retrieves the details of the payment that was previously created. Supply the unique payment code      that was returned when you created it and Emil Api will return the corresponding payment information.
+     * Retrieves the details of the payment that was previously created. Supply the unique payment code      that was returned when you created it and Emil Api will return the corresponding payment information.  **Required Permissions**  \"payment-management.payments.view\"
      * @summary Retrieve the payment
      * @param {string} code
      * @param {string} [authorization] Bearer Token
@@ -118,17 +124,20 @@ export declare const PaymentsApiFactory: (configuration?: Configuration, basePat
      */
     getPayment(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetPaymentResponseClass>;
     /**
-     * Returns a list of payments you have previously created.          The payments are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
+     * Returns a list of payments you have previously created.          The payments are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.  **Required Permissions**  \"payment-management.payments.view\"
      * @summary List payments
      * @param {string} [authorization] Bearer Token
+     * @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 {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: code, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug&lt;/i&gt;
-     * @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: code, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug&lt;/i&gt;
+     * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
      * @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: id, createdAt, code, amount&lt;/i&gt;
      * @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: transactions&lt;i&gt;
+     * @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: code, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug&lt;/i&gt;
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listPayments(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListPaymentsResponseClass>;
+    listPayments(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPaymentsResponseClass>;
 };
 /**
  * Request parameters for createPayment operation in PaymentsApi.
@@ -192,6 +201,18 @@ export interface PaymentsApiListPaymentsRequest {
      * @memberof PaymentsApiListPayments
      */
     readonly authorization?: string;
+    /**
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @type {number}
+     * @memberof PaymentsApiListPayments
+     */
+    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 PaymentsApiListPayments
+     */
+    readonly pageToken?: string;
     /**
      * 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: code, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug&lt;/i&gt;
      * @type {string}
@@ -199,11 +220,11 @@ export interface PaymentsApiListPaymentsRequest {
      */
     readonly filter?: string;
     /**
-     * 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: code, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug&lt;/i&gt;
+     * To search the list by any field, pass search&#x3D;xxx to fetch the result.
      * @type {string}
      * @memberof PaymentsApiListPayments
      */
-    readonly filters?: string;
+    readonly search?: string;
     /**
      * 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: id, createdAt, code, amount&lt;/i&gt;
      * @type {string}
@@ -216,6 +237,12 @@ export interface PaymentsApiListPaymentsRequest {
      * @memberof PaymentsApiListPayments
      */
     readonly expand?: string;
+    /**
+     * 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: code, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug&lt;/i&gt;
+     * @type {string}
+     * @memberof PaymentsApiListPayments
+     */
+    readonly filters?: string;
 }
 /**
  * PaymentsApi - object-oriented interface
@@ -225,7 +252,7 @@ export interface PaymentsApiListPaymentsRequest {
  */
 export declare class PaymentsApi extends BaseAPI {
     /**
-     * This will create a payment for a specified account. This function is idempotent.
+     * This will create a payment for a specified account. This function is idempotent.  **Required Permissions**  \"payment-management.payments.create\"
      * @summary Create the payment
      * @param {PaymentsApiCreatePaymentRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -234,7 +261,7 @@ export declare class PaymentsApi extends BaseAPI {
      */
     createPayment(requestParameters: PaymentsApiCreatePaymentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePaymentResponseClass, any>>;
     /**
-     * Retrieves the details of the payment that was previously created. Supply the unique payment code      that was returned when you created it and Emil Api will return the corresponding payment information.
+     * Retrieves the details of the payment that was previously created. Supply the unique payment code      that was returned when you created it and Emil Api will return the corresponding payment information.  **Required Permissions**  \"payment-management.payments.view\"
      * @summary Retrieve the payment
      * @param {PaymentsApiGetPaymentRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -243,7 +270,7 @@ export declare class PaymentsApi extends BaseAPI {
      */
     getPayment(requestParameters: PaymentsApiGetPaymentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPaymentResponseClass, any>>;
     /**
-     * Returns a list of payments you have previously created.          The payments are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
+     * Returns a list of payments you have previously created.          The payments are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.  **Required Permissions**  \"payment-management.payments.view\"
      * @summary List payments
      * @param {PaymentsApiListPaymentsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.

package/dist/api/payments-api.js

@@ -97,7 +97,7 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
     var _this = this;
     return {
         /**
-         * This will create a payment for a specified account. This function is idempotent.
+         * This will create a payment for a specified account. This function is idempotent.  **Required Permissions**  \"payment-management.payments.create\"
          * @summary Create the payment
          * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique.      Usually, a generated v4 UUID is enough.
          * @param {CreatePaymentRequestDto} createPaymentRequestDto
@@ -152,7 +152,7 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
             });
         },
         /**
-         * Retrieves the details of the payment that was previously created. Supply the unique payment code      that was returned when you created it and Emil Api will return the corresponding payment information.
+         * Retrieves the details of the payment that was previously created. Supply the unique payment code      that was returned when you created it and Emil Api will return the corresponding payment information.  **Required Permissions**  \"payment-management.payments.view\"
          * @summary Retrieve the payment
          * @param {string} code
          * @param {string} [authorization] Bearer Token
@@ -204,17 +204,20 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
             });
         },
         /**
-         * Returns a list of payments you have previously created.          The payments are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
+         * Returns a list of payments you have previously created.          The payments are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.  **Required Permissions**  \"payment-management.payments.view\"
          * @summary List payments
          * @param {string} [authorization] Bearer Token
+         * @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 {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: code, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug</i>
-         * @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: code, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug</i>
+         * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
          * @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: id, createdAt, code, amount</i>
          * @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: transactions<i>
+         * @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: code, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug</i>
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listPayments: function (authorization, filter, filters, order, expand, options) {
+        listPayments: 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;
@@ -237,11 +240,17 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
                             // authentication bearer required
                             // http bearer authentication required
                             _a.sent();
+                            if (pageSize !== undefined) {
+                                localVarQueryParameter['pageSize'] = pageSize;
+                            }
+                            if (pageToken !== undefined) {
+                                localVarQueryParameter['pageToken'] = pageToken;
+                            }
                             if (filter !== undefined) {
                                 localVarQueryParameter['filter'] = filter;
                             }
-                            if (filters !== undefined) {
-                                localVarQueryParameter['filters'] = filters;
+                            if (search !== undefined) {
+                                localVarQueryParameter['search'] = search;
                             }
                             if (order !== undefined) {
                                 localVarQueryParameter['order'] = order;
@@ -249,6 +258,9 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
                             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);
                             }
@@ -274,7 +286,7 @@ var PaymentsApiFp = function (configuration) {
     var localVarAxiosParamCreator = (0, exports.PaymentsApiAxiosParamCreator)(configuration);
     return {
         /**
-         * This will create a payment for a specified account. This function is idempotent.
+         * This will create a payment for a specified account. This function is idempotent.  **Required Permissions**  \"payment-management.payments.create\"
          * @summary Create the payment
          * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique.      Usually, a generated v4 UUID is enough.
          * @param {CreatePaymentRequestDto} createPaymentRequestDto
@@ -296,7 +308,7 @@ var PaymentsApiFp = function (configuration) {
             });
         },
         /**
-         * Retrieves the details of the payment that was previously created. Supply the unique payment code      that was returned when you created it and Emil Api will return the corresponding payment information.
+         * Retrieves the details of the payment that was previously created. Supply the unique payment code      that was returned when you created it and Emil Api will return the corresponding payment information.  **Required Permissions**  \"payment-management.payments.view\"
          * @summary Retrieve the payment
          * @param {string} code
          * @param {string} [authorization] Bearer Token
@@ -318,22 +330,25 @@ var PaymentsApiFp = function (configuration) {
             });
         },
         /**
-         * Returns a list of payments you have previously created.          The payments are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
+         * Returns a list of payments you have previously created.          The payments are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.  **Required Permissions**  \"payment-management.payments.view\"
          * @summary List payments
          * @param {string} [authorization] Bearer Token
+         * @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 {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: code, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug</i>
-         * @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: code, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug</i>
+         * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
          * @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: id, createdAt, code, amount</i>
          * @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: transactions<i>
+         * @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: code, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug</i>
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listPayments: function (authorization, filter, filters, order, expand, options) {
+        listPayments: 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.listPayments(authorization, filter, filters, order, expand, options)];
+                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.listPayments(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)];
@@ -352,7 +367,7 @@ var PaymentsApiFactory = function (configuration, basePath, axios) {
     var localVarFp = (0, exports.PaymentsApiFp)(configuration);
     return {
         /**
-         * This will create a payment for a specified account. This function is idempotent.
+         * This will create a payment for a specified account. This function is idempotent.  **Required Permissions**  \"payment-management.payments.create\"
          * @summary Create the payment
          * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique.      Usually, a generated v4 UUID is enough.
          * @param {CreatePaymentRequestDto} createPaymentRequestDto
@@ -364,7 +379,7 @@ var PaymentsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.createPayment(idempotencyKey, createPaymentRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
         },
         /**
-         * Retrieves the details of the payment that was previously created. Supply the unique payment code      that was returned when you created it and Emil Api will return the corresponding payment information.
+         * Retrieves the details of the payment that was previously created. Supply the unique payment code      that was returned when you created it and Emil Api will return the corresponding payment information.  **Required Permissions**  \"payment-management.payments.view\"
          * @summary Retrieve the payment
          * @param {string} code
          * @param {string} [authorization] Bearer Token
@@ -376,18 +391,21 @@ var PaymentsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.getPayment(code, authorization, expand, options).then(function (request) { return request(axios, basePath); });
         },
         /**
-         * Returns a list of payments you have previously created.          The payments are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
+         * Returns a list of payments you have previously created.          The payments are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.  **Required Permissions**  \"payment-management.payments.view\"
          * @summary List payments
          * @param {string} [authorization] Bearer Token
+         * @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 {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: code, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug</i>
-         * @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: code, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug</i>
+         * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
          * @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: id, createdAt, code, amount</i>
          * @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: transactions<i>
+         * @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: code, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug</i>
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listPayments: function (authorization, filter, filters, order, expand, options) {
-            return localVarFp.listPayments(authorization, filter, filters, order, expand, options).then(function (request) { return request(axios, basePath); });
+        listPayments: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
+            return localVarFp.listPayments(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
         },
     };
 };
@@ -404,7 +422,7 @@ var PaymentsApi = /** @class */ (function (_super) {
         return _super !== null && _super.apply(this, arguments) || this;
     }
     /**
-     * This will create a payment for a specified account. This function is idempotent.
+     * This will create a payment for a specified account. This function is idempotent.  **Required Permissions**  \"payment-management.payments.create\"
      * @summary Create the payment
      * @param {PaymentsApiCreatePaymentRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -416,7 +434,7 @@ var PaymentsApi = /** @class */ (function (_super) {
         return (0, exports.PaymentsApiFp)(this.configuration).createPayment(requestParameters.idempotencyKey, requestParameters.createPaymentRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     /**
-     * Retrieves the details of the payment that was previously created. Supply the unique payment code      that was returned when you created it and Emil Api will return the corresponding payment information.
+     * Retrieves the details of the payment that was previously created. Supply the unique payment code      that was returned when you created it and Emil Api will return the corresponding payment information.  **Required Permissions**  \"payment-management.payments.view\"
      * @summary Retrieve the payment
      * @param {PaymentsApiGetPaymentRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -428,7 +446,7 @@ var PaymentsApi = /** @class */ (function (_super) {
         return (0, exports.PaymentsApiFp)(this.configuration).getPayment(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     /**
-     * Returns a list of payments you have previously created.          The payments are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
+     * Returns a list of payments you have previously created.          The payments are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.  **Required Permissions**  \"payment-management.payments.view\"
      * @summary List payments
      * @param {PaymentsApiListPaymentsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -438,7 +456,7 @@ var PaymentsApi = /** @class */ (function (_super) {
     PaymentsApi.prototype.listPayments = function (requestParameters, options) {
         var _this = this;
         if (requestParameters === void 0) { requestParameters = {}; }
-        return (0, exports.PaymentsApiFp)(this.configuration).listPayments(requestParameters.authorization, requestParameters.filter, requestParameters.filters, requestParameters.order, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
+        return (0, exports.PaymentsApiFp)(this.configuration).listPayments(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); });
     };
     return PaymentsApi;
 }(base_1.BaseAPI));