snaptrade-typescript-sdk 8.5.0 → 8.7.0

package/.konfig/generate-id.txt

@@ -1 +1 @@
-23c52a19-6df6-49be-bcc9-c9a1f0602b2c
+da703192-74cf-4e40-a6e8-b57469e2b225

package/README.md

@@ -1,25 +1,24 @@
-## snaptrade-typescript-sdk@8.5.0
-Connect brokerage accounts to your app for live positions and trading
-
-
-**Important note: this library is can be used in both the client-side or server-side, but using it
-in client-side browser code is not recommended as you would expose security credentials.**
+# snaptrade-typescript-sdk@8.7.0
 
-### Installing
+Connect brokerage accounts to your app for live positions and trading
+## Installing
 
-#### npm
+### npm
 ```
 npm install snaptrade-typescript-sdk --save
 ```
 
-#### yarn
+### yarn
 ```
 yarn add snaptrade-typescript-sdk
 ```
 
+**Important note: this library is can be used in both the client-side or server-side, but using it
+in client-side browser code is not recommended as you would expose security credentials.**
 
 
-### Getting Started
+
+## Getting Started
 
 ```typescript
 const { Snaptrade } = require("snaptrade-typescript-sdk");
@@ -94,7 +93,6 @@ function getUserId() {
 }
 
 main();
-
 ```
 
 ## Documentation for API Endpoints

package/configuration.ts

@@ -110,7 +110,7 @@ export class Configuration {
         this.accessToken = param.accessToken;
         this.basePath = param.basePath;
         this.baseOptions = param.baseOptions ?? {};
-        this.userAgent = param.userAgent === undefined ? "Konfig/8.5.0/typescript" : param.userAgent;
+        this.userAgent = param.userAgent === undefined ? "Konfig/8.7.0/typescript" : param.userAgent;
         this.formDataCtor = param.formDataCtor;
     }
 

package/dist/configuration.js

@@ -34,7 +34,7 @@ var Configuration = /** @class */ (function () {
         this.accessToken = param.accessToken;
         this.basePath = param.basePath;
         this.baseOptions = (_a = param.baseOptions) !== null && _a !== void 0 ? _a : {};
-        this.userAgent = param.userAgent === undefined ? "Konfig/8.5.0/typescript" : param.userAgent;
+        this.userAgent = param.userAgent === undefined ? "Konfig/8.7.0/typescript" : param.userAgent;
         this.formDataCtor = param.formDataCtor;
     }
     /**

package/dist/models/options-holdings.d.ts

@@ -53,5 +53,5 @@ export interface OptionsHoldings {
      * @type {number}
      * @memberof OptionsHoldings
      */
-    'average_purchase_price'?: number;
+    'average_purchase_price'?: number | null;
 }

package/dist/models/options-position.d.ts

@@ -59,5 +59,5 @@ export interface OptionsPosition {
      * @type {number}
      * @memberof OptionsPosition
      */
-    'average_purchase_price'?: number;
+    'average_purchase_price'?: number | null;
 }

package/dist/models/position.d.ts

@@ -52,5 +52,5 @@ export interface Position {
      * @type {number}
      * @memberof Position
      */
-    'average_purchase_price'?: number;
+    'average_purchase_price'?: number | null;
 }

package/dist/models/session-event.d.ts

@@ -52,6 +52,12 @@ export interface SessionEvent {
      * @memberof SessionEvent
      */
     'brokerage_status_code'?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof SessionEvent
+     */
+    'brokerage_authorization_id'?: string;
 }
 export declare const SessionEventSessionEventTypeEnum: {
     readonly ConnectionFailed: "CONNECTION_FAILED";

package/dist/models/symbol.d.ts

@@ -11,6 +11,7 @@
  */
 import { Currency } from './currency';
 import { Exchange } from './exchange';
+import { SecurityType } from './security-type';
 /**
  * Symbol
  * @export
@@ -54,4 +55,10 @@ export interface Symbol {
      * @memberof Symbol
      */
     'exchange'?: Exchange;
+    /**
+     *
+     * @type {SecurityType}
+     * @memberof Symbol
+     */
+    'type'?: SecurityType;
 }

package/docs/AccountInformationApi.md

@@ -23,23 +23,23 @@ 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 getAllUserHoldingsResponse = await snaptrade.accountInformation.getAllUserHoldings({
-        "userId": "John.doe@snaptrade.com",
-        "userSecret": "USERSECRET123",
-        "brokerageAuthorizations": "917c8734-8470-4a3e-a18f-57c3f2ee6631",
-    })
-
-console.log(getAllUserHoldingsResponse)
-
+  // 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 getAllUserHoldingsResponse =
+  await snaptrade.accountInformation.getAllUserHoldings({
+    userId: "John.doe@snaptrade.com",
+    userSecret: "USERSECRET123",
+    brokerageAuthorizations: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
+  });
+
+console.log(getAllUserHoldingsResponse);
 ```
 
 
@@ -81,23 +81,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 getUserAccountBalanceResponse = await snaptrade.accountInformation.getUserAccountBalance({
-        "userId": "John.doe@snaptrade.com",
-        "userSecret": "USERSECRET123",
-        "accountId": "accountId_example",
-    })
-
-console.log(getUserAccountBalanceResponse)
-
+  // 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 getUserAccountBalanceResponse =
+  await snaptrade.accountInformation.getUserAccountBalance({
+    userId: "John.doe@snaptrade.com",
+    userSecret: "USERSECRET123",
+    accountId: "accountId_example",
+  });
+
+console.log(getUserAccountBalanceResponse);
 ```
 
 
