Merge pull request #28 from clear-street/release-please--branches--ma…

…in--changes--next--components--studio-sdk release: 0.1.0-alpha.7
clear-street · Aug 30, 2024 · 4afd83d · 4afd83d
2 parents 472dfc0 + 68d9553
commit 4afd83d
Show file tree

Hide file tree

Showing 12 changed files with 69 additions and 527 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -22,8 +22,8 @@ jobs:
         with:
           node-version: '18'
 
-      - name: Install dependencies
-        run: yarn install
+      - name: Bootstrap
+        run: ./scripts/bootstrap
 
       - name: Check types
         run: ./scripts/lint
@@ -41,8 +41,8 @@ jobs:
         with:
           node-version: '18'
 
-      - name: Install dependencies
-        run: yarn install
+      - name: Bootstrap
+        run: ./scripts/bootstrap
 
       - name: Check build
         run: ./scripts/build

diff --git a/.release-please-manifest.json b/.release-please-manifest.json
@@ -1,3 +1,3 @@
 {
-  ".": "0.1.0-alpha.6"
+  ".": "0.1.0-alpha.7"
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,20 @@
 # Changelog
 
+## 0.1.0-alpha.7 (2024-08-30)
+
+Full Changelog: [v0.1.0-alpha.6...v0.1.0-alpha.7](https://github.com/clear-street/studio-sdk-node/compare/v0.1.0-alpha.6...v0.1.0-alpha.7)
+
+### Features
+
+* **api:** update via SDK Studio ([#30](https://github.com/clear-street/studio-sdk-node/issues/30)) ([ad826be](https://github.com/clear-street/studio-sdk-node/commit/ad826be6ea6678b03691ab72e9eb89f882772be9))
+* **api:** update via SDK Studio ([#31](https://github.com/clear-street/studio-sdk-node/issues/31)) ([6138a55](https://github.com/clear-street/studio-sdk-node/commit/6138a557b80a6cae32b1dcb2ae27d38f223e60bd))
+
+
+### Chores
+
+* **ci:** install deps via ./script/bootstrap ([#29](https://github.com/clear-street/studio-sdk-node/issues/29)) ([19b9d30](https://github.com/clear-street/studio-sdk-node/commit/19b9d3003c642234a8180f9ec82573fd1957e082))
+* run tsc as part of lint script ([#27](https://github.com/clear-street/studio-sdk-node/issues/27)) ([c2e864b](https://github.com/clear-street/studio-sdk-node/commit/c2e864b0f771fc58d577eb32b36bdd1f986e7ccc))
+
 ## 0.1.0-alpha.6 (2024-08-27)
 
 Full Changelog: [v0.1.0-alpha.5...v0.1.0-alpha.6](https://github.com/clear-street/studio-sdk-node/compare/v0.1.0-alpha.5...v0.1.0-alpha.6)

diff --git a/README.md b/README.md
@@ -22,7 +22,9 @@ The full API of this library can be found in [api.md](api.md).
 ```js
 import StudioSDK from '@clear-street/studio-sdk';
 
-const client = new StudioSDK();
+const client = new StudioSDK({
+  bearerToken: process.env['STUDIO_SDK_BEARER_TOKEN'], // This is the default and can be omitted
+});
 
 async function main() {
   const entity = await client.entities.retrieve('<your_entity_id>');
@@ -41,7 +43,9 @@ This library includes TypeScript definitions for all request params and response
 ```ts
 import StudioSDK from '@clear-street/studio-sdk';
 
-const client = new StudioSDK();
+const client = new StudioSDK({
+  bearerToken: process.env['STUDIO_SDK_BEARER_TOKEN'], // This is the default and can be omitted
+});
 
 async function main() {
   const entity: StudioSDK.Entity = await client.entities.retrieve('<your_entity_id>');

diff --git a/api.md b/api.md
@@ -2,11 +2,12 @@
 
 Types:
 
+- <code><a href="./src/resources/shared.ts">BaseStrategy</a></code>
 - <code><a href="./src/resources/shared.ts">LocateOrder</a></code>
 - <code><a href="./src/resources/shared.ts">Order</a></code>
-- <code><a href="./src/resources/shared.ts">PnlSummaryForAccount</a></code>
 - <code><a href="./src/resources/shared.ts">Position</a></code>
 - <code><a href="./src/resources/shared.ts">RegtMarginSimulation</a></code>
+- <code><a href="./src/resources/shared.ts">Strategy</a></code>
 - <code><a href="./src/resources/shared.ts">Trade</a></code>
 
 # Entities

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@clear-street/studio-sdk",
-  "version": "0.1.0-alpha.6",
+  "version": "0.1.0-alpha.7",
   "description": "The official TypeScript library for the Studio SDK API",
   "author": "Studio SDK <[email protected]>",
   "types": "dist/index.d.ts",

diff --git a/scripts/lint b/scripts/lint
@@ -6,3 +6,6 @@ cd "$(dirname "$0")/.."
 
 echo "==> Running eslint"
 ESLINT_USE_FLAT_CONFIG="false" ./node_modules/.bin/eslint --ext ts,js .
+
+echo "==> Running tsc"
+./node_modules/.bin/tsc --noEmit
diff --git a/src/index.ts b/src/index.ts
@@ -196,11 +196,12 @@ export namespace StudioSDK {
   export import Instrument = API.Instrument;
   export import InstrumentRetrieveParams = API.InstrumentRetrieveParams;
 
+  export import BaseStrategy = API.BaseStrategy;
   export import LocateOrder = API.LocateOrder;
   export import Order = API.Order;
-  export import PnlSummaryForAccount = API.PnlSummaryForAccount;
   export import Position = API.Position;
   export import RegtMarginSimulation = API.RegtMarginSimulation;
+  export import Strategy = API.Strategy;
   export import Trade = API.Trade;
 }
 

diff --git a/src/resources/accounts/bulk-orders.ts b/src/resources/accounts/bulk-orders.ts
@@ -3,6 +3,7 @@
 import { APIResource } from '../../resource';
 import * as Core from '../../core';
 import * as BulkOrdersAPI from './bulk-orders';
+import * as Shared from '../shared';
 
 export class BulkOrders extends APIResource {
   /**
@@ -143,153 +144,13 @@ export namespace BulkOrderCreateParams {
      * The execution strategy to use for this order. If not provided, our smart
      * order-router will handle execution for your order.
      */
-    strategy?:
-      | Order.BaseStrategy
-      | Order.BaseStrategy
-      | Order.BaseStrategy
-      | Order.BaseStrategy
-      | Order.BaseStrategy
-      | Order.BaseStrategy;
+    strategy?: Shared.Strategy;
 
     /**
      * Denotes the format of the provided `symbol` field.
      */
     symbol_format?: 'cms' | 'osi';
   }
-
-  export namespace Order {
-    export interface BaseStrategy {
-      /**
-       * The type of strategy. This must be set to the respective strategy type.
-       */
-      type: 'sor' | 'dark' | 'ap' | 'pov' | 'twap' | 'vwap';
-
-      /**
-       * The timestamp to stop routing, defaults to market close.
-       */
-      end_at?: number;
-
-      /**
-       * The timestamp to start routing, defaults to now.
-       */
-      start_at?: number;
-
-      /**
-       * The urgency associated with the execution strategy.
-       */
-      urgency?: 'super-passive' | 'passive' | 'moderate' | 'aggressive' | 'super-aggressive';
-    }
-
-    export interface BaseStrategy {
-      /**
-       * The type of strategy. This must be set to the respective strategy type.
-       */
-      type: 'sor' | 'dark' | 'ap' | 'pov' | 'twap' | 'vwap';
-
-      /**
-       * The timestamp to stop routing, defaults to market close.
-       */
-      end_at?: number;
-
-      /**
-       * The timestamp to start routing, defaults to now.
-       */
-      start_at?: number;
-
-      /**
-       * The urgency associated with the execution strategy.
-       */
-      urgency?: 'super-passive' | 'passive' | 'moderate' | 'aggressive' | 'super-aggressive';
-    }
-
-    export interface BaseStrategy {
-      /**
-       * The type of strategy. This must be set to the respective strategy type.
-       */
-      type: 'sor' | 'dark' | 'ap' | 'pov' | 'twap' | 'vwap';
-
-      /**
-       * The timestamp to stop routing, defaults to market close.
-       */
-      end_at?: number;
-
-      /**
-       * The timestamp to start routing, defaults to now.
-       */
-      start_at?: number;
-
-      /**
-       * The urgency associated with the execution strategy.
-       */
-      urgency?: 'super-passive' | 'passive' | 'moderate' | 'aggressive' | 'super-aggressive';
-    }
-
-    export interface BaseStrategy {
-      /**
-       * The type of strategy. This must be set to the respective strategy type.
-       */
-      type: 'sor' | 'dark' | 'ap' | 'pov' | 'twap' | 'vwap';
-
-      /**
-       * The timestamp to stop routing, defaults to market close.
-       */
-      end_at?: number;
-
-      /**
-       * The timestamp to start routing, defaults to now.
-       */
-      start_at?: number;
-
-      /**
-       * The urgency associated with the execution strategy.
-       */
-      urgency?: 'super-passive' | 'passive' | 'moderate' | 'aggressive' | 'super-aggressive';
-    }
-
-    export interface BaseStrategy {
-      /**
-       * The type of strategy. This must be set to the respective strategy type.
-       */
-      type: 'sor' | 'dark' | 'ap' | 'pov' | 'twap' | 'vwap';
-
-      /**
-       * The timestamp to stop routing, defaults to market close.
-       */
-      end_at?: number;
-
-      /**
-       * The timestamp to start routing, defaults to now.
-       */
-      start_at?: number;
-
-      /**
-       * The urgency associated with the execution strategy.
-       */
-      urgency?: 'super-passive' | 'passive' | 'moderate' | 'aggressive' | 'super-aggressive';
-    }
-
-    export interface BaseStrategy {
-      /**
-       * The type of strategy. This must be set to the respective strategy type.
-       */
-      type: 'sor' | 'dark' | 'ap' | 'pov' | 'twap' | 'vwap';
-
-      /**
-       * The timestamp to stop routing, defaults to market close.
-       */
-      end_at?: number;
-
-      /**
-       * The timestamp to start routing, defaults to now.
-       */
-      start_at?: number;
-
-      /**
-       * The urgency associated with the execution strategy.
-       */
-      urgency?: 'super-passive' | 'passive' | 'moderate' | 'aggressive' | 'super-aggressive';
-    }
-  }
 }
 
 export namespace BulkOrders {