@emilgroup/payment-sdk 1.0.0

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

@@ -0,0 +1,281 @@
+/**
+ * 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 { CreatePaymentRequestDto } from '../models';
+import { CreatePaymentResponseClass } from '../models';
+import { GetPaymentResponseClass } from '../models';
+import { ListPaymentsResponseClass } from '../models';
+/**
+ * PaymentsApi - axios parameter creator
+ * @export
+ */
+export declare const PaymentsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Creates a payment for a specified account. This function is idempotent.
+     * @summary Create a 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
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPayment: (idempotencyKey: string, createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves the details of a payment that was previously created. Supply the unique payment      code that was returned when you created the payment and Emil Api will return the corresponding payment      information.
+     * @summary Retrieve a payment
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token
+     * @param {string} [expand] Fields to expand response by
+     * @param {string} [expand2] Fields to expand response by
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPayment: (code: string, authorization?: string, expand?: string, expand2?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns a list of payments you’ve previously created. The payments are returned in sorted order,        with the oldest payment 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 100. 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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPayments: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * PaymentsApi - functional programming interface
+ * @export
+ */
+export declare const PaymentsApiFp: (configuration?: Configuration) => {
+    /**
+     * Creates a payment for a specified account. This function is idempotent.
+     * @summary Create a 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
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPayment(idempotencyKey: string, createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePaymentResponseClass>>;
+    /**
+     * Retrieves the details of a payment that was previously created. Supply the unique payment      code that was returned when you created the payment and Emil Api will return the corresponding payment      information.
+     * @summary Retrieve a payment
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token
+     * @param {string} [expand] Fields to expand response by
+     * @param {string} [expand2] Fields to expand response by
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPayment(code: string, authorization?: string, expand?: string, expand2?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPaymentResponseClass>>;
+    /**
+     * Returns a list of payments you’ve previously created. The payments are returned in sorted order,        with the oldest payment 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 100. 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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPayments(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPaymentsResponseClass>>;
+};
+/**
+ * PaymentsApi - factory interface
+ * @export
+ */
+export declare const PaymentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Creates a payment for a specified account. This function is idempotent.
+     * @summary Create a 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
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPayment(idempotencyKey: string, createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePaymentResponseClass>;
+    /**
+     * Retrieves the details of a payment that was previously created. Supply the unique payment      code that was returned when you created the payment and Emil Api will return the corresponding payment      information.
+     * @summary Retrieve a payment
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token
+     * @param {string} [expand] Fields to expand response by
+     * @param {string} [expand2] Fields to expand response by
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPayment(code: string, authorization?: string, expand?: string, expand2?: string, options?: any): AxiosPromise<GetPaymentResponseClass>;
+    /**
+     * Returns a list of payments you’ve previously created. The payments are returned in sorted order,        with the oldest payment 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 100. 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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPayments(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListPaymentsResponseClass>;
+};
+/**
+ * Request parameters for createPayment operation in PaymentsApi.
+ * @export
+ * @interface PaymentsApiCreatePaymentRequest
+ */
+export interface PaymentsApiCreatePaymentRequest {
+    /**
+     * Idempotency Key used to make the request idempotent. The key should be unique.      Usually, a generated v4 UUID is enough.
+     * @type {string}
+     * @memberof PaymentsApiCreatePayment
+     */
+    readonly idempotencyKey: string;
+    /**
+     *
+     * @type {CreatePaymentRequestDto}
+     * @memberof PaymentsApiCreatePayment
+     */
+    readonly createPaymentRequestDto: CreatePaymentRequestDto;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof PaymentsApiCreatePayment
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getPayment operation in PaymentsApi.
+ * @export
+ * @interface PaymentsApiGetPaymentRequest
+ */
+export interface PaymentsApiGetPaymentRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof PaymentsApiGetPayment
+     */
+    readonly code: string;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof PaymentsApiGetPayment
+     */
+    readonly authorization?: string;
+    /**
+     * Fields to expand response by
+     * @type {string}
+     * @memberof PaymentsApiGetPayment
+     */
+    readonly expand?: string;
+    /**
+     * Fields to expand response by
+     * @type {string}
+     * @memberof PaymentsApiGetPayment
+     */
+    readonly expand2?: string;
+}
+/**
+ * Request parameters for listPayments operation in PaymentsApi.
+ * @export
+ * @interface PaymentsApiListPaymentsRequest
+ */
+export interface PaymentsApiListPaymentsRequest {
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof PaymentsApiListPayments
+     */
+    readonly authorization?: string;
+    /**
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 100. Default: 10.
+     * @type {any}
+     * @memberof PaymentsApiListPayments
+     */
+    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 PaymentsApiListPayments
+     */
+    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 PaymentsApiListPayments
+     */
+    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 PaymentsApiListPayments
+     */
+    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 PaymentsApiListPayments
+     */
+    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 PaymentsApiListPayments
+     */
+    readonly expand?: any;
+}
+/**
+ * PaymentsApi - object-oriented interface
+ * @export
+ * @class PaymentsApi
+ * @extends {BaseAPI}
+ */
+export declare class PaymentsApi extends BaseAPI {
+    /**
+     * Creates a payment for a specified account. This function is idempotent.
+     * @summary Create a payment
+     * @param {PaymentsApiCreatePaymentRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PaymentsApi
+     */
+    createPayment(requestParameters: PaymentsApiCreatePaymentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePaymentResponseClass, any>>;
+    /**
+     * Retrieves the details of a payment that was previously created. Supply the unique payment      code that was returned when you created the payment and Emil Api will return the corresponding payment      information.
+     * @summary Retrieve a payment
+     * @param {PaymentsApiGetPaymentRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PaymentsApi
+     */
+    getPayment(requestParameters: PaymentsApiGetPaymentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPaymentResponseClass, any>>;
+    /**
+     * Returns a list of payments you’ve previously created. The payments are returned in sorted order,        with the oldest payment 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.
+     * @throws {RequiredError}
+     * @memberof PaymentsApi
+     */
+    listPayments(requestParameters?: PaymentsApiListPaymentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPaymentsResponseClass, any>>;
+}