snaptrade-typescript-sdk 8.6.0 → 8.7.0

package/docs/TradingApi.md

@@ -25,24 +25,24 @@ Method | HTTP request | Description
 
 
 ```typescript
-import { Snaptrade } from "snaptrade-typescript-sdk"
+import { Snaptrade } from "snaptrade-typescript-sdk";
 
 const snaptrade = new Snaptrade({
-    // Defining the base path is optional and defaults to https://api.snaptrade.com/api/v1
-    // basePath: "https://api.snaptrade.com/api/v1",
-    consumerKey: "YOUR_CONSUMER_KEY",
-    clientId: "YOUR_CLIENT_ID",
-})
-
-const cancelUserAccountOrderResponse = await snaptrade.trading.cancelUserAccountOrder({
-        "userId": "John.doe@snaptrade.com",
-        "userSecret": "USERSECRET123",
-        "accountId": "accountId_example",
-        "brokerage_order_id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
-    })
-
-console.log(cancelUserAccountOrderResponse)
-
+  // Defining the base path is optional and defaults to https://api.snaptrade.com/api/v1
+  // basePath: "https://api.snaptrade.com/api/v1",
+  consumerKey: "YOUR_CONSUMER_KEY",
+  clientId: "YOUR_CLIENT_ID",
+});
+
+const cancelUserAccountOrderResponse =
+  await snaptrade.trading.cancelUserAccountOrder({
+    userId: "John.doe@snaptrade.com",
+    userSecret: "USERSECRET123",
+    accountId: "accountId_example",
+    brokerage_order_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
+  });
+
+console.log(cancelUserAccountOrderResponse);
 ```
 
 
@@ -84,23 +84,23 @@ Name | Type | Description  | Notes
 
 
 ```typescript
-import { Snaptrade } from "snaptrade-typescript-sdk"
+import { Snaptrade } from "snaptrade-typescript-sdk";
 
 const snaptrade = new Snaptrade({
-    // Defining the base path is optional and defaults to https://api.snaptrade.com/api/v1
-    // basePath: "https://api.snaptrade.com/api/v1",
-    consumerKey: "YOUR_CONSUMER_KEY",
-    clientId: "YOUR_CLIENT_ID",
-})
-
-const getCalculatedTradeImpactByIdResponse = await snaptrade.trading.getCalculatedTradeImpactById({
-        "portfolioGroupId": "portfolioGroupId_example",
-        "calculatedTradeId": "calculatedTradeId_example",
-        "tradeId": "tradeId_example",
-    })
-
-console.log(getCalculatedTradeImpactByIdResponse)
-
+  // Defining the base path is optional and defaults to https://api.snaptrade.com/api/v1
+  // basePath: "https://api.snaptrade.com/api/v1",
+  consumerKey: "YOUR_CONSUMER_KEY",
+  clientId: "YOUR_CLIENT_ID",
+});
+
+const getCalculatedTradeImpactByIdResponse =
+  await snaptrade.trading.getCalculatedTradeImpactById({
+    portfolioGroupId: "portfolioGroupId_example",
+    calculatedTradeId: "calculatedTradeId_example",
+    tradeId: "tradeId_example",
+  });
+
+console.log(getCalculatedTradeImpactByIdResponse);
 ```
 
 
@@ -139,22 +139,22 @@ Name | Type | Description  | Notes
 
 
 ```typescript
-import { Snaptrade } from "snaptrade-typescript-sdk"
+import { Snaptrade } from "snaptrade-typescript-sdk";
 
 const snaptrade = new Snaptrade({
-    // Defining the base path is optional and defaults to https://api.snaptrade.com/api/v1
-    // basePath: "https://api.snaptrade.com/api/v1",
-    consumerKey: "YOUR_CONSUMER_KEY",
-    clientId: "YOUR_CLIENT_ID",
-})
-
-const getCalculatedTradesImpactResponse = await snaptrade.trading.getCalculatedTradesImpact({
-        "portfolioGroupId": "portfolioGroupId_example",
-        "calculatedTradeId": "calculatedTradeId_example",
-    })
-
-console.log(getCalculatedTradesImpactResponse)
-
+  // Defining the base path is optional and defaults to https://api.snaptrade.com/api/v1
+  // basePath: "https://api.snaptrade.com/api/v1",
+  consumerKey: "YOUR_CONSUMER_KEY",
+  clientId: "YOUR_CLIENT_ID",
+});
+
+const getCalculatedTradesImpactResponse =
+  await snaptrade.trading.getCalculatedTradesImpact({
+    portfolioGroupId: "portfolioGroupId_example",
+    calculatedTradeId: "calculatedTradeId_example",
+  });
+
+console.log(getCalculatedTradesImpactResponse);
 ```
 
 
