@emilgroup/payment-sdk-node 1.23.0 → 1.23.1-beta.10

package/dist/api/payment-requests-api.d.ts

@@ -0,0 +1,393 @@
+/**
+ * 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 { CreatePaymentRequestRequestDto } from '../models';
+import { CreatePaymentRequestResponseClass } from '../models';
+import { GetPaymentRequestResponseClass } from '../models';
+import { ListPaymentRequestsResponseClass } from '../models';
+import { UpdatePaymentRequestRequestDto } from '../models';
+import { UpdatePaymentRequestResponseClass } from '../models';
+/**
+ * PaymentRequestsApi - axios parameter creator
+ * @export
+ */
+export declare const PaymentRequestsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * This will create payment request.  **Required Permissions**  \"payment-management.payments.create\"
+     * @summary Create the payment request
+     * @param {CreatePaymentRequestRequestDto} createPaymentRequestRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPaymentRequest: (createPaymentRequestRequestDto: CreatePaymentRequestRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * This will delete payment request.  **Required Permissions**  \"payment-management.payments.delete\"
+     * @summary Delete the payment request
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deletePaymentRequest: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * This will get payment request.  **Required Permissions**  \"payment-management.payments.view\"
+     * @summary Retrieve the payment request
+     * @param {string} code Unique identifier for the object.
+     * @param {string} expand
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPaymentRequest: (code: string, expand: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves a list of paymentrequests.  **Required Permissions**  \"payment-management.payments.view\"
+     * @summary List payment requests
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @param {string} [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 {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: id, code, type, status, direction, paymentMethodPsp, paymentMethodType, createdAt&lt;/i&gt;
+     * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @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: createdAt&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;
+     * @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: id, code, type, status, direction, paymentMethodPsp, paymentMethodType, createdAt&lt;/i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPaymentRequests: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * This will update payment request.  **Required Permissions**  \"payment-management.payments.update\"
+     * @summary Update the payment request
+     * @param {string} code Unique identifier for the object.
+     * @param {UpdatePaymentRequestRequestDto} updatePaymentRequestRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updatePaymentRequest: (code: string, updatePaymentRequestRequestDto: UpdatePaymentRequestRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * PaymentRequestsApi - functional programming interface
+ * @export
+ */
+export declare const PaymentRequestsApiFp: (configuration?: Configuration) => {
+    /**
+     * This will create payment request.  **Required Permissions**  \"payment-management.payments.create\"
+     * @summary Create the payment request
+     * @param {CreatePaymentRequestRequestDto} createPaymentRequestRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPaymentRequest(createPaymentRequestRequestDto: CreatePaymentRequestRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePaymentRequestResponseClass>>;
+    /**
+     * This will delete payment request.  **Required Permissions**  \"payment-management.payments.delete\"
+     * @summary Delete the payment request
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deletePaymentRequest(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
+    /**
+     * This will get payment request.  **Required Permissions**  \"payment-management.payments.view\"
+     * @summary Retrieve the payment request
+     * @param {string} code Unique identifier for the object.
+     * @param {string} expand
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPaymentRequest(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPaymentRequestResponseClass>>;
+    /**
+     * Retrieves a list of paymentrequests.  **Required Permissions**  \"payment-management.payments.view\"
+     * @summary List payment requests
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @param {string} [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 {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: id, code, type, status, direction, paymentMethodPsp, paymentMethodType, createdAt&lt;/i&gt;
+     * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @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: createdAt&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;
+     * @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: id, code, type, status, direction, paymentMethodPsp, paymentMethodType, createdAt&lt;/i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPaymentRequests(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPaymentRequestsResponseClass>>;
+    /**
+     * This will update payment request.  **Required Permissions**  \"payment-management.payments.update\"
+     * @summary Update the payment request
+     * @param {string} code Unique identifier for the object.
+     * @param {UpdatePaymentRequestRequestDto} updatePaymentRequestRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updatePaymentRequest(code: string, updatePaymentRequestRequestDto: UpdatePaymentRequestRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdatePaymentRequestResponseClass>>;
+};
+/**
+ * PaymentRequestsApi - factory interface
+ * @export
+ */
+export declare const PaymentRequestsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * This will create payment request.  **Required Permissions**  \"payment-management.payments.create\"
+     * @summary Create the payment request
+     * @param {CreatePaymentRequestRequestDto} createPaymentRequestRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPaymentRequest(createPaymentRequestRequestDto: CreatePaymentRequestRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePaymentRequestResponseClass>;
+    /**
+     * This will delete payment request.  **Required Permissions**  \"payment-management.payments.delete\"
+     * @summary Delete the payment request
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deletePaymentRequest(code: string, authorization?: string, options?: any): AxiosPromise<object>;
+    /**
+     * This will get payment request.  **Required Permissions**  \"payment-management.payments.view\"
+     * @summary Retrieve the payment request
+     * @param {string} code Unique identifier for the object.
+     * @param {string} expand
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPaymentRequest(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetPaymentRequestResponseClass>;
+    /**
+     * Retrieves a list of paymentrequests.  **Required Permissions**  \"payment-management.payments.view\"
+     * @summary List payment requests
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @param {string} [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 {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: id, code, type, status, direction, paymentMethodPsp, paymentMethodType, createdAt&lt;/i&gt;
+     * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @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: createdAt&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;
+     * @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: id, code, type, status, direction, paymentMethodPsp, paymentMethodType, createdAt&lt;/i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPaymentRequests(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPaymentRequestsResponseClass>;
+    /**
+     * This will update payment request.  **Required Permissions**  \"payment-management.payments.update\"
+     * @summary Update the payment request
+     * @param {string} code Unique identifier for the object.
+     * @param {UpdatePaymentRequestRequestDto} updatePaymentRequestRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updatePaymentRequest(code: string, updatePaymentRequestRequestDto: UpdatePaymentRequestRequestDto, authorization?: string, options?: any): AxiosPromise<UpdatePaymentRequestResponseClass>;
+};
+/**
+ * Request parameters for createPaymentRequest operation in PaymentRequestsApi.
+ * @export
+ * @interface PaymentRequestsApiCreatePaymentRequestRequest
+ */
+export interface PaymentRequestsApiCreatePaymentRequestRequest {
+    /**
+     *
+     * @type {CreatePaymentRequestRequestDto}
+     * @memberof PaymentRequestsApiCreatePaymentRequest
+     */
+    readonly createPaymentRequestRequestDto: CreatePaymentRequestRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PaymentRequestsApiCreatePaymentRequest
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for deletePaymentRequest operation in PaymentRequestsApi.
+ * @export
+ * @interface PaymentRequestsApiDeletePaymentRequestRequest
+ */
+export interface PaymentRequestsApiDeletePaymentRequestRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof PaymentRequestsApiDeletePaymentRequest
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PaymentRequestsApiDeletePaymentRequest
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getPaymentRequest operation in PaymentRequestsApi.
+ * @export
+ * @interface PaymentRequestsApiGetPaymentRequestRequest
+ */
+export interface PaymentRequestsApiGetPaymentRequestRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof PaymentRequestsApiGetPaymentRequest
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PaymentRequestsApiGetPaymentRequest
+     */
+    readonly expand: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PaymentRequestsApiGetPaymentRequest
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for listPaymentRequests operation in PaymentRequestsApi.
+ * @export
+ * @interface PaymentRequestsApiListPaymentRequestsRequest
+ */
+export interface PaymentRequestsApiListPaymentRequestsRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PaymentRequestsApiListPaymentRequests
+     */
+    readonly authorization?: string;
+    /**
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @type {number}
+     * @memberof PaymentRequestsApiListPaymentRequests
+     */
+    readonly pageSize?: number;
+    /**
+     * 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 {string}
+     * @memberof PaymentRequestsApiListPaymentRequests
+     */
+    readonly pageToken?: 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: id, code, type, status, direction, paymentMethodPsp, paymentMethodType, createdAt&lt;/i&gt;
+     * @type {string}
+     * @memberof PaymentRequestsApiListPaymentRequests
+     */
+    readonly filter?: string;
+    /**
+     * To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @type {string}
+     * @memberof PaymentRequestsApiListPaymentRequests
+     */
+    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: createdAt&lt;/i&gt;
+     * @type {string}
+     * @memberof PaymentRequestsApiListPaymentRequests
+     */
+    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;
+     * @type {string}
+     * @memberof PaymentRequestsApiListPaymentRequests
+     */
+    readonly expand?: 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: id, code, type, status, direction, paymentMethodPsp, paymentMethodType, createdAt&lt;/i&gt;
+     * @type {string}
+     * @memberof PaymentRequestsApiListPaymentRequests
+     */
+    readonly filters?: string;
+}
+/**
+ * Request parameters for updatePaymentRequest operation in PaymentRequestsApi.
+ * @export
+ * @interface PaymentRequestsApiUpdatePaymentRequestRequest
+ */
+export interface PaymentRequestsApiUpdatePaymentRequestRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof PaymentRequestsApiUpdatePaymentRequest
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {UpdatePaymentRequestRequestDto}
+     * @memberof PaymentRequestsApiUpdatePaymentRequest
+     */
+    readonly updatePaymentRequestRequestDto: UpdatePaymentRequestRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PaymentRequestsApiUpdatePaymentRequest
+     */
+    readonly authorization?: string;
+}
+/**
+ * PaymentRequestsApi - object-oriented interface
+ * @export
+ * @class PaymentRequestsApi
+ * @extends {BaseAPI}
+ */
+export declare class PaymentRequestsApi extends BaseAPI {
+    /**
+     * This will create payment request.  **Required Permissions**  \"payment-management.payments.create\"
+     * @summary Create the payment request
+     * @param {PaymentRequestsApiCreatePaymentRequestRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PaymentRequestsApi
+     */
+    createPaymentRequest(requestParameters: PaymentRequestsApiCreatePaymentRequestRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePaymentRequestResponseClass, any, {}>>;
+    /**
+     * This will delete payment request.  **Required Permissions**  \"payment-management.payments.delete\"
+     * @summary Delete the payment request
+     * @param {PaymentRequestsApiDeletePaymentRequestRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PaymentRequestsApi
+     */
+    deletePaymentRequest(requestParameters: PaymentRequestsApiDeletePaymentRequestRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>;
+    /**
+     * This will get payment request.  **Required Permissions**  \"payment-management.payments.view\"
+     * @summary Retrieve the payment request
+     * @param {PaymentRequestsApiGetPaymentRequestRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PaymentRequestsApi
+     */
+    getPaymentRequest(requestParameters: PaymentRequestsApiGetPaymentRequestRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPaymentRequestResponseClass, any, {}>>;
+    /**
+     * Retrieves a list of paymentrequests.  **Required Permissions**  \"payment-management.payments.view\"
+     * @summary List payment requests
+     * @param {PaymentRequestsApiListPaymentRequestsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PaymentRequestsApi
+     */
+    listPaymentRequests(requestParameters?: PaymentRequestsApiListPaymentRequestsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPaymentRequestsResponseClass, any, {}>>;
+    /**
+     * This will update payment request.  **Required Permissions**  \"payment-management.payments.update\"
+     * @summary Update the payment request
+     * @param {PaymentRequestsApiUpdatePaymentRequestRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PaymentRequestsApi
+     */
+    updatePaymentRequest(requestParameters: PaymentRequestsApiUpdatePaymentRequestRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdatePaymentRequestResponseClass, any, {}>>;
+}