@emilgroup/payment-sdk 1.4.1-beta.4 → 1.4.1-beta.40

package/api/refunds-api.ts

@@ -0,0 +1,436 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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.
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { Configuration } from '../configuration';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
+// @ts-ignore
+import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
+// @ts-ignore
+import { CreateRefundRequestDto } from '../models';
+/**
+ * RefundsApi - axios parameter creator
+ * @export
+ */
+export const RefundsApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * 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.
+         * @throws {RequiredError}
+         */
+        createRefund: async (createRefundRequestDto: CreateRefundRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'createRefundRequestDto' is not null or undefined
+            assertParamExists('createRefund', 'createRefundRequestDto', createRefundRequestDto)
+            const localVarPath = `/paymentservice/v1/refunds`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            let baseAccessToken;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+                baseAccessToken = configuration.accessToken;
+            }
+
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication bearer required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
+                localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
+            }
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(createRefundRequestDto, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 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} [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: async (code: string, authorization?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'code' is not null or undefined
+            assertParamExists('getRefund', 'code', code)
+            const localVarPath = `/paymentservice/v1/refunds/{code}`
+                .replace(`{${"code"}}`, encodeURIComponent(String(code)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            let baseAccessToken;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+                baseAccessToken = configuration.accessToken;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication bearer required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (expand !== undefined) {
+                localVarQueryParameter['expand'] = expand;
+            }
+
+            if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
+                localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 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 {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: async (authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/paymentservice/v1/refunds`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            let baseAccessToken;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+                baseAccessToken = configuration.accessToken;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication bearer required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (filter !== undefined) {
+                localVarQueryParameter['filter'] = filter;
+            }
+
+            if (filters !== undefined) {
+                localVarQueryParameter['filters'] = filters;
+            }
+
+            if (search !== undefined) {
+                localVarQueryParameter['search'] = search;
+            }
+
+            if (order !== undefined) {
+                localVarQueryParameter['order'] = order;
+            }
+
+            if (expand !== undefined) {
+                localVarQueryParameter['expand'] = expand;
+            }
+
+            if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
+                localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * RefundsApi - functional programming interface
+ * @export
+ */
+export const RefundsApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = RefundsApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * 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.
+         * @throws {RequiredError}
+         */
+        async createRefund(createRefundRequestDto: CreateRefundRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.createRefund(createRefundRequestDto, authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+        /**
+         * 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} [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}
+         */
+        async getRefund(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getRefund(code, authorization, expand, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+        /**
+         * 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 {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}
+         */
+        async listRefunds(authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listRefunds(authorization, filter, filters, search, order, expand, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+    }
+};
+
+/**
+ * RefundsApi - factory interface
+ * @export
+ */
+export const RefundsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = RefundsApiFp(configuration)
+    return {
+        /**
+         * 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.
+         * @throws {RequiredError}
+         */
+        createRefund(createRefundRequestDto: CreateRefundRequestDto, authorization?: string, options?: any): AxiosPromise<void> {
+            return localVarFp.createRefund(createRefundRequestDto, authorization, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * 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} [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, authorization?: string, expand?: string, options?: any): AxiosPromise<void> {
+            return localVarFp.getRefund(code, authorization, expand, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * 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 {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, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<void> {
+            return localVarFp.listRefunds(authorization, filter, filters, search, order, expand, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * Request parameters for createRefund operation in RefundsApi.
+ * @export
+ * @interface RefundsApiCreateRefundRequest
+ */
+export interface RefundsApiCreateRefundRequest {
+    /**
+     * 
+     * @type {CreateRefundRequestDto}
+     * @memberof RefundsApiCreateRefund
+     */
+    readonly createRefundRequestDto: CreateRefundRequestDto
+
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof RefundsApiCreateRefund
+     */
+    readonly authorization?: string
+}
+
+/**
+ * Request parameters for getRefund operation in RefundsApi.
+ * @export
+ * @interface RefundsApiGetRefundRequest
+ */
+export interface RefundsApiGetRefundRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof RefundsApiGetRefund
+     */
+    readonly code: string
+
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof RefundsApiGetRefund
+     */
+    readonly authorization?: string
+
+    /**
+     * 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 expand?: string
+}
+
+/**
+ * Request parameters for listRefunds operation in RefundsApi.
+ * @export
+ * @interface RefundsApiListRefundsRequest
+ */
+export interface RefundsApiListRefundsRequest {
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof RefundsApiListRefunds
+     */
+    readonly authorization?: 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, status, reason, psp, accountCode, invoiceCode&lt;/i&gt;
+     * @type {string}
+     * @memberof RefundsApiListRefunds
+     */
+    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, status, reason, psp, accountCode, invoiceCode&lt;/i&gt;
+     * @type {string}
+     * @memberof RefundsApiListRefunds
+     */
+    readonly filters?: string
+
+    /**
+     * 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 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, updatedAt, amount&lt;/i&gt;
+     * @type {string}
+     * @memberof RefundsApiListRefunds
+     */
+    readonly order?: string
+
+    /**
+     * 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 expand?: string
+}
+
+/**
+ * RefundsApi - object-oriented interface
+ * @export
+ * @class RefundsApi
+ * @extends {BaseAPI}
+ */
+export 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}
+     * @memberof RefundsApi
+     */
+    public createRefund(requestParameters: RefundsApiCreateRefundRequest, options?: AxiosRequestConfig) {
+        return RefundsApiFp(this.configuration).createRefund(requestParameters.createRefundRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * 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}
+     * @memberof RefundsApi
+     */
+    public getRefund(requestParameters: RefundsApiGetRefundRequest, options?: AxiosRequestConfig) {
+        return RefundsApiFp(this.configuration).getRefund(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * 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}
+     * @memberof RefundsApi
+     */
+    public listRefunds(requestParameters: RefundsApiListRefundsRequest = {}, options?: AxiosRequestConfig) {
+        return RefundsApiFp(this.configuration).listRefunds(requestParameters.authorization, requestParameters.filter, requestParameters.filters, requestParameters.search, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
+    }
+}