snaptrade-typescript-sdk 9.0.38 → 9.0.39

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.38/typescript" : param.userAgent;
+        this.userAgent = param.userAgent === undefined ? "Konfig/9.0.39/typescript" : param.userAgent;
         this.formDataCtor = param.formDataCtor;
     }
     /**

package/dist/models/account.d.ts

@@ -14,7 +14,7 @@ export interface Account {
      */
     'id'?: string;
     /**
-     * Unique identifier for the connection (brokerage authorization). This is the UUID used to reference the connection in SnapTrade.
+     * Unique identifier for the connection. This is the UUID used to reference the connection in SnapTrade.
      * @type {string}
      * @memberof Account
      */
@@ -51,7 +51,7 @@ export interface Account {
      */
     'created_date'?: string;
     /**
-     * Additional information about the account, such as account type, status, etc. This information is specific to the brokerage and there\'s no standard format for this data. Please use at your own risk.
+     * Additional information about the account, such as account type, status, etc. This information is specific to the brokerage and there\'s no standard format for this data. This field is deprecated and subject to removal in a future version.
      * @type {{ [key: string]: any; }}
      * @memberof Account
      * @deprecated

package/dist/models/brokerage-authorization-disabled-confirmation.d.ts

@@ -1,5 +1,5 @@
 /**
- *
+ * Confirmation that the connection has been disabled.
  * @export
  * @interface BrokerageAuthorizationDisabledConfirmation
  */

package/dist/models/brokerage-authorization-refresh-confirmation.d.ts

@@ -1,5 +1,5 @@
 /**
- *
+ * Confirmation that the syncs have been scheduled.
  * @export
  * @interface BrokerageAuthorizationRefreshConfirmation
  */

package/dist/models/brokerage-authorization.d.ts

@@ -1,27 +1,28 @@
 import { Brokerage } from './brokerage';
 /**
- *
+ * A single connection with a brokerage. Note that `Connection` and `Brokerage Authorization` are interchangeable, but the term `Connection` is preferred and used in the doc for consistency.  A connection is usually tied to a single login at a brokerage. A single connection can contain multiple brokerage accounts.  SnapTrade performs de-duping on connections for a given user. If the user has an existing connection with the brokerage, when connecting the brokerage with the same credentials, SnapTrade will return the existing connection instead of creating a new one.
  * @export
  * @interface BrokerageAuthorization
  */
 export interface BrokerageAuthorization {
     [key: string]: any;
     /**
-     *
+     * Unique identifier for the connection. This is the UUID used to reference the connection in SnapTrade.
      * @type {string}
      * @memberof BrokerageAuthorization
      */
     'id'?: string;
     /**
-     * Time
+     * Timestamp of when the connection was established in SnapTrade.
      * @type {string}
      * @memberof BrokerageAuthorization
      */
     'created_date'?: string;
     /**
-     * Time
+     * Timestamp of when the connection was last updated in SnapTrade. This field is deprecated. Please let us know if you have a valid use case for this field.
      * @type {string}
      * @memberof BrokerageAuthorization
+     * @deprecated
      */
     'updated_date'?: string;
     /**
@@ -31,33 +32,34 @@ export interface BrokerageAuthorization {
      */
     'brokerage'?: Brokerage;
     /**
-     * Connection Name
+     * A short, human-readable name for the connection.
      * @type {string}
      * @memberof BrokerageAuthorization
      */
     'name'?: string;
     /**
-     *
+     * Whether the connection is read-only or trade-enabled. A read-only connection can only be used to fetch data, while a trade-enabled connection can be used to place trades. Valid values are `read` and `trade`.
      * @type {string}
      * @memberof BrokerageAuthorization
      */
     'type'?: string;
     /**
-     *
+     * Whether the connection is disabled. A disabled connection can no longer access the latest data from the brokerage, but will continue to return the last cached state. A connection can become disabled for many reasons and differs by brokerage. Here are some common scenarios:  - The user has changed their username or password at the brokerage. - The user has explicitly removed the access grant at the brokerage. - The session has expired at the brokerage and now requires explicit user re-authentication.  Please see [this guide](https://docs.snaptrade.com/docs/fix-broken-connections) on how to fix a disabled connection.
      * @type {boolean}
      * @memberof BrokerageAuthorization
      */
     'disabled'?: boolean;
     /**
-     * Disabled date
+     * Timestamp of when the connection was disabled in SnapTrade.
      * @type {string}
      * @memberof BrokerageAuthorization
      */
     'disabled_date'?: string | null;
     /**
-     * Additional data about brokerage authorization
+     * Additional data about the connection. This information is specific to the brokerage and there\'s no standard format for this data. This field is deprecated and subject to removal in a future version.
      * @type {{ [key: string]: any; }}
      * @memberof BrokerageAuthorization
+     * @deprecated
      */
     'meta'?: {
         [key: string]: any;

package/dist/models/brokerage-type.d.ts

@@ -1,5 +1,5 @@
 /**
- * Type of brokerage
+ * Type of brokerage. Currently supports traditional brokerages and crypto exchanges.
  * @export
  * @interface BrokerageType
  */

package/dist/models/brokerage.d.ts

@@ -1,17 +1,23 @@
 import { BrokerageType } from './brokerage-type';
 /**
- *
+ * Describes a brokerage that SnapTrade supports.
  * @export
  * @interface Brokerage
  */
 export interface Brokerage {
     [key: string]: any;
     /**
-     *
+     * Unique identifier for the brokerage firm. This is the UUID used to reference the brokerage in SnapTrade.
      * @type {string}
      * @memberof Brokerage
      */
     'id'?: string;
+    /**
+     * A short, unique identifier for the brokerage. It is usually the name of the brokerage in capital letters and will never change.
+     * @type {string}
+     * @memberof Brokerage
+     */
+    'slug'?: string;
     /**
      * Full name of the brokerage.
      * @type {string}
@@ -25,95 +31,75 @@ export interface Brokerage {
      */
     'display_name'?: string;
     /**
-     *
+     * A brief description of the brokerage.
      * @type {string}
      * @memberof Brokerage
      */
     'description'?: string;
     /**
-     *
+     * URL to the brokerage\'s logo.
      * @type {string}
      * @memberof Brokerage
      */
     'aws_s3_logo_url'?: string;
     /**
-     *
+     * URL to the brokerage\'s logo in square format.
      * @type {string}
      * @memberof Brokerage
      */
     'aws_s3_square_logo_url'?: string | null;
     /**
-     *
+     * This field is deprecated.
      * @type {string}
      * @memberof Brokerage
+     * @deprecated
      */
     'open_url'?: string | null;
     /**
-     * A unique identifier for that brokerage. It is usually the name of the brokerage in capital letters and will never change.
-     * @type {string}
-     * @memberof Brokerage
-     */
-    'slug'?: string;
-    /**
-     *
+     * URL to the brokerage\'s website.
      * @type {string}
      * @memberof Brokerage
      */
     'url'?: string;
     /**
-     *
+     * Whether the brokerage is enabled in SnapTrade. A disabled brokerage will not be available for new connections.
      * @type {boolean}
      * @memberof Brokerage
      */
     'enabled'?: boolean;
     /**
-     *
+     * Whether the brokerage is currently in maintenance mode. A brokerage in maintenance mode will not be available for new connections.
      * @type {boolean}
      * @memberof Brokerage
      */
     'maintenance_mode'?: boolean;
     /**
-     *
+     * This field is deprecated. Please contact us if you have a valid use case for it.
      * @type {boolean}
      * @memberof Brokerage
+     * @deprecated
      */
     'allows_fractional_units'?: boolean | null;
     /**
-     *
+     * Whether the brokerage allows trading through SnapTrade.
      * @type {boolean}
      * @memberof Brokerage
      */
     'allows_trading'?: boolean | null;
     /**
-     *
+     * This field is deprecated. Please contact us if you have a valid use case for it.
      * @type {boolean}
      * @memberof Brokerage
+     * @deprecated
      */
     'has_reporting'?: boolean | null;
     /**
-     *
+     * This field is deprecated. Please contact us if you have a valid use case for it.
      * @type {boolean}
      * @memberof Brokerage
+     * @deprecated
      */
     'is_real_time_connection'?: boolean;
-    /**
-     *
-     * @type {boolean}
-     * @memberof Brokerage
-     */
-    'allows_trading_through_snaptrade_api'?: boolean | null;
-    /**
-     *
-     * @type {boolean}
-     * @memberof Brokerage
-     */
-    'is_scraping_integration'?: boolean;
-    /**
-     *
-     * @type {string}
-     * @memberof Brokerage
-     */
-    'default_currency'?: string;
     /**
      *
      * @type {BrokerageType}
@@ -121,9 +107,10 @@ export interface Brokerage {
      */
     'brokerage_type'?: BrokerageType;
     /**
-     * List of exchange ID supported by brokerage
+     * This field is deprecated. Please contact us if you have a valid use case for it.
      * @type {Array<any>}
      * @memberof Brokerage
+     * @deprecated
      */
     'exchanges'?: Array<any>;
 }

package/package.json

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