@brokerize/client 1.4.0 → 1.6.0

package/dist/cjs/swagger/apis/SecuritiesApi.js

@@ -0,0 +1,118 @@
+"use strict";
+/* 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.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SecuritiesApi = void 0;
+const runtime = __importStar(require("../runtime"));
+const models_1 = require("../models");
+/**
+ *
+ */
+class SecuritiesApi extends runtime.BaseAPI {
+    /**
+     * Load the current quotes for the given `securityQuotesToken` (provided by `PreparedTrade`). Currently, polling this endpoint is the only way to get the current quotes. A polling interval of 2500 milliseconds is recommended and it counts towards the general rate limit.
+     */
+    async getSecurityQuotesRaw(requestParameters, initOverrides) {
+        if (requestParameters.securityQuotesToken === null ||
+            requestParameters.securityQuotesToken === undefined) {
+            throw new runtime.RequiredError("securityQuotesToken", "Required parameter requestParameters.securityQuotesToken was null or undefined when calling getSecurityQuotes.");
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-brkrz-client-id"] =
+                this.configuration.apiKey("x-brkrz-client-id"); // clientId authentication
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("idToken", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/securities/quotes/{securityQuotesToken}`.replace(`{${"securityQuotesToken"}}`, encodeURIComponent(String(requestParameters.securityQuotesToken))),
+            method: "GET",
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, models_1.SecurityQuotesResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Load the current quotes for the given `securityQuotesToken` (provided by `PreparedTrade`). Currently, polling this endpoint is the only way to get the current quotes. A polling interval of 2500 milliseconds is recommended and it counts towards the general rate limit.
+     */
+    async getSecurityQuotes(requestParameters, initOverrides) {
+        const response = await this.getSecurityQuotesRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Load metadata about the given securityQuotesToken. This includes the currency, decimals and the quote source name.
+     */
+    async getSecurityQuotesMetaRaw(requestParameters, initOverrides) {
+        if (requestParameters.securityQuotesToken === null ||
+            requestParameters.securityQuotesToken === undefined) {
+            throw new runtime.RequiredError("securityQuotesToken", "Required parameter requestParameters.securityQuotesToken was null or undefined when calling getSecurityQuotesMeta.");
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-brkrz-client-id"] =
+                this.configuration.apiKey("x-brkrz-client-id"); // clientId authentication
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("idToken", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/securities/quotes/{securityQuotesToken}/meta`.replace(`{${"securityQuotesToken"}}`, encodeURIComponent(String(requestParameters.securityQuotesToken))),
+            method: "GET",
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, models_1.SecurityQuotesMetaFromJSON)(jsonValue));
+    }
+    /**
+     * Load metadata about the given securityQuotesToken. This includes the currency, decimals and the quote source name.
+     */
+    async getSecurityQuotesMeta(requestParameters, initOverrides) {
+        const response = await this.getSecurityQuotesMetaRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+}
+exports.SecuritiesApi = SecuritiesApi;

package/dist/cjs/swagger/apis/SessionApi.d.ts

@@ -0,0 +1,146 @@
+/**
+ * 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 * as runtime from "../runtime";
+import { AddSessionCompleteChallengeParams, AddSessionParams, Challenge, ConfirmOAuthParams, ConfirmOAuthResponse, CreateTanChallengeParams, DecoupledOperationStatus, EnableSessionTanParams, EnableSessionTanResponse, EndSessionTanResponse, LoginResponse, LoginResponseReady, LogoutOkResponseBody, OkResponseBody, PrepareOAuthRedirectParams, PrepareOAuthRedirectResponse, SessionResponse } from "../models";
+export interface AddSessionRequest {
+    addSessionParams: AddSessionParams;
+}
+export interface AddSessionCompleteChallengeRequest {
+    addSessionCompleteChallengeParams: AddSessionCompleteChallengeParams;
+}
+export interface CancelDecoupledOperationLegacyRequest {
+    sessionId: string;
+    decoupledOperationId: string;
+}
+export interface ConfirmOAuthRequest {
+    confirmOAuthParams: ConfirmOAuthParams;
+}
+export interface CreateSessionTanChallengeRequest {
+    sessionId: string;
+    createTanChallengeParams: CreateTanChallengeParams;
+}
+export interface EnableSessionTanRequest {
+    sessionId: string;
+    enableSessionTanParams: EnableSessionTanParams;
+}
+export interface EndSessionTanRequest {
+    sessionId: string;
+}
+export interface GetDecoupledOperationStatusLegacyRequest {
+    sessionId: string;
+    decoupledOperationId: string;
+}
+export interface LogoutSessionRequest {
+    sessionId: string;
+}
+export interface PrepareOAuthRedirectRequest {
+    prepareOAuthRedirectParams: PrepareOAuthRedirectParams;
+}
+export interface TriggerSessionSyncRequest {
+    sessionId: string;
+}
+/**
+ *
+ */
+export declare class SessionApi extends runtime.BaseAPI {
+    /**
+     */
+    addSessionRaw(requestParameters: AddSessionRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<runtime.ApiResponse<LoginResponse>>;
+    /**
+     */
+    addSession(requestParameters: AddSessionRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<LoginResponse>;
+    /**
+     * If login returns the state `challenge`, the login must be completed by providing a challenge response first.
+     */
+    addSessionCompleteChallengeRaw(requestParameters: AddSessionCompleteChallengeRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<runtime.ApiResponse<LoginResponseReady>>;
+    /**
+     * If login returns the state `challenge`, the login must be completed by providing a challenge response first.
+     */
+    addSessionCompleteChallenge(requestParameters: AddSessionCompleteChallengeRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<LoginResponseReady>;
+    /**
+     * Cancel a decoupled operation.  This is deprecated, use the new `CancelDecoupledOperation` instead (which does not require the sessionId anymore).
+     */
+    cancelDecoupledOperationLegacyRaw(requestParameters: CancelDecoupledOperationLegacyRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Cancel a decoupled operation.  This is deprecated, use the new `CancelDecoupledOperation` instead (which does not require the sessionId anymore).
+     */
+    cancelDecoupledOperationLegacy(requestParameters: CancelDecoupledOperationLegacyRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<void>;
+    /**
+     * For brokers with OAuth login processes, this adds the session to the user\'s account after redirects happen. Only the user that is redirected from the broker login in the browser will receive the `code`. This step ensures that the logged-in user at brokerize is actually the one that has gone through the broker OAuth steps.
+     */
+    confirmOAuthRaw(requestParameters: ConfirmOAuthRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<runtime.ApiResponse<ConfirmOAuthResponse>>;
+    /**
+     * For brokers with OAuth login processes, this adds the session to the user\'s account after redirects happen. Only the user that is redirected from the broker login in the browser will receive the `code`. This step ensures that the logged-in user at brokerize is actually the one that has gone through the broker OAuth steps.
+     */
+    confirmOAuth(requestParameters: ConfirmOAuthRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<ConfirmOAuthResponse>;
+    /**
+     * If the user chose an auth method from `GetAuthInfo` with the flow `CHALLENGE_RESPONSE`, before enabling session TAN, a challenge must be requested first.
+     */
+    createSessionTanChallengeRaw(requestParameters: CreateSessionTanChallengeRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<runtime.ApiResponse<Challenge>>;
+    /**
+     * If the user chose an auth method from `GetAuthInfo` with the flow `CHALLENGE_RESPONSE`, before enabling session TAN, a challenge must be requested first.
+     */
+    createSessionTanChallenge(requestParameters: CreateSessionTanChallengeRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<Challenge>;
+    /**
+     */
+    enableSessionTanRaw(requestParameters: EnableSessionTanRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<runtime.ApiResponse<EnableSessionTanResponse>>;
+    /**
+     */
+    enableSessionTan(requestParameters: EnableSessionTanRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<EnableSessionTanResponse>;
+    /**
+     * End Session TAN for the given broker session.  If applicable, the broker may return a message with a confirmation code which can be looked up in the initial activation SMS. If message is present in the response, it should be displayed to the user.
+     */
+    endSessionTanRaw(requestParameters: EndSessionTanRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<runtime.ApiResponse<EndSessionTanResponse>>;
+    /**
+     * End Session TAN for the given broker session.  If applicable, the broker may return a message with a confirmation code which can be looked up in the initial activation SMS. If message is present in the response, it should be displayed to the user.
+     */
+    endSessionTan(requestParameters: EndSessionTanRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<EndSessionTanResponse>;
+    /**
+     * Get the status of a decoupled operation.  This is deprecated, use the new `GetDecoupledOperation` instead, which does not require the `sessionId` any more.
+     */
+    getDecoupledOperationStatusLegacyRaw(requestParameters: GetDecoupledOperationStatusLegacyRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<runtime.ApiResponse<DecoupledOperationStatus>>;
+    /**
+     * Get the status of a decoupled operation.  This is deprecated, use the new `GetDecoupledOperation` instead, which does not require the `sessionId` any more.
+     */
+    getDecoupledOperationStatusLegacy(requestParameters: GetDecoupledOperationStatusLegacyRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<DecoupledOperationStatus>;
+    /**
+     * Get the currently active broker sessions of the user\'s account.
+     */
+    getSessionsRaw(initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<runtime.ApiResponse<SessionResponse>>;
+    /**
+     * Get the currently active broker sessions of the user\'s account.
+     */
+    getSessions(initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<SessionResponse>;
+    /**
+     * Log out from the given broker session.
+     */
+    logoutSessionRaw(requestParameters: LogoutSessionRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<runtime.ApiResponse<LogoutOkResponseBody>>;
+    /**
+     * Log out from the given broker session.
+     */
+    logoutSession(requestParameters: LogoutSessionRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<LogoutOkResponseBody>;
+    /**
+     * For brokers with `isOAuth`, sessions can not be created using `AddSession`. This is how a session can be added for an OAuth-based login process:  1. use `prepareOAuthRedirect` to obtain a URL to redirect to. You can provide a `returnTo` URL which will be redirected to later. Note that a list of allowed URLs has to be configured for the client. 2. redirect the user\'s browser to the `redirectTo` URL 3. after the user has logged in at the broker\'s interface, a redirect to `returnTo` with the URL query parameters `verifysession=1`, `code` and `ticketId` will happen 4. the `returnTo` page must call `confirmOAuth` with the given `ticketId` and `code` to finally add the session to the user\'s account
+     */
+    prepareOAuthRedirectRaw(requestParameters: PrepareOAuthRedirectRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<runtime.ApiResponse<PrepareOAuthRedirectResponse>>;
+    /**
+     * For brokers with `isOAuth`, sessions can not be created using `AddSession`. This is how a session can be added for an OAuth-based login process:  1. use `prepareOAuthRedirect` to obtain a URL to redirect to. You can provide a `returnTo` URL which will be redirected to later. Note that a list of allowed URLs has to be configured for the client. 2. redirect the user\'s browser to the `redirectTo` URL 3. after the user has logged in at the broker\'s interface, a redirect to `returnTo` with the URL query parameters `verifysession=1`, `code` and `ticketId` will happen 4. the `returnTo` page must call `confirmOAuth` with the given `ticketId` and `code` to finally add the session to the user\'s account
+     */
+    prepareOAuthRedirect(requestParameters: PrepareOAuthRedirectRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<PrepareOAuthRedirectResponse>;
+    /**
+     * Trigger a background sync process for the given broker session. This means that a sync will be scheduled as soon as possible. All data related to the portfolio (e.g. positions and orders) will be loaded into the brokerize database.
+     */
+    triggerSessionSyncRaw(requestParameters: TriggerSessionSyncRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<runtime.ApiResponse<OkResponseBody>>;
+    /**
+     * Trigger a background sync process for the given broker session. This means that a sync will be scheduled as soon as possible. All data related to the portfolio (e.g. positions and orders) will be loaded into the brokerize database.
+     */
+    triggerSessionSync(requestParameters: TriggerSessionSyncRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<OkResponseBody>;
+}