@clear-street/clearstreet 0.75.0 → 0.77.0

package/resources/v1/v1.js

@@ -18,8 +18,6 @@ const PositionsAPI = tslib_1.__importStar(require("./positions.js"));
 const positions_1 = require("./positions.js");
 const WatchlistAPI = tslib_1.__importStar(require("./watchlist.js"));
 const watchlist_1 = require("./watchlist.js");
-const WebsocketAPI = tslib_1.__importStar(require("./websocket.js"));
-const websocket_1 = require("./websocket.js");
 const InstrumentDataAPI = tslib_1.__importStar(require("./instrument-data/instrument-data.js"));
 const instrument_data_1 = require("./instrument-data/instrument-data.js");
 const OmniAIAPI = tslib_1.__importStar(require("./omni-ai/omni-ai.js"));
@@ -36,7 +34,6 @@ class V1 extends resource_1.APIResource {
         this.orders = new OrdersAPI.Orders(this._client);
         this.positions = new PositionsAPI.Positions(this._client);
         this.watchlist = new WatchlistAPI.Watchlist(this._client);
-        this.websocket = new WebsocketAPI.Websocket(this._client);
     }
 }
 exports.V1 = V1;
@@ -49,5 +46,4 @@ V1.OmniAI = omni_ai_1.OmniAI;
 V1.Orders = orders_1.Orders;
 V1.Positions = positions_1.Positions;
 V1.Watchlist = watchlist_1.Watchlist;
-V1.Websocket = websocket_1.Websocket;
 //# sourceMappingURL=v1.js.map

package/resources/v1/v1.js.map

@@ -1 +1 @@
-{"version":3,"file":"v1.js","sourceRoot":"","sources":["../../src/resources/v1/v1.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAClD,mEAA0C;AAC1C,4CA2BoB;AACpB,wEAA+C;AAC/C,kDAAkF;AAClF,mEAA0C;AAC1C,4CAcoB;AACpB,yEAAgD;AAChD,kDAkBuB;AACvB,+DAAsC;AACtC,wCAgCkB;AAClB,qEAA4C;AAC5C,8CAqBqB;AACrB,qEAA4C;AAC5C,8CAiBqB;AACrB,qEAA4C;AAC5C,8CAAwC;AACxC,gGAAuE;AACvE,0EAoC2C;AAC3C,wEAA+C;AAC/C,kDA0B2B;AAE3B,MAAa,EAAG,SAAQ,sBAAW;IAAnC;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,eAAU,GAA6B,IAAI,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAClF,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,mBAAc,GAAqC,IAAI,iBAAiB,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACtG,gBAAW,GAA+B,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvF,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9D,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9D,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7E,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7E,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC/E,CAAC;CAAA;AAXD,gBAWC;AAOD,EAAE,CAAC,QAAQ,GAAG,mBAAQ,CAAC;AACvB,EAAE,CAAC,UAAU,GAAG,wBAAU,CAAC;AAC3B,EAAE,CAAC,QAAQ,GAAG,mBAAQ,CAAC;AACvB,EAAE,CAAC,cAAc,GAAG,gCAAc,CAAC;AACnC,EAAE,CAAC,WAAW,GAAG,yBAAW,CAAC;AAC7B,EAAE,CAAC,MAAM,GAAG,gBAAM,CAAC;AACnB,EAAE,CAAC,MAAM,GAAG,eAAM,CAAC;AACnB,EAAE,CAAC,SAAS,GAAG,qBAAS,CAAC;AACzB,EAAE,CAAC,SAAS,GAAG,qBAAS,CAAC;AACzB,EAAE,CAAC,SAAS,GAAG,qBAAS,CAAC"}
+{"version":3,"file":"v1.js","sourceRoot":"","sources":["../../src/resources/v1/v1.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAClD,mEAA0C;AAC1C,4CA2BoB;AACpB,wEAA+C;AAC/C,kDAAkF;AAClF,mEAA0C;AAC1C,4CAcoB;AACpB,yEAAgD;AAChD,kDAkBuB;AACvB,+DAAsC;AACtC,wCAgCkB;AAClB,qEAA4C;AAC5C,8CAqBqB;AACrB,qEAA4C;AAC5C,8CAiBqB;AACrB,gGAAuE;AACvE,0EAoC2C;AAC3C,wEAA+C;AAC/C,kDA0B2B;AAE3B,MAAa,EAAG,SAAQ,sBAAW;IAAnC;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,eAAU,GAA6B,IAAI,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAClF,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,mBAAc,GAAqC,IAAI,iBAAiB,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACtG,gBAAW,GAA+B,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvF,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9D,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9D,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7E,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC/E,CAAC;CAAA;AAVD,gBAUC;AAOD,EAAE,CAAC,QAAQ,GAAG,mBAAQ,CAAC;AACvB,EAAE,CAAC,UAAU,GAAG,wBAAU,CAAC;AAC3B,EAAE,CAAC,QAAQ,GAAG,mBAAQ,CAAC;AACvB,EAAE,CAAC,cAAc,GAAG,gCAAc,CAAC;AACnC,EAAE,CAAC,WAAW,GAAG,yBAAW,CAAC;AAC7B,EAAE,CAAC,MAAM,GAAG,gBAAM,CAAC;AACnB,EAAE,CAAC,MAAM,GAAG,eAAM,CAAC;AACnB,EAAE,CAAC,SAAS,GAAG,qBAAS,CAAC;AACzB,EAAE,CAAC,SAAS,GAAG,qBAAS,CAAC"}

package/resources/v1/v1.mjs

@@ -14,8 +14,6 @@ import * as PositionsAPI from "./positions.mjs";
 import { Positions, } from "./positions.mjs";
 import * as WatchlistAPI from "./watchlist.mjs";
 import { Watchlist, } from "./watchlist.mjs";
-import * as WebsocketAPI from "./websocket.mjs";
-import { Websocket } from "./websocket.mjs";
 import * as InstrumentDataAPI from "./instrument-data/instrument-data.mjs";
 import { InstrumentData, } from "./instrument-data/instrument-data.mjs";
 import * as OmniAIAPI from "./omni-ai/omni-ai.mjs";
@@ -32,7 +30,6 @@ export class V1 extends APIResource {
         this.orders = new OrdersAPI.Orders(this._client);
         this.positions = new PositionsAPI.Positions(this._client);
         this.watchlist = new WatchlistAPI.Watchlist(this._client);
-        this.websocket = new WebsocketAPI.Websocket(this._client);
     }
 }
 V1.Accounts = Accounts;
@@ -44,5 +41,4 @@ V1.OmniAI = OmniAI;
 V1.Orders = Orders;
 V1.Positions = Positions;
 V1.Watchlist = Watchlist;
-V1.Websocket = Websocket;
 //# sourceMappingURL=v1.mjs.map

package/resources/v1/v1.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"v1.mjs","sourceRoot":"","sources":["../../src/resources/v1/v1.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,WAAW,uBAAmB;AAC1C,OAAO,EAkBL,QAAQ,GAST,uBAAmB;AACpB,OAAO,KAAK,aAAa,0BAAsB;AAC/C,OAAO,EAAE,UAAU,EAAyC,0BAAsB;AAClF,OAAO,KAAK,WAAW,uBAAmB;AAC1C,OAAO,EACL,QAAQ,GAaT,uBAAmB;AACpB,OAAO,KAAK,cAAc,0BAAsB;AAChD,OAAO,EAcL,WAAW,GAIZ,0BAAsB;AACvB,OAAO,KAAK,SAAS,qBAAiB;AACtC,OAAO,EAwBL,MAAM,GAQP,qBAAiB;AAClB,OAAO,KAAK,YAAY,wBAAoB;AAC5C,OAAO,EAoBL,SAAS,GACV,wBAAoB;AACrB,OAAO,KAAK,YAAY,wBAAoB;AAC5C,OAAO,EAEL,SAAS,GAeV,wBAAoB;AACrB,OAAO,KAAK,YAAY,wBAAoB;AAC5C,OAAO,EAAE,SAAS,EAAE,wBAAoB;AACxC,OAAO,KAAK,iBAAiB,8CAA0C;AACvE,OAAO,EAWL,cAAc,GAyBf,8CAA0C;AAC3C,OAAO,KAAK,SAAS,8BAA0B;AAC/C,OAAO,EAcL,MAAM,GAYP,8BAA0B;AAE3B,MAAM,OAAO,EAAG,SAAQ,WAAW;IAAnC;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,eAAU,GAA6B,IAAI,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAClF,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,mBAAc,GAAqC,IAAI,iBAAiB,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACtG,gBAAW,GAA+B,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvF,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9D,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9D,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7E,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7E,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC/E,CAAC;CAAA;AAOD,EAAE,CAAC,QAAQ,GAAG,QAAQ,CAAC;AACvB,EAAE,CAAC,UAAU,GAAG,UAAU,CAAC;AAC3B,EAAE,CAAC,QAAQ,GAAG,QAAQ,CAAC;AACvB,EAAE,CAAC,cAAc,GAAG,cAAc,CAAC;AACnC,EAAE,CAAC,WAAW,GAAG,WAAW,CAAC;AAC7B,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC;AACnB,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC;AACnB,EAAE,CAAC,SAAS,GAAG,SAAS,CAAC;AACzB,EAAE,CAAC,SAAS,GAAG,SAAS,CAAC;AACzB,EAAE,CAAC,SAAS,GAAG,SAAS,CAAC"}
+{"version":3,"file":"v1.mjs","sourceRoot":"","sources":["../../src/resources/v1/v1.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,WAAW,uBAAmB;AAC1C,OAAO,EAkBL,QAAQ,GAST,uBAAmB;AACpB,OAAO,KAAK,aAAa,0BAAsB;AAC/C,OAAO,EAAE,UAAU,EAAyC,0BAAsB;AAClF,OAAO,KAAK,WAAW,uBAAmB;AAC1C,OAAO,EACL,QAAQ,GAaT,uBAAmB;AACpB,OAAO,KAAK,cAAc,0BAAsB;AAChD,OAAO,EAcL,WAAW,GAIZ,0BAAsB;AACvB,OAAO,KAAK,SAAS,qBAAiB;AACtC,OAAO,EAwBL,MAAM,GAQP,qBAAiB;AAClB,OAAO,KAAK,YAAY,wBAAoB;AAC5C,OAAO,EAoBL,SAAS,GACV,wBAAoB;AACrB,OAAO,KAAK,YAAY,wBAAoB;AAC5C,OAAO,EAEL,SAAS,GAeV,wBAAoB;AACrB,OAAO,KAAK,iBAAiB,8CAA0C;AACvE,OAAO,EAWL,cAAc,GAyBf,8CAA0C;AAC3C,OAAO,KAAK,SAAS,8BAA0B;AAC/C,OAAO,EAcL,MAAM,GAYP,8BAA0B;AAE3B,MAAM,OAAO,EAAG,SAAQ,WAAW;IAAnC;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,eAAU,GAA6B,IAAI,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAClF,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,mBAAc,GAAqC,IAAI,iBAAiB,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACtG,gBAAW,GAA+B,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvF,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9D,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9D,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7E,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC/E,CAAC;CAAA;AAOD,EAAE,CAAC,QAAQ,GAAG,QAAQ,CAAC;AACvB,EAAE,CAAC,UAAU,GAAG,UAAU,CAAC;AAC3B,EAAE,CAAC,QAAQ,GAAG,QAAQ,CAAC;AACvB,EAAE,CAAC,cAAc,GAAG,cAAc,CAAC;AACnC,EAAE,CAAC,WAAW,GAAG,WAAW,CAAC;AAC7B,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC;AACnB,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC;AACnB,EAAE,CAAC,SAAS,GAAG,SAAS,CAAC;AACzB,EAAE,CAAC,SAAS,GAAG,SAAS,CAAC"}

package/resources/v1/watchlist.d.mts

@@ -139,11 +139,13 @@ export interface WatchlistItemEntry {
      */
     added_at: string;
     /**
-     * Price when the item was added
+     * Price when the item was added When a null/undefined value is observed, it
+     * indicates that there is no available data.
      */
     added_price?: string | null;
     /**
-     * Instrument details
+     * Instrument details When a null/undefined value is observed, it indicates that
+     * there is no available data.
      */
     instrument?: InstrumentsAPI.Instrument | null;
 }

package/resources/v1/watchlist.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"watchlist.d.mts","sourceRoot":"","sources":["../../src/resources/v1/watchlist.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,MAAM,sBAAkB;AACpC,OAAO,KAAK,cAAc,0BAAsB;AAChD,OAAO,KAAK,SAAS,qBAAiB;AACtC,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;OAUG;IACH,gBAAgB,CACd,WAAW,EAAE,MAAM,EACnB,IAAI,EAAE,+BAA+B,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;IAIhD;;;;;;;;;OASG;IACH,eAAe,CACb,IAAI,EAAE,8BAA8B,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gCAAgC,CAAC;IAI/C;;;;;;;;;OASG;IACH,eAAe,CACb,WAAW,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gCAAgC,CAAC;IAI/C;;;;;;;;;;;;;OAaG;IACH,mBAAmB,CACjB,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,kCAAkC,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oCAAoC,CAAC;IAKnD;;;;;;;;;OASG;IACH,gBAAgB,CACd,WAAW,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;IAIhD;;;;;;;OAOG;IACH,aAAa,CACX,KAAK,GAAE,4BAA4B,GAAG,IAAI,GAAG,SAAc,EAC3D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;CAG9C;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAEjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,MAAM,kBAAkB,GAAG,KAAK,CAAC,cAAc,CAAC,CAAC;AAEvD;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,UAAU,CAAC,EAAE,cAAc,CAAC,UAAU,GAAG,IAAI,CAAC;CAC/C;AAED,MAAM,WAAW,iCAAkC,SAAQ,MAAM,CAAC,YAAY;IAC5E;;OAEG;IACH,IAAI,EAAE,oBAAoB,CAAC;CAC5B;AAED,MAAM,WAAW,gCAAiC,SAAQ,MAAM,CAAC,YAAY;IAC3E;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;CACtB;AAED,MAAM,WAAW,gCAAiC,SAAQ,MAAM,CAAC,YAAY;IAC3E,IAAI,EAAE,IAAI,CAAC;CACZ;AAED,MAAM,WAAW,oCAAqC,SAAQ,MAAM,CAAC,YAAY;IAC/E,IAAI,EAAE,IAAI,CAAC;CACZ;AAED,MAAM,WAAW,iCAAkC,SAAQ,MAAM,CAAC,YAAY;IAC5E;;OAEG;IACH,IAAI,EAAE,eAAe,CAAC;CACvB;AAED,MAAM,WAAW,8BAA+B,SAAQ,MAAM,CAAC,YAAY;IACzE,IAAI,EAAE,kBAAkB,CAAC;CAC1B;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,aAAa,EAAE,SAAS,CAAC,oBAAoB,CAAC;CAC/C;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,4BAA4B;IAC3C;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
+{"version":3,"file":"watchlist.d.mts","sourceRoot":"","sources":["../../src/resources/v1/watchlist.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,MAAM,sBAAkB;AACpC,OAAO,KAAK,cAAc,0BAAsB;AAChD,OAAO,KAAK,SAAS,qBAAiB;AACtC,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;OAUG;IACH,gBAAgB,CACd,WAAW,EAAE,MAAM,EACnB,IAAI,EAAE,+BAA+B,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;IAIhD;;;;;;;;;OASG;IACH,eAAe,CACb,IAAI,EAAE,8BAA8B,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gCAAgC,CAAC;IAI/C;;;;;;;;;OASG;IACH,eAAe,CACb,WAAW,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gCAAgC,CAAC;IAI/C;;;;;;;;;;;;;OAaG;IACH,mBAAmB,CACjB,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,kCAAkC,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oCAAoC,CAAC;IAKnD;;;;;;;;;OASG;IACH,gBAAgB,CACd,WAAW,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;IAIhD;;;;;;;OAOG;IACH,aAAa,CACX,KAAK,GAAE,4BAA4B,GAAG,IAAI,GAAG,SAAc,EAC3D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;CAG9C;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAEjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,MAAM,kBAAkB,GAAG,KAAK,CAAC,cAAc,CAAC,CAAC;AAEvD;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,UAAU,CAAC,EAAE,cAAc,CAAC,UAAU,GAAG,IAAI,CAAC;CAC/C;AAED,MAAM,WAAW,iCAAkC,SAAQ,MAAM,CAAC,YAAY;IAC5E;;OAEG;IACH,IAAI,EAAE,oBAAoB,CAAC;CAC5B;AAED,MAAM,WAAW,gCAAiC,SAAQ,MAAM,CAAC,YAAY;IAC3E;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;CACtB;AAED,MAAM,WAAW,gCAAiC,SAAQ,MAAM,CAAC,YAAY;IAC3E,IAAI,EAAE,IAAI,CAAC;CACZ;AAED,MAAM,WAAW,oCAAqC,SAAQ,MAAM,CAAC,YAAY;IAC/E,IAAI,EAAE,IAAI,CAAC;CACZ;AAED,MAAM,WAAW,iCAAkC,SAAQ,MAAM,CAAC,YAAY;IAC5E;;OAEG;IACH,IAAI,EAAE,eAAe,CAAC;CACvB;AAED,MAAM,WAAW,8BAA+B,SAAQ,MAAM,CAAC,YAAY;IACzE,IAAI,EAAE,kBAAkB,CAAC;CAC1B;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,aAAa,EAAE,SAAS,CAAC,oBAAoB,CAAC;CAC/C;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,4BAA4B;IAC3C;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}

package/resources/v1/watchlist.d.ts

@@ -139,11 +139,13 @@ export interface WatchlistItemEntry {
      */
     added_at: string;
     /**
-     * Price when the item was added
+     * Price when the item was added When a null/undefined value is observed, it
+     * indicates that there is no available data.
      */
     added_price?: string | null;
     /**
-     * Instrument details
+     * Instrument details When a null/undefined value is observed, it indicates that
+     * there is no available data.
      */
     instrument?: InstrumentsAPI.Instrument | null;
 }

package/resources/v1/watchlist.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"watchlist.d.ts","sourceRoot":"","sources":["../../src/resources/v1/watchlist.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,MAAM,qBAAkB;AACpC,OAAO,KAAK,cAAc,yBAAsB;AAChD,OAAO,KAAK,SAAS,oBAAiB;AACtC,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;OAUG;IACH,gBAAgB,CACd,WAAW,EAAE,MAAM,EACnB,IAAI,EAAE,+BAA+B,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;IAIhD;;;;;;;;;OASG;IACH,eAAe,CACb,IAAI,EAAE,8BAA8B,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gCAAgC,CAAC;IAI/C;;;;;;;;;OASG;IACH,eAAe,CACb,WAAW,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gCAAgC,CAAC;IAI/C;;;;;;;;;;;;;OAaG;IACH,mBAAmB,CACjB,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,kCAAkC,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oCAAoC,CAAC;IAKnD;;;;;;;;;OASG;IACH,gBAAgB,CACd,WAAW,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;IAIhD;;;;;;;OAOG;IACH,aAAa,CACX,KAAK,GAAE,4BAA4B,GAAG,IAAI,GAAG,SAAc,EAC3D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;CAG9C;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAEjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,MAAM,kBAAkB,GAAG,KAAK,CAAC,cAAc,CAAC,CAAC;AAEvD;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,UAAU,CAAC,EAAE,cAAc,CAAC,UAAU,GAAG,IAAI,CAAC;CAC/C;AAED,MAAM,WAAW,iCAAkC,SAAQ,MAAM,CAAC,YAAY;IAC5E;;OAEG;IACH,IAAI,EAAE,oBAAoB,CAAC;CAC5B;AAED,MAAM,WAAW,gCAAiC,SAAQ,MAAM,CAAC,YAAY;IAC3E;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;CACtB;AAED,MAAM,WAAW,gCAAiC,SAAQ,MAAM,CAAC,YAAY;IAC3E,IAAI,EAAE,IAAI,CAAC;CACZ;AAED,MAAM,WAAW,oCAAqC,SAAQ,MAAM,CAAC,YAAY;IAC/E,IAAI,EAAE,IAAI,CAAC;CACZ;AAED,MAAM,WAAW,iCAAkC,SAAQ,MAAM,CAAC,YAAY;IAC5E;;OAEG;IACH,IAAI,EAAE,eAAe,CAAC;CACvB;AAED,MAAM,WAAW,8BAA+B,SAAQ,MAAM,CAAC,YAAY;IACzE,IAAI,EAAE,kBAAkB,CAAC;CAC1B;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,aAAa,EAAE,SAAS,CAAC,oBAAoB,CAAC;CAC/C;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,4BAA4B;IAC3C;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
+{"version":3,"file":"watchlist.d.ts","sourceRoot":"","sources":["../../src/resources/v1/watchlist.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,MAAM,qBAAkB;AACpC,OAAO,KAAK,cAAc,yBAAsB;AAChD,OAAO,KAAK,SAAS,oBAAiB;AACtC,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;OAUG;IACH,gBAAgB,CACd,WAAW,EAAE,MAAM,EACnB,IAAI,EAAE,+BAA+B,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;IAIhD;;;;;;;;;OASG;IACH,eAAe,CACb,IAAI,EAAE,8BAA8B,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gCAAgC,CAAC;IAI/C;;;;;;;;;OASG;IACH,eAAe,CACb,WAAW,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gCAAgC,CAAC;IAI/C;;;;;;;;;;;;;OAaG;IACH,mBAAmB,CACjB,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,kCAAkC,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oCAAoC,CAAC;IAKnD;;;;;;;;;OASG;IACH,gBAAgB,CACd,WAAW,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;IAIhD;;;;;;;OAOG;IACH,aAAa,CACX,KAAK,GAAE,4BAA4B,GAAG,IAAI,GAAG,SAAc,EAC3D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;CAG9C;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAEjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,MAAM,kBAAkB,GAAG,KAAK,CAAC,cAAc,CAAC,CAAC;AAEvD;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,UAAU,CAAC,EAAE,cAAc,CAAC,UAAU,GAAG,IAAI,CAAC;CAC/C;AAED,MAAM,WAAW,iCAAkC,SAAQ,MAAM,CAAC,YAAY;IAC5E;;OAEG;IACH,IAAI,EAAE,oBAAoB,CAAC;CAC5B;AAED,MAAM,WAAW,gCAAiC,SAAQ,MAAM,CAAC,YAAY;IAC3E;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;CACtB;AAED,MAAM,WAAW,gCAAiC,SAAQ,MAAM,CAAC,YAAY;IAC3E,IAAI,EAAE,IAAI,CAAC;CACZ;AAED,MAAM,WAAW,oCAAqC,SAAQ,MAAM,CAAC,YAAY;IAC/E,IAAI,EAAE,IAAI,CAAC;CACZ;AAED,MAAM,WAAW,iCAAkC,SAAQ,MAAM,CAAC,YAAY;IAC5E;;OAEG;IACH,IAAI,EAAE,eAAe,CAAC;CACvB;AAED,MAAM,WAAW,8BAA+B,SAAQ,MAAM,CAAC,YAAY;IACzE,IAAI,EAAE,kBAAkB,CAAC;CAC1B;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,aAAa,EAAE,SAAS,CAAC,oBAAoB,CAAC;CAC/C;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,4BAA4B;IAC3C;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}

package/src/resources/v1/accounts.ts

@@ -142,7 +142,8 @@ export interface Account {
   type: AccountType;
 
   /**
-   * The date the account was closed, if applicable
+   * The date the account was closed, if applicable When a null/undefined value is
+   * observed, it indicates it does not apply.
    */
   close_date?: string | null;
 }
@@ -232,17 +233,20 @@ export interface AccountBalances {
   withdrawable_cash: string;
 
   /**
-   * Margin-account-only details.
+   * Margin-account-only details. When a null/undefined value is observed, it
+   * indicates it does not apply.
    */
   margin_details?: MarginDetails | null;
 
   /**
-   * Applied multiplier for margin calculations.
+   * Applied multiplier for margin calculations. When a null/undefined value is
+   * observed, it indicates it does not apply.
    */
   multiplier?: string | null;
 
   /**
-   * The total market value of all short positions.
+   * The total market value of all short positions. When null/undefined, the value
+   * should be assumed to be zero. The field is omitted to simplify the response.
    */
   short_market_value?: string | null;
 }
@@ -269,27 +273,32 @@ export interface AccountBalancesSod {
   short_market_value: string;
 
   /**
-   * Timestamp for the start-of-day values.
+   * Timestamp for the start-of-day values. When a null/undefined value is observed,
+   * it indicates that there is no available data.
    */
   asof?: string | null;
 
   /**
-   * @deprecated Start-of-day day-trade buying power.
+   * @deprecated Start-of-day day-trade buying power. When a null/undefined value is
+   * observed, it indicates it does not apply.
    */
   day_trade_buying_power?: string | null;
 
   /**
-   * Start-of-day maintenance margin excess.
+   * Start-of-day maintenance margin excess. When a null/undefined value is observed,
+   * it indicates it does not apply.
    */
   maintenance_margin_excess?: string | null;
 
   /**
-   * Start-of-day maintenance margin requirement.
+   * Start-of-day maintenance margin requirement. When a null/undefined value is
+   * observed, it indicates it does not apply.
    */
   maintenance_margin_requirement?: string | null;
 
   /**
-   * Start-of-day trade cash.
+   * Start-of-day trade cash. When a null/undefined value is observed, it indicates
+   * it does not apply.
    */
   trade_cash?: string | null;
 }
@@ -298,7 +307,8 @@ export type AccountList = Array<Account>;
 
 export interface AccountSettings {
   /**
-   * Risk settings for the account
+   * Risk settings for the account When a null/undefined value is observed, it
+   * indicates that there is no available data.
    */
   risk?: RiskSettings | null;
 }
@@ -363,7 +373,8 @@ export interface MarginDetails {
 
   /**
    * @deprecated The amount of day-trade buying power used during the current trading
-   * day.
+   * day. When null/undefined, the value should be assumed to be zero. The field is
+   * omitted to simplify the response.
    */
   day_trade_buying_power_usage?: string | null;
 
@@ -373,7 +384,8 @@ export interface MarginDetails {
   top_contributors?: Array<MarginTopContributor>;
 
   /**
-   * Current usage totals.
+   * Current usage totals. When a null/undefined value is observed, it indicates that
+   * there is no available data.
    */
   usage?: MarginDetailsUsage | null;
 }
@@ -507,7 +519,8 @@ export interface PortfolioHistorySegment {
  */
 export interface RiskSettings {
   /**
-   * The maximum notional value available to the account
+   * The maximum notional value available to the account When a null/undefined value
+   * is observed, it indicates that there is no available data.
    */
   max_notional?: string | null;
 }

package/src/resources/v1/calendar.ts

@@ -124,7 +124,8 @@ export interface MarketStatus {
   is_open: boolean;
 
   /**
-   * Current session type if market is open, null if closed
+   * Current session type if market is open, null if closed When a null/undefined
+   * value is observed, it indicates it does not apply.
    */
   current_session?: MarketSessionType | null;
 }
@@ -150,12 +151,13 @@ export interface SessionSchedule {
 
   /**
    * ISO 8601 duration until session closes. Null if session is not currently open.
+   * When a null/undefined value is observed, it indicates it does not apply.
    */
   time_until_close?: string | null;
 
   /**
    * ISO 8601 duration until session opens. Null if session has already started or
-   * closed.
+   * closed. When a null/undefined value is observed, it indicates it does not apply.
    */
   time_until_open?: string | null;
 }
@@ -165,17 +167,20 @@ export interface SessionSchedule {
  */
 export interface TradingSessions {
   /**
-   * After-hours session schedule, null if not available
+   * After-hours session schedule, null if not available When a null/undefined value
+   * is observed, it indicates it does not apply.
    */
   after_hours?: SessionSchedule | null;
 
   /**
-   * Pre-market session schedule, null if not available
+   * Pre-market session schedule, null if not available When a null/undefined value
+   * is observed, it indicates it does not apply.
    */
   pre_market?: SessionSchedule | null;
 
   /**
-   * Regular trading session schedule, null if holiday/weekend
+   * Regular trading session schedule, null if holiday/weekend When a null/undefined
+   * value is observed, it indicates it does not apply.
    */
   regular?: SessionSchedule | null;
 }

package/src/resources/v1/index.ts

@@ -201,4 +201,3 @@ export {
   type WatchlistDeleteWatchlistItemParams,
   type WatchlistGetWatchlistsParams,
 } from './watchlist';
-export { Websocket } from './websocket';

package/src/resources/v1/instrument-data/instrument-data.ts

@@ -264,17 +264,20 @@ export interface InstrumentAnalystConsensus {
   date: string;
 
   /**
-   * Count of individual analyst recommendations by category
+   * Count of individual analyst recommendations by category When a null/undefined
+   * value is observed, it indicates that there is no available data.
    */
   distribution?: AnalystDistribution | null;
 
   /**
-   * Aggregated analyst price target statistics
+   * Aggregated analyst price target statistics When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   price_target?: PriceTarget | null;
 
   /**
-   * Consensus analyst rating
+   * Consensus analyst rating When a null/undefined value is observed, it indicates
+   * that there is no available data.
    */
   rating?: AnalystRating | null;
 }
@@ -823,35 +826,41 @@ export interface InstrumentDividendEvent {
   ex_date: string;
 
   /**
-   * The declaration date of the dividend
+   * The declaration date of the dividend When a null/undefined value is observed, it
+   * indicates that there is no available data.
    */
   declaration_date?: string | null;
 
   /**
-   * The dividend amount per share.
+   * The dividend amount per share. When a null/undefined value is observed, it
+   * indicates that there is no available data.
    */
   dividend_amount?: string | null;
 
   /**
-   * The dividend yield as a percentage of the stock price.
+   * The dividend yield as a percentage of the stock price. When a null/undefined
+   * value is observed, it indicates that there is no available data.
    */
   dividend_yield?: string | null;
 
   /**
-   * The frequency of the dividend payments (e.g., "Quarterly", "Annual").
+   * The frequency of the dividend payments (e.g., "Quarterly", "Annual"). When a
+   * null/undefined value is observed, it indicates that there is no available data.
    */
   frequency?: string | null;
 
   /**
    * The payment date is the date on which a declared stock dividend is scheduled to
-   * be paid.
+   * be paid. When a null/undefined value is observed, it indicates that there is no
+   * available data.
    */
   payment_date?: string | null;
 
   /**
    * The record date, set by a company's board of directors, is when a company
    * compiles a list of shareholders of the stock for which it has declared a
-   * dividend.
+   * dividend. When a null/undefined value is observed, it indicates that there is no
+   * available data.
    */
   record_date?: string | null;
 }
@@ -866,32 +875,38 @@ export interface InstrumentEarnings {
   date: string;
 
   /**
-   * The actual earnings per share (EPS) for the period
+   * The actual earnings per share (EPS) for the period When a null/undefined value
+   * is observed, it indicates that there is no available data.
    */
   eps_actual?: string | null;
 
   /**
-   * The estimated earnings per share (EPS) for the period
+   * The estimated earnings per share (EPS) for the period When a null/undefined
+   * value is observed, it indicates that there is no available data.
    */
   eps_estimate?: string | null;
 
   /**
-   * The percentage difference between actual and estimated EPS
+   * The percentage difference between actual and estimated EPS When a null/undefined
+   * value is observed, it indicates that there is no available data.
    */
   eps_surprise_percent?: string | null;
 
   /**
-   * The actual total revenue for the period
+   * The actual total revenue for the period When a null/undefined value is observed,
+   * it indicates that there is no available data.
    */
   revenue_actual?: string | null;
 
   /**
-   * The estimated total revenue for the period
+   * The estimated total revenue for the period When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   revenue_estimate?: string | null;
 
   /**
-   * The percentage difference between actual and estimated revenue
+   * The percentage difference between actual and estimated revenue When a
+   * null/undefined value is observed, it indicates that there is no available data.
    */
   revenue_surprise_percent?: string | null;
 }
@@ -911,37 +926,44 @@ export interface InstrumentEventEnvelope {
   type: AllEventsEventType;
 
   /**
-   * Dividend payload when type is DIVIDEND.
+   * Dividend payload when type is DIVIDEND. When a null/undefined value is observed,
+   * it indicates it does not apply.
    */
   dividend_event_data?: InstrumentDividendEvent | null;
 
   /**
-   * Earnings payload when type is EARNINGS.
+   * Earnings payload when type is EARNINGS. When a null/undefined value is observed,
+   * it indicates it does not apply.
    */
   earnings_event_data?: InstrumentEarnings | null;
 
   /**
-   * Instrument identifier, when available.
+   * Instrument identifier, when available. When a null/undefined value is observed,
+   * it indicates that there is no available data.
    */
   instrument_id?: string | null;
 
   /**
-   * IPO payload when type is IPO.
+   * IPO payload when type is IPO. When a null/undefined value is observed, it
+   * indicates it does not apply.
    */
   ipo_event_data?: InstrumentEventIpoItem | null;
 
   /**
-   * Instrument name associated with the event, when available.
+   * Instrument name associated with the event, when available. When a null/undefined
+   * value is observed, it indicates that there is no available data.
    */
   name?: string | null;
 
   /**
-   * The currency used for reporting financial data.
+   * The currency used for reporting financial data. When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   reporting_currency?: string | null;
 
   /**
-   * Stock split payload when type is STOCK_SPLIT.
+   * Stock split payload when type is STOCK_SPLIT. When a null/undefined value is
+   * observed, it indicates it does not apply.
    */
   stock_split_event_data?: InstrumentSplitEvent | null;
 }
@@ -951,37 +973,44 @@ export interface InstrumentEventEnvelope {
  */
 export interface InstrumentEventIpoItem {
   /**
-   * IPO action.
+   * IPO action. When a null/undefined value is observed, it indicates that there is
+   * no available data.
    */
   actions?: string | null;
 
   /**
-   * IPO announced timestamp.
+   * IPO announced timestamp. When a null/undefined value is observed, it indicates
+   * that there is no available data.
    */
   announced_at?: string | null;
 
   /**
-   * IPO company name.
+   * IPO company name. When a null/undefined value is observed, it indicates that
+   * there is no available data.
    */
   company?: string | null;
 
   /**
-   * IPO exchange.
+   * IPO exchange. When a null/undefined value is observed, it indicates that there
+   * is no available data.
    */
   exchange?: string | null;
 
   /**
-   * IPO market cap.
+   * IPO market cap. When a null/undefined value is observed, it indicates that there
+   * is no available data.
    */
   market_cap?: string | null;
 
   /**
-   * IPO price range.
+   * IPO price range. When a null/undefined value is observed, it indicates that
+   * there is no available data.
    */
   price_range?: string | null;
 
   /**
-   * IPO shares offered.
+   * IPO shares offered. When a null/undefined value is observed, it indicates that
+   * there is no available data.
    */
   shares?: string | null;
 }
@@ -1026,7 +1055,8 @@ export interface InstrumentEventsData {
   splits: Array<InstrumentSplitEvent>;
 
   /**
-   * The currency used for reporting financial data
+   * The currency used for reporting financial data When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   reporting_currency?: string | null;
 }
@@ -1036,78 +1066,93 @@ export interface InstrumentEventsData {
  */
 export interface InstrumentFundamentals {
   /**
-   * The average daily trading volume over the past 30 days
+   * The average daily trading volume over the past 30 days When a null/undefined
+   * value is observed, it indicates that there is no available data.
    */
   average_volume?: number | null;
 
   /**
    * The beta value, measuring the instrument's volatility relative to the overall
-   * market
+   * market When a null/undefined value is observed, it indicates that there is no
+   * available data.
    */
   beta?: string | null;
 
   /**
-   * A detailed description of the instrument or company
+   * A detailed description of the instrument or company When a null/undefined value
+   * is observed, it indicates that there is no available data.
    */
   description?: string | null;
 
   /**
-   * The trailing twelve months (TTM) dividend yield
+   * The trailing twelve months (TTM) dividend yield When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   dividend_yield?: string | null;
 
   /**
-   * The trailing twelve months (TTM) earnings per share
+   * The trailing twelve months (TTM) earnings per share When a null/undefined value
+   * is observed, it indicates that there is no available data.
    */
   earnings_per_share?: string | null;
 
   /**
-   * The highest price over the last 52 weeks
+   * The highest price over the last 52 weeks When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   fifty_two_week_high?: string | null;
 
   /**
-   * The lowest price over the last 52 weeks
+   * The lowest price over the last 52 weeks When a null/undefined value is observed,
+   * it indicates that there is no available data.
    */
   fifty_two_week_low?: string | null;
 
   /**
-   * The specific industry of the instrument's issuer
+   * The specific industry of the instrument's issuer When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   industry?: string | null;
 
   /**
-   * The date the instrument was first listed
+   * The date the instrument was first listed When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   list_date?: string | null;
 
   /**
-   * URL to a representative logo image for the instrument or issuer
+   * URL to a representative logo image for the instrument or issuer When a
+   * null/undefined value is observed, it indicates that there is no available data.
    */
   logo_url?: string | null;
 
   /**
-   * The total market capitalization
+   * The total market capitalization When a null/undefined value is observed, it
+   * indicates that there is no available data.
    */
   market_cap?: string | null;
 
   /**
-   * The closing price from the previous trading day
+   * The closing price from the previous trading day When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   previous_close?: string | null;
 
   /**
-   * The price-to-earnings (P/E) ratio for the trailing twelve months (TTM)
+   * The price-to-earnings (P/E) ratio for the trailing twelve months (TTM) When a
+   * null/undefined value is observed, it indicates that there is no available data.
    */
   price_to_earnings?: string | null;
 
   /**
-   * The currency used for reporting financial data
+   * The currency used for reporting financial data When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   reporting_currency?: string | null;
 
   /**
-   * The business sector of the instrument's issuer
+   * The business sector of the instrument's issuer When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   sector?: string | null;
 }