@emilgroup/payment-sdk 1.4.1-beta.30 → 1.4.1-beta.31

package/api/payments-api.ts

@@ -29,7 +29,7 @@ import { CreatePaymentRequestDto } from '../models';
 export const PaymentsApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
         /**
-         * Creates a payment for a specified account. This function is idempotent.
+         * This will create a payment for a specified account. This function is idempotent.
          * @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 
@@ -85,20 +85,15 @@ export const PaymentsApiAxiosParamCreator = function (configuration?: Configurat
         /**
          * 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.
          * @summary Retrieve the payment
-         * @param {string} code 
-         * @param {string} code2 Unique identifier for the object.
-         * @param {string} expand Fields to expand response by
+         * @param {string} code Unique identifier for the object.
          * @param {string} [authorization] Bearer Token
+         * @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 {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getPayment: async (code: string, code2: string, expand: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+        getPayment: async (code: string, authorization?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'code' is not null or undefined
             assertParamExists('getPayment', 'code', code)
-            // verify required parameter 'code2' is not null or undefined
-            assertParamExists('getPayment', 'code2', code2)
-            // verify required parameter 'expand' is not null or undefined
-            assertParamExists('getPayment', 'expand', expand)
             const localVarPath = `/paymentservice/v1/payments/{code}`
                 .replace(`{${"code"}}`, encodeURIComponent(String(code)));
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -118,10 +113,6 @@ export const PaymentsApiAxiosParamCreator = function (configuration?: Configurat
             // http bearer authentication required
             await setBearerAuthToObject(localVarHeaderParameter, configuration)
 
-            if (code2 !== undefined) {
-                localVarQueryParameter['code'] = code2;
-            }
-
             if (expand !== undefined) {
                 localVarQueryParameter['expand'] = expand;
             }
@@ -142,20 +133,20 @@ export const PaymentsApiAxiosParamCreator = function (configuration?: Configurat
             };
         },
         /**
-         * 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.
          * @summary List payments
          * @param {string} [authorization] Bearer Token
          * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
          * @param {any} [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 {any} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+         * @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&lt;/i&gt;
          * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
-         * @param {any} [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 {any} [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 {any} [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 {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&lt;/i&gt;
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listPayments: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+        listPayments: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
             const localVarPath = `/paymentservice/v1/payments`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -228,7 +219,7 @@ export const PaymentsApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = PaymentsApiAxiosParamCreator(configuration)
     return {
         /**
-         * Creates a payment for a specified account. This function is idempotent.
+         * This will create a payment for a specified account. This function is idempotent.
          * @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 
@@ -243,32 +234,31 @@ export const PaymentsApiFp = function(configuration?: 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.
          * @summary Retrieve the payment
-         * @param {string} code 
-         * @param {string} code2 Unique identifier for the object.
-         * @param {string} expand Fields to expand response by
+         * @param {string} code Unique identifier for the object.
          * @param {string} [authorization] Bearer Token
+         * @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 {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async getPayment(code: string, code2: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.getPayment(code, code2, expand, authorization, options);
+        async getPayment(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getPayment(code, authorization, expand, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, 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.
          * @summary List payments
          * @param {string} [authorization] Bearer Token
          * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
          * @param {any} [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 {any} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+         * @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&lt;/i&gt;
          * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
-         * @param {any} [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 {any} [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 {any} [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 {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&lt;/i&gt;
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async listPayments(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
+        async listPayments(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
             const localVarAxiosArgs = await localVarAxiosParamCreator.listPayments(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
@@ -283,7 +273,7 @@ export const PaymentsApiFactory = function (configuration?: Configuration, baseP
     const localVarFp = PaymentsApiFp(configuration)
     return {
         /**
-         * Creates a payment for a specified account. This function is idempotent.
+         * This will create a payment for a specified account. This function is idempotent.
          * @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 
@@ -297,31 +287,30 @@ export const PaymentsApiFactory = function (configuration?: Configuration, baseP
         /**
          * 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.
          * @summary Retrieve the payment
-         * @param {string} code 
-         * @param {string} code2 Unique identifier for the object.
-         * @param {string} expand Fields to expand response by
+         * @param {string} code Unique identifier for the object.
          * @param {string} [authorization] Bearer Token
+         * @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 {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getPayment(code: string, code2: string, expand: string, authorization?: string, options?: any): AxiosPromise<void> {
-            return localVarFp.getPayment(code, code2, expand, authorization, options).then((request) => request(axios, basePath));
+        getPayment(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<void> {
+            return localVarFp.getPayment(code, authorization, expand, options).then((request) => 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.
          * @summary List payments
          * @param {string} [authorization] Bearer Token
          * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
          * @param {any} [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 {any} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+         * @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&lt;/i&gt;
          * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
-         * @param {any} [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 {any} [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 {any} [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 {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&lt;/i&gt;
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listPayments(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<void> {
+        listPayments(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<void> {
             return localVarFp.listPayments(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
         },
     };
@@ -361,33 +350,26 @@ export interface PaymentsApiCreatePaymentRequest {
  * @interface PaymentsApiGetPaymentRequest
  */
 export interface PaymentsApiGetPaymentRequest {
-    /**
-     * 
-     * @type {string}
-     * @memberof PaymentsApiGetPayment
-     */
-    readonly code: string
-
     /**
      * Unique identifier for the object.
      * @type {string}
      * @memberof PaymentsApiGetPayment
      */
-    readonly code2: string
+    readonly code: string
 
     /**
-     * Fields to expand response by
+     * Bearer Token
      * @type {string}
      * @memberof PaymentsApiGetPayment
      */
-    readonly expand: string
+    readonly authorization?: string
 
     /**
-     * Bearer Token
+     * 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;
      * @type {string}
      * @memberof PaymentsApiGetPayment
      */
-    readonly authorization?: string
+    readonly expand?: string
 }
 
 /**
@@ -418,11 +400,11 @@ export interface PaymentsApiListPaymentsRequest {
     readonly pageToken?: any
 
     /**
-     * Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
-     * @type {any}
+     * 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&lt;/i&gt;
+     * @type {string}
      * @memberof PaymentsApiListPayments
      */
