snaptrade-typescript-sdk 9.0.20 → 9.0.22

package/dist/common.js

@@ -157,7 +157,7 @@ exports.removeTrailingSlash = removeTrailingSlash;
  * Wrap an axios request in a try/catch block to catch network errors and parse the response body
  */
 function wrapAxiosRequest(makeRequest) {
-    var _a, _b, _c;
+    var _a, _b, _c, _d, _e;
     return __awaiter(this, void 0, void 0, function* () {
         try {
             return yield makeRequest();
@@ -168,13 +168,13 @@ function wrapAxiosRequest(makeRequest) {
                     const responseBody = ((_a = e.response) === null || _a === void 0 ? void 0 : _a.data) instanceof ReadableStream
                         ? yield (0, error_1.readableStreamToString)(e.response.data)
                         : (_b = e.response) === null || _b === void 0 ? void 0 : _b.data;
-                    throw new error_1.SnaptradeError(e, (0, error_1.parseIfJson)(responseBody));
+                    throw new error_1.SnaptradeError(e, (0, error_1.parseIfJson)(responseBody), (_c = e.response) === null || _c === void 0 ? void 0 : _c.headers);
                 }
                 catch (innerError) {
                     if (innerError instanceof ReferenceError) {
                         // Got: "ReferenceError: ReadableStream is not defined"
                         // This means we are in a Node environment so just throw the original error
-                        throw new error_1.SnaptradeError(e, (_c = e.response) === null || _c === void 0 ? void 0 : _c.data);
+                        throw new error_1.SnaptradeError(e, (_d = e.response) === null || _d === void 0 ? void 0 : _d.data, (_e = e.response) === null || _e === void 0 ? void 0 : _e.headers);
                     }
                     if (innerError instanceof error_1.SnaptradeError) {
                         // Got "SnaptradeError" from the above try block

package/dist/configuration.js

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

package/dist/error.d.ts

@@ -30,7 +30,7 @@ export declare class SnaptradeError extends Error {
      * HTTP request method (see https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods)
      */
     readonly method?: string;
-    constructor(axiosError: AxiosError, responseBody: unknown);
+    constructor(axiosError: AxiosError, responseBody: unknown, headers: unknown);
     toJSON(): {
         name: string;
         message: string;

package/dist/error.js

@@ -24,9 +24,10 @@ exports.parseIfJson = exports.readableStreamToString = exports.SnaptradeError =
  * This class provides a wrapper for network errors when making requests to SnapTrade
  */
 class SnaptradeError extends Error {
-    constructor(axiosError, responseBody) {
+    constructor(axiosError, responseBody, headers) {
         var _a, _b, _c, _d, _e;
-        super(axiosError.message);
+        const message = axiosError.message + "\nRESPONSE HEADERS:\n" + JSON.stringify(headers, null, 2);
+        super(message);
         this.name = "SnaptradeError";
         this.code = axiosError.code;
         this.method = (_b = (_a = axiosError.config) === null || _a === void 0 ? void 0 : _a.method) === null || _b === void 0 ? void 0 : _b.toUpperCase();

package/dist/models/account-order-record.d.ts

@@ -1,5 +1,4 @@
 import { AccountOrderRecordStatus } from './account-order-record-status';
-import { Action } from './action';
 import { OptionsSymbol } from './options-symbol';
 import { UniversalSymbol } from './universal-symbol';
 /**
@@ -40,11 +39,11 @@ export interface AccountOrderRecord {
      */
     'option_symbol'?: OptionsSymbol;
     /**
-     * Trade Action
-     * @type {Action}
+     * Trade Action potential values include (but are not limited to) - BUY - SELL - BUY_COVER - SELL_SHORT - BUY_OPEN - BUY_CLOSE - SELL_OPEN - SELL_CLOSE
+     * @type {string}
      * @memberof AccountOrderRecord
      */
-    'action'?: Action;
+    'action'?: string;
     /**
      *
      * @type {number}

package/dist/models/{action.d.ts → action-strict.d.ts}

@@ -3,4 +3,4 @@
  * @export
  * @enum {string}
  */
-export type Action = 'BUY' | 'SELL';
+export type ActionStrict = 'BUY' | 'SELL';

package/dist/models/delete-user-response.d.ts

@@ -12,7 +12,7 @@ export interface DeleteUserResponse {
      */
     'status'?: string;
     /**
-     * SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it\'s unique to a user
+     * SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable.
      * @type {string}
      * @memberof DeleteUserResponse
      */

package/dist/models/index.d.ts

@@ -7,7 +7,7 @@ export * from './account-order-record';
 export * from './account-order-record-status';
 export * from './account-simple';
 export * from './account-sync-status';
-export * from './action';
+export * from './action-strict';
 export * from './amount';
 export * from './authentication-login-snap-trade-user200-response';
 export * from './balance';
@@ -38,6 +38,7 @@ export * from './manual-trade';
 export * from './manual-trade-and-impact';
 export * from './manual-trade-balance';
 export * from './manual-trade-form';
+export * from './manual-trade-form-notional-value';
 export * from './manual-trade-symbol';
 export * from './model400-failed-request-response';
 export * from './model401-failed-request-response';
@@ -54,6 +55,7 @@ export * from './model-portfolio-security';
 export * from './monthly-dividends';
 export * from './net-contributions';
 export * from './net-dividend';
+export * from './notional-value';
 export * from './option-chain-inner';
 export * from './option-chain-inner-chain-per-root-inner';
 export * from './option-chain-inner-chain-per-root-inner-chain-per-strike-price-inner';

package/dist/models/index.js

@@ -23,7 +23,7 @@ __exportStar(require("./account-order-record"), exports);
 __exportStar(require("./account-order-record-status"), exports);
 __exportStar(require("./account-simple"), exports);
 __exportStar(require("./account-sync-status"), exports);
-__exportStar(require("./action"), exports);
+__exportStar(require("./action-strict"), exports);
 __exportStar(require("./amount"), exports);
 __exportStar(require("./authentication-login-snap-trade-user200-response"), exports);
 __exportStar(require("./balance"), exports);
@@ -54,6 +54,7 @@ __exportStar(require("./manual-trade"), exports);
 __exportStar(require("./manual-trade-and-impact"), exports);
 __exportStar(require("./manual-trade-balance"), exports);
 __exportStar(require("./manual-trade-form"), exports);
+__exportStar(require("./manual-trade-form-notional-value"), exports);
 __exportStar(require("./manual-trade-symbol"), exports);
 __exportStar(require("./model400-failed-request-response"), exports);
 __exportStar(require("./model401-failed-request-response"), exports);
@@ -70,6 +71,7 @@ __exportStar(require("./model-portfolio-security"), exports);
 __exportStar(require("./monthly-dividends"), exports);
 __exportStar(require("./net-contributions"), exports);
 __exportStar(require("./net-dividend"), exports);
+__exportStar(require("./notional-value"), exports);
 __exportStar(require("./option-chain-inner"), exports);
 __exportStar(require("./option-chain-inner-chain-per-root-inner"), exports);
 __exportStar(require("./option-chain-inner-chain-per-root-inner-chain-per-strike-price-inner"), exports);

package/dist/models/manual-trade-form-notional-value.d.ts

@@ -0,0 +1,6 @@
+import { NotionalValue } from './notional-value';
+/**
+ * @type ManualTradeFormNotionalValue
+ * @export
+ */
+export type ManualTradeFormNotionalValue = NotionalValue;

package/dist/models/manual-trade-form-notional-value.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/manual-trade-form.d.ts

@@ -1,4 +1,5 @@
-import { Action } from './action';
+import { ActionStrict } from './action-strict';
+import { ManualTradeFormNotionalValue } from './manual-trade-form-notional-value';
 import { OrderTypeStrict } from './order-type-strict';
 import { TimeInForceStrict } from './time-in-force-strict';
 /**
@@ -15,10 +16,10 @@ export interface ManualTradeForm {
     'account_id'?: string;
     /**
      * Trade Action
-     * @type {Action}
+     * @type {ActionStrict}
      * @memberof ManualTradeForm
      */
-    'action'?: Action;
+    'action'?: ActionStrict;
     /**
      * Order Type
      * @type {OrderTypeStrict}
@@ -57,8 +58,8 @@ export interface ManualTradeForm {
     'universal_symbol_id'?: string;
     /**
      *
-     * @type {number}
+     * @type {ManualTradeFormNotionalValue}
      * @memberof ManualTradeForm
      */
-    'notional_value'?: number | null;
+    'notional_value'?: ManualTradeFormNotionalValue | null;
 }

package/dist/models/manual-trade.d.ts

@@ -1,4 +1,4 @@
-import { Action } from './action';
+import { ActionStrict } from './action-strict';
 import { ManualTradeSymbol } from './manual-trade-symbol';
 import { OrderTypeStrict } from './order-type-strict';
 /**
@@ -40,10 +40,10 @@ export interface ManualTrade {
     'symbol'?: ManualTradeSymbol;
     /**
      * Trade Action
-     * @type {Action}
+     * @type {ActionStrict}
      * @memberof ManualTrade
      */
-    'action'?: Action;
+    'action'?: ActionStrict;
     /**
      *
      * @type {number}

package/dist/models/notional-value.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @type NotionalValue
+ * Dollar amount to trade. Cannot work with units. Can only work for market order types and day for time in force. **Only available for Alpaca, Alpaca Paper, and Robinhood.**
+ * @export
+ */
+export type NotionalValue = number | string;

package/dist/models/notional-value.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -24,7 +24,7 @@ export interface SessionEvent {
      */
     'session_id'?: string;
     /**
-     * SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it\'s unique to a user
+     * SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable.
      * @type {string}
      * @memberof SessionEvent
      */
@@ -48,5 +48,5 @@ export interface SessionEvent {
      */
     'brokerage_authorization_id'?: string;
 }
-type SessionEventSessionEventTypeEnum = 'CONNECTION_FAILED' | 'DISCLAIMER_ACCEPTED' | 'BROKERAGE_CONNECTION_INITIATED' | 'BROKERAGE_AUTHENTICATION' | 'MFA_AUTHORIZATION' | 'CONNECTION_SUCCESSFUL' | 'PARTNER_REDIRECT';
+type SessionEventSessionEventTypeEnum = 'OAUTH_REDIRECT' | 'DISCLAIMER_ACCEPTED' | 'BROKERAGE_CONNECTION_INITIATED' | 'BROKERAGE_RECONNECT_INITIATED' | 'BROKERAGE_AUTHENTICATION' | 'OAUTH_BROKERAGE_AUTHENTICATION' | 'MFA_REQUESTED' | 'MFA_SUBMITTED' | 'MFA_CHOICE_REQUESTED' | 'MFA_CHOICE_SUBMITTED' | 'CONNECTION_SUCCESSFUL' | 'CONNECTION_FAILED' | 'PARTNER_REDIRECT' | 'CONNECTION_ABORTED' | 'SESSION_STARTED';
 export {};

package/dist/models/snap-trade-register-user-request-body.d.ts

@@ -5,7 +5,7 @@
  */
 export interface SnapTradeRegisterUserRequestBody {
     /**
-     * SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it\'s unique to a user
+     * SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable.
      * @type {string}
      * @memberof SnapTradeRegisterUserRequestBody
      */

package/dist/models/user-idand-secret.d.ts

@@ -5,7 +5,7 @@
  */
 export interface UserIDandSecret {
     /**
-     * SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it\'s unique to a user
+     * SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable.
      * @type {string}
      * @memberof UserIDandSecret
      */

package/package.json

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