@emilgroup/commission-sdk-node 1.0.0-beta.1

package/api/default-api.ts

@@ -0,0 +1,128 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService 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 { InlineResponse200 } from '../models';
+// @ts-ignore
+import { InlineResponse503 } from '../models';
+// URLSearchParams not necessarily used
+// @ts-ignore
+import { URL, URLSearchParams } from 'url';
+const FormData = require('form-data');
+/**
+ * DefaultApi - axios parameter creator
+ * @export
+ */
+export const DefaultApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * Returns the health status of the CommissionService service.        This endpoint is used to monitor the operational status of the CommissionService service.        It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
+         * @summary Health Check
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        check: async (options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/commissionservice/health`;
+            // 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;
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * DefaultApi - functional programming interface
+ * @export
+ */
+export const DefaultApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = DefaultApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * Returns the health status of the CommissionService service.        This endpoint is used to monitor the operational status of the CommissionService service.        It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
+         * @summary Health Check
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async check(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse200>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.check(options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+    }
+};
+
+/**
+ * DefaultApi - factory interface
+ * @export
+ */
+export const DefaultApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = DefaultApiFp(configuration)
+    return {
+        /**
+         * Returns the health status of the CommissionService service.        This endpoint is used to monitor the operational status of the CommissionService service.        It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
+         * @summary Health Check
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        check(options?: any): AxiosPromise<InlineResponse200> {
+            return localVarFp.check(options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * DefaultApi - object-oriented interface
+ * @export
+ * @class DefaultApi
+ * @extends {BaseAPI}
+ */
+export class DefaultApi extends BaseAPI {
+    /**
+     * Returns the health status of the CommissionService service.        This endpoint is used to monitor the operational status of the CommissionService service.        It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
+     * @summary Health Check
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    public check(options?: AxiosRequestConfig) {
+        return DefaultApiFp(this.configuration).check(options).then((request) => request(this.axios, this.basePath));
+    }
+}

package/api.ts

@@ -0,0 +1,37 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService 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 { 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 { CommissionAgreementVersionsApi } from './api';
+import { CommissionAgreementsApi } from './api';
+import { CommissionsApi } from './api';
+import { DefaultApi } from './api';
+
+
+export * from './api/commission-agreement-versions-api';
+export * from './api/commission-agreements-api';
+export * from './api/commissions-api';
+export * from './api/default-api';
+

package/base.ts

@@ -0,0 +1,327 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService 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 { 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: string;
+}
+
+export interface SwitchWorkspaceRequest {
+    username: string;
+    targetWorkspace: string;
+}
+
+export interface SwitchWorkspaceResponseClass {
+    accessToken: string;
+    permissions: string;
+}
+
+export enum Environment {
+    Production = 'https://apiv2.emil.de',
+    Test = 'https://apiv2-test.emil.de',
+    Staging = 'https://apiv2-staging.emil.de',
+    Development = 'https://apiv2-dev.emil.de',
+    ProductionZurich = 'https://eu-central-2.apiv2.emil.de',
+}
+
+let _retry_count = 0
+let _retry = null
+
+export function resetRetry() {
+    _retry_count = 0
+}
+
+/**
+ *
+ * @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 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, targetWorkspace?: string) {
+        this.configuration.basePath = env;
+
+        await this.loadCredentials();
+
+        if (this.username) {
+            await this.authorize(this.username, this.password, targetWorkspace);
+            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, targetWorkspace?: 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;
+
+        // Switch workspace if provided
+        if (targetWorkspace) {
+            await this.switchWorkspace(targetWorkspace);
+        }
+    }
+    async switchWorkspace(targetWorkspace: string): Promise<void> {
+        const options: AxiosRequestConfig = {
+            method: 'POST',
+            url: `${this.configuration.basePath}/authservice/v1/workspaces/switch`,
+            headers: {
+                'Content-Type': 'application/json',
+                'Authorization': `Bearer ${this.configuration.accessToken}`,
+                'Cookie': this.configuration.refreshToken,
+            },
+            data: {
+                username: this.configuration.username,
+                targetWorkspace,
+            } as SwitchWorkspaceRequest,
+            withCredentials: true,
+        };
+
+        const response = await globalAxios.request<SwitchWorkspaceResponseClass>(options);
+
+        const { data: { accessToken } } = response;
+        this.configuration.accessToken = `Bearer ${accessToken}`;
+
+        const refreshToken = this.extractRefreshToken(response);
+        if (refreshToken) {
+            this.configuration.refreshToken = refreshToken;
+        }
+    }
+
+    async refreshTokenInternal(): 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.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.refreshTokenInternal();
+                            const accessToken = `Bearer ${tokenString}`;
+
+                            originalConfig.headers['Authorization'] = accessToken;
+
+                            this.configuration.accessToken = accessToken;
+
+                            return axios.request(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 
+                    && err.isAxiosError
+                    && originalConfig.headers.hasOwnProperty('Authorization')
+                    && _retry_count < 4
+                ){ 
+                    _retry_count++;
+                    try {
+                        const tokenString = await this.refreshTokenInternal();
+                        const accessToken = `Bearer ${tokenString}`;
+
+                        _retry = true;
+                        originalConfig.headers['Authorization'] = accessToken; 
+
+                        this.configuration.accessToken = accessToken;
+
+                        return axios.request({
+                            ...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 {
+    override name: "RequiredError" = "RequiredError";
+    constructor(public field: string, msg?: string) {
+        super(msg);
+    }
+}
+

package/common.ts

@@ -0,0 +1,199 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService 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 { 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"] = configuration.getBearerToken(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"] = configuration.getBearerToken(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);
+    };
+}
+
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService 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.
+ */
+
+
+export interface IStorageConverter<D, SD> {
+  toStorageData( data: D ): SD;
+  fromStorageData( storageData: SD ): D;
+}
+
+export interface IStorage {
+  get<T>( key: string, converter?: IStorageConverter<T, any> ): T | null;
+  set<T>( key: string, value: T, converter?: IStorageConverter<T, any> ): void;
+}
+
+export class LocalStorage implements IStorage {
+  readonly storage: Storage;
+
+  constructor() {
+    this.storage = localStorage;
+  }
+
+  get<T>( key: string, converter?: IStorageConverter<T, any> ): T | null {
+    const jsonValue = this.storage.getItem( key );
+    if ( jsonValue === null ) {
+      return null;
+    }
+    const value = JSON.parse( jsonValue );
+    if ( converter !== undefined ) {
+      return converter.fromStorageData( value );
+    } else {
+      return value as T;
+    }
+  }
+
+  set<T>( key: string, value: T, converter?: IStorageConverter<T, any> ): void {
+    let valueToStore: any = value;
+    if ( converter !== undefined ) {
+      valueToStore = converter.toStorageData( value );
+    }
+    const jsonValue = JSON.stringify( valueToStore );
+    this.storage.setItem( key, jsonValue );
+  }
+}
+
+let _defaultStorage: IStorage = null;
+
+export const defaultStorage = (): IStorage => {
+  return _defaultStorage || (_defaultStorage = new LocalStorage());
+};