@kanmon/sdk 2.0.0

package/src/openapi/auth/auth.ts

@@ -0,0 +1,79 @@
+import { RequestContext } from "../http/http";
+
+/**
+ * Interface authentication schemes.
+ */
+export interface SecurityAuthentication {
+    /*
+     * @return returns the name of the security authentication as specified in OAI
+     */
+    getName(): string;
+
+    /**
+     * Applies the authentication scheme to the request context
+     *
+     * @params context the request context which should use this authentication scheme
+     */
+    applySecurityAuthentication(context: RequestContext): void | Promise<void>;
+}
+
+export interface TokenProvider {
+  getToken(): Promise<string> | string;
+}
+
+/**
+ * Applies apiKey authentication to the request context.
+ */
+export class AuthorizationAuthentication implements SecurityAuthentication {
+    /**
+     * Configures this api key authentication with the necessary properties
+     *
+     * @param apiKey: The api key to be used for every request
+     */
+    public constructor(private apiKey: string) {}
+
+    public getName(): string {
+        return "Authorization";
+    }
+
+    public applySecurityAuthentication(context: RequestContext) {
+        context.setHeaderParam("Authorization", this.apiKey);
+    }
+}
+
+
+export type AuthMethods = {
+    "default"?: SecurityAuthentication,
+    "Authorization"?: SecurityAuthentication
+}
+
+export type ApiKeyConfiguration = string;
+export type HttpBasicConfiguration = { "username": string, "password": string };
+export type HttpBearerConfiguration = { tokenProvider: TokenProvider };
+export type OAuth2Configuration = { accessToken: string };
+
+export type AuthMethodsConfiguration = {
+    "default"?: SecurityAuthentication,
+    "Authorization"?: ApiKeyConfiguration
+}
+
+/**
+ * Creates the authentication methods from a swagger description.
+ *
+ */
+export function configureAuthMethods(config: AuthMethodsConfiguration | undefined): AuthMethods {
+    let authMethods: AuthMethods = {}
+
+    if (!config) {
+        return authMethods;
+    }
+    authMethods["default"] = config["default"]
+
+    if (config["Authorization"]) {
+        authMethods["Authorization"] = new AuthorizationAuthentication(
+            config["Authorization"]
+        );
+    }
+
+    return authMethods;
+}

package/src/openapi/configuration.ts

@@ -0,0 +1,82 @@
+import { HttpLibrary } from "./http/http";
+import { Middleware, PromiseMiddleware, PromiseMiddlewareWrapper } from "./middleware";
+import { IsomorphicFetchHttpLibrary as DefaultHttpLibrary } from "./http/isomorphic-fetch";
+import { BaseServerConfiguration, server1 } from "./servers";
+import { configureAuthMethods, AuthMethods, AuthMethodsConfiguration } from "./auth/auth";
+
+export interface Configuration {
+    readonly baseServer: BaseServerConfiguration;
+    readonly httpApi: HttpLibrary;
+    readonly middleware: Middleware[];
+    readonly authMethods: AuthMethods;
+}
+
+
+/**
+ * Interface with which a configuration object can be configured.
+ */
+export interface ConfigurationParameters {
+    /**
+     * Default server to use - a list of available servers (according to the 
+     * OpenAPI yaml definition) is included in the `servers` const in `./servers`. You can also
+     * create your own server with the `ServerConfiguration` class from the same 
+     * file.
+     */
+    baseServer?: BaseServerConfiguration;
+    /**
+     * HTTP library to use e.g. IsomorphicFetch. This can usually be skipped as 
+     * all generators come with a default library.
+     * If available, additional libraries can be imported from `./http/*`
+     */
+    httpApi?: HttpLibrary;
+
+    /**
+     * The middlewares which will be applied to requests and responses. You can 
+     * add any number of middleware components to modify requests before they 
+     * are sent or before they are deserialized by implementing the `Middleware`
+     * interface defined in `./middleware`
+     */
+    middleware?: Middleware[];
+    /**
+     * Configures middleware functions that return promises instead of 
+     * Observables (which are used by `middleware`). Otherwise allows for the 
+     * same functionality as `middleware`, i.e., modifying requests before they 
+     * are sent and before they are deserialized.
+     */
+    promiseMiddleware?: PromiseMiddleware[];
+    /**
+     * Configuration for the available authentication methods (e.g., api keys) 
+     * according to the OpenAPI yaml definition. For the definition, please refer to 
+     * `./auth/auth`
+     */
+    authMethods?: AuthMethodsConfiguration
+}
+
+/**
+ * Provide your `ConfigurationParameters` to this function to get a `Configuration`
+ * object that can be used to configure your APIs (in the constructor or 
+ * for each request individually).
+ *
+ * If a property is not included in conf, a default is used:
+ *    - baseServer: server1
+ *    - httpApi: IsomorphicFetchHttpLibrary
+ *    - middleware: []
+ *    - promiseMiddleware: []
+ *    - authMethods: {}
+ *
+ * @param conf partial configuration
+ */
+export function createConfiguration(conf: ConfigurationParameters = {}): Configuration {
+    const configuration: Configuration = {
+        baseServer: conf.baseServer !== undefined ? conf.baseServer : server1,
+        httpApi: conf.httpApi || new DefaultHttpLibrary(),
+        middleware: conf.middleware || [],
+        authMethods: configureAuthMethods(conf.authMethods)
+    };
+    if (conf.promiseMiddleware) {
+        conf.promiseMiddleware.forEach(
+            m => configuration.middleware.push(new PromiseMiddlewareWrapper(m))
+        );
+    }
+    return configuration;
+}

