@emilgroup/payment-sdk 1.4.1-beta.5 → 1.4.1-beta.7

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

@@ -0,0 +1,269 @@
+/**
+ * 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 { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { Configuration } from '../configuration';
+import { RequestArgs, BaseAPI } from '../base';
+import { CreateRefundRequestDto } from '../models';
+import { CreateRefundResponseClass } from '../models';
+import { GetRefundResponseClass } from '../models';
+import { ListRefundsResponseClass } from '../models';
+/**
+ * RefundsApi - axios parameter creator
+ * @export
+ */
+export declare const RefundsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @param {CreateRefundRequestDto} createRefundRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createRefund: (createRefundRequestDto: CreateRefundRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {string} code
+     * @param {string} code2 Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token
+     * @param {string} [expand] Fields to expand response by
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getRefund: (code: string, code2: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @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 {*} [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>;
+};
+/**
+ * RefundsApi - functional programming interface
+ * @export
+ */
+export declare const RefundsApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @param {CreateRefundRequestDto} createRefundRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createRefund(createRefundRequestDto: CreateRefundRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateRefundResponseClass>>;
+    /**
+     *
+     * @param {string} code
+     * @param {string} code2 Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token
+     * @param {string} [expand] Fields to expand response by
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getRefund(code: string, code2: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetRefundResponseClass>>;
+    /**
+     *
+     * @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 {*} [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>>;
+};
+/**
+ * RefundsApi - factory interface
+ * @export
+ */
+export declare const RefundsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @param {CreateRefundRequestDto} createRefundRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createRefund(createRefundRequestDto: CreateRefundRequestDto, authorization?: string, options?: any): AxiosPromise<CreateRefundResponseClass>;
+    /**
+     *
+     * @param {string} code
+     * @param {string} code2 Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token
+     * @param {string} [expand] Fields to expand response by
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getRefund(code: string, code2: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetRefundResponseClass>;
+    /**
+     *
+     * @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 {*} [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>;
+};
+/**
+ * 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;
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof RefundsApiGetRefund
+     */
+    readonly code2: string;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof RefundsApiGetRefund
+     */
+    readonly authorization?: string;
+    /**
+     * Fields to expand response by
+     * @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;
+    /**
+     * 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}
+     * @memberof RefundsApiListRefunds
+     */
+    readonly filter?: any;
+    /**
+     * 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}
+     * @memberof RefundsApiListRefunds
+     */
+    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}
+     * @memberof RefundsApiListRefunds
+     */
+    readonly order?: any;
+    /**
+     * 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}
+     * @memberof RefundsApiListRefunds
+     */
+    readonly expand?: any;
+    /**
+     * 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}
+     * @memberof RefundsApiListRefunds
+     */
+    readonly filters?: any;
+}
+/**
+ * RefundsApi - object-oriented interface
+ * @export
+ * @class RefundsApi
+ * @extends {BaseAPI}
+ */
+export declare class RefundsApi extends BaseAPI {
+    /**
+     *
+     * @param {RefundsApiCreateRefundRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RefundsApi
+     */
+    createRefund(requestParameters: RefundsApiCreateRefundRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateRefundResponseClass, any>>;
+    /**
+     *
+     * @param {RefundsApiGetRefundRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RefundsApi
+     */
+    getRefund(requestParameters: RefundsApiGetRefundRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetRefundResponseClass, any>>;
+    /**
+     *
+     * @param {RefundsApiListRefundsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RefundsApi
+     */
+    listRefunds(requestParameters?: RefundsApiListRefundsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListRefundsResponseClass, any>>;
+}