-    readonly filter?: any
+    readonly filter?: string
 
     /**
      * To search the list by any field, pass search&#x3D;xxx to fetch the result.
@@ -432,25 +414,25 @@ export interface PaymentsApiListPaymentsRequest {
     readonly search?: any
 
     /**
-     * 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 {any}
+     * 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}
      * @memberof PaymentsApiListPayments
      */
-    readonly order?: any
+    readonly order?: string
 
     /**
-     * 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 {any}
+     * 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;
+     * @type {string}
      * @memberof PaymentsApiListPayments
      */
-    readonly expand?: any
+    readonly expand?: string
 
     /**
-     * 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 {any}
+     * 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&lt;/i&gt;
+     * @type {string}
      * @memberof PaymentsApiListPayments
      */
-    readonly filters?: any
+    readonly filters?: string
 }
 
 /**
@@ -461,7 +443,7 @@ export interface PaymentsApiListPaymentsRequest {
  */
 export class PaymentsApi extends BaseAPI {
     /**
-     * Creates a payment for a specified account. This function is idempotent.
+     * This will create a payment for a specified account. This function is idempotent.
      * @summary Create the payment
      * @param {PaymentsApiCreatePaymentRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -481,11 +463,11 @@ export class PaymentsApi extends BaseAPI {
      * @memberof PaymentsApi
      */
     public getPayment(requestParameters: PaymentsApiGetPaymentRequest, options?: AxiosRequestConfig) {
-        return PaymentsApiFp(this.configuration).getPayment(requestParameters.code, requestParameters.code2, requestParameters.expand, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+        return PaymentsApiFp(this.configuration).getPayment(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then((request) => 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.
      * @summary List payments
      * @param {PaymentsApiListPaymentsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.