package/src/openapi/http/http.ts

@@ -0,0 +1,247 @@
+// TODO: evaluate if we can easily get rid of this library
+import  FormData from "form-data";
+import { URL, URLSearchParams } from 'url';
+import * as http from 'http';
+import * as https from 'https';
+import { Observable, from } from '../rxjsStub';
+
+export * from './isomorphic-fetch';
+
+/**
+ * Represents an HTTP method.
+ */
+export enum HttpMethod {
+    GET = "GET",
+    HEAD = "HEAD",
+    POST = "POST",
+    PUT = "PUT",
+    DELETE = "DELETE",
+    CONNECT = "CONNECT",
+    OPTIONS = "OPTIONS",
+    TRACE = "TRACE",
+    PATCH = "PATCH"
+}
+
+/**
+ * Represents an HTTP file which will be transferred from or to a server.
+ */
+export type HttpFile = {
+    data: Buffer,
+    name: string
+};
+
+export class HttpException extends Error {
+    public constructor(msg: string) {
+        super(msg);
+    }
+}
+
+/**
+ * Represents the body of an outgoing HTTP request.
+ */
+export type RequestBody = undefined | string | FormData | URLSearchParams;
+
+function ensureAbsoluteUrl(url: string) {
+    if (url.startsWith("http://") || url.startsWith("https://")) {
+        return url;
+    }
+    throw new Error("You need to define an absolute base url for the server.");
+}
+
+/**
+ * Represents an HTTP request context
+ */
+export class RequestContext {
+    private headers: { [key: string]: string } = {};
+    private body: RequestBody = undefined;
+    private url: URL;
+    private agent: http.Agent | https.Agent | undefined = undefined;
+
+    /**
+     * Creates the request context using a http method and request resource url
+     *
+     * @param url url of the requested resource
+     * @param httpMethod http method
+     */
+    public constructor(url: string, private httpMethod: HttpMethod) {
+        this.url = new URL(ensureAbsoluteUrl(url));
+    }
+
+    /*
+     * Returns the url set in the constructor including the query string
+     *
+     */
+    public getUrl(): string {
+        return this.url.toString().endsWith("/") ?
+            this.url.toString().slice(0, -1)
+            : this.url.toString();
+    }
+
+    /**
+     * Replaces the url set in the constructor with this url.
+     *
+     */
+    public setUrl(url: string) {
+        this.url = new URL(ensureAbsoluteUrl(url));
+    }
+
+    /**
+     * Sets the body of the http request either as a string or FormData
+     *
+     * Note that setting a body on a HTTP GET, HEAD, DELETE, CONNECT or TRACE
+     * request is discouraged.
+     * https://httpwg.org/http-core/draft-ietf-httpbis-semantics-latest.html#rfc.section.7.3.1
+     *
+     * @param body the body of the request
+     */
+    public setBody(body: RequestBody) {
+        this.body = body;
+    }
+
+    public getHttpMethod(): HttpMethod {
+        return this.httpMethod;
+    }
+
+    public getHeaders(): { [key: string]: string } {
+        return this.headers;
+    }
+
+    public getBody(): RequestBody {
+        return this.body;
+    }
+
+    public setQueryParam(name: string, value: string) {
+        this.url.searchParams.set(name, value);
+    }
+
+    /**
+     * Sets a cookie with the name and value. NO check  for duplicate cookies is performed
+     *
+     */
+    public addCookie(name: string, value: string): void {
+        if (!this.headers["Cookie"]) {
+            this.headers["Cookie"] = "";
+        }
+        this.headers["Cookie"] += name + "=" + value + "; ";
+    }
+
+    public setHeaderParam(key: string, value: string): void  {
+        this.headers[key] = value;
+    }
+    
+    public setAgent(agent: http.Agent | https.Agent) {
+        this.agent = agent;
+    }
+
+    public getAgent(): http.Agent | https.Agent | undefined {
+        return this.agent;
+    }
+}
+
+export interface ResponseBody {
+    text(): Promise<string>;
+    binary(): Promise<Buffer>;
+}
+
+/**
+ * Helper class to generate a `ResponseBody` from binary data
+ */
+export class SelfDecodingBody implements ResponseBody {
+    constructor(private dataSource: Promise<Buffer>) {}
+
+    binary(): Promise<Buffer> {
+        return this.dataSource;
+    }
+
+    async text(): Promise<string> {
+        const data: Buffer = await this.dataSource;
+        return data.toString();
+    }
+}
+
+export class ResponseContext {
+    public constructor(
+        public httpStatusCode: number,
+        public headers: { [key: string]: string },
+        public body: ResponseBody
+    ) {}
+
+    /**
+     * Parse header value in the form `value; param1="value1"`
+     *
+     * E.g. for Content-Type or Content-Disposition
+     * Parameter names are converted to lower case
+     * The first parameter is returned with the key `""`
+     */
+    public getParsedHeader(headerName: string): { [parameter: string]: string } {
+        const result: { [parameter: string]: string } = {};
+        if (!this.headers[headerName]) {
+            return result;
+        }
+
+        const parameters = this.headers[headerName].split(";");
+        for (const parameter of parameters) {
+            let [key, value] = parameter.split("=", 2);
+            key = key.toLowerCase().trim();
+            if (value === undefined) {
+                result[""] = key;
+            } else {
+                value = value.trim();
+                if (value.startsWith('"') && value.endsWith('"')) {
+                    value = value.substring(1, value.length - 1);
+                }
+                result[key] = value;
+            }
+        }
+        return result;
+    }
+
+    public async getBodyAsFile(): Promise<HttpFile> {
+        const data = await this.body.binary();
+        const fileName = this.getParsedHeader("content-disposition")["filename"] || "";
+        return { data, name: fileName };
+    }
+
+    /**
+     * Use a heuristic to get a body of unknown data structure.
+     * Return as string if possible, otherwise as binary.
+     */
+    public getBodyAsAny(): Promise<string | Buffer | undefined> {
+        try {
+            return this.body.text();
+        } catch {}
+
+        try {
+            return this.body.binary();
+        } catch {}
+
+        return Promise.resolve(undefined);
+    }
+}
+
+export interface HttpLibrary {
+    send(request: RequestContext): Observable<ResponseContext>;
+}
+
+export interface PromiseHttpLibrary {
+    send(request: RequestContext): Promise<ResponseContext>;
+}
+
+export function wrapHttpLibrary(promiseHttpLibrary: PromiseHttpLibrary): HttpLibrary {
+  return {
+    send(request: RequestContext): Observable<ResponseContext> {
+      return from(promiseHttpLibrary.send(request));
+    }
+  }
+}
+
+export class HttpInfo<T> extends ResponseContext {
+    public constructor(
+        public httpStatusCode: number,
+        public headers: { [key: string]: string },
+        public body: ResponseBody,
+        public data: T,
+    ) {
+        super(httpStatusCode, headers, body);
+    }
+}