@@ -192,29 +192,28 @@ Name | Type | Description  | Notes
 
 
 ```typescript
-import { Snaptrade } from "snaptrade-typescript-sdk"
+import { Snaptrade } from "snaptrade-typescript-sdk";
 
 const snaptrade = new Snaptrade({
-    // Defining the base path is optional and defaults to https://api.snaptrade.com/api/v1
-    // basePath: "https://api.snaptrade.com/api/v1",
-    consumerKey: "YOUR_CONSUMER_KEY",
-    clientId: "YOUR_CLIENT_ID",
-})
+  // Defining the base path is optional and defaults to https://api.snaptrade.com/api/v1
+  // basePath: "https://api.snaptrade.com/api/v1",
+  consumerKey: "YOUR_CONSUMER_KEY",
+  clientId: "YOUR_CLIENT_ID",
+});
 
 const getOrderImpactResponse = await snaptrade.trading.getOrderImpact({
-        "userId": "John.doe@snaptrade.com",
-        "userSecret": "USERSECRET123",
-        "account_id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
-        "action": "BUY",
-        "order_type": "Limit",
-        "price": 31.33,
-        "stop": 31.33,
-        "time_in_force": "Day",
-        "universal_symbol_id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
-    })
-
-console.log(getOrderImpactResponse)
-
+  userId: "John.doe@snaptrade.com",
+  userSecret: "USERSECRET123",
+  account_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
+  action: "BUY",
+  order_type: "Limit",
+  price: 31.33,
+  stop: 31.33,
+  time_in_force: "Day",
+  universal_symbol_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
+});
+
+console.log(getOrderImpactResponse);
 ```
 
 
@@ -256,24 +255,24 @@ Name | Type | Description  | Notes
 
 
 ```typescript
-import { Snaptrade } from "snaptrade-typescript-sdk"
+import { Snaptrade } from "snaptrade-typescript-sdk";
 
 const snaptrade = new Snaptrade({
-    // Defining the base path is optional and defaults to https://api.snaptrade.com/api/v1
-    // basePath: "https://api.snaptrade.com/api/v1",
-    consumerKey: "YOUR_CONSUMER_KEY",
-    clientId: "YOUR_CLIENT_ID",
-})
-
-const getUserAccountQuotesResponse = await snaptrade.trading.getUserAccountQuotes({
-        "userId": "John.doe@snaptrade.com",
-        "userSecret": "USERSECRET123",
-        "symbols": "symbols_example",
-        "accountId": "accountId_example",
-    })
-
-console.log(getUserAccountQuotesResponse)
-
+  // Defining the base path is optional and defaults to https://api.snaptrade.com/api/v1
+  // basePath: "https://api.snaptrade.com/api/v1",
+  consumerKey: "YOUR_CONSUMER_KEY",
+  clientId: "YOUR_CLIENT_ID",
+});
+
+const getUserAccountQuotesResponse =
+  await snaptrade.trading.getUserAccountQuotes({
+    userId: "John.doe@snaptrade.com",
+    userSecret: "USERSECRET123",
+    symbols: "symbols_example",
+    accountId: "accountId_example",
+  });
+
+console.log(getUserAccountQuotesResponse);
 ```
 
 
@@ -315,28 +314,28 @@ Name | Type | Description  | Notes
 
 
 ```typescript
-import { Snaptrade } from "snaptrade-typescript-sdk"
+import { Snaptrade } from "snaptrade-typescript-sdk";
 
 const snaptrade = new Snaptrade({
-    // Defining the base path is optional and defaults to https://api.snaptrade.com/api/v1
-    // basePath: "https://api.snaptrade.com/api/v1",
-    consumerKey: "YOUR_CONSUMER_KEY",
-    clientId: "YOUR_CLIENT_ID",
-})
-
-const modifyCalculatedTradeByIdResponse = await snaptrade.trading.modifyCalculatedTradeById({
-        "portfolioGroupId": "portfolioGroupId_example",
-        "calculatedTradeId": "calculatedTradeId_example",
-        "tradeId": "tradeId_example",
-        "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
-        "action": "BUY",
-        "units": 6,
-        "price": 24.81,
-        "sequence": 1,
-    })
-
-console.log(modifyCalculatedTradeByIdResponse)
-
+  // Defining the base path is optional and defaults to https://api.snaptrade.com/api/v1
+  // basePath: "https://api.snaptrade.com/api/v1",
+  consumerKey: "YOUR_CONSUMER_KEY",
+  clientId: "YOUR_CLIENT_ID",
+});
+
+const modifyCalculatedTradeByIdResponse =
+  await snaptrade.trading.modifyCalculatedTradeById({
+    portfolioGroupId: "portfolioGroupId_example",
+    calculatedTradeId: "calculatedTradeId_example",
+    tradeId: "tradeId_example",
+    id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
+    action: "BUY",
+    units: 6,
+    price: 24.81,
+    sequence: 1,
+  });
+
+console.log(modifyCalculatedTradeByIdResponse);
 ```
 
 
@@ -376,22 +375,22 @@ Name | Type | Description  | Notes
 
 
 ```typescript
-import { Snaptrade } from "snaptrade-typescript-sdk"
+import { Snaptrade } from "snaptrade-typescript-sdk";
 
 const snaptrade = new Snaptrade({
-    // Defining the base path is optional and defaults to https://api.snaptrade.com/api/v1
-    // basePath: "https://api.snaptrade.com/api/v1",
-    consumerKey: "YOUR_CONSUMER_KEY",
-    clientId: "YOUR_CLIENT_ID",
-})
-
-const placeCalculatedTradesResponse = await snaptrade.trading.placeCalculatedTrades({
-        "portfolioGroupId": "portfolioGroupId_example",
-        "calculatedTradeId": "calculatedTradeId_example",
-    })
-
-console.log(placeCalculatedTradesResponse)
-
+  // Defining the base path is optional and defaults to https://api.snaptrade.com/api/v1
+  // basePath: "https://api.snaptrade.com/api/v1",
+  consumerKey: "YOUR_CONSUMER_KEY",
+  clientId: "YOUR_CLIENT_ID",
+});
+
+const placeCalculatedTradesResponse =
+  await snaptrade.trading.placeCalculatedTrades({
+    portfolioGroupId: "portfolioGroupId_example",
+    calculatedTradeId: "calculatedTradeId_example",
+  });
+
+console.log(placeCalculatedTradesResponse);
 ```
 
 
@@ -429,29 +428,28 @@ Name | Type | Description  | Notes
 
 
 ```typescript
-import { Snaptrade } from "snaptrade-typescript-sdk"
+import { Snaptrade } from "snaptrade-typescript-sdk";
 
 const snaptrade = new Snaptrade({
-    // Defining the base path is optional and defaults to https://api.snaptrade.com/api/v1
-    // basePath: "https://api.snaptrade.com/api/v1",
-    consumerKey: "YOUR_CONSUMER_KEY",
-    clientId: "YOUR_CLIENT_ID",
-})
+  // Defining the base path is optional and defaults to https://api.snaptrade.com/api/v1
+  // basePath: "https://api.snaptrade.com/api/v1",
+  consumerKey: "YOUR_CONSUMER_KEY",
+  clientId: "YOUR_CLIENT_ID",
+});
 
 const placeForceOrderResponse = await snaptrade.trading.placeForceOrder({
-        "userId": "John.doe@snaptrade.com",
-        "userSecret": "USERSECRET123",
-        "account_id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
-        "action": "BUY",
-        "order_type": "Limit",
-        "price": 31.33,
-        "stop": 31.33,
-        "time_in_force": "Day",
-        "universal_symbol_id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
-    })
-
-console.log(placeForceOrderResponse)
-
+  userId: "John.doe@snaptrade.com",
+  userSecret: "USERSECRET123",
+  account_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
+  action: "BUY",
+  order_type: "Limit",
+  price: 31.33,
+  stop: 31.33,
+  time_in_force: "Day",
+  universal_symbol_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
+});
+
+console.log(placeForceOrderResponse);
 ```
 
 
@@ -493,22 +491,21 @@ Name | Type | Description  | Notes
 
 
 ```typescript
-import { Snaptrade } from "snaptrade-typescript-sdk"
+import { Snaptrade } from "snaptrade-typescript-sdk";
 
 const snaptrade = new Snaptrade({
-    // Defining the base path is optional and defaults to https://api.snaptrade.com/api/v1
-    // basePath: "https://api.snaptrade.com/api/v1",
-    consumerKey: "YOUR_CONSUMER_KEY",
-    clientId: "YOUR_CLIENT_ID",
-})
+  // Defining the base path is optional and defaults to https://api.snaptrade.com/api/v1
+  // basePath: "https://api.snaptrade.com/api/v1",
+  consumerKey: "YOUR_CONSUMER_KEY",
+  clientId: "YOUR_CLIENT_ID",
+});
 
 const placeOCOOrderResponse = await snaptrade.trading.placeOCOOrder({
-        "userId": "John.doe@snaptrade.com",
-        "userSecret": "USERSECRET123",
-    })
-
-console.log(placeOCOOrderResponse)
+  userId: "John.doe@snaptrade.com",
+  userSecret: "USERSECRET123",
+});
 
+console.log(placeOCOOrderResponse);
 ```
 
 
@@ -549,23 +546,22 @@ Name | Type | Description  | Notes
 
 
 ```typescript
-import { Snaptrade } from "snaptrade-typescript-sdk"
+import { Snaptrade } from "snaptrade-typescript-sdk";
 
 const snaptrade = new Snaptrade({
-    // Defining the base path is optional and defaults to https://api.snaptrade.com/api/v1
-    // basePath: "https://api.snaptrade.com/api/v1",
-    consumerKey: "YOUR_CONSUMER_KEY",
-    clientId: "YOUR_CLIENT_ID",
-})
+  // Defining the base path is optional and defaults to https://api.snaptrade.com/api/v1
+  // basePath: "https://api.snaptrade.com/api/v1",
+  consumerKey: "YOUR_CONSUMER_KEY",
+  clientId: "YOUR_CLIENT_ID",
+});
 
 const placeOrderResponse = await snaptrade.trading.placeOrder({
-        "tradeId": "tradeId_example",
-        "userId": "John.doe@snaptrade.com",
-        "userSecret": "USERSECRET123",
-    })
-
-console.log(placeOrderResponse)
+  tradeId: "tradeId_example",
+  userId: "John.doe@snaptrade.com",
+  userSecret: "USERSECRET123",
+});
 
+console.log(placeOrderResponse);
 ```
 
 

package/docs/TransactionsAndReportingApi.md

@@ -19,26 +19,28 @@ Returns activities (transactions) for a user. Specifing start and end date is hi
 
 
 ```typescript
-import { Snaptrade } from "snaptrade-typescript-sdk"
+import { Snaptrade } from "snaptrade-typescript-sdk";
 
 const snaptrade = new Snaptrade({
-    // Defining the base path is optional and defaults to https://api.snaptrade.com/api/v1
-    // basePath: "https://api.snaptrade.com/api/v1",
-    consumerKey: "YOUR_CONSUMER_KEY",
-    clientId: "YOUR_CLIENT_ID",
-})
-
-const getActivitiesResponse = await snaptrade.transactionsAndReporting.getActivities({
-        "startDate": "2022-01-24",
-        "endDate": "2022-01-24",
-        "accounts": "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2",
-        "brokerageAuthorizations": "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2",
-        "userId": "John.doe@snaptrade.com",
-        "userSecret": "USERSECRET123",
-    })
-
-console.log(getActivitiesResponse)
-
+  // Defining the base path is optional and defaults to https://api.snaptrade.com/api/v1
+  // basePath: "https://api.snaptrade.com/api/v1",
+  consumerKey: "YOUR_CONSUMER_KEY",
+  clientId: "YOUR_CLIENT_ID",
+});
+
+const getActivitiesResponse =
+  await snaptrade.transactionsAndReporting.getActivities({
+    startDate: "2022-01-24",
+    endDate: "2022-01-24",
+    accounts:
+      "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2",
+    brokerageAuthorizations:
+      "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2",
+    userId: "John.doe@snaptrade.com",
+    userSecret: "USERSECRET123",
+  });
+
+console.log(getActivitiesResponse);
 ```
 
 
@@ -83,27 +85,28 @@ Returns performance information (contributions, dividends, rate of return, etc)
 
 
 ```typescript
-import { Snaptrade } from "snaptrade-typescript-sdk"
+import { Snaptrade } from "snaptrade-typescript-sdk";
 
 const snaptrade = new Snaptrade({
-    // Defining the base path is optional and defaults to https://api.snaptrade.com/api/v1
-    // basePath: "https://api.snaptrade.com/api/v1",
-    consumerKey: "YOUR_CONSUMER_KEY",
-    clientId: "YOUR_CLIENT_ID",
-})
-
-const getReportingCustomRangeResponse = await snaptrade.transactionsAndReporting.getReportingCustomRange({
-        "startDate": "2022-01-24",
-        "endDate": "2022-01-24",
-        "accounts": "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2",
-        "detailed": true,
-        "frequency": "monthly",
-        "userId": "John.doe@snaptrade.com",
-        "userSecret": "USERSECRET123",
-    })
-
-console.log(getReportingCustomRangeResponse)
-
+  // Defining the base path is optional and defaults to https://api.snaptrade.com/api/v1
+  // basePath: "https://api.snaptrade.com/api/v1",
+  consumerKey: "YOUR_CONSUMER_KEY",
+  clientId: "YOUR_CLIENT_ID",
+});
+
+const getReportingCustomRangeResponse =
+  await snaptrade.transactionsAndReporting.getReportingCustomRange({
+    startDate: "2022-01-24",
+    endDate: "2022-01-24",
+    accounts:
+      "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2",
+    detailed: true,
+    frequency: "monthly",
+    userId: "John.doe@snaptrade.com",
+    userSecret: "USERSECRET123",
+  });
+
+console.log(getReportingCustomRangeResponse);
 ```
 
 

package/models/session-event.ts

@@ -57,6 +57,12 @@ export interface SessionEvent {
      * @memberof SessionEvent
      */
     'brokerage_status_code'?: number | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof SessionEvent
+     */
+    'brokerage_authorization_id'?: string;
 }
 
 export const SessionEventSessionEventTypeEnum = {

package/models/symbol.ts

@@ -18,6 +18,9 @@ import { Currency } from './currency';
 // May contain unused imports in some cases
 // @ts-ignore
 import { Exchange } from './exchange';
+// May contain unused imports in some cases
+// @ts-ignore
+import { SecurityType } from './security-type';
 
 /**
  * Symbol
@@ -63,5 +66,11 @@ export interface Symbol {
      * @memberof Symbol
      */
     'exchange'?: Exchange;
+    /**
+     * 
+     * @type {SecurityType}
+     * @memberof Symbol
+     */
+    'type'?: SecurityType;
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "snaptrade-typescript-sdk",
-  "version": "8.6.0",
+  "version": "8.7.0",
   "description": "Client for SnapTrade",
   "author": "Konfig",
   "engines": {