@brokerize/client 1.4.0 → 1.5.0

package/dist/client.d.ts

@@ -2545,6 +2545,13 @@ declare interface ClientConfig {
      * @memberof ClientConfig
      */
     allowRequestsWithoutOrigin: boolean;
+    /**
+     * If true, security logo URLs (`Security.logos`) are returned with positions/orders for this client.
+     * Logos are served via `logos.brokerize.com`.
+     * @type {boolean}
+     * @memberof ClientConfig
+     */
+    allowSecurityLogos?: boolean;
     /**
      *
      * @type {Array<string>}
@@ -2585,11 +2592,20 @@ declare interface ClientConfig {
      */
     enabled: boolean;
     /**
-     *
+     * How long guest users will be kept after their last activity.
+     * If the user has set up a RecoveryPhrase, `guestUserInactivityTimeoutSecondsRecoveryPhrase` is used instead (if defined).
      * @type {number}
      * @memberof ClientConfig
      */
     guestUserInactivityTimeoutSeconds?: number;
+    /**
+     * How long guest users will be kept after their last activity *if they have a RecoveryPhrase*.
+     *
+     * If the user has no RecoveryPhrase, `guestUserInactivityTimeoutSeconds` is used instead (if defined).
+     * @type {number}
+     * @memberof ClientConfig
+     */
+    guestUserInactivityTimeoutSecondsRecoveryPhrase?: number;
     /**
      *
      * @type {GuestUserLifetime}
@@ -2732,6 +2748,15 @@ declare interface ClientConfigUpdate {
      * @memberof ClientConfigUpdate
      */
     allowRequestsWithoutOrigin?: boolean;
+    /**
+     * If true, security logo URLs (`Security.logos`) are returned with positions/orders for this client.
+     * Logos are served via `logos.brokerize.com`.
+     *
+     * Default is false.
+     * @type {boolean}
+     * @memberof ClientConfigUpdate
+     */
+    allowSecurityLogos?: boolean;
     /**
      *
      * @type {Array<string>}
@@ -2783,11 +2808,20 @@ declare interface ClientConfigUpdate {
      */
     enabled?: boolean;
     /**
-     *
+     * How long guest users will be kept after their last activity.
+     * If the user has set up a RecoveryPhrase, `guestUserInactivityTimeoutSecondsRecoveryPhrase` is used instead (if defined).
      * @type {number}
      * @memberof ClientConfigUpdate
      */
     guestUserInactivityTimeoutSeconds?: number | null;
+    /**
+     * How long guest users will be kept after their last activity *if they have a RecoveryPhrase*.
+     *
+     * If the user has no RecoveryPhrase, `guestUserInactivityTimeoutSeconds` is used instead (if defined).
+     * @type {number}
+     * @memberof ClientConfigUpdate
+     */
+    guestUserInactivityTimeoutSecondsRecoveryPhrase?: number | null;
     /**
      *
      * @type {GuestUserLifetime}
@@ -7842,6 +7876,7 @@ declare namespace Models {
         Security,
         SecuritySelector,
         SecurityDetailedInfo,
+        SecurityLogoUrls,
         SellPosition,
         Session,
         SessionResponse,
@@ -9224,6 +9259,11 @@ declare namespace openApiClient {
         SecurityDetailedInfoToJSONRecursive,
         SecurityDetailedInfoToJSON,
         SecurityDetailedInfo,
+        SecurityLogoUrlsFromJSON,
+        SecurityLogoUrlsFromJSONTyped,
+        SecurityLogoUrlsToJSONRecursive,
+        SecurityLogoUrlsToJSON,
+        SecurityLogoUrls,
         SecurityQuoteFromJSON,
         SecurityQuoteFromJSONTyped,
         SecurityQuoteToJSONRecursive,
@@ -9612,6 +9652,12 @@ declare interface Order {
      * @memberof Order
      */
     intent?: OrderIntentEnum;
+    /**
+     * If this is true, the order data retrieved from the broker is incomplete. Fields may be missing or be incomplete.
+     * @type {boolean}
+     * @memberof Order
+     */
+    isIncomplete?: boolean;
     /**
      * The ISIN of the security to trade, if applicable. Note that at least one of `isin` and `usTicker` must be set.
      *
@@ -9955,7 +10001,7 @@ declare interface OrderCostEstimation {
     /**
      * If present, users have to accept this message before creating an order.
      * If accepting the costs and performing the order is one click (which is allowed), the create order button label
-     * must contain the information that costs are accepted.
+     * must contain the information that costs are accepted. May contain (some) HTML
      * @type {string}
      * @memberof OrderCostEstimation
      */
@@ -12452,6 +12498,12 @@ declare interface Security {
      * @deprecated
      */
     isin?: string;
+    /**
+     *
+     * @type {SecurityLogoUrls}
+     * @memberof Security
+     */
+    logos?: SecurityLogoUrls;
     /**
      *
      * @type {string}
@@ -12552,6 +12604,39 @@ declare function SecurityFromJSON(json: any): Security;
 
 declare function SecurityFromJSONTyped(json: any, ignoreDiscriminator: boolean): Security;
 
+/**
+ * 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.
+ */
+/**
+ * URLs to logos (e.g. company logos) for a security. Only present if the
+ * client is configured to receive logos (`allowSecurityLogos`).
+ * @export
+ * @interface SecurityLogoUrls
+ */
+declare interface SecurityLogoUrls {
+    /**
+     * Square SVG logo. Directly embeddable URL served via `logos.brokerize.com`.
+     * @type {string}
+     * @memberof SecurityLogoUrls
+     */
+    svgSquare?: string;
+}
+
+declare function SecurityLogoUrlsFromJSON(json: any): SecurityLogoUrls;
+
+declare function SecurityLogoUrlsFromJSONTyped(json: any, ignoreDiscriminator: boolean): SecurityLogoUrls;
+
+declare function SecurityLogoUrlsToJSON(value?: SecurityLogoUrls | null): any;
+
+declare function SecurityLogoUrlsToJSONRecursive(value?: SecurityLogoUrls | null, ignoreParent?: boolean): any;
+
 /**
  * brokerize
  * The brokerize API allows clients to implement multi-brokerage with a unified interface. For more information, visit brokerize.com

package/dist/modelExports.d.ts

@@ -135,6 +135,7 @@ export { RiskClassInfo } from "./swagger/models/RiskClassInfo";
 export { Security } from "./swagger/models/Security";
 export { SecuritySelector } from "./swagger/models/SecuritySelector";
 export { SecurityDetailedInfo } from "./swagger/models/SecurityDetailedInfo";
+export { SecurityLogoUrls } from "./swagger/models/SecurityLogoUrls";
 export { SellPosition } from "./swagger/models/SellPosition";
 export { Session } from "./swagger/models/Session";
 export { SessionResponse } from "./swagger/models/SessionResponse";

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

@@ -25,6 +25,13 @@ export interface ClientConfig {
      * @memberof ClientConfig
      */
     allowRequestsWithoutOrigin: boolean;
+    /**
+     * If true, security logo URLs (`Security.logos`) are returned with positions/orders for this client.
+     * Logos are served via `logos.brokerize.com`.
+     * @type {boolean}
+     * @memberof ClientConfig
+     */
+    allowSecurityLogos?: boolean;
     /**
      *
      * @type {Array<string>}
@@ -65,11 +72,20 @@ export interface ClientConfig {
      */
     enabled: boolean;
     /**
-     *
+     * How long guest users will be kept after their last activity.
+     * If the user has set up a RecoveryPhrase, `guestUserInactivityTimeoutSecondsRecoveryPhrase` is used instead (if defined).
      * @type {number}
      * @memberof ClientConfig
      */
     guestUserInactivityTimeoutSeconds?: number;
+    /**
+     * How long guest users will be kept after their last activity *if they have a RecoveryPhrase*.
+     *
+     * If the user has no RecoveryPhrase, `guestUserInactivityTimeoutSeconds` is used instead (if defined).
+     * @type {number}
+     * @memberof ClientConfig
+     */
+    guestUserInactivityTimeoutSecondsRecoveryPhrase?: number;
     /**
      *
      * @type {GuestUserLifetime}

package/dist/swagger/models/ClientConfig.js

@@ -25,6 +25,9 @@ export function ClientConfigFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         allowRequestsWithoutOrigin: json["allowRequestsWithoutOrigin"],
+        allowSecurityLogos: !exists(json, "allowSecurityLogos")
+            ? undefined
+            : json["allowSecurityLogos"],
         allowedOrigins: json["allowedOrigins"],
         allowedOriginsRegularExpressions: !exists(json, "allowedOriginsRegularExpressions")
             ? undefined
@@ -38,6 +41,9 @@ export function ClientConfigFromJSONTyped(json, ignoreDiscriminator) {
         guestUserInactivityTimeoutSeconds: !exists(json, "guestUserInactivityTimeoutSeconds")
             ? undefined
             : json["guestUserInactivityTimeoutSeconds"],
+        guestUserInactivityTimeoutSecondsRecoveryPhrase: !exists(json, "guestUserInactivityTimeoutSecondsRecoveryPhrase")
+            ? undefined
+            : json["guestUserInactivityTimeoutSecondsRecoveryPhrase"],
         guestUserLifetime: !exists(json, "guestUserLifetime")
             ? undefined
             : GuestUserLifetimeFromJSON(json["guestUserLifetime"]),
@@ -76,6 +82,7 @@ export function ClientConfigToJSONRecursive(value, ignoreParent = false) {
     }
     return {
         allowRequestsWithoutOrigin: value.allowRequestsWithoutOrigin,
+        allowSecurityLogos: value.allowSecurityLogos,
         allowedOrigins: value.allowedOrigins,
         allowedOriginsRegularExpressions: value.allowedOriginsRegularExpressions,
         brokerEnvFilter: mapValues(value.brokerEnvFilter, BrokerEnvFilterTypeToJSON),
@@ -83,6 +90,7 @@ export function ClientConfigToJSONRecursive(value, ignoreParent = false) {
         cryptoTradingAllowed: value.cryptoTradingAllowed,
         enabled: value.enabled,
         guestUserInactivityTimeoutSeconds: value.guestUserInactivityTimeoutSeconds,
+        guestUserInactivityTimeoutSecondsRecoveryPhrase: value.guestUserInactivityTimeoutSecondsRecoveryPhrase,
         guestUserLifetime: GuestUserLifetimeToJSON(value.guestUserLifetime),
         hideOfflinePortfolios: value.hideOfflinePortfolios,
         legalEntityName: value.legalEntityName,

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

@@ -28,6 +28,15 @@ export interface ClientConfigUpdate {
      * @memberof ClientConfigUpdate
      */
     allowRequestsWithoutOrigin?: boolean;
+    /**
+     * If true, security logo URLs (`Security.logos`) are returned with positions/orders for this client.
+     * Logos are served via `logos.brokerize.com`.
+     *
+     * Default is false.
+     * @type {boolean}
+     * @memberof ClientConfigUpdate
+     */
+    allowSecurityLogos?: boolean;
     /**
      *
      * @type {Array<string>}
@@ -79,11 +88,20 @@ export interface ClientConfigUpdate {
      */
     enabled?: boolean;
     /**
-     *
+     * How long guest users will be kept after their last activity.
+     * If the user has set up a RecoveryPhrase, `guestUserInactivityTimeoutSecondsRecoveryPhrase` is used instead (if defined).
      * @type {number}
      * @memberof ClientConfigUpdate
      */
     guestUserInactivityTimeoutSeconds?: number | null;
+    /**
+     * How long guest users will be kept after their last activity *if they have a RecoveryPhrase*.
+     *
+     * If the user has no RecoveryPhrase, `guestUserInactivityTimeoutSeconds` is used instead (if defined).
+     * @type {number}
+     * @memberof ClientConfigUpdate
+     */
+    guestUserInactivityTimeoutSecondsRecoveryPhrase?: number | null;
     /**
      *
      * @type {GuestUserLifetime}

package/dist/swagger/models/ClientConfigUpdate.js

@@ -30,6 +30,9 @@ export function ClientConfigUpdateFromJSONTyped(json, ignoreDiscriminator) {
         allowRequestsWithoutOrigin: !exists(json, "allowRequestsWithoutOrigin")
             ? undefined
             : json["allowRequestsWithoutOrigin"],
+        allowSecurityLogos: !exists(json, "allowSecurityLogos")
+            ? undefined
+            : json["allowSecurityLogos"],
         allowedOrigins: !exists(json, "allowedOrigins")
             ? undefined
             : json["allowedOrigins"],
@@ -55,6 +58,9 @@ export function ClientConfigUpdateFromJSONTyped(json, ignoreDiscriminator) {
         guestUserInactivityTimeoutSeconds: !exists(json, "guestUserInactivityTimeoutSeconds")
             ? undefined
             : json["guestUserInactivityTimeoutSeconds"],
+        guestUserInactivityTimeoutSecondsRecoveryPhrase: !exists(json, "guestUserInactivityTimeoutSecondsRecoveryPhrase")
+            ? undefined
+            : json["guestUserInactivityTimeoutSecondsRecoveryPhrase"],
         guestUserLifetime: !exists(json, "guestUserLifetime")
             ? undefined
             : GuestUserLifetimeFromJSON(json["guestUserLifetime"]),
@@ -110,6 +116,7 @@ export function ClientConfigUpdateToJSONRecursive(value, ignoreParent = false) {
     }
     return {
         allowRequestsWithoutOrigin: value.allowRequestsWithoutOrigin,
+        allowSecurityLogos: value.allowSecurityLogos,
         allowedOrigins: value.allowedOrigins,
         allowedOriginsRegularExpressions: value.allowedOriginsRegularExpressions,
         brokerClientIds: BrokerClientCfgToJSON(value.brokerClientIds),
@@ -121,6 +128,7 @@ export function ClientConfigUpdateToJSONRecursive(value, ignoreParent = false) {
         cryptoTradingAllowed: value.cryptoTradingAllowed,
         enabled: value.enabled,
         guestUserInactivityTimeoutSeconds: value.guestUserInactivityTimeoutSeconds,
+        guestUserInactivityTimeoutSecondsRecoveryPhrase: value.guestUserInactivityTimeoutSecondsRecoveryPhrase,
         guestUserLifetime: GuestUserLifetimeToJSON(value.guestUserLifetime),
         hideOfflinePortfolios: value.hideOfflinePortfolios,
         legalEntityName: value.legalEntityName,

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

@@ -222,6 +222,12 @@ export interface Order {
      * @memberof Order
      */
     intent?: OrderIntentEnum;
+    /**
+     * If this is true, the order data retrieved from the broker is incomplete. Fields may be missing or be incomplete.
+     * @type {boolean}
+     * @memberof Order
+     */
+    isIncomplete?: boolean;
     /**
      * The ISIN of the security to trade, if applicable. Note that at least one of `isin` and `usTicker` must be set.
      *

package/dist/swagger/models/Order.js

@@ -110,6 +110,9 @@ export function OrderFromJSONTyped(json, ignoreDiscriminator) {
         id: json["id"],
         ifDoneLimit: !exists(json, "ifDoneLimit") ? undefined : json["ifDoneLimit"],
         intent: !exists(json, "intent") ? undefined : json["intent"],
+        isIncomplete: !exists(json, "isIncomplete")
+            ? undefined
+            : json["isIncomplete"],
         isin: json["isin"],
         limit: !exists(json, "limit") ? undefined : json["limit"],
         limitCurrencyIso: !exists(json, "limitCurrencyIso")
@@ -217,6 +220,7 @@ export function OrderToJSONRecursive(value, ignoreParent = false) {
         id: value.id,
         ifDoneLimit: value.ifDoneLimit,
         intent: value.intent,
+        isIncomplete: value.isIncomplete,
         isin: value.isin,
         limit: value.limit,
         limitCurrencyIso: value.limitCurrencyIso,

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

@@ -20,7 +20,7 @@ export interface OrderCostEstimation {
     /**
      * If present, users have to accept this message before creating an order.
      * If accepting the costs and performing the order is one click (which is allowed), the create order button label
-     * must contain the information that costs are accepted.
+     * must contain the information that costs are accepted. May contain (some) HTML
      * @type {string}
      * @memberof OrderCostEstimation
      */

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

@@ -8,6 +8,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { SecurityLogoUrls } from "./SecurityLogoUrls";
 import { SecuritySelector } from "./SecuritySelector";
 /**
  * A security's basic data like symbols and names.
@@ -29,6 +30,12 @@ export interface Security {
      * @deprecated
      */
     isin?: string;
+    /**
+     *
+     * @type {SecurityLogoUrls}
+     * @memberof Security
+     */
+    logos?: SecurityLogoUrls;
     /**
      *
      * @type {string}

package/dist/swagger/models/Security.js

@@ -11,6 +11,7 @@
  * Do not edit the class manually.
  */
 import { exists } from "../runtime";
+import { SecurityLogoUrlsFromJSON, SecurityLogoUrlsToJSON, } from "./SecurityLogoUrls";
 import { SecuritySelectorFromJSON, SecuritySelectorToJSON, } from "./SecuritySelector";
 /**
  * @export
@@ -29,6 +30,9 @@ export function SecurityFromJSONTyped(json, ignoreDiscriminator) {
     return {
         cryptoCode: !exists(json, "cryptoCode") ? undefined : json["cryptoCode"],
         isin: !exists(json, "isin") ? undefined : json["isin"],
+        logos: !exists(json, "logos")
+            ? undefined
+            : SecurityLogoUrlsFromJSON(json["logos"]),
         name: !exists(json, "name") ? undefined : json["name"],
         priceFactor: !exists(json, "priceFactor") ? undefined : json["priceFactor"],
         selector: SecuritySelectorFromJSON(json["selector"]),
@@ -49,6 +53,7 @@ export function SecurityToJSONRecursive(value, ignoreParent = false) {
     return {
         cryptoCode: value.cryptoCode,
         isin: value.isin,
+        logos: SecurityLogoUrlsToJSON(value.logos),
         name: value.name,
         priceFactor: value.priceFactor,
         selector: SecuritySelectorToJSON(value.selector),

package/dist/swagger/models/SecurityLogoUrls.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.
+ */
+/**
+ * URLs to logos (e.g. company logos) for a security. Only present if the
+ * client is configured to receive logos (`allowSecurityLogos`).
+ * @export
+ * @interface SecurityLogoUrls
+ */
+export interface SecurityLogoUrls {
+    /**
+     * Square SVG logo. Directly embeddable URL served via `logos.brokerize.com`.
+     * @type {string}
+     * @memberof SecurityLogoUrls
+     */
+    svgSquare?: string;
+}
+export declare function SecurityLogoUrlsFromJSON(json: any): SecurityLogoUrls;
+export declare function SecurityLogoUrlsFromJSONTyped(json: any, ignoreDiscriminator: boolean): SecurityLogoUrls;
+export declare function SecurityLogoUrlsToJSONRecursive(value?: SecurityLogoUrls | null, ignoreParent?: boolean): any;
+export declare function SecurityLogoUrlsToJSON(value?: SecurityLogoUrls | null): any;

package/dist/swagger/models/SecurityLogoUrls.js

@@ -0,0 +1,38 @@
+/* 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 SecurityLogoUrlsFromJSON(json) {
+    return SecurityLogoUrlsFromJSONTyped(json, false);
+}
+export function SecurityLogoUrlsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json === undefined || json === null) {
+        return json;
+    }
+    return {
+        svgSquare: !exists(json, "svgSquare") ? undefined : json["svgSquare"],
+    };
+}
+export function SecurityLogoUrlsToJSONRecursive(value, ignoreParent = false) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        svgSquare: value.svgSquare,
+    };
+}
+export function SecurityLogoUrlsToJSON(value) {
+    return SecurityLogoUrlsToJSONRecursive(value, false);
+}

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

@@ -209,6 +209,7 @@ export * from "./RenderGenericTableParams";
 export * from "./RiskClassInfo";
 export * from "./Security";
 export * from "./SecurityDetailedInfo";
+export * from "./SecurityLogoUrls";
 export * from "./SecurityQuote";
 export * from "./SecurityQuotes";
 export * from "./SecurityQuotesMeta";

package/dist/swagger/models/index.js

@@ -211,6 +211,7 @@ export * from "./RenderGenericTableParams";
 export * from "./RiskClassInfo";
 export * from "./Security";
 export * from "./SecurityDetailedInfo";
+export * from "./SecurityLogoUrls";
 export * from "./SecurityQuote";
 export * from "./SecurityQuotes";
 export * from "./SecurityQuotesMeta";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brokerize/client",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "Client for the brokerize.com API",
   "keywords": [],
   "homepage": "https://github.com/brokerize/client-js#readme",