@emilgroup/payment-sdk 1.4.1-beta.8 → 1.5.0

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

@@ -1,6 +1,6 @@
 /**
  * Emil Payment Service
- * This service directly communicates with the various Payment Service Providers (PSPs)    in order to charge or refund customers. This service will automatically connect to the PSP linked   in your admin configuration; meaning if you configured Stripe, it will automatically create a payment   on Stripe when you create it in Emil.
+ * This service directly communicates with the various Payment Service Providers (PSPs)   in order to charge or refund customers. This service will automatically connect to the PSP linked   in your admin configuration; meaning if you configured Stripe, it will automatically create a payment   on Stripe when you create it in Emil.
  *
  * The version of the OpenAPI document: 1.0
  * Contact: kontakt@emil.de
@@ -22,7 +22,8 @@ import { ListRefundsResponseClass } from '../models';
  */
 export declare const RefundsApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
-     *
+     * This will create a refund in the database.
+     * @summary Create the refund
      * @param {CreateRefundRequestDto} createRefundRequestDto
      * @param {string} [authorization] Bearer Token
      * @param {*} [options] Override http request option.
@@ -30,29 +31,28 @@ export declare const RefundsApiAxiosParamCreator: (configuration?: Configuration
      */
     createRefund: (createRefundRequestDto: CreateRefundRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *
+     * Retrieves the details of the refund that was previously created. Supply the unique refund code      that was returned when you created it and Emil Api will return the corresponding refund information.
+     * @summary Retrieve the refund
      * @param {string} code
-     * @param {string} code2 Unique identifier for the object.
-     * @param {string} expand Fields to expand response by
      * @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: refundItems&lt;i&gt;
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getRefund: (code: string, code2: string, expand: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    getRefund: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *
+     * Returns a list of refunds you have previously created.          The refunds are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
+     * @summary List refunds
      * @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 {any} [search] Search the list by any field. For instance, if you want to search by code     add code&#x3D;xxx in order 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} [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, status, reason, psp, accountCode, invoiceCode&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, status, reason, psp, accountCode, invoiceCode&lt;/i&gt;
+     * @param {string} [search] Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Searchable fields: id, createdAt, updatedAt, amount, psp, accountCode, invoiceCode, reason, status&lt;/i&gt;
+     * @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, updatedAt, 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: refundItems&lt;i&gt;
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listRefunds: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    listRefunds: (authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * RefundsApi - functional programming interface
@@ -60,7 +60,8 @@ export declare const RefundsApiAxiosParamCreator: (configuration?: Configuration
  */
 export declare const RefundsApiFp: (configuration?: Configuration) => {
     /**
-     *
+     * This will create a refund in the database.
+     * @summary Create the refund
      * @param {CreateRefundRequestDto} createRefundRequestDto
      * @param {string} [authorization] Bearer Token
      * @param {*} [options] Override http request option.
@@ -68,29 +69,28 @@ export declare const RefundsApiFp: (configuration?: Configuration) => {
      */
     createRefund(createRefundRequestDto: CreateRefundRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateRefundResponseClass>>;
     /**
-     *
+     * Retrieves the details of the refund that was previously created. Supply the unique refund code      that was returned when you created it and Emil Api will return the corresponding refund information.
+     * @summary Retrieve the refund
      * @param {string} code
-     * @param {string} code2 Unique identifier for the object.
-     * @param {string} expand Fields to expand response by
      * @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: refundItems&lt;i&gt;
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getRefund(code: string, code2: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetRefundResponseClass>>;
+    getRefund(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetRefundResponseClass>>;
     /**
-     *
+     * Returns a list of refunds you have previously created.          The refunds are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
+     * @summary List refunds
      * @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 {any} [search] Search the list by any field. For instance, if you want to search by code     add code&#x3D;xxx in order 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} [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, status, reason, psp, accountCode, invoiceCode&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, status, reason, psp, accountCode, invoiceCode&lt;/i&gt;
+     * @param {string} [search] Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Searchable fields: id, createdAt, updatedAt, amount, psp, accountCode, invoiceCode, reason, status&lt;/i&gt;
+     * @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, updatedAt, 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: refundItems&lt;i&gt;
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listRefunds(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListRefundsResponseClass>>;
+    listRefunds(authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListRefundsResponseClass>>;
 };
 /**
  * RefundsApi - factory interface
@@ -98,7 +98,8 @@ export declare const RefundsApiFp: (configuration?: Configuration) => {
  */
 export declare const RefundsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
-     *
+     * This will create a refund in the database.
+     * @summary Create the refund
      * @param {CreateRefundRequestDto} createRefundRequestDto
      * @param {string} [authorization] Bearer Token
      * @param {*} [options] Override http request option.
@@ -106,29 +107,28 @@ export declare const RefundsApiFactory: (configuration?: Configuration, basePath
      */
     createRefund(createRefundRequestDto: CreateRefundRequestDto, authorization?: string, options?: any): AxiosPromise<CreateRefundResponseClass>;
     /**
-     *
+     * Retrieves the details of the refund that was previously created. Supply the unique refund code      that was returned when you created it and Emil Api will return the corresponding refund information.
+     * @summary Retrieve the refund
      * @param {string} code
-     * @param {string} code2 Unique identifier for the object.
-     * @param {string} expand Fields to expand response by
      * @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: refundItems&lt;i&gt;
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getRefund(code: string, code2: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetRefundResponseClass>;
+    getRefund(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetRefundResponseClass>;
     /**
-     *
+     * Returns a list of refunds you have previously created.          The refunds are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
+     * @summary List refunds
      * @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 {any} [search] Search the list by any field. For instance, if you want to search by code     add code&#x3D;xxx in order 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} [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, status, reason, psp, accountCode, invoiceCode&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, status, reason, psp, accountCode, invoiceCode&lt;/i&gt;
+     * @param {string} [search] Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Searchable fields: id, createdAt, updatedAt, amount, psp, accountCode, invoiceCode, reason, status&lt;/i&gt;
+     * @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, updatedAt, 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: refundItems&lt;i&gt;
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listRefunds(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<ListRefundsResponseClass>;
+    listRefunds(authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListRefundsResponseClass>;
 };
 /**
  * Request parameters for createRefund operation in RefundsApi.
@@ -162,23 +162,17 @@ export interface RefundsApiGetRefundRequest {
      */
     readonly code: string;
     /**
-     * Unique identifier for the object.
-     * @type {string}
-     * @memberof RefundsApiGetRefund
-     */
-    readonly code2: string;
-    /**
-     * Fields to expand response by
+     * Bearer Token
      * @type {string}
      * @memberof RefundsApiGetRefund
      */
-    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: refundItems&lt;i&gt;
      * @type {string}
      * @memberof RefundsApiGetRefund
      */
-    readonly authorization?: string;
+    readonly expand?: string;
 }
 /**
  * Request parameters for listRefunds operation in RefundsApi.
@@ -193,47 +187,35 @@ export interface RefundsApiListRefundsRequest {
      */
     readonly authorization?: string;
     /**
-     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
-     * @type {any}
-     * @memberof RefundsApiListRefunds
-     */
-    readonly pageSize?: any;
-    /**
-     * 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 {any}
-     * @memberof RefundsApiListRefunds
-     */
-    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, status, reason, psp, accountCode, invoiceCode&lt;/i&gt;
+     * @type {string}
      * @memberof RefundsApiListRefunds
      */
-    readonly filter?: any;
+    readonly filter?: string;
     /**
-     * Search the list by any field. For instance, if you want to search by code     add code&#x3D;xxx in order to fetch the result.
-     * @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, status, reason, psp, accountCode, invoiceCode&lt;/i&gt;
+     * @type {string}
      * @memberof RefundsApiListRefunds
      */
-    readonly search?: any;
+    readonly filters?: 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 {any}
+     * Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Searchable fields: id, createdAt, updatedAt, amount, psp, accountCode, invoiceCode, reason, status&lt;/i&gt;
+     * @type {string}
      * @memberof RefundsApiListRefunds
      */
-    readonly order?: any;
+    readonly search?: 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}
+     * 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, updatedAt, amount&lt;/i&gt;
+     * @type {string}
      * @memberof RefundsApiListRefunds
      */
-    readonly expand?: any;
+    readonly order?: 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}
+     * 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: refundItems&lt;i&gt;
+     * @type {string}
      * @memberof RefundsApiListRefunds
      */
-    readonly filters?: any;
+    readonly expand?: string;
 }
 /**
  * RefundsApi - object-oriented interface
@@ -243,7 +225,8 @@ export interface RefundsApiListRefundsRequest {
  */
 export declare class RefundsApi extends BaseAPI {
     /**
-     *
+     * This will create a refund in the database.
+     * @summary Create the refund
      * @param {RefundsApiCreateRefundRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -251,7 +234,8 @@ export declare class RefundsApi extends BaseAPI {
      */
     createRefund(requestParameters: RefundsApiCreateRefundRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateRefundResponseClass, any>>;
     /**
-     *
+     * Retrieves the details of the refund that was previously created. Supply the unique refund code      that was returned when you created it and Emil Api will return the corresponding refund information.
+     * @summary Retrieve the refund
      * @param {RefundsApiGetRefundRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -259,7 +243,8 @@ export declare class RefundsApi extends BaseAPI {
      */
     getRefund(requestParameters: RefundsApiGetRefundRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetRefundResponseClass, any>>;
     /**
-     *
+     * Returns a list of refunds you have previously created.          The refunds are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
+     * @summary List refunds
      * @param {RefundsApiListRefundsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}