snaptrade-typescript-sdk 12.1.0 → 12.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.mjs CHANGED
@@ -433,7 +433,7 @@ const AccountInformationApiAxiosParamCreator = function(configuration) {
433
433
  };
434
434
  },
435
435
  /**
436
- * Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock`, `etf`, and `mutualfund` positions may include `tax_lots` when tax lot data is enabled for the account. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
436
+ * Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock`, `etf`, and `mutualfund` positions may include `tax_lots` when tax lot data is enabled for the account. To see which institutions support tax lot data, please see our [supported institutions doc](https://support.snaptrade.com/brokerages). If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
437
437
  * @summary List all account positions
438
438
  * @param {string} accountId
439
439
  * @param {string} [userId]
@@ -1228,7 +1228,7 @@ const AccountInformationApiFp = function(configuration) {
1228
1228
  });
1229
1229
  },
1230
1230
  /**
1231
- * Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock`, `etf`, and `mutualfund` positions may include `tax_lots` when tax lot data is enabled for the account. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
1231
+ * Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock`, `etf`, and `mutualfund` positions may include `tax_lots` when tax lot data is enabled for the account. To see which institutions support tax lot data, please see our [supported institutions doc](https://support.snaptrade.com/brokerages). If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
1232
1232
  * @summary List all account positions
1233
1233
  * @param {AccountInformationApiGetAllAccountPositionsRequest<TAuth>} requestParameters Request parameters.
1234
1234
  * @param {*} [options] Override http request option.
@@ -1479,7 +1479,7 @@ const AccountInformationApiFactory = function(configuration, basePath, axios) {
1479
1479
  return localVarFp.getAccountBalanceHistory(requestParameters, options).then((request) => request(axios, basePath));
1480
1480
  },
1481
1481
  /**
1482
- * Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock`, `etf`, and `mutualfund` positions may include `tax_lots` when tax lot data is enabled for the account. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
1482
+ * Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock`, `etf`, and `mutualfund` positions may include `tax_lots` when tax lot data is enabled for the account. To see which institutions support tax lot data, please see our [supported institutions doc](https://support.snaptrade.com/brokerages). If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
1483
1483
  * @summary List all account positions
1484
1484
  * @param {AccountInformationApiGetAllAccountPositionsRequest<TAuth>} requestParameters Request parameters.
1485
1485
  * @param {*} [options] Override http request option.
@@ -1611,7 +1611,7 @@ var AccountInformationApiGenerated = class extends BaseAPI {
1611
1611
  return AccountInformationApiFp(this.configuration).getAccountBalanceHistory(requestParameters, options).then((request) => request(this.axios, this.basePath));
1612
1612
  }
1613
1613
  /**
1614
- * Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock`, `etf`, and `mutualfund` positions may include `tax_lots` when tax lot data is enabled for the account. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
1614
+ * Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock`, `etf`, and `mutualfund` positions may include `tax_lots` when tax lot data is enabled for the account. To see which institutions support tax lot data, please see our [supported institutions doc](https://support.snaptrade.com/brokerages). If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
1615
1615
  * @summary List all account positions
1616
1616
  * @param {AccountInformationApiGetAllAccountPositionsRequest<TAuth>} requestParameters Request parameters.
1617
1617
  * @param {*} [options] Override http request option.
@@ -5434,13 +5434,14 @@ const TradingApiAxiosParamCreator = function(configuration) {
5434
5434
  };
5435
5435
  },
5436
5436
  /**
5437
- * Returns a quote for a single option contract. The option contract is specified using in the 21 character OCC format. For example `AAPL 251114C00240000` represents a call option on AAPL expiring on 2025-11-14 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format) **Note:** These are derived values and are not suitable for trading purposes.
5437
+ * Returns a quote for a single option contract. The option contract is specified using in the 21 character OCC format. For example `AAPL 251114C00240000` represents a call option on AAPL expiring on 2025-11-14 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format) **Note:** These are derived values and are not suitable for trading purposes. **This Endpoint is deprecated and will cease to return data as of October 1, 2026**
5438
5438
  * @summary Get option quote
5439
5439
  * @param {string} accountId
5440
5440
  * @param {string} symbol The OCC-formatted option symbol.
5441
5441
  * @param {string} [userId]
5442
5442
  * @param {string} [userSecret]
5443
5443
  * @param {*} [options] Override http request option.
5444
+ * @deprecated
5444
5445
  * @throws {RequiredError}
5445
5446
  */
5446
5447
  getUserAccountOptionQuotes: async (accountId, symbol, userId, userSecret, options = {}) => {
@@ -6325,10 +6326,11 @@ const TradingApiFp = function(configuration) {
6325
6326
  });
6326
6327
  },
6327
6328
  /**
6328
- * Returns a quote for a single option contract. The option contract is specified using in the 21 character OCC format. For example `AAPL 251114C00240000` represents a call option on AAPL expiring on 2025-11-14 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format) **Note:** These are derived values and are not suitable for trading purposes.
6329
+ * Returns a quote for a single option contract. The option contract is specified using in the 21 character OCC format. For example `AAPL 251114C00240000` represents a call option on AAPL expiring on 2025-11-14 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format) **Note:** These are derived values and are not suitable for trading purposes. **This Endpoint is deprecated and will cease to return data as of October 1, 2026**
6329
6330
  * @summary Get option quote
6330
6331
  * @param {TradingApiGetUserAccountOptionQuotesRequest<TAuth>} requestParameters Request parameters.
6331
6332
  * @param {*} [options] Override http request option.
6333
+ * @deprecated
6332
6334
  * @throws {RequiredError}
6333
6335
  */
6334
6336
  async getUserAccountOptionQuotes(requestParameters, options) {
@@ -6655,10 +6657,11 @@ const TradingApiFactory = function(configuration, basePath, axios) {
6655
6657
  return localVarFp.getOrderImpact(requestParameters, options).then((request) => request(axios, basePath));
6656
6658
  },
6657
6659
  /**
6658
- * Returns a quote for a single option contract. The option contract is specified using in the 21 character OCC format. For example `AAPL 251114C00240000` represents a call option on AAPL expiring on 2025-11-14 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format) **Note:** These are derived values and are not suitable for trading purposes.
6660
+ * Returns a quote for a single option contract. The option contract is specified using in the 21 character OCC format. For example `AAPL 251114C00240000` represents a call option on AAPL expiring on 2025-11-14 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format) **Note:** These are derived values and are not suitable for trading purposes. **This Endpoint is deprecated and will cease to return data as of October 1, 2026**
6659
6661
  * @summary Get option quote
6660
6662
  * @param {TradingApiGetUserAccountOptionQuotesRequest<TAuth>} requestParameters Request parameters.
6661
6663
  * @param {*} [options] Override http request option.
6664
+ * @deprecated
6662
6665
  * @throws {RequiredError}
6663
6666
  */
6664
6667
  getUserAccountOptionQuotes(requestParameters, options) {
@@ -6808,10 +6811,11 @@ var TradingApiGenerated = class extends BaseAPI {
6808
6811
  return TradingApiFp(this.configuration).getOrderImpact(requestParameters, options).then((request) => request(this.axios, this.basePath));
6809
6812
  }
6810
6813
  /**
6811
- * Returns a quote for a single option contract. The option contract is specified using in the 21 character OCC format. For example `AAPL 251114C00240000` represents a call option on AAPL expiring on 2025-11-14 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format) **Note:** These are derived values and are not suitable for trading purposes.
6814
+ * Returns a quote for a single option contract. The option contract is specified using in the 21 character OCC format. For example `AAPL 251114C00240000` represents a call option on AAPL expiring on 2025-11-14 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format) **Note:** These are derived values and are not suitable for trading purposes. **This Endpoint is deprecated and will cease to return data as of October 1, 2026**
6812
6815
  * @summary Get option quote
6813
6816
  * @param {TradingApiGetUserAccountOptionQuotesRequest<TAuth>} requestParameters Request parameters.
6814
6817
  * @param {*} [options] Override http request option.
6818
+ * @deprecated
6815
6819
  * @throws {RequiredError}
6816
6820
  * @memberof TradingApiGenerated
6817
6821
  */
@@ -6968,7 +6972,7 @@ var Configuration = class {
6968
6972
  }
6969
6973
  this.basePath = param.basePath;
6970
6974
  this.baseOptions = param.baseOptions ?? {};
6971
- this.userAgent = param.userAgent === void 0 ? "Konfig/12.1.0/typescript" : param.userAgent;
6975
+ this.userAgent = param.userAgent === void 0 ? "Konfig/12.1.2/typescript" : param.userAgent;
6972
6976
  this.formDataCtor = param.formDataCtor;
6973
6977
  }
6974
6978
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "snaptrade-typescript-sdk",
3
- "version": "12.1.0",
3
+ "version": "12.1.2",
4
4
  "description": "Client for SnapTrade",
5
5
  "author": "Konfig",
6
6
  "engines": {