package/src/openapi/http/isomorphic-fetch.ts

@@ -0,0 +1,32 @@
+import {HttpLibrary, RequestContext, ResponseContext} from './http';
+import { from, Observable } from '../rxjsStub';
+import fetch from "node-fetch";
+
+export class IsomorphicFetchHttpLibrary implements HttpLibrary {
+
+    public send(request: RequestContext): Observable<ResponseContext> {
+        let method = request.getHttpMethod().toString();
+        let body = request.getBody();
+
+        const resultPromise = fetch(request.getUrl(), {
+            method: method,
+            body: body as any,
+            headers: request.getHeaders(),
+            agent: request.getAgent(),
+        }).then((resp: any) => {
+            const headers: { [name: string]: string } = {};
+            resp.headers.forEach((value: string, name: string) => {
+              headers[name] = value;
+            });
+
+            const body = {
+              text: () => resp.text(),
+              binary: () => resp.buffer()
+            };
+            return new ResponseContext(resp.status, headers, body);
+        });
+
+        return from<Promise<ResponseContext>>(resultPromise);
+
+    }
+}

package/src/openapi/index.ts

@@ -0,0 +1,12 @@
+export * from "./http/http";
+export * from "./auth/auth";
+export * from "./models/all";
+export { createConfiguration } from "./configuration"
+export { Configuration } from "./configuration"
+export * from "./apis/exception";
+export * from "./servers";
+export { RequiredError } from "./apis/baseapi";
+
+export { PromiseMiddleware as Middleware } from './middleware';
+export { BankAccountsApiCreateBusinessBankAccountRequest, BankAccountsApiGetBusinessBankAccountRequest, BankAccountsApiGetBusinessBankAccountsRequest, BankAccountsApiUpdateBusinessBankAccountRequest, ObjectBankAccountsApi as BankAccountsApi,  BusinessesApiCreateBusinessRequest, BusinessesApiGetBusinessRequest, BusinessesApiGetBusinessActivityLogRequest, BusinessesApiGetBusinessesRequest, BusinessesApiUpdateBusinessRequest, ObjectBusinessesApi as BusinessesApi,  ConnectTokensApiConnectTokenRequest, ObjectConnectTokensApi as ConnectTokensApi,  DocumentsApiCreateBusinessDocumentRequest, ObjectDocumentsApi as DocumentsApi,  DrawRequestsApiGetDrawRequestRequest, DrawRequestsApiGetDrawRequestsRequest, ObjectDrawRequestsApi as DrawRequestsApi,  EmbeddedSessionsApiCreateEmbeddedSessionRequest, ObjectEmbeddedSessionsApi as EmbeddedSessionsApi,  InvoicesApiGetInvoiceRequest, InvoicesApiGetInvoicesRequest, ObjectInvoicesApi as InvoicesApi,  IssuedProductsApiGetAllIssuedProductsRequest, IssuedProductsApiGetIssuedProductByIdRequest, ObjectIssuedProductsApi as IssuedProductsApi,  OffersApiGetAllOffersRequest, OffersApiGetOfferByIdRequest, ObjectOffersApi as OffersApi,  PaymentsApiGetPaymentByIdRequest, PaymentsApiGetPaymentScheduleForAIssuedProductRequest, ObjectPaymentsApi as PaymentsApi,  PrequalificationsApiGetPrequalifiedBusinessesRequest, ObjectPrequalificationsApi as PrequalificationsApi,  UsersApiCreateUserRequest, UsersApiGetUserRequest, UsersApiGetUsersRequest, UsersApiMergeUserIntoBusinesRequest, UsersApiUpdateUserRequest, ObjectUsersApi as UsersApi } from './types/ObjectParamAPI';
+

package/src/openapi/middleware.ts

@@ -0,0 +1,66 @@
+import {RequestContext, ResponseContext} from './http/http';
+import { Observable, from } from './rxjsStub';
+
+/**
+ * Defines the contract for a middleware intercepting requests before
+ * they are sent (but after the RequestContext was created)
+ * and before the ResponseContext is unwrapped.
+ *
+ */
+export interface Middleware {
+    /**
+     * Modifies the request before the request is sent.
+     *
+     * @param context RequestContext of a request which is about to be sent to the server
+     * @returns an observable of the updated request context
+     *
+     */
+    pre(context: RequestContext): Observable<RequestContext>;
+    /**
+     * Modifies the returned response before it is deserialized.
+     *
+     * @param context ResponseContext of a sent request
+     * @returns an observable of the modified response context
+     */
+    post(context: ResponseContext): Observable<ResponseContext>;
+}
+
+export class PromiseMiddlewareWrapper implements Middleware {
+
+    public constructor(private middleware: PromiseMiddleware) {
+
+    }
+
+    pre(context: RequestContext): Observable<RequestContext> {
+        return from(this.middleware.pre(context));
+    }
+
+    post(context: ResponseContext): Observable<ResponseContext> {
+        return from(this.middleware.post(context));
+    }
+
+}
+
+/**
+ * Defines the contract for a middleware intercepting requests before
+ * they are sent (but after the RequestContext was created)
+ * and before the ResponseContext is unwrapped.
+ *
+ */
+export interface PromiseMiddleware {
+    /**
+     * Modifies the request before the request is sent.
+     *
+     * @param context RequestContext of a request which is about to be sent to the server
+     * @returns an observable of the updated request context
+     *
+     */
+    pre(context: RequestContext): Promise<RequestContext>;
+        /**
+     * Modifies the returned response before it is deserialized.
+     *
+     * @param context ResponseContext of a sent request
+     * @returns an observable of the modified response context
+     */
+    post(context: ResponseContext): Promise<ResponseContext>;
+}

package/src/openapi/models/ActivityLog.ts

@@ -0,0 +1,98 @@
+/**
+ * Kanmon Public V2 API
+ * Kanmon\'s public api. Contains all of the endpoints for both capital providers and platforms
+ *
+ * OpenAPI spec version: 2.0.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 { HttpFile } from '../http/http';
+
+export class ActivityLog {
+    /**
+    * The UUID representing the activity log item in Kanmon.
+    */
+    'id': string;
+    /**
+    * The UUID representing the business in Kanmon.
+    */
+    'businessId': string;
+    /**
+    * Your platform’s unique business ID for the user.
+    */
+    'platformBusinessId': string | null;
+    /**
+    * Event details and schema: https://kanmon.dev/docs/types-webhooks
+    */
+    'payload': any;
+    /**
+    * A description of the log event type.
+    */
+    'eventType': string;
+    /**
+    * Creation UTC ISO 8601 timestamp of the business.
+    */
+    'createdAt': string;
+    /**
+    * Last updated UTC ISO 8601 timestamp of the business.
+    */
+    'updatedAt': string;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "id",
+            "baseName": "id",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "businessId",
+            "baseName": "businessId",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "platformBusinessId",
+            "baseName": "platformBusinessId",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "payload",
+            "baseName": "payload",
+            "type": "any",
+            "format": ""
+        },
+        {
+            "name": "eventType",
+            "baseName": "eventType",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "createdAt",
+            "baseName": "createdAt",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "updatedAt",
+            "baseName": "updatedAt",
+            "type": "string",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return ActivityLog.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+