@brokerize/client 1.0.1

package/dist/swagger/models/AddOriginRequest.d.ts

@@ -0,0 +1,27 @@
+/**
+ * brokerize
+ * The brokerize API allows clients to implement multi-brokerage with a unified interface. For more information, visit brokerize.com
+ *
+ *
+ *
+ * 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 AddOriginRequest
+ */
+export interface AddOriginRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof AddOriginRequest
+     */
+    origin: string;
+}
+export declare function AddOriginRequestFromJSON(json: any): AddOriginRequest;
+export declare function AddOriginRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AddOriginRequest;
+export declare function AddOriginRequestToJSONRecursive(value?: AddOriginRequest | null, ignoreParent?: boolean): any;
+export declare function AddOriginRequestToJSON(value?: AddOriginRequest | null): any;

package/dist/swagger/models/AddOriginRequest.js

@@ -0,0 +1,37 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * brokerize
+ * The brokerize API allows clients to implement multi-brokerage with a unified interface. For more information, visit brokerize.com
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export function AddOriginRequestFromJSON(json) {
+    return AddOriginRequestFromJSONTyped(json, false);
+}
+export function AddOriginRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json === undefined || json === null) {
+        return json;
+    }
+    return {
+        origin: json["origin"],
+    };
+}
+export function AddOriginRequestToJSONRecursive(value, ignoreParent = false) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        origin: value.origin,
+    };
+}
+export function AddOriginRequestToJSON(value) {
+    return AddOriginRequestToJSONRecursive(value, false);
+}

package/dist/swagger/models/AddSessionCompleteChallengeParams.d.ts

@@ -0,0 +1,33 @@
+/**
+ * brokerize
+ * The brokerize API allows clients to implement multi-brokerage with a unified interface. For more information, visit brokerize.com
+ *
+ *
+ *
+ * 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 AddSessionCompleteChallengeParams
+ */
+export interface AddSessionCompleteChallengeParams {
+    /**
+     *
+     * @type {string}
+     * @memberof AddSessionCompleteChallengeParams
+     */
+    challengeId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof AddSessionCompleteChallengeParams
+     */
+    challengeResponse: string;
+}
+export declare function AddSessionCompleteChallengeParamsFromJSON(json: any): AddSessionCompleteChallengeParams;
+export declare function AddSessionCompleteChallengeParamsFromJSONTyped(json: any, ignoreDiscriminator: boolean): AddSessionCompleteChallengeParams;
+export declare function AddSessionCompleteChallengeParamsToJSONRecursive(value?: AddSessionCompleteChallengeParams | null, ignoreParent?: boolean): any;
+export declare function AddSessionCompleteChallengeParamsToJSON(value?: AddSessionCompleteChallengeParams | null): any;

package/dist/swagger/models/AddSessionCompleteChallengeParams.js

@@ -0,0 +1,39 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * brokerize
+ * The brokerize API allows clients to implement multi-brokerage with a unified interface. For more information, visit brokerize.com
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export function AddSessionCompleteChallengeParamsFromJSON(json) {
+    return AddSessionCompleteChallengeParamsFromJSONTyped(json, false);
+}
+export function AddSessionCompleteChallengeParamsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json === undefined || json === null) {
+        return json;
+    }
+    return {
+        challengeId: json["challengeId"],
+        challengeResponse: json["challengeResponse"],
+    };
+}
+export function AddSessionCompleteChallengeParamsToJSONRecursive(value, ignoreParent = false) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        challengeId: value.challengeId,
+        challengeResponse: value.challengeResponse,
+    };
+}
+export function AddSessionCompleteChallengeParamsToJSON(value) {
+    return AddSessionCompleteChallengeParamsToJSONRecursive(value, false);
+}

package/dist/swagger/models/AddSessionParams.d.ts

@@ -0,0 +1,45 @@
+/**
+ * brokerize
+ * The brokerize API allows clients to implement multi-brokerage with a unified interface. For more information, visit brokerize.com
+ *
+ *
+ *
+ * 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 AddSessionParams
+ */
+export interface AddSessionParams {
+    /**
+     *
+     * @type {string}
+     * @memberof AddSessionParams
+     */
+    brokerName: string;
+    /**
+     *
+     * @type {string}
+     * @memberof AddSessionParams
+     */
+    env: string;
+    /**
+     *
+     * @type {string}
+     * @memberof AddSessionParams
+     */
+    password: string;
+    /**
+     *
+     * @type {string}
+     * @memberof AddSessionParams
+     */
+    username: string;
+}
+export declare function AddSessionParamsFromJSON(json: any): AddSessionParams;
+export declare function AddSessionParamsFromJSONTyped(json: any, ignoreDiscriminator: boolean): AddSessionParams;
+export declare function AddSessionParamsToJSONRecursive(value?: AddSessionParams | null, ignoreParent?: boolean): any;
+export declare function AddSessionParamsToJSON(value?: AddSessionParams | null): any;

package/dist/swagger/models/AddSessionParams.js

@@ -0,0 +1,43 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * brokerize
+ * The brokerize API allows clients to implement multi-brokerage with a unified interface. For more information, visit brokerize.com
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export function AddSessionParamsFromJSON(json) {
+    return AddSessionParamsFromJSONTyped(json, false);
+}
+export function AddSessionParamsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json === undefined || json === null) {
+        return json;
+    }
+    return {
+        brokerName: json["brokerName"],
+        env: json["env"],
+        password: json["password"],
+        username: json["username"],
+    };
+}
+export function AddSessionParamsToJSONRecursive(value, ignoreParent = false) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        brokerName: value.brokerName,
+        env: value.env,
+        password: value.password,
+        username: value.username,
+    };
+}
+export function AddSessionParamsToJSON(value) {
+    return AddSessionParamsToJSONRecursive(value, false);
+}

package/dist/swagger/models/Amount.d.ts

@@ -0,0 +1,72 @@
+/**
+ * brokerize
+ * The brokerize API allows clients to implement multi-brokerage with a unified interface. For more information, visit brokerize.com
+ *
+ *
+ *
+ * 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 Amount
+ */
+export interface Amount {
+    /**
+     * - ISO code (e.g. EUR for Euro), if it is a monetary amount
+     * - or 'USDT' if its Tether (https://en.wikipedia.org/wiki/Tether_(cryptocurrency)
+     * - or 'XXX' if it is pieces
+     * - or 'PRC' if it is a percentage
+     * - or 'PRM' if it is permil
+     * - or 'XXP' if it is points (as for indices)
+     * - or 'GRAMS' if it is grams (as for precious metals)
+     * @type {string}
+     * @memberof Amount
+     */
+    currency?: string;
+    /**
+     * Date in the format YYYY-MM-DD for validityType: 'GTD'
+     * Date in the format Date ISO string YYYY-MM-DDThh:mm:ss.fffZ for validityType: 'GTDT'
+     * @type {string}
+     * @memberof Amount
+     */
+    date?: string;
+    /**
+     * If this is present and true, a "value is provided in realtime" indicator can be displayed.
+     * If this is present and false, a "value is provided delayed" indicator can be displayed.
+     * If this is not present, no such indication is available.
+     * @type {boolean}
+     * @memberof Amount
+     */
+    isRealtime?: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof Amount
+     */
+    maxDecimals?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof Amount
+     */
+    minDecimals?: number;
+    /**
+     * If the amount is valid at a given point in time, this can be set (e.g. for quotes). This is a UNIX timestamp in milliseconds.
+     * @type {number}
+     * @memberof Amount
+     */
+    timestamp?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof Amount
+     */
+    value?: number;
+}
+export declare function AmountFromJSON(json: any): Amount;
+export declare function AmountFromJSONTyped(json: any, ignoreDiscriminator: boolean): Amount;
+export declare function AmountToJSONRecursive(value?: Amount | null, ignoreParent?: boolean): any;
+export declare function AmountToJSON(value?: Amount | null): any;

package/dist/swagger/models/Amount.js

@@ -0,0 +1,50 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * brokerize
+ * The brokerize API allows clients to implement multi-brokerage with a unified interface. For more information, visit brokerize.com
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { exists } from "../runtime";
+export function AmountFromJSON(json) {
+    return AmountFromJSONTyped(json, false);
+}
+export function AmountFromJSONTyped(json, ignoreDiscriminator) {
+    if (json === undefined || json === null) {
+        return json;
+    }
+    return {
+        currency: !exists(json, "currency") ? undefined : json["currency"],
+        date: !exists(json, "date") ? undefined : json["date"],
+        isRealtime: !exists(json, "isRealtime") ? undefined : json["isRealtime"],
+        maxDecimals: !exists(json, "maxDecimals") ? undefined : json["maxDecimals"],
+        minDecimals: !exists(json, "minDecimals") ? undefined : json["minDecimals"],
+        timestamp: !exists(json, "timestamp") ? undefined : json["timestamp"],
+        value: !exists(json, "value") ? undefined : json["value"],
+    };
+}
+export function AmountToJSONRecursive(value, ignoreParent = false) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        currency: value.currency,
+        date: value.date,
+        isRealtime: value.isRealtime,
+        maxDecimals: value.maxDecimals,
+        minDecimals: value.minDecimals,
+        timestamp: value.timestamp,
+        value: value.value,
+    };
+}
+export function AmountToJSON(value) {
+    return AmountToJSONRecursive(value, false);
+}

package/dist/swagger/models/AuthInfo.d.ts

@@ -0,0 +1,54 @@
+/**
+ * brokerize
+ * The brokerize API allows clients to implement multi-brokerage with a unified interface. For more information, visit brokerize.com
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { AuthMethod } from "./AuthMethod";
+/**
+ *
+ * @export
+ * @interface AuthInfo
+ */
+export interface AuthInfo {
+    /**
+     * If this is present and true, the only operation that the AuthMethods can be used to is to activate Session TAN (`session.authorizeSessionTan`).
+     * All other operations (e.g. order creation etc.) require Session TAN to be activated first.
+     * @type {boolean}
+     * @memberof AuthInfo
+     */
+    allOperationsRequireSessionTan?: boolean;
+    /**
+     *
+     * @type {Array<AuthMethod>}
+     * @memberof AuthInfo
+     */
+    authMethods: Array<AuthMethod>;
+    /**
+     *
+     * @type {boolean}
+     * @memberof AuthInfo
+     */
+    sessionTanActive?: boolean;
+    /**
+     * If this is true, session TAN can be ended using the `EndSessionTan` endpoint when it is no longer needed, leaving the
+     * session active. This is not supported by all brokers.
+     * @type {boolean}
+     * @memberof AuthInfo
+     */
+    sessionTanCanBeEnded: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof AuthInfo
+     */
+    sessionTanSupported?: boolean;
+}
+export declare function AuthInfoFromJSON(json: any): AuthInfo;
+export declare function AuthInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): AuthInfo;
+export declare function AuthInfoToJSONRecursive(value?: AuthInfo | null, ignoreParent?: boolean): any;
+export declare function AuthInfoToJSON(value?: AuthInfo | null): any;

package/dist/swagger/models/AuthInfo.js

@@ -0,0 +1,53 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * brokerize
+ * The brokerize API allows clients to implement multi-brokerage with a unified interface. For more information, visit brokerize.com
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { exists } from "../runtime";
+import { AuthMethodFromJSON, AuthMethodToJSON, } from "./AuthMethod";
+export function AuthInfoFromJSON(json) {
+    return AuthInfoFromJSONTyped(json, false);
+}
+export function AuthInfoFromJSONTyped(json, ignoreDiscriminator) {
+    if (json === undefined || json === null) {
+        return json;
+    }
+    return {
+        allOperationsRequireSessionTan: !exists(json, "allOperationsRequireSessionTan")
+            ? undefined
+            : json["allOperationsRequireSessionTan"],
+        authMethods: json["authMethods"].map(AuthMethodFromJSON),
+        sessionTanActive: !exists(json, "sessionTanActive")
+            ? undefined
+            : json["sessionTanActive"],
+        sessionTanCanBeEnded: json["sessionTanCanBeEnded"],
+        sessionTanSupported: !exists(json, "sessionTanSupported")
+            ? undefined
+            : json["sessionTanSupported"],
+    };
+}
+export function AuthInfoToJSONRecursive(value, ignoreParent = false) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        allOperationsRequireSessionTan: value.allOperationsRequireSessionTan,
+        authMethods: value.authMethods.map(AuthMethodToJSON),
+        sessionTanActive: value.sessionTanActive,
+        sessionTanCanBeEnded: value.sessionTanCanBeEnded,
+        sessionTanSupported: value.sessionTanSupported,
+    };
+}
+export function AuthInfoToJSON(value) {
+    return AuthInfoToJSONRecursive(value, false);
+}

package/dist/swagger/models/AuthMethod.d.ts

@@ -0,0 +1,28 @@
+/**
+ * brokerize
+ * The brokerize API allows clients to implement multi-brokerage with a unified interface. For more information, visit brokerize.com
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { AuthMethodChallengeResponse } from "./AuthMethodChallengeResponse";
+import { AuthMethodDecoupled } from "./AuthMethodDecoupled";
+import { AuthMethodTan } from "./AuthMethodTan";
+/**
+ * @type AuthMethod
+ *
+ * @export
+ */
+export type AuthMethod = ({
+    flow: "CHALLENGE_RESPONSE";
+} & AuthMethodChallengeResponse) | ({
+    flow: "DECOUPLED";
+} & AuthMethodDecoupled) | ({
+    flow: "TAN";
+} & AuthMethodTan);
+export declare function AuthMethodFromJSON(json: any): AuthMethod;
+export declare function AuthMethodFromJSONTyped(json: any, ignoreDiscriminator: boolean): AuthMethod;
+export declare function AuthMethodToJSON(value?: AuthMethod | null): any;

package/dist/swagger/models/AuthMethod.js

@@ -0,0 +1,51 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * brokerize
+ * The brokerize API allows clients to implement multi-brokerage with a unified interface. For more information, visit brokerize.com
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { AuthMethodChallengeResponseFromJSONTyped, AuthMethodChallengeResponseToJSON, } from "./AuthMethodChallengeResponse";
+import { AuthMethodDecoupledFromJSONTyped, AuthMethodDecoupledToJSON, } from "./AuthMethodDecoupled";
+import { AuthMethodTanFromJSONTyped, AuthMethodTanToJSON, } from "./AuthMethodTan";
+export function AuthMethodFromJSON(json) {
+    return AuthMethodFromJSONTyped(json, false);
+}
+export function AuthMethodFromJSONTyped(json, ignoreDiscriminator) {
+    if (json === undefined || json === null) {
+        return json;
+    }
+    switch (json["flow"]) {
+        case "CHALLENGE_RESPONSE":
+            return Object.assign(Object.assign({}, AuthMethodChallengeResponseFromJSONTyped(json, true)), { flow: "CHALLENGE_RESPONSE" });
+        case "DECOUPLED":
+            return Object.assign(Object.assign({}, AuthMethodDecoupledFromJSONTyped(json, true)), { flow: "DECOUPLED" });
+        case "TAN":
+            return Object.assign(Object.assign({}, AuthMethodTanFromJSONTyped(json, true)), { flow: "TAN" });
+        default:
+            throw new Error(`No variant of AuthMethod exists with 'flow=${json["flow"]}'`);
+    }
+}
+export function AuthMethodToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    switch (value["flow"]) {
+        case "CHALLENGE_RESPONSE":
+            return AuthMethodChallengeResponseToJSON(value);
+        case "DECOUPLED":
+            return AuthMethodDecoupledToJSON(value);
+        case "TAN":
+            return AuthMethodTanToJSON(value);
+        default:
+            throw new Error(`No variant of AuthMethod exists with 'flow=${value["flow"]}'`);
+    }
+}

package/dist/swagger/models/AuthMethodChallengeResponse.d.ts

@@ -0,0 +1,94 @@
+/**
+ * brokerize
+ * The brokerize API allows clients to implement multi-brokerage with a unified interface. For more information, visit brokerize.com
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * With the `CHALLENGE_RESPONSE` flow, to execute an operation, a challenge has to be created as the first step
+ * and the response to the challenge will be provided with the actual operation as a second API call:
+ *
+ * 1) The end user requests challenge with a button labelled `getChallengeLabel`, which triggers the `createXYZChallenge` endpoint (e.g. `CreateSessionTanChallenge`)
+ * 2) The challenge is then presented to the user. It may be a code to look up from a sheet of paper, a photoTAN to scan with the
+ *    broker's mobile app or anything else (details are described in `Challenge`).
+ * 3) `AuthMethod.challengeResponseIsOnlyConfirmation` determines if and how the user must actually enter a response text:
+ *    - If `challengeResponseIsOnlyConfirmation=true`: the final API call (e.g. `EnableSessionTan`) is only a confirmation of some second factor (i.e. the user tells us they
+ *      have allowed the action in their broker's mobile app). In this case, the `challengeResponse` must be sent as an empty string once
+ *      the user clicks the corresponding confirm button.
+ *    - Otherwise, the user is expected to provide a textual `challengeResponse`. In this case, a text field for the `challengeResponse` must be displayed
+ *      and labelled with `tanFieldLabel`. The  `challengeResponse` is sent as entered by the user to the actual action endpoint (e.g. `EnableSessionTan`)
+ * @export
+ * @interface AuthMethodChallengeResponse
+ */
+export interface AuthMethodChallengeResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof AuthMethodChallengeResponse
+     */
+    flow: AuthMethodChallengeResponseFlowEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof AuthMethodChallengeResponse
+     */
+    challengeLabel?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof AuthMethodChallengeResponse
+     */
+    challengeResponseIsOnlyConfirmation?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof AuthMethodChallengeResponse
+     */
+    getChallengeLabel: string;
+    /**
+     * If this is true, the auth method should not be offered to users on phones (e.g. for photoTAN, where the TAN has to
+     * be scanned with a phone).
+     * @type {boolean}
+     * @memberof AuthMethodChallengeResponse
+     */
+    hideOnPhones?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof AuthMethodChallengeResponse
+     */
+    id: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof AuthMethodChallengeResponse
+     */
+    isDefaultMethod?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof AuthMethodChallengeResponse
+     */
+    label: string;
+    /**
+     *
+     * @type {string}
+     * @memberof AuthMethodChallengeResponse
+     */
+    tanFieldLabel: string;
+}
+/**
+ * @export
+ */
+export declare const AuthMethodChallengeResponseFlowEnum: {
+    readonly ChallengeResponse: "CHALLENGE_RESPONSE";
+};
+export type AuthMethodChallengeResponseFlowEnum = (typeof AuthMethodChallengeResponseFlowEnum)[keyof typeof AuthMethodChallengeResponseFlowEnum];
+export declare function AuthMethodChallengeResponseFromJSON(json: any): AuthMethodChallengeResponse;
+export declare function AuthMethodChallengeResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): AuthMethodChallengeResponse;
+export declare function AuthMethodChallengeResponseToJSONRecursive(value?: AuthMethodChallengeResponse | null, ignoreParent?: boolean): any;
+export declare function AuthMethodChallengeResponseToJSON(value?: AuthMethodChallengeResponse | null): any;