@clear-street/clearstreet 0.0.0 → 0.73.0

package/src/resources/v1/watchlist.ts

@@ -0,0 +1,292 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as Shared from '../shared';
+import * as InstrumentsAPI from './instruments';
+import * as OrdersAPI from './orders';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+/**
+ * Create and manage watchlists.
+ */
+export class Watchlist extends APIResource {
+  /**
+   * Add an instrument to a watchlist
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.watchlist.addWatchlistItem(
+   *   '550e8400-e29b-41d4-a716-446655440000',
+   *   { instrument_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
+   * );
+   * ```
+   */
+  addWatchlistItem(
+    watchlistID: string,
+    body: WatchlistAddWatchlistItemParams,
+    options?: RequestOptions,
+  ): APIPromise<WatchlistAddWatchlistItemResponse> {
+    return this._client.post(path`/v1/watchlists/${watchlistID}/items`, { body, ...options });
+  }
+
+  /**
+   * Create Watchlist
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.watchlist.createWatchlist({
+   *   name: 'name',
+   * });
+   * ```
+   */
+  createWatchlist(
+    body: WatchlistCreateWatchlistParams,
+    options?: RequestOptions,
+  ): APIPromise<WatchlistCreateWatchlistResponse> {
+    return this._client.post('/v1/watchlists', { body, ...options });
+  }
+
+  /**
+   * Delete a watchlist and all its items
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.watchlist.deleteWatchlist(
+   *   '550e8400-e29b-41d4-a716-446655440000',
+   * );
+   * ```
+   */
+  deleteWatchlist(
+    watchlistID: string,
+    options?: RequestOptions,
+  ): APIPromise<WatchlistDeleteWatchlistResponse> {
+    return this._client.delete(path`/v1/watchlists/${watchlistID}`, options);
+  }
+
+  /**
+   * Delete an instrument from a watchlist
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.v1.watchlist.deleteWatchlistItem(
+   *     '660e8400-e29b-41d4-a716-446655440001',
+   *     {
+   *       watchlist_id: '550e8400-e29b-41d4-a716-446655440000',
+   *     },
+   *   );
+   * ```
+   */
+  deleteWatchlistItem(
+    itemID: string,
+    params: WatchlistDeleteWatchlistItemParams,
+    options?: RequestOptions,
+  ): APIPromise<WatchlistDeleteWatchlistItemResponse> {
+    const { watchlist_id } = params;
+    return this._client.delete(path`/v1/watchlists/${watchlist_id}/items/${itemID}`, options);
+  }
+
+  /**
+   * Get a watchlist by ID with all its items
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.watchlist.getWatchlistByID(
+   *   '550e8400-e29b-41d4-a716-446655440000',
+   * );
+   * ```
+   */
+  getWatchlistByID(
+    watchlistID: string,
+    options?: RequestOptions,
+  ): APIPromise<WatchlistGetWatchlistByIDResponse> {
+    return this._client.get(path`/v1/watchlists/${watchlistID}`, options);
+  }
+
+  /**
+   * List watchlists for the authenticated user
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.watchlist.getWatchlists();
+   * ```
+   */
+  getWatchlists(
+    query: WatchlistGetWatchlistsParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<WatchlistGetWatchlistsResponse> {
+    return this._client.get('/v1/watchlists', { query, ...options });
+  }
+}
+
+/**
+ * Response data for adding a watchlist item
+ */
+export interface AddWatchlistItemData {
+  /**
+   * ID of the created item
+   */
+  item_id: string;
+}
+
+/**
+ * Detailed watchlist with all items
+ */
+export interface WatchlistDetail {
+  /**
+   * Watchlist ID
+   */
+  id: string;
+
+  /**
+   * Creation timestamp
+   */
+  created_at: string;
+
+  /**
+   * Items in the watchlist
+   */
+  items: Array<WatchlistItemEntry>;
+
+  /**
+   * Watchlist name
+   */
+  name: string;
+}
+
+/**
+ * Represents a user watchlist.
+ */
+export interface WatchlistEntry {
+  /**
+   * The unique identifier for the watchlist.
+   */
+  id: string;
+
+  /**
+   * The timestamp when the watchlist was created.
+   */
+  created_at: string;
+
+  /**
+   * The user-provided watchlist name.
+   */
+  name: string;
+}
+
+export type WatchlistEntryList = Array<WatchlistEntry>;
+
+/**
+ * A single item in a watchlist
+ */
+export interface WatchlistItemEntry {
+  /**
+   * Item ID
+   */
+  id: string;
+
+  /**
+   * When the item was added
+   */
+  added_at: string;
+
+  /**
+   * Price when the item was added
+   */
+  added_price?: string | null;
+
+  /**
+   * Instrument details
+   */
+  instrument?: InstrumentsAPI.Instrument | null;
+}
+
+export interface WatchlistAddWatchlistItemResponse extends Shared.BaseResponse {
+  /**
+   * Response data for adding a watchlist item
+   */
+  data: AddWatchlistItemData;
+}
+
+export interface WatchlistCreateWatchlistResponse extends Shared.BaseResponse {
+  /**
+   * Represents a user watchlist.
+   */
+  data: WatchlistEntry;
+}
+
+export interface WatchlistDeleteWatchlistResponse extends Shared.BaseResponse {
+  data: null;
+}
+
+export interface WatchlistDeleteWatchlistItemResponse extends Shared.BaseResponse {
+  data: null;
+}
+
+export interface WatchlistGetWatchlistByIDResponse extends Shared.BaseResponse {
+  /**
+   * Detailed watchlist with all items
+   */
+  data: WatchlistDetail;
+}
+
+export interface WatchlistGetWatchlistsResponse extends Shared.BaseResponse {
+  data: WatchlistEntryList;
+}
+
+export interface WatchlistAddWatchlistItemParams {
+  /**
+   * OEMS instrument UUID
+   */
+  instrument_id: OrdersAPI.InstrumentIDOrSymbol;
+}
+
+export interface WatchlistCreateWatchlistParams {
+  /**
+   * The desired watchlist name.
+   */
+  name: string;
+}
+
+export interface WatchlistDeleteWatchlistItemParams {
+  /**
+   * Watchlist ID
+   */
+  watchlist_id: string;
+}
+
+export interface WatchlistGetWatchlistsParams {
+  /**
+   * The number of items to return per page. Only used when page_token is not
+   * provided.
+   */
+  page_size?: number;
+
+  /**
+   * Token for retrieving the next or previous page of results. Contains encoded
+   * pagination state; when provided, page_size is ignored.
+   */
+  page_token?: string;
+}
+
+export declare namespace Watchlist {
+  export {
+    type AddWatchlistItemData as AddWatchlistItemData,
+    type WatchlistDetail as WatchlistDetail,
+    type WatchlistEntry as WatchlistEntry,
+    type WatchlistEntryList as WatchlistEntryList,
+    type WatchlistItemEntry as WatchlistItemEntry,
+    type WatchlistAddWatchlistItemResponse as WatchlistAddWatchlistItemResponse,
+    type WatchlistCreateWatchlistResponse as WatchlistCreateWatchlistResponse,
+    type WatchlistDeleteWatchlistResponse as WatchlistDeleteWatchlistResponse,
+    type WatchlistDeleteWatchlistItemResponse as WatchlistDeleteWatchlistItemResponse,
+    type WatchlistGetWatchlistByIDResponse as WatchlistGetWatchlistByIDResponse,
+    type WatchlistGetWatchlistsResponse as WatchlistGetWatchlistsResponse,
+    type WatchlistAddWatchlistItemParams as WatchlistAddWatchlistItemParams,
+    type WatchlistCreateWatchlistParams as WatchlistCreateWatchlistParams,
+    type WatchlistDeleteWatchlistItemParams as WatchlistDeleteWatchlistItemParams,
+    type WatchlistGetWatchlistsParams as WatchlistGetWatchlistsParams,
+  };
+}

package/src/resources/v1/websocket.ts

@@ -0,0 +1,26 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+
+/**
+ * Active Websocket.
+ */
+export class Websocket extends APIResource {
+  /**
+   * Upgrade the HTTP connection to a WebSocket and echo incoming messages.
+   *
+   * @example
+   * ```ts
+   * await client.v1.websocket.websocketHandler();
+   * ```
+   */
+  websocketHandler(options?: RequestOptions): APIPromise<void> {
+    return this._client.get('/v1/ws', {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}

package/src/resources/v1.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './v1/index';

package/src/resources.ts

@@ -0,0 +1 @@
+export * from './resources/index';

package/src/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  // this config is included in the published src directory to prevent TS errors
+  // from appearing when users go to source, and VSCode opens the source .ts file
+  // via declaration maps
+  "include": ["index.ts"],
+  "compilerOptions": {
+    "target": "ES2015",
+    "lib": ["DOM", "DOM.Iterable", "ES2018"],
+    "moduleResolution": "node"
+  }
+}

package/src/uploads.ts

@@ -0,0 +1,2 @@
+/** @deprecated Import from ./core/uploads instead */
+export * from './core/uploads';

package/src/version.ts

@@ -0,0 +1 @@
+export const VERSION = '0.73.0'; // x-release-please-version

package/uploads.d.mts

@@ -0,0 +1,3 @@
+/** @deprecated Import from ./core/uploads instead */
+export * from "./core/uploads.mjs";
+//# sourceMappingURL=uploads.d.mts.map

package/uploads.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.d.mts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":"AAAA,qDAAqD;AACrD,mCAA+B"}

package/uploads.d.ts

@@ -0,0 +1,3 @@
+/** @deprecated Import from ./core/uploads instead */
+export * from "./core/uploads.js";
+//# sourceMappingURL=uploads.d.ts.map

package/uploads.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.d.ts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":"AAAA,qDAAqD;AACrD,kCAA+B"}

package/uploads.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("./internal/tslib.js");
+/** @deprecated Import from ./core/uploads instead */
+tslib_1.__exportStar(require("./core/uploads.js"), exports);
+//# sourceMappingURL=uploads.js.map

package/uploads.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.js","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":";;;AAAA,qDAAqD;AACrD,4DAA+B"}

package/uploads.mjs

@@ -0,0 +1,3 @@
+/** @deprecated Import from ./core/uploads instead */
+export * from "./core/uploads.mjs";
+//# sourceMappingURL=uploads.mjs.map

package/uploads.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.mjs","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":"AAAA,qDAAqD;AACrD,mCAA+B"}

package/version.d.mts

@@ -0,0 +1,2 @@
+export declare const VERSION = "0.73.0";
+//# sourceMappingURL=version.d.mts.map

package/version.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.mts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,WAAW,CAAC"}

package/version.d.ts

@@ -0,0 +1,2 @@
+export declare const VERSION = "0.73.0";
+//# sourceMappingURL=version.d.ts.map

package/version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,WAAW,CAAC"}

package/version.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VERSION = void 0;
+exports.VERSION = '0.73.0'; // x-release-please-version
+//# sourceMappingURL=version.js.map

package/version.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,QAAQ,CAAC,CAAC,2BAA2B"}

package/version.mjs

@@ -0,0 +1,2 @@
+export const VERSION = '0.73.0'; // x-release-please-version
+//# sourceMappingURL=version.mjs.map

package/version.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,2BAA2B"}