@@ -137,23 +137,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 getUserAccountDetailsResponse = await snaptrade.accountInformation.getUserAccountDetails({
-        "userId": "John.doe@snaptrade.com",
-        "userSecret": "USERSECRET123",
-        "accountId": "accountId_example",
-    })
-
-console.log(getUserAccountDetailsResponse)
-
+  // 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 getUserAccountDetailsResponse =
+  await snaptrade.accountInformation.getUserAccountDetails({
+    userId: "John.doe@snaptrade.com",
+    userSecret: "USERSECRET123",
+    accountId: "accountId_example",
+  });
+
+console.log(getUserAccountDetailsResponse);
 ```
 
 
@@ -193,24 +193,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 getUserAccountOrdersResponse = await snaptrade.accountInformation.getUserAccountOrders({
-        "userId": "John.doe@snaptrade.com",
-        "userSecret": "USERSECRET123",
-        "state": "all",
-        "accountId": "accountId_example",
-    })
-
-console.log(getUserAccountOrdersResponse)
-
+  // 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 getUserAccountOrdersResponse =
+  await snaptrade.accountInformation.getUserAccountOrders({
+    userId: "John.doe@snaptrade.com",
+    userSecret: "USERSECRET123",
+    state: "all",
+    accountId: "accountId_example",
+  });
+
+console.log(getUserAccountOrdersResponse);
 ```
 
 
@@ -251,23 +251,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 getUserAccountPositionsResponse = await snaptrade.accountInformation.getUserAccountPositions({
-        "userId": "John.doe@snaptrade.com",
-        "userSecret": "USERSECRET123",
-        "accountId": "accountId_example",
-    })
-
-console.log(getUserAccountPositionsResponse)
-
+  // 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 getUserAccountPositionsResponse =
+  await snaptrade.accountInformation.getUserAccountPositions({
+    userId: "John.doe@snaptrade.com",
+    userSecret: "USERSECRET123",
+    accountId: "accountId_example",
+  });
+
+console.log(getUserAccountPositionsResponse);
 ```
 
 
@@ -307,23 +307,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 getUserHoldingsResponse = await snaptrade.accountInformation.getUserHoldings({
-        "accountId": "917c8734-8470-4a3e-a18f-57c3f2ee6631",
-        "userId": "John.doe@snaptrade.com",
-        "userSecret": "USERSECRET123",
-    })
-
-console.log(getUserHoldingsResponse)
-
+  // 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 getUserHoldingsResponse =
+  await snaptrade.accountInformation.getUserHoldings({
+    accountId: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
+    userId: "John.doe@snaptrade.com",
+    userSecret: "USERSECRET123",
+  });
+
+console.log(getUserHoldingsResponse);
 ```
 
 
@@ -365,22 +365,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 listUserAccountsResponse = await snaptrade.accountInformation.listUserAccounts({
-        "userId": "John.doe@snaptrade.com",
-        "userSecret": "USERSECRET123",
-    })
-
-console.log(listUserAccountsResponse)
-
+  // 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 listUserAccountsResponse =
+  await snaptrade.accountInformation.listUserAccounts({
+    userId: "John.doe@snaptrade.com",
+    userSecret: "USERSECRET123",
+  });
+
+console.log(listUserAccountsResponse);
 ```
 
 
@@ -419,23 +419,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 updateUserAccountResponse = await snaptrade.accountInformation.updateUserAccount({
-        "userId": "John.doe@snaptrade.com",
-        "userSecret": "USERSECRET123",
-        "accountId": "accountId_example",
-    })
-
-console.log(updateUserAccountResponse)
-
+  // 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 updateUserAccountResponse =
+  await snaptrade.accountInformation.updateUserAccount({
+    userId: "John.doe@snaptrade.com",
+    userSecret: "USERSECRET123",
+    accountId: "accountId_example",
+  });
+
+console.log(updateUserAccountResponse);
 ```
 
 

package/docs/ApiDisclaimerApi.md

@@ -16,22 +16,21 @@ 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",
-})
+  // 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 acceptResponse = await snaptrade.apiDisclaimer.accept({
-        "userId": "John.doe@snaptrade.com",
-        "userSecret": "USERSECRET123",
-    })
-
-console.log(acceptResponse)
+  userId: "John.doe@snaptrade.com",
+  userSecret: "USERSECRET123",
+});
 
+console.log(acceptResponse);
 ```
 
 

package/docs/ApiStatusApi.md

@@ -18,19 +18,18 @@ Check whether the API is operational and verify timestamps.
 
 
 ```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 checkResponse = await snaptrade.apiStatus.check()
-
-console.log(checkResponse)
+const checkResponse = await snaptrade.apiStatus.check();
 
+console.log(checkResponse);
 ```