snaptrade-typescript-sdk 8.19.0 → 8.20.0

package/README.md

@@ -1,4 +1,4 @@
-# snaptrade-typescript-sdk@8.19.0
+# snaptrade-typescript-sdk@8.20.0
 
 Connect brokerage accounts to your app for live positions and trading
 ## Installing
@@ -13,7 +13,7 @@ npm install snaptrade-typescript-sdk --save
 yarn add snaptrade-typescript-sdk
 ```
 
-**Important note: this library is can be used in both the client-side or server-side, but using it
+**Important note: this library 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.**
 
 

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

@@ -0,0 +1,525 @@
+/**
+ * SnapTrade
+ * Connect brokerage accounts to your app for live positions and trading
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: api@snaptrade.com
+ *
+ * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
+ * Do not edit the class manually.
+ */
+import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { Configuration } from '../configuration';
+import { RequestArgs, BaseAPI } from '../base';
+import { Account } from '../models';
+import { AccountHoldings } from '../models';
+import { AccountHoldingsAccount } from '../models';
+import { AccountOrderRecord } from '../models';
+import { Balance } from '../models';
+import { Position } from '../models';
+/**
+ * AccountInformationApi - axios parameter creator
+ * @export
+ */
+export declare const AccountInformationApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary List all accounts for the user, plus balances and positions for each account.
+     * @param {string} userId
+     * @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.
+     * @throws {RequiredError}
+     */
+    getAllUserHoldings: (userId: string, userSecret: string, brokerageAuthorizations?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Get all cash balances of an investment account
+     * @param {string} userId
+     * @param {string} userSecret
+     * @param {string} accountId The ID of the account get positions.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUserAccountBalance: (userId: string, userSecret: string, accountId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Return details of a specific investment account
+     * @param {string} userId
+     * @param {string} userSecret
+     * @param {string} accountId The ID of the account to get detail of.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUserAccountDetails: (userId: string, userSecret: string, accountId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Get all history of orders placed in account
+     * @param {string} userId
+     * @param {string} userSecret
+     * @param {string} accountId The ID of the account get positions.
+     * @param {'all' | 'open' | 'executed'} [state] defaults value is set to \&quot;all\&quot;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUserAccountOrders: (userId: string, userSecret: string, accountId: string, state?: 'all' | 'open' | 'executed', options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Get all positions of an investment account
+     * @param {string} userId
+     * @param {string} userSecret
+     * @param {string} accountId The ID of the account get positions.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUserAccountPositions: (userId: string, userSecret: string, accountId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary List balances, positions and orders for the specified account.
+     * @param {string} accountId The ID of the account to fetch holdings for.
+     * @param {string} userId
+     * @param {string} userSecret
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUserHoldings: (accountId: string, userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary List all investment accounts for the user
+     * @param {string} userId
+     * @param {string} userSecret
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listUserAccounts: (userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Update details of an investment account
+     * @param {string} userId
+     * @param {string} userSecret
+     * @param {string} accountId The ID of the account to update.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateUserAccount: (userId: string, userSecret: string, accountId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * AccountInformationApi - functional programming interface
+ * @export
+ */
+export declare const AccountInformationApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary List all accounts for the user, plus balances and positions for each account.
+     * @param {AccountInformationApiGetAllUserHoldingsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAllUserHoldings(requestParameters: AccountInformationApiGetAllUserHoldingsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AccountHoldings>>>;
+    /**
+     *
+     * @summary Get all cash balances of an investment account
+     * @param {AccountInformationApiGetUserAccountBalanceRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUserAccountBalance(requestParameters: AccountInformationApiGetUserAccountBalanceRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Balance>>>;
+    /**
+     *
+     * @summary Return details of a specific investment account
+     * @param {AccountInformationApiGetUserAccountDetailsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUserAccountDetails(requestParameters: AccountInformationApiGetUserAccountDetailsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Account>>;
+    /**
+     *
+     * @summary Get all history of orders placed in account
+     * @param {AccountInformationApiGetUserAccountOrdersRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUserAccountOrders(requestParameters: AccountInformationApiGetUserAccountOrdersRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AccountOrderRecord>>>;
+    /**
+     *
+     * @summary Get all positions of an investment account
+     * @param {AccountInformationApiGetUserAccountPositionsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUserAccountPositions(requestParameters: AccountInformationApiGetUserAccountPositionsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Position>>>;
+    /**
+     *
+     * @summary List balances, positions and orders for the specified account.
+     * @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUserHoldings(requestParameters: AccountInformationApiGetUserHoldingsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountHoldingsAccount>>;
+    /**
+     *
+     * @summary List all investment accounts for the user
+     * @param {AccountInformationApiListUserAccountsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listUserAccounts(requestParameters: AccountInformationApiListUserAccountsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Account>>>;
+    /**
+     *
+     * @summary Update details of an investment account
+     * @param {AccountInformationApiUpdateUserAccountRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateUserAccount(requestParameters: AccountInformationApiUpdateUserAccountRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Account>>>;
+};
+/**
+ * AccountInformationApi - factory interface
+ * @export
+ */
+export declare const AccountInformationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary List all accounts for the user, plus balances and positions for each account.
+     * @param {AccountInformationApiGetAllUserHoldingsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAllUserHoldings(requestParameters: AccountInformationApiGetAllUserHoldingsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<AccountHoldings>>;
+    /**
+     *
+     * @summary Get all cash balances of an investment account
+     * @param {AccountInformationApiGetUserAccountBalanceRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUserAccountBalance(requestParameters: AccountInformationApiGetUserAccountBalanceRequest, options?: AxiosRequestConfig): AxiosPromise<Array<Balance>>;
+    /**
+     *
+     * @summary Return details of a specific investment account
+     * @param {AccountInformationApiGetUserAccountDetailsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUserAccountDetails(requestParameters: AccountInformationApiGetUserAccountDetailsRequest, options?: AxiosRequestConfig): AxiosPromise<Account>;
+    /**
+     *
+     * @summary Get all history of orders placed in account
+     * @param {AccountInformationApiGetUserAccountOrdersRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUserAccountOrders(requestParameters: AccountInformationApiGetUserAccountOrdersRequest, options?: AxiosRequestConfig): AxiosPromise<Array<AccountOrderRecord>>;
+    /**
+     *
+     * @summary Get all positions of an investment account
+     * @param {AccountInformationApiGetUserAccountPositionsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUserAccountPositions(requestParameters: AccountInformationApiGetUserAccountPositionsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<Position>>;
+    /**
+     *
+     * @summary List balances, positions and orders for the specified account.
+     * @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUserHoldings(requestParameters: AccountInformationApiGetUserHoldingsRequest, options?: AxiosRequestConfig): AxiosPromise<AccountHoldingsAccount>;
+    /**
+     *
+     * @summary List all investment accounts for the user
+     * @param {AccountInformationApiListUserAccountsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listUserAccounts(requestParameters: AccountInformationApiListUserAccountsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<Account>>;
+    /**
+     *
+     * @summary Update details of an investment account
+     * @param {AccountInformationApiUpdateUserAccountRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateUserAccount(requestParameters: AccountInformationApiUpdateUserAccountRequest, options?: AxiosRequestConfig): AxiosPromise<Array<Account>>;
+};
+/**
+ * Request parameters for getAllUserHoldings operation in AccountInformationApi.
+ * @export
+ * @interface AccountInformationApiGetAllUserHoldingsRequest
+ */
+export type AccountInformationApiGetAllUserHoldingsRequest = {
+    /**
+    *
+    * @type {string}
+    * @memberof AccountInformationApiGetAllUserHoldings
+    */
+    readonly userId: string;
+    /**
+    *
+    * @type {string}
+    * @memberof AccountInformationApiGetAllUserHoldings
+    */
+    readonly userSecret: string;
+    /**
+    * Optional. Comma seperated list of authorization IDs (only use if filtering is needed on one or more authorizations).
+    * @type {string}
+    * @memberof AccountInformationApiGetAllUserHoldings
+    */
+    readonly brokerageAuthorizations?: string;
+};
+/**
+ * Request parameters for getUserAccountBalance operation in AccountInformationApi.
+ * @export
+ * @interface AccountInformationApiGetUserAccountBalanceRequest
+ */
+export type AccountInformationApiGetUserAccountBalanceRequest = {
+    /**
+    *
+    * @type {string}
+    * @memberof AccountInformationApiGetUserAccountBalance
+    */
+    readonly userId: string;
+    /**
+    *
+    * @type {string}
+    * @memberof AccountInformationApiGetUserAccountBalance
+    */
+    readonly userSecret: string;
+    /**
+    * The ID of the account get positions.
+    * @type {string}
+    * @memberof AccountInformationApiGetUserAccountBalance
+    */
+    readonly accountId: string;
+};
+/**
+ * Request parameters for getUserAccountDetails operation in AccountInformationApi.
+ * @export
+ * @interface AccountInformationApiGetUserAccountDetailsRequest
+ */
+export type AccountInformationApiGetUserAccountDetailsRequest = {
+    /**
+    *
+    * @type {string}
+    * @memberof AccountInformationApiGetUserAccountDetails
+    */
+    readonly userId: string;
+    /**
+    *
+    * @type {string}
+    * @memberof AccountInformationApiGetUserAccountDetails
+    */
+    readonly userSecret: string;
+    /**
+    * The ID of the account to get detail of.
+    * @type {string}
+    * @memberof AccountInformationApiGetUserAccountDetails
+    */
+    readonly accountId: string;
+};
+/**
+ * Request parameters for getUserAccountOrders operation in AccountInformationApi.
+ * @export
+ * @interface AccountInformationApiGetUserAccountOrdersRequest
+ */
+export type AccountInformationApiGetUserAccountOrdersRequest = {
+    /**
+    *
+    * @type {string}
+    * @memberof AccountInformationApiGetUserAccountOrders
+    */
+    readonly userId: string;
+    /**
+    *
+    * @type {string}
+    * @memberof AccountInformationApiGetUserAccountOrders
+    */
+    readonly userSecret: string;
+    /**
+    * The ID of the account get positions.
+    * @type {string}
+    * @memberof AccountInformationApiGetUserAccountOrders
+    */
+    readonly accountId: string;
+    /**
+    * defaults value is set to \"all\"
+    * @type {'all' | 'open' | 'executed'}
+    * @memberof AccountInformationApiGetUserAccountOrders
+    */
+    readonly state?: 'all' | 'open' | 'executed';
+};
+/**
+ * Request parameters for getUserAccountPositions operation in AccountInformationApi.
+ * @export
+ * @interface AccountInformationApiGetUserAccountPositionsRequest
+ */
+export type AccountInformationApiGetUserAccountPositionsRequest = {
+    /**
+    *
+    * @type {string}
+    * @memberof AccountInformationApiGetUserAccountPositions
+    */
+    readonly userId: string;
+    /**
+    *
+    * @type {string}
+    * @memberof AccountInformationApiGetUserAccountPositions
+    */
+    readonly userSecret: string;
+    /**
+    * The ID of the account get positions.
+    * @type {string}
+    * @memberof AccountInformationApiGetUserAccountPositions
+    */
+    readonly accountId: string;
+};
+/**
+ * Request parameters for getUserHoldings operation in AccountInformationApi.
+ * @export
+ * @interface AccountInformationApiGetUserHoldingsRequest
+ */
+export type AccountInformationApiGetUserHoldingsRequest = {
+    /**
+    * The ID of the account to fetch holdings for.
+    * @type {string}
+    * @memberof AccountInformationApiGetUserHoldings
+    */
+    readonly accountId: string;
+    /**
+    *
+    * @type {string}
+    * @memberof AccountInformationApiGetUserHoldings
+    */
+    readonly userId: string;
+    /**
+    *
+    * @type {string}
+    * @memberof AccountInformationApiGetUserHoldings
+    */
+    readonly userSecret: string;
+};
+/**
+ * Request parameters for listUserAccounts operation in AccountInformationApi.
+ * @export
+ * @interface AccountInformationApiListUserAccountsRequest
+ */
+export type AccountInformationApiListUserAccountsRequest = {
+    /**
+    *
+    * @type {string}
+    * @memberof AccountInformationApiListUserAccounts
+    */
+    readonly userId: string;
+    /**
+    *
+    * @type {string}
+    * @memberof AccountInformationApiListUserAccounts
+    */
+    readonly userSecret: string;
+};
+/**
+ * Request parameters for updateUserAccount operation in AccountInformationApi.
+ * @export
+ * @interface AccountInformationApiUpdateUserAccountRequest
+ */
+export type AccountInformationApiUpdateUserAccountRequest = {
+    /**
+    *
+    * @type {string}
+    * @memberof AccountInformationApiUpdateUserAccount
+    */
+    readonly userId: string;
+    /**
+    *
+    * @type {string}
+    * @memberof AccountInformationApiUpdateUserAccount
+    */
+    readonly userSecret: string;
+    /**
+    * The ID of the account to update.
+    * @type {string}
+    * @memberof AccountInformationApiUpdateUserAccount
+    */
+    readonly accountId: string;
+};
+/**
+ * AccountInformationApiGenerated - object-oriented interface
+ * @export
+ * @class AccountInformationApiGenerated
+ * @extends {BaseAPI}
+ */
+export declare class AccountInformationApiGenerated extends BaseAPI {
+    /**
+     *
+     * @summary List all accounts for the user, plus balances and positions for each account.
+     * @param {AccountInformationApiGetAllUserHoldingsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AccountInformationApiGenerated
+     */
+    getAllUserHoldings(requestParameters: AccountInformationApiGetAllUserHoldingsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountHoldings[], any>>;
+    /**
+     *
+     * @summary Get all cash balances of an investment account
+     * @param {AccountInformationApiGetUserAccountBalanceRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AccountInformationApiGenerated
+     */
+    getUserAccountBalance(requestParameters: AccountInformationApiGetUserAccountBalanceRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Balance[], any>>;
+    /**
+     *
+     * @summary Return details of a specific investment account
+     * @param {AccountInformationApiGetUserAccountDetailsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AccountInformationApiGenerated
+     */
+    getUserAccountDetails(requestParameters: AccountInformationApiGetUserAccountDetailsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Account, any>>;
+    /**
+     *
+     * @summary Get all history of orders placed in account
+     * @param {AccountInformationApiGetUserAccountOrdersRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AccountInformationApiGenerated
+     */
+    getUserAccountOrders(requestParameters: AccountInformationApiGetUserAccountOrdersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord[], any>>;
+    /**
+     *
+     * @summary Get all positions of an investment account
+     * @param {AccountInformationApiGetUserAccountPositionsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AccountInformationApiGenerated
+     */
+    getUserAccountPositions(requestParameters: AccountInformationApiGetUserAccountPositionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Position[], any>>;
+    /**
+     *
+     * @summary List balances, positions and orders for the specified account.
+     * @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AccountInformationApiGenerated
+     */
+    getUserHoldings(requestParameters: AccountInformationApiGetUserHoldingsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountHoldingsAccount, any>>;
+    /**
+     *
+     * @summary List all investment accounts for the user
+     * @param {AccountInformationApiListUserAccountsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AccountInformationApiGenerated
+     */
+    listUserAccounts(requestParameters: AccountInformationApiListUserAccountsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Account[], any>>;
+    /**
+     *
+     * @summary Update details of an investment account
+     * @param {AccountInformationApiUpdateUserAccountRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AccountInformationApiGenerated
+     */
+    updateUserAccount(requestParameters: AccountInformationApiUpdateUserAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Account[], any>>;
+}