@emilgroup/payment-sdk-node 1.0.0

package/api.ts

@@ -0,0 +1,46 @@
+/* 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
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import { Configuration } from './configuration';
+import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios';
+// URLSearchParams not necessarily used
+// @ts-ignore
+import { URL, URLSearchParams } from 'url';
+import FormData from 'form-data'
+// 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';
+import { BankAccountsApi } from './api';
+import { PaymentMethodsApi } from './api';
+import { PaymentServiceProvidersApi } from './api';
+import { PaymentSetupApi } from './api';
+import { PaymentsApi } from './api';
+import { WebhooksApi } from './api';
+
+
+export * from './api/bank-accounts-api';
+export * from './api/payment-methods-api';
+export * from './api/payment-service-providers-api';
+export * from './api/payment-setup-api';
+export * from './api/payments-api';
+export * from './api/webhooks-api';
+
+
+export enum Environment {
+    Production = 'https://apiv2.emil.de',
+    Test = 'https://apiv2-test.emil.de',
+}

package/base.ts

@@ -0,0 +1,293 @@
+/* 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
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import { Configuration } from "./configuration";
+// Some imports not used depending on template conditions
+// @ts-ignore
+import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios';
+import * as fs from 'fs';
+import * as path from 'path';
+import * as os from 'os';
+
+export const BASE_PATH = "https://apiv2.emil.de".replace(/\/+$/, "");
+const CONFIG_DIRECTORY = '.emil';
+const CONFIG_FILENAME = 'credentials';
+const KEY_USERNAME = 'emil_username';
+const KEY_PASSWORD = 'emil_password';
+
+const filePath = os.homedir() + path.sep + CONFIG_DIRECTORY + path.sep + CONFIG_FILENAME;
+/**
+ *
+ * @export
+ */
+export const COLLECTION_FORMATS = {
+    csv: ",",
+    ssv: " ",
+    tsv: "\t",
+    pipes: "|",
+};
+
+export interface LoginClass {
+    accessToken: string;
+    permissions: Array<string>;
+    newPasswordRequired: boolean;
+}
+
+export enum Environment {
+    Production = 'https://apiv2.emil.de',
+    Test = 'https://apiv2-test.emil.de',
+}
+
+/**
+ *
+ * @export
+ * @interface RequestArgs
+ */
+export interface RequestArgs {
+    url: string;
+    options: AxiosRequestConfig;
+}
+
+const NETWORK_ERROR_MESSAGE = "Network Error";
+
+/**
+ *
+ * @export
+ * @class BaseAPI
+ */
+export class BaseAPI {
+    protected configuration: Configuration;
+    private lastRequestConfig?: AxiosRequestConfig;
+    private username?: string;
+    private password?: string;
+
+    constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = globalAxios) {
+        if (configuration) {
+            this.configuration = configuration;
+            this.basePath = configuration.basePath || this.basePath;
+        } else {
+            this.configuration = new Configuration({
+                basePath: this.basePath,
+            });
+        }
+
+        this.attachInterceptor(axios);
+    }
+
+    async initialize(env: Environment = Environment.Production) {
+        this.configuration.basePath = env;
+
+        await this.loadCredentials();
+
+        if (this.username) {
+            await this.authorize(this.username, this.password);
+            this.password = null; // to avoid keeping password loaded in memory.
+        }
+    }
+
+    private async loadCredentials() {
+        try {
+            await this.readConfigFile();
+        } catch (error) {
+            console.warn(`No credentials file found. Check that ${filePath} exists.`);
+        }
+
+        this.readEnvVariables();
+
+        if (!this.username) {
+            console.info(`No credentials found in credentials file or environment variables. Either provide some or use 
+                authorize() function.`);
+        }
+    }
+
+    private async readConfigFile() {
+        const file = await fs.promises.readFile(filePath, 'utf-8');
+
+        const lines = file.split(os.EOL)
+            .filter(Boolean);
+
+        lines.forEach((line: string) => {
+            if (line.startsWith(KEY_USERNAME)) {
+                this.username = line.length > KEY_USERNAME.length + 1 ? line.substring(KEY_USERNAME.length + 1) : '';
+            } else if (line.startsWith(KEY_PASSWORD)) {
+                this.password = line.length > KEY_PASSWORD.length + 1 ? line.substring(KEY_PASSWORD.length + 1) : '';
+            }
+        });
+    }
+
+    private readEnvVariables(): boolean {
+        if (process.env.EMIL_USERNAME) {
+            this.username = process.env.EMIL_USERNAME;
+            this.password = process.env.EMIL_PASSWORD || '';
+
+            return true;
+        }
+
+        return false;
+    }
+    
+    selectEnvironment(env: Environment) {
+        this.configuration.basePath = env;
+    }
+
+    async authorize(username: string, password: string): Promise<void> {
+        const options: AxiosRequestConfig = {
+            method: 'POST',
+            url: `${this.configuration.basePath}/authservice/v1/login`,
+            headers: { 'Content-Type': 'application/json' },
+            data: {
+                username,
+                password,
+            },
+            withCredentials: true,
+        };
+
+        const response = await globalAxios.request<LoginClass>(options);
+
+        const { data: { accessToken } } = response;
+        this.configuration.username = username;
+        this.configuration.accessToken = `Bearer ${accessToken}`;
+
+        const refreshToken = this.extractRefreshToken(response)
+        this.configuration.refreshToken = refreshToken;
+    }
+
+    async refreshToken(): Promise<string> {
+        const { username, refreshToken } = this.configuration;
+        
+
+        if (!username || !refreshToken) {
+            return '';
+        }
+
+        const options: AxiosRequestConfig = {
+            method: 'POST',
+            url: `${this.configuration.basePath}/authservice/v1/refresh-token`,
+            headers: {
+                'Content-Type': 'application/json',
+                Cookie: refreshToken,
+            },
+            data: { username: username },
+            withCredentials: true,
+        };
+        const { data: { accessToken } } = await globalAxios.request<LoginClass>(options);
+
+        return accessToken;
+    }
+
+    private extractRefreshToken(response: AxiosResponse): string {
+        if (response.headers && response.headers['set-cookie']
+            && response.headers['set-cookie'].length > 0) {
+
+            return `${response.headers['set-cookie'][0].split(';')[0]};`;
+        }
+
+        return '';
+    }
+
+    getConfiguration(): Configuration {
+        return this.configuration;
+    }
+
+    private attachInterceptor(axios: AxiosInstance) {
+        axios.interceptors.request.use((config) => {
+            if (config.url?.indexOf('refresh-token') === -1) {
+                this.lastRequestConfig = config;
+            }
+
+            return config;
+        });
+        axios.interceptors.response.use(
+            (res) => {
+                return res;
+            },
+            async (err) => {
+                let originalConfig = err.config;
+                if (err.response) {
+                    // Access Token was expired
+                    if (err.response.status === 401 && !originalConfig._retry) {
+                        originalConfig._retry = true;
+                        try {
+                            const tokenString = await this.refreshToken();
+                            const accessToken = `Bearer ${tokenString}`;
+
+                            const localVarHeaderParameter = {} as any;
+                            localVarHeaderParameter['Authorization'] = accessToken;
+
+                            originalConfig.headers = {
+                                ...originalConfig.headers,
+                                ...localVarHeaderParameter,
+                            };
+
+                            this.configuration.accessToken = accessToken;
+
+                            return axios(originalConfig);
+                        } catch (_error) {
+                            if (_error.response && _error.response.data) {
+                                return Promise.reject(_error.response.data);
+                            }
+                            return Promise.reject(_error);
+                        }
+                    }
+                    if (err.response.status === 403 && err.response.data) {
+                        return Promise.reject(err.response.data);
+                    }
+                } else if (err.message === NETWORK_ERROR_MESSAGE && !originalConfig._retry) {
+                    try {
+                        const tokenString = await this.refreshToken();
+                        const accessToken = `Bearer ${tokenString}`;
+
+                        const localVarHeaderParameter = {} as any;
+                        localVarHeaderParameter['Authorization'] = accessToken;
+
+                        this.lastRequestConfig.headers = {
+                            ...originalConfig.headers,
+                            ...localVarHeaderParameter,
+                        };
+
+                        originalConfig = {
+                            ...this.lastRequestConfig,
+                        }
+
+                        originalConfig._retry = true;
+
+                        this.configuration.accessToken = accessToken;
+
+                        return axios(originalConfig);
+                    } catch (_error) {
+                        if (_error.response && _error.response.data) {
+                            return Promise.reject(_error.response.data);
+                        }
+                        return Promise.reject(_error);
+                    }                    
+                }
+                return Promise.reject(err);
+            }
+        );
+    }
+};
+
+/**
+ *
+ * @export
+ * @class RequiredError
+ * @extends {Error}
+ */
+export class RequiredError extends Error {
+    name: "RequiredError" = "RequiredError";
+    constructor(public field: string, msg?: string) {
+        super(msg);
+    }
+}

package/common.ts

@@ -0,0 +1,138 @@
+/* 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
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import { Configuration } from "./configuration";
+import { RequiredError, RequestArgs } from "./base";
+import { AxiosInstance, AxiosResponse } from 'axios';
+import { URL, URLSearchParams } from 'url';
+/**
+ *
+ * @export
+ */
+export const DUMMY_BASE_URL = 'https://example.com'
+
+/**
+ *
+ * @throws {RequiredError}
+ * @export
+ */
+export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) {
+    if (paramValue === null || paramValue === undefined) {
+        throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`);
+    }
+}
+
+/**
+ *
+ * @export
+ */
+export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) {
+    if (configuration && configuration.apiKey) {
+        const localVarApiKeyValue = typeof configuration.apiKey === 'function'
+            ? await configuration.apiKey(keyParamName)
+            : await configuration.apiKey;
+        object[keyParamName] = localVarApiKeyValue;
+    }
+}
+
+/**
+ *
+ * @export
+ */
+export const setBasicAuthToObject = function (object: any, configuration?: Configuration) {
+    if (configuration && (configuration.username || configuration.password)) {
+        object["auth"] = { username: configuration.username, password: configuration.password };
+    }
+}
+
+/**
+ *
+ * @export
+ */
+export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) {
+    if (configuration && configuration.accessToken) {
+        const accessToken = typeof configuration.accessToken === 'function'
+            ? await configuration.accessToken()
+            : await configuration.accessToken;
+        object["Authorization"] = "Bearer " + accessToken;
+    }
+}
+
+/**
+ *
+ * @export
+ */
+export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) {
+    if (configuration && configuration.accessToken) {
+        const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
+            ? await configuration.accessToken(name, scopes)
+            : await configuration.accessToken;
+        object["Authorization"] = "Bearer " + localVarAccessTokenValue;
+    }
+}
+
+/**
+ *
+ * @export
+ */
+export const setSearchParams = function (url: URL, ...objects: any[]) {
+    const searchParams = new URLSearchParams(url.search);
+    for (const object of objects) {
+        for (const key in object) {
+            if (Array.isArray(object[key])) {
+                searchParams.delete(key);
+                for (const item of object[key]) {
+                    searchParams.append(key, item);
+                }
+            } else {
+                searchParams.set(key, object[key]);
+            }
+        }
+    }
+    url.search = searchParams.toString();
+}
+
+/**
+ *
+ * @export
+ */
+export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) {
+    const nonString = typeof value !== 'string';
+    const needsSerialization = nonString && configuration && configuration.isJsonMime
+        ? configuration.isJsonMime(requestOptions.headers['Content-Type'])
+        : nonString;
+    return needsSerialization
+        ? JSON.stringify(value !== undefined ? value : {})
+        : (value || "");
+}
+
+/**
+ *
+ * @export
+ */
+export const toPathString = function (url: URL) {
+    return url.pathname + url.search + url.hash
+}
+
+/**
+ *
+ * @export
+ */
+export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) {
+    return <T = unknown, R = AxiosResponse<T>>(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
+        const axiosRequestArgs = {...axiosArgs.options, url: (configuration?.basePath || basePath) + axiosArgs.url};
+        return axios.request<T, R>(axiosRequestArgs);
+    };
+}

package/configuration.ts

@@ -0,0 +1,109 @@
+/* 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
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+export interface ConfigurationParameters {
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    username?: string;
+    password?: string;
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    basePath?: string;
+    baseOptions?: any;
+    formDataCtor?: new () => any;
+}
+
+export class Configuration {
+    /**
+     * parameter for apiKey security
+     * @param name security name
+     * @memberof Configuration
+     */
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    /**
+     * parameter for basic security
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    username?: string;
+    /**
+     * parameter for basic security
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    password?: string;
+    /**
+     * parameter for oauth2 security
+     * @param name security name
+     * @param scopes oauth2 scope
+     * @memberof Configuration
+     */
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    /**
+     * override base path
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    basePath?: string;
+    /**
+     * base options for axios calls
+     *
+     * @type {any}
+     * @memberof Configuration
+     */
+    baseOptions?: any;
+    /**
+     * The FormData constructor that will be used to create multipart form data
+     * requests. You can inject this here so that execution environments that
+     * do not support the FormData class can still run the generated client.
+     *
+     * @type {new () => FormData}
+     */
+    formDataCtor?: new () => any;
+
+    /**
+     * parameter for automatically refreshing access token for oauth2 security
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    refreshToken?: string;
+
+    constructor(param: ConfigurationParameters = {}) {
+        this.apiKey = param.apiKey;
+        this.username = param.username;
+        this.password = param.password;
+        this.accessToken = param.accessToken;
+        this.basePath = param.basePath;
+        this.baseOptions = param.baseOptions;
+        this.formDataCtor = param.formDataCtor;
+    }
+
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    public isJsonMime(mime: string): boolean {
+        const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i');
+        return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json');
+    }
+}

package/dist/api/bank-accounts-api.d.ts

@@ -0,0 +1,96 @@
+/**
+ * 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
+ *
+ *
+ * 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 { CreateBankAccountRequestDto } from '../models';
+/**
+ * BankAccountsApi - axios parameter creator
+ * @export
+ */
+export declare const BankAccountsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Creates a bank account for a specified account.
+     * @summary Create a bank account
+     * @param {CreateBankAccountRequestDto} createBankAccountRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createBankAccount: (createBankAccountRequestDto: CreateBankAccountRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * BankAccountsApi - functional programming interface
+ * @export
+ */
+export declare const BankAccountsApiFp: (configuration?: Configuration) => {
+    /**
+     * Creates a bank account for a specified account.
+     * @summary Create a bank account
+     * @param {CreateBankAccountRequestDto} createBankAccountRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createBankAccount(createBankAccountRequestDto: CreateBankAccountRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
+};
+/**
+ * BankAccountsApi - factory interface
+ * @export
+ */
+export declare const BankAccountsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Creates a bank account for a specified account.
+     * @summary Create a bank account
+     * @param {CreateBankAccountRequestDto} createBankAccountRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createBankAccount(createBankAccountRequestDto: CreateBankAccountRequestDto, authorization?: string, options?: any): AxiosPromise<object>;
+};
+/**
+ * Request parameters for createBankAccount operation in BankAccountsApi.
+ * @export
+ * @interface BankAccountsApiCreateBankAccountRequest
+ */
+export interface BankAccountsApiCreateBankAccountRequest {
+    /**
+     *
+     * @type {CreateBankAccountRequestDto}
+     * @memberof BankAccountsApiCreateBankAccount
+     */
+    readonly createBankAccountRequestDto: CreateBankAccountRequestDto;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof BankAccountsApiCreateBankAccount
+     */
+    readonly authorization?: string;
+}
+/**
+ * BankAccountsApi - object-oriented interface
+ * @export
+ * @class BankAccountsApi
+ * @extends {BaseAPI}
+ */
+export declare class BankAccountsApi extends BaseAPI {
+    /**
+     * Creates a bank account for a specified account.
+     * @summary Create a bank account
+     * @param {BankAccountsApiCreateBankAccountRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BankAccountsApi
+     */
+    createBankAccount(requestParameters: BankAccountsApiCreateBankAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
+}