@emilgroup/billing-sdk-node 1.1.0 → 1.4.0

package/api/payments-setup-api.ts

@@ -0,0 +1,408 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Emil PublicAPI
+ * The Emil Public API description
+ *
+ * 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 { CompletePaymentSetupRequestDto } from '../models';
+// @ts-ignore
+import { CompletePaymentSetupResponseClass } from '../models';
+// @ts-ignore
+import { GetPublicPspSettingsResponseClass } from '../models';
+// @ts-ignore
+import { InitiatePaymentSetupRequestDto } from '../models';
+// @ts-ignore
+import { InitiatePaymentSetupResponseClass } from '../models';
+// URLSearchParams not necessarily used
+// @ts-ignore
+import { URL, URLSearchParams } from 'url';
+const FormData = require('form-data');
+/**
+ * PaymentsSetupApi - axios parameter creator
+ * @export
+ */
+export const PaymentsSetupApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * This will send the customer payment info from stripe or paypal to the backend.
+         * @summary Complete a payment setup
+         * @param {CompletePaymentSetupRequestDto} completePaymentSetupRequestDto 
+         * @param {string} [idempotencyKey] An idempotency key is a unique value generated by the client which the server uses to recognize subsequent retries of the same request. How you create unique keys is up to you, but we suggest using V4 UUIDs, or another random string with enough entropy to avoid collisions. Idempotency keys can be up to 255 characters long.
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        completePaymentSetup: async (completePaymentSetupRequestDto: CompletePaymentSetupRequestDto, idempotencyKey?: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'completePaymentSetupRequestDto' is not null or undefined
+            assertParamExists('completePaymentSetup', 'completePaymentSetupRequestDto', completePaymentSetupRequestDto)
+            const localVarPath = `/publicapi/v1/payment-setup/complete`;
+            // 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 (idempotencyKey !== undefined && idempotencyKey !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
+                localVarHeaderParameter['Idempotency-Key'] = String(idempotencyKey ? idempotencyKey : baseAccessToken);
+            }
+
+            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(completePaymentSetupRequestDto, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * This will send the customer the public key to load the payment form and complete the payment setup.
+         * @summary Get public key and psp
+         * @param {string} [idempotencyKey] An idempotency key is a unique value generated by the client which the server uses to recognize subsequent retries of the same request. How you create unique keys is up to you, but we suggest using V4 UUIDs, or another random string with enough entropy to avoid collisions. Idempotency keys can be up to 255 characters long.
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getPublicPSPConfig: async (idempotencyKey?: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/publicapi/v1/payment-setup/get-psp-config`;
+            // 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 (idempotencyKey !== undefined && idempotencyKey !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
+                localVarHeaderParameter['Idempotency-Key'] = String(idempotencyKey ? idempotencyKey : baseAccessToken);
+            }
+
+            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,
+            };
+        },
+        /**
+         * This will Initiate an account inside the payment service providers and they will generate a secret token which is allow user add its payment information.
+         * @summary Initiate a payment setup
+         * @param {InitiatePaymentSetupRequestDto} initiatePaymentSetupRequestDto 
+         * @param {string} [idempotencyKey] An idempotency key is a unique value generated by the client which the server uses to recognize subsequent retries of the same request. How you create unique keys is up to you, but we suggest using V4 UUIDs, or another random string with enough entropy to avoid collisions. Idempotency keys can be up to 255 characters long.
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        initiatePaymentSetup: async (initiatePaymentSetupRequestDto: InitiatePaymentSetupRequestDto, idempotencyKey?: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'initiatePaymentSetupRequestDto' is not null or undefined
+            assertParamExists('initiatePaymentSetup', 'initiatePaymentSetupRequestDto', initiatePaymentSetupRequestDto)
+            const localVarPath = `/publicapi/v1/payment-setup/initiate`;
+            // 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 (idempotencyKey !== undefined && idempotencyKey !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
+                localVarHeaderParameter['Idempotency-Key'] = String(idempotencyKey ? idempotencyKey : baseAccessToken);
+            }
+
+            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(initiatePaymentSetupRequestDto, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * PaymentsSetupApi - functional programming interface
+ * @export
+ */
+export const PaymentsSetupApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = PaymentsSetupApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * This will send the customer payment info from stripe or paypal to the backend.
+         * @summary Complete a payment setup
+         * @param {CompletePaymentSetupRequestDto} completePaymentSetupRequestDto 
+         * @param {string} [idempotencyKey] An idempotency key is a unique value generated by the client which the server uses to recognize subsequent retries of the same request. How you create unique keys is up to you, but we suggest using V4 UUIDs, or another random string with enough entropy to avoid collisions. Idempotency keys can be up to 255 characters long.
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async completePaymentSetup(completePaymentSetupRequestDto: CompletePaymentSetupRequestDto, idempotencyKey?: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CompletePaymentSetupResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.completePaymentSetup(completePaymentSetupRequestDto, idempotencyKey, authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+        /**
+         * This will send the customer the public key to load the payment form and complete the payment setup.
+         * @summary Get public key and psp
+         * @param {string} [idempotencyKey] An idempotency key is a unique value generated by the client which the server uses to recognize subsequent retries of the same request. How you create unique keys is up to you, but we suggest using V4 UUIDs, or another random string with enough entropy to avoid collisions. Idempotency keys can be up to 255 characters long.
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getPublicPSPConfig(idempotencyKey?: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPublicPspSettingsResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getPublicPSPConfig(idempotencyKey, authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+        /**
+         * This will Initiate an account inside the payment service providers and they will generate a secret token which is allow user add its payment information.
+         * @summary Initiate a payment setup
+         * @param {InitiatePaymentSetupRequestDto} initiatePaymentSetupRequestDto 
+         * @param {string} [idempotencyKey] An idempotency key is a unique value generated by the client which the server uses to recognize subsequent retries of the same request. How you create unique keys is up to you, but we suggest using V4 UUIDs, or another random string with enough entropy to avoid collisions. Idempotency keys can be up to 255 characters long.
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async initiatePaymentSetup(initiatePaymentSetupRequestDto: InitiatePaymentSetupRequestDto, idempotencyKey?: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InitiatePaymentSetupResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.initiatePaymentSetup(initiatePaymentSetupRequestDto, idempotencyKey, authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+    }
+};
+
+/**
+ * PaymentsSetupApi - factory interface
+ * @export
+ */
+export const PaymentsSetupApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = PaymentsSetupApiFp(configuration)
+    return {
+        /**
+         * This will send the customer payment info from stripe or paypal to the backend.
+         * @summary Complete a payment setup
+         * @param {CompletePaymentSetupRequestDto} completePaymentSetupRequestDto 
+         * @param {string} [idempotencyKey] An idempotency key is a unique value generated by the client which the server uses to recognize subsequent retries of the same request. How you create unique keys is up to you, but we suggest using V4 UUIDs, or another random string with enough entropy to avoid collisions. Idempotency keys can be up to 255 characters long.
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        completePaymentSetup(completePaymentSetupRequestDto: CompletePaymentSetupRequestDto, idempotencyKey?: string, authorization?: string, options?: any): AxiosPromise<CompletePaymentSetupResponseClass> {
+            return localVarFp.completePaymentSetup(completePaymentSetupRequestDto, idempotencyKey, authorization, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * This will send the customer the public key to load the payment form and complete the payment setup.
+         * @summary Get public key and psp
+         * @param {string} [idempotencyKey] An idempotency key is a unique value generated by the client which the server uses to recognize subsequent retries of the same request. How you create unique keys is up to you, but we suggest using V4 UUIDs, or another random string with enough entropy to avoid collisions. Idempotency keys can be up to 255 characters long.
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getPublicPSPConfig(idempotencyKey?: string, authorization?: string, options?: any): AxiosPromise<GetPublicPspSettingsResponseClass> {
+            return localVarFp.getPublicPSPConfig(idempotencyKey, authorization, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * This will Initiate an account inside the payment service providers and they will generate a secret token which is allow user add its payment information.
+         * @summary Initiate a payment setup
+         * @param {InitiatePaymentSetupRequestDto} initiatePaymentSetupRequestDto 
+         * @param {string} [idempotencyKey] An idempotency key is a unique value generated by the client which the server uses to recognize subsequent retries of the same request. How you create unique keys is up to you, but we suggest using V4 UUIDs, or another random string with enough entropy to avoid collisions. Idempotency keys can be up to 255 characters long.
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        initiatePaymentSetup(initiatePaymentSetupRequestDto: InitiatePaymentSetupRequestDto, idempotencyKey?: string, authorization?: string, options?: any): AxiosPromise<InitiatePaymentSetupResponseClass> {
+            return localVarFp.initiatePaymentSetup(initiatePaymentSetupRequestDto, idempotencyKey, authorization, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * Request parameters for completePaymentSetup operation in PaymentsSetupApi.
+ * @export
+ * @interface PaymentsSetupApiCompletePaymentSetupRequest
+ */
+export interface PaymentsSetupApiCompletePaymentSetupRequest {
+    /**
+     * 
+     * @type {CompletePaymentSetupRequestDto}
+     * @memberof PaymentsSetupApiCompletePaymentSetup
+     */
+    readonly completePaymentSetupRequestDto: CompletePaymentSetupRequestDto
+
+    /**
+     * An idempotency key is a unique value generated by the client which the server uses to recognize subsequent retries of the same request. How you create unique keys is up to you, but we suggest using V4 UUIDs, or another random string with enough entropy to avoid collisions. Idempotency keys can be up to 255 characters long.
+     * @type {string}
+     * @memberof PaymentsSetupApiCompletePaymentSetup
+     */
+    readonly idempotencyKey?: string
+
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof PaymentsSetupApiCompletePaymentSetup
+     */
+    readonly authorization?: string
+}
+
+/**
+ * Request parameters for getPublicPSPConfig operation in PaymentsSetupApi.
+ * @export
+ * @interface PaymentsSetupApiGetPublicPSPConfigRequest
+ */
+export interface PaymentsSetupApiGetPublicPSPConfigRequest {
+    /**
+     * An idempotency key is a unique value generated by the client which the server uses to recognize subsequent retries of the same request. How you create unique keys is up to you, but we suggest using V4 UUIDs, or another random string with enough entropy to avoid collisions. Idempotency keys can be up to 255 characters long.
+     * @type {string}
+     * @memberof PaymentsSetupApiGetPublicPSPConfig
+     */
+    readonly idempotencyKey?: string
+
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof PaymentsSetupApiGetPublicPSPConfig
+     */
+    readonly authorization?: string
+}
+
+/**
+ * Request parameters for initiatePaymentSetup operation in PaymentsSetupApi.
+ * @export
+ * @interface PaymentsSetupApiInitiatePaymentSetupRequest
+ */
+export interface PaymentsSetupApiInitiatePaymentSetupRequest {
+    /**
+     * 
+     * @type {InitiatePaymentSetupRequestDto}
+     * @memberof PaymentsSetupApiInitiatePaymentSetup
+     */
+    readonly initiatePaymentSetupRequestDto: InitiatePaymentSetupRequestDto
+
+    /**
+     * An idempotency key is a unique value generated by the client which the server uses to recognize subsequent retries of the same request. How you create unique keys is up to you, but we suggest using V4 UUIDs, or another random string with enough entropy to avoid collisions. Idempotency keys can be up to 255 characters long.
+     * @type {string}
+     * @memberof PaymentsSetupApiInitiatePaymentSetup
+     */
+    readonly idempotencyKey?: string
+
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof PaymentsSetupApiInitiatePaymentSetup
+     */
+    readonly authorization?: string
+}
+
+/**
+ * PaymentsSetupApi - object-oriented interface
+ * @export
+ * @class PaymentsSetupApi
+ * @extends {BaseAPI}
+ */
+export class PaymentsSetupApi extends BaseAPI {
+    /**
+     * This will send the customer payment info from stripe or paypal to the backend.
+     * @summary Complete a payment setup
+     * @param {PaymentsSetupApiCompletePaymentSetupRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PaymentsSetupApi
+     */
+    public completePaymentSetup(requestParameters: PaymentsSetupApiCompletePaymentSetupRequest, options?: AxiosRequestConfig) {
+        return PaymentsSetupApiFp(this.configuration).completePaymentSetup(requestParameters.completePaymentSetupRequestDto, requestParameters.idempotencyKey, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * This will send the customer the public key to load the payment form and complete the payment setup.
+     * @summary Get public key and psp
+     * @param {PaymentsSetupApiGetPublicPSPConfigRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PaymentsSetupApi
+     */
+    public getPublicPSPConfig(requestParameters: PaymentsSetupApiGetPublicPSPConfigRequest = {}, options?: AxiosRequestConfig) {
+        return PaymentsSetupApiFp(this.configuration).getPublicPSPConfig(requestParameters.idempotencyKey, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * This will Initiate an account inside the payment service providers and they will generate a secret token which is allow user add its payment information.
+     * @summary Initiate a payment setup
+     * @param {PaymentsSetupApiInitiatePaymentSetupRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PaymentsSetupApi
+     */
+    public initiatePaymentSetup(requestParameters: PaymentsSetupApiInitiatePaymentSetupRequest, options?: AxiosRequestConfig) {
+        return PaymentsSetupApiFp(this.configuration).initiatePaymentSetup(requestParameters.initiatePaymentSetupRequestDto, requestParameters.idempotencyKey, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    }
+}