snaptrade-typescript-sdk 8.26.0 → 8.27.0

package/README.md

@@ -1,4 +1,4 @@
-# snaptrade-typescript-sdk@8.26.0
+# snaptrade-typescript-sdk@8.27.0
 
 Connect brokerage accounts to your app for live positions and trading
 ## Installing
@@ -115,9 +115,9 @@ Tag | Method | HTTP request | Description
 *Authentication* | [**listSnapTradeUsers**](docs/AuthenticationApi.md#listSnapTradeUsers) | **GET** /snapTrade/listUsers | List SnapTrade users
 *Authentication* | [**loginSnapTradeUser**](docs/AuthenticationApi.md#loginSnapTradeUser) | **POST** /snapTrade/login | Login user & generate connection link
 *Authentication* | [**registerSnapTradeUser**](docs/AuthenticationApi.md#registerSnapTradeUser) | **POST** /snapTrade/registerUser | Create SnapTrade user
-*Connections* | [**detailBrokerageAuthorization**](docs/ConnectionsApi.md#detailBrokerageAuthorization) | **GET** /authorizations/{authorizationId} | Get detail of a specific brokerage authorizations for the user
+*Connections* | [**detailBrokerageAuthorization**](docs/ConnectionsApi.md#detailBrokerageAuthorization) | **GET** /authorizations/{authorizationId} | Get brokerage authorization details
 *Connections* | [**listBrokerageAuthorizations**](docs/ConnectionsApi.md#listBrokerageAuthorizations) | **GET** /authorizations | List all brokerage authorizations for the user
-*Connections* | [**removeBrokerageAuthorization**](docs/ConnectionsApi.md#removeBrokerageAuthorization) | **DELETE** /authorizations/{authorizationId} | Remove a brokerage authorization.
+*Connections* | [**removeBrokerageAuthorization**](docs/ConnectionsApi.md#removeBrokerageAuthorization) | **DELETE** /authorizations/{authorizationId} | Delete brokerage authorization
 *Connections* | [**sessionEvents**](docs/ConnectionsApi.md#sessionEvents) | **GET** /sessionEvents | List all session events for the partner
 *Error Logs* | [**listUserErrors**](docs/ErrorLogsApi.md#listUserErrors) | **GET** /snapTrade/listUserErrors | Retrieve error logs on behalf of your SnapTrade users
 *Options* | [**getOptionStrategy**](docs/OptionsApi.md#getOptionStrategy) | **POST** /accounts/{accountId}/optionStrategy | Creates an option strategy object that will be used to place an option strategy order

package/dist/api/account-information-api-generated.d.ts

@@ -29,6 +29,7 @@ export declare const AccountInformationApiAxiosParamCreator: (configuration?: Co
      * @param {string} userSecret
      * @param {string} [brokerageAuthorizations] Optional. Comma seperated list of authorization IDs (only use if filtering is needed on one or more authorizations).
      * @param {*} [options] Override http request option.
+     * @deprecated
      * @throws {RequiredError}
      */
     getAllUserHoldings: (userId: string, userSecret: string, brokerageAuthorizations?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
@@ -113,6 +114,7 @@ export declare const AccountInformationApiFp: (configuration?: Configuration) =>
      * @summary List all accounts for the user, plus balances, positions, and orders for each account.
      * @param {AccountInformationApiGetAllUserHoldingsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
+     * @deprecated
      * @throws {RequiredError}
      */
     getAllUserHoldings(requestParameters: AccountInformationApiGetAllUserHoldingsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AccountHoldings>>>;
@@ -183,6 +185,7 @@ export declare const AccountInformationApiFactory: (configuration?: Configuratio
      * @summary List all accounts for the user, plus balances, positions, and orders for each account.
      * @param {AccountInformationApiGetAllUserHoldingsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
+     * @deprecated
      * @throws {RequiredError}
      */
     getAllUserHoldings(requestParameters: AccountInformationApiGetAllUserHoldingsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<AccountHoldings>>;
@@ -455,6 +458,7 @@ export declare class AccountInformationApiGenerated extends BaseAPI {
      * @summary List all accounts for the user, plus balances, positions, and orders for each account.
      * @param {AccountInformationApiGetAllUserHoldingsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
+     * @deprecated
      * @throws {RequiredError}
      * @memberof AccountInformationApiGenerated
      */

package/dist/api/account-information-api-generated.js

@@ -42,6 +42,7 @@ const AccountInformationApiAxiosParamCreator = function (configuration) {
          * @param {string} userSecret
          * @param {string} [brokerageAuthorizations] Optional. Comma seperated list of authorization IDs (only use if filtering is needed on one or more authorizations).
          * @param {*} [options] Override http request option.
+         * @deprecated
          * @throws {RequiredError}
          */
         getAllUserHoldings: (userId, userSecret, brokerageAuthorizations, options = {}) => __awaiter(this, void 0, void 0, function* () {
@@ -474,6 +475,7 @@ const AccountInformationApiFp = function (configuration) {
          * @summary List all accounts for the user, plus balances, positions, and orders for each account.
          * @param {AccountInformationApiGetAllUserHoldingsRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
+         * @deprecated
          * @throws {RequiredError}
          */
         getAllUserHoldings(requestParameters, options) {
@@ -588,6 +590,7 @@ const AccountInformationApiFactory = function (configuration, basePath, axios) {
          * @summary List all accounts for the user, plus balances, positions, and orders for each account.
          * @param {AccountInformationApiGetAllUserHoldingsRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
+         * @deprecated
          * @throws {RequiredError}
          */
         getAllUserHoldings(requestParameters, options) {
@@ -678,6 +681,7 @@ class AccountInformationApiGenerated extends base_1.BaseAPI {
      * @summary List all accounts for the user, plus balances, positions, and orders for each account.
      * @param {AccountInformationApiGetAllUserHoldingsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
+     * @deprecated
      * @throws {RequiredError}
      * @memberof AccountInformationApiGenerated
      */

package/dist/api/connections-api-generated.d.ts

@@ -20,7 +20,7 @@ import { ConnectionsSessionEvents200ResponseInner } from '../models';
 export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
      *
-     * @summary Get detail of a specific brokerage authorizations for the user
+     * @summary Get brokerage authorization details
      * @param {string} authorizationId The ID of a brokerage authorization object.
      * @param {string} userId
      * @param {string} userSecret
@@ -39,7 +39,7 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
     listBrokerageAuthorizations: (userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
-     * @summary Remove a brokerage authorization.
+     * @summary Delete brokerage authorization
      * @param {string} authorizationId The ID of the Authorization to delete.
      * @param {string} userId
      * @param {string} userSecret
@@ -65,7 +65,7 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
 export declare const ConnectionsApiFp: (configuration?: Configuration) => {
     /**
      *
-     * @summary Get detail of a specific brokerage authorizations for the user
+     * @summary Get brokerage authorization details
      * @param {ConnectionsApiDetailBrokerageAuthorizationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -81,7 +81,7 @@ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
     listBrokerageAuthorizations(requestParameters: ConnectionsApiListBrokerageAuthorizationsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BrokerageAuthorization>>>;
     /**
      *
-     * @summary Remove a brokerage authorization.
+     * @summary Delete brokerage authorization
      * @param {ConnectionsApiRemoveBrokerageAuthorizationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -103,7 +103,7 @@ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
 export declare const ConnectionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
      *
-     * @summary Get detail of a specific brokerage authorizations for the user
+     * @summary Get brokerage authorization details
      * @param {ConnectionsApiDetailBrokerageAuthorizationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -119,7 +119,7 @@ export declare const ConnectionsApiFactory: (configuration?: Configuration, base
     listBrokerageAuthorizations(requestParameters: ConnectionsApiListBrokerageAuthorizationsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<BrokerageAuthorization>>;
     /**
      *
-     * @summary Remove a brokerage authorization.
+     * @summary Delete brokerage authorization
      * @param {ConnectionsApiRemoveBrokerageAuthorizationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -237,7 +237,7 @@ export type ConnectionsApiSessionEventsRequest = {
 export declare class ConnectionsApiGenerated extends BaseAPI {
     /**
      *
-     * @summary Get detail of a specific brokerage authorizations for the user
+     * @summary Get brokerage authorization details
      * @param {ConnectionsApiDetailBrokerageAuthorizationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -255,7 +255,7 @@ export declare class ConnectionsApiGenerated extends BaseAPI {
     listBrokerageAuthorizations(requestParameters: ConnectionsApiListBrokerageAuthorizationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BrokerageAuthorization[], any>>;
     /**
      *
-     * @summary Remove a brokerage authorization.
+     * @summary Delete brokerage authorization
      * @param {ConnectionsApiRemoveBrokerageAuthorizationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}

package/dist/api/connections-api-generated.js

@@ -37,7 +37,7 @@ const ConnectionsApiAxiosParamCreator = function (configuration) {
     return {
         /**
          *
-         * @summary Get detail of a specific brokerage authorizations for the user
+         * @summary Get brokerage authorization details
          * @param {string} authorizationId The ID of a brokerage authorization object.
          * @param {string} userId
          * @param {string} userSecret
@@ -139,7 +139,7 @@ const ConnectionsApiAxiosParamCreator = function (configuration) {
         }),
         /**
          *
-         * @summary Remove a brokerage authorization.
+         * @summary Delete brokerage authorization
          * @param {string} authorizationId The ID of the Authorization to delete.
          * @param {string} userId
          * @param {string} userSecret
@@ -253,7 +253,7 @@ const ConnectionsApiFp = function (configuration) {
     return {
         /**
          *
-         * @summary Get detail of a specific brokerage authorizations for the user
+         * @summary Get brokerage authorization details
          * @param {ConnectionsApiDetailBrokerageAuthorizationRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -279,7 +279,7 @@ const ConnectionsApiFp = function (configuration) {
         },
         /**
          *
-         * @summary Remove a brokerage authorization.
+         * @summary Delete brokerage authorization
          * @param {ConnectionsApiRemoveBrokerageAuthorizationRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -315,7 +315,7 @@ const ConnectionsApiFactory = function (configuration, basePath, axios) {
     return {
         /**
          *
-         * @summary Get detail of a specific brokerage authorizations for the user
+         * @summary Get brokerage authorization details
          * @param {ConnectionsApiDetailBrokerageAuthorizationRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -335,7 +335,7 @@ const ConnectionsApiFactory = function (configuration, basePath, axios) {
         },
         /**
          *
-         * @summary Remove a brokerage authorization.
+         * @summary Delete brokerage authorization
          * @param {ConnectionsApiRemoveBrokerageAuthorizationRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -365,7 +365,7 @@ exports.ConnectionsApiFactory = ConnectionsApiFactory;
 class ConnectionsApiGenerated extends base_1.BaseAPI {
     /**
      *
-     * @summary Get detail of a specific brokerage authorizations for the user
+     * @summary Get brokerage authorization details
      * @param {ConnectionsApiDetailBrokerageAuthorizationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -387,7 +387,7 @@ class ConnectionsApiGenerated extends base_1.BaseAPI {
     }
     /**
      *
-     * @summary Remove a brokerage authorization.
+     * @summary Delete brokerage authorization
      * @param {ConnectionsApiRemoveBrokerageAuthorizationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}

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

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

@@ -59,10 +59,4 @@ export interface OptionsPosition {
      * @memberof OptionsPosition
      */
     'fractional_units'?: number | null;
-    /**
-     * The book price of the asset
-     * @type {number}
-     * @memberof OptionsPosition
-     */
-    'book_price'?: number | null;
 }

package/dist/models/position.d.ts

@@ -52,10 +52,4 @@ export interface Position {
      * @memberof Position
      */
     'average_purchase_price'?: number | null;
-    /**
-     * The book price of the asset
-     * @type {number}
-     * @memberof Position
-     */
-    'book_price'?: number | null;
 }

package/dist/models/user-settings.d.ts

@@ -10,7 +10,7 @@
  */
 import { Currency } from './currency';
 /**
- * Passiv user account settings
+ * User account settings
  * @export
  * @interface UserSettings
  */

package/package.json

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