snaptrade-typescript-sdk 8.19.0 → 8.21.0
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/README.md +16 -16
- package/dist/api/account-information-api-generated.d.ts +525 -0
- package/dist/api/account-information-api-generated.js +765 -0
- package/dist/api/account-information-api.d.ts +3 -525
- package/dist/api/account-information-api.js +17 -1044
- package/dist/api/api-status-api-generated.d.ts +69 -0
- package/dist/api/api-status-api-generated.js +131 -0
- package/dist/api/api-status-api.d.ts +3 -69
- package/dist/api/api-status-api.js +17 -198
- package/dist/api/authentication-api-generated.d.ts +266 -0
- package/dist/api/authentication-api-generated.js +461 -0
- package/dist/api/authentication-api.d.ts +3 -266
- package/dist/api/authentication-api.js +17 -656
- package/dist/api/connections-api-generated.d.ts +274 -0
- package/dist/api/connections-api-generated.js +411 -0
- package/dist/api/connections-api.d.ts +3 -274
- package/dist/api/connections-api.js +17 -578
- package/dist/api/error-logs-api-generated.d.ts +93 -0
- package/dist/api/error-logs-api-generated.js +152 -0
- package/dist/api/error-logs-api.d.ts +3 -93
- package/dist/api/error-logs-api.js +17 -235
- package/dist/api/options-api-generated.d.ts +368 -0
- package/dist/api/options-api-generated.js +530 -0
- package/dist/api/options-api.d.ts +3 -368
- package/dist/api/options-api.js +17 -725
- package/dist/api/reference-data-api-generated.d.ts +467 -0
- package/dist/api/reference-data-api-generated.js +872 -0
- package/dist/api/reference-data-api.d.ts +3 -467
- package/dist/api/reference-data-api.js +17 -1241
- package/dist/api/trading-api-generated.d.ts +402 -0
- package/dist/api/trading-api-generated.js +613 -0
- package/dist/api/trading-api.d.ts +3 -402
- package/dist/api/trading-api.js +17 -836
- package/dist/api/transactions-and-reporting-api-generated.d.ts +217 -0
- package/dist/api/transactions-and-reporting-api-generated.js +287 -0
- package/dist/api/transactions-and-reporting-api.d.ts +3 -217
- package/dist/api/transactions-and-reporting-api.js +17 -398
- package/dist/base.js +10 -31
- package/dist/client-custom.js +3 -5
- package/dist/client.d.ts +1 -1
- package/dist/client.js +17 -35
- package/dist/common.js +64 -123
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +9 -11
- package/dist/error.d.ts +56 -0
- package/dist/error.js +104 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.js +1 -0
- package/dist/jest.config.js +1 -1
- package/dist/pagination/page.js +15 -43
- package/dist/pagination/pageable.js +32 -88
- package/dist/pagination/paginate.js +15 -53
- package/dist/requestAfterHook.js +14 -14
- package/dist/requestBeforeHook.js +1 -1
- package/dist/requestBeforeUrlHook.d.ts +7 -0
- package/dist/requestBeforeUrlHook.js +5 -0
- package/package.json +2 -2
- package/dist/api/account-information-api-custom.d.ts +0 -3
- package/dist/api/account-information-api-custom.js +0 -27
- package/dist/api/api-status-api-custom.d.ts +0 -3
- package/dist/api/api-status-api-custom.js +0 -27
- package/dist/api/authentication-api-custom.d.ts +0 -3
- package/dist/api/authentication-api-custom.js +0 -27
- package/dist/api/connections-api-custom.d.ts +0 -3
- package/dist/api/connections-api-custom.js +0 -27
- package/dist/api/error-logs-api-custom.d.ts +0 -3
- package/dist/api/error-logs-api-custom.js +0 -27
- package/dist/api/options-api-custom.d.ts +0 -3
- package/dist/api/options-api-custom.js +0 -27
- package/dist/api/reference-data-api-custom.d.ts +0 -3
- package/dist/api/reference-data-api-custom.js +0 -27
- package/dist/api/trading-api-custom.d.ts +0 -3
- package/dist/api/trading-api-custom.js +0 -27
- package/dist/api/transactions-and-reporting-api-custom.d.ts +0 -3
- package/dist/api/transactions-and-reporting-api-custom.js +0 -27
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# snaptrade-typescript-sdk@8.
|
|
1
|
+
# snaptrade-typescript-sdk@8.21.0
|
|
2
2
|
|
|
3
3
|
Connect brokerage accounts to your app for live positions and trading
|
|
4
4
|
## Installing
|
|
@@ -13,7 +13,7 @@ npm install snaptrade-typescript-sdk --save
|
|
|
13
13
|
yarn add snaptrade-typescript-sdk
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
**Important note: this library
|
|
16
|
+
**Important note: this library can be used in both the client-side or server-side, but using it
|
|
17
17
|
in client-side browser code is not recommended as you would expose security credentials.**
|
|
18
18
|
|
|
19
19
|
|
|
@@ -101,20 +101,20 @@ All URIs are relative to *https://api.snaptrade.com/api/v1*
|
|
|
101
101
|
|
|
102
102
|
Class | Method | HTTP request | Description
|
|
103
103
|
------------ | ------------- | ------------- | -------------
|
|
104
|
-
*AccountInformationApi* | [**getAllUserHoldings**](docs/AccountInformationApi.md#getAllUserHoldings) | **GET** /holdings | List all accounts for the user, plus balances and
|
|
105
|
-
*AccountInformationApi* | [**getUserAccountBalance**](docs/AccountInformationApi.md#getUserAccountBalance) | **GET** /accounts/{accountId}/balances |
|
|
104
|
+
*AccountInformationApi* | [**getAllUserHoldings**](docs/AccountInformationApi.md#getAllUserHoldings) | **GET** /holdings | List all accounts for the user, plus balances, positions, and orders for each account.
|
|
105
|
+
*AccountInformationApi* | [**getUserAccountBalance**](docs/AccountInformationApi.md#getUserAccountBalance) | **GET** /accounts/{accountId}/balances | List account balances
|
|
106
106
|
*AccountInformationApi* | [**getUserAccountDetails**](docs/AccountInformationApi.md#getUserAccountDetails) | **GET** /accounts/{accountId} | Return details of a specific investment account
|
|
107
107
|
*AccountInformationApi* | [**getUserAccountOrders**](docs/AccountInformationApi.md#getUserAccountOrders) | **GET** /accounts/{accountId}/orders | Get all history of orders placed in account
|
|
108
|
-
*AccountInformationApi* | [**getUserAccountPositions**](docs/AccountInformationApi.md#getUserAccountPositions) | **GET** /accounts/{accountId}/positions |
|
|
108
|
+
*AccountInformationApi* | [**getUserAccountPositions**](docs/AccountInformationApi.md#getUserAccountPositions) | **GET** /accounts/{accountId}/positions | List account positions
|
|
109
109
|
*AccountInformationApi* | [**getUserHoldings**](docs/AccountInformationApi.md#getUserHoldings) | **GET** /accounts/{accountId}/holdings | List balances, positions and orders for the specified account.
|
|
110
|
-
*AccountInformationApi* | [**listUserAccounts**](docs/AccountInformationApi.md#listUserAccounts) | **GET** /accounts | List
|
|
110
|
+
*AccountInformationApi* | [**listUserAccounts**](docs/AccountInformationApi.md#listUserAccounts) | **GET** /accounts | List accounts
|
|
111
111
|
*AccountInformationApi* | [**updateUserAccount**](docs/AccountInformationApi.md#updateUserAccount) | **PUT** /accounts/{accountId} | Update details of an investment account
|
|
112
112
|
*ApiStatusApi* | [**check**](docs/ApiStatusApi.md#check) | **GET** / | Get API Status
|
|
113
|
-
*AuthenticationApi* | [**deleteSnapTradeUser**](docs/AuthenticationApi.md#deleteSnapTradeUser) | **DELETE** /snapTrade/deleteUser | Delete
|
|
114
|
-
*AuthenticationApi* | [**getUserJWT**](docs/AuthenticationApi.md#getUserJWT) | **GET** /snapTrade/encryptedJWT |
|
|
115
|
-
*AuthenticationApi* | [**listSnapTradeUsers**](docs/AuthenticationApi.md#listSnapTradeUsers) | **GET** /snapTrade/listUsers |
|
|
116
|
-
*AuthenticationApi* | [**loginSnapTradeUser**](docs/AuthenticationApi.md#loginSnapTradeUser) | **POST** /snapTrade/login |
|
|
117
|
-
*AuthenticationApi* | [**registerSnapTradeUser**](docs/AuthenticationApi.md#registerSnapTradeUser) | **POST** /snapTrade/registerUser |
|
|
113
|
+
*AuthenticationApi* | [**deleteSnapTradeUser**](docs/AuthenticationApi.md#deleteSnapTradeUser) | **DELETE** /snapTrade/deleteUser | Delete SnapTrade user
|
|
114
|
+
*AuthenticationApi* | [**getUserJWT**](docs/AuthenticationApi.md#getUserJWT) | **GET** /snapTrade/encryptedJWT | Generate encrypted JWT token
|
|
115
|
+
*AuthenticationApi* | [**listSnapTradeUsers**](docs/AuthenticationApi.md#listSnapTradeUsers) | **GET** /snapTrade/listUsers | List SnapTrade users
|
|
116
|
+
*AuthenticationApi* | [**loginSnapTradeUser**](docs/AuthenticationApi.md#loginSnapTradeUser) | **POST** /snapTrade/login | Login user & generate connection link
|
|
117
|
+
*AuthenticationApi* | [**registerSnapTradeUser**](docs/AuthenticationApi.md#registerSnapTradeUser) | **POST** /snapTrade/registerUser | Create SnapTrade user
|
|
118
118
|
*ConnectionsApi* | [**detailBrokerageAuthorization**](docs/ConnectionsApi.md#detailBrokerageAuthorization) | **GET** /authorizations/{authorizationId} | Get detail of a specific brokerage authorizations for the user
|
|
119
119
|
*ConnectionsApi* | [**listBrokerageAuthorizations**](docs/ConnectionsApi.md#listBrokerageAuthorizations) | **GET** /authorizations | List all brokerage authorizations for the user
|
|
120
120
|
*ConnectionsApi* | [**removeBrokerageAuthorization**](docs/ConnectionsApi.md#removeBrokerageAuthorization) | **DELETE** /authorizations/{authorizationId} | Remove a brokerage authorization.
|
|
@@ -128,14 +128,14 @@ Class | Method | HTTP request | Description
|
|
|
128
128
|
*ReferenceDataApi* | [**getCurrencyExchangeRatePair**](docs/ReferenceDataApi.md#getCurrencyExchangeRatePair) | **GET** /currencies/rates/{currencyPair} | Return the exchange rate of a currency pair
|
|
129
129
|
*ReferenceDataApi* | [**getPartnerInfo**](docs/ReferenceDataApi.md#getPartnerInfo) | **GET** /snapTrade/partners | Get metadata related to Snaptrade partner
|
|
130
130
|
*ReferenceDataApi* | [**getSecurityTypes**](docs/ReferenceDataApi.md#getSecurityTypes) | **GET** /securityTypes | List of all security types.
|
|
131
|
-
*ReferenceDataApi* | [**getStockExchanges**](docs/ReferenceDataApi.md#getStockExchanges) | **GET** /exchanges |
|
|
131
|
+
*ReferenceDataApi* | [**getStockExchanges**](docs/ReferenceDataApi.md#getStockExchanges) | **GET** /exchanges | List exchanges
|
|
132
132
|
*ReferenceDataApi* | [**getSymbols**](docs/ReferenceDataApi.md#getSymbols) | **POST** /symbols | Search for symbols
|
|
133
133
|
*ReferenceDataApi* | [**getSymbolsByTicker**](docs/ReferenceDataApi.md#getSymbolsByTicker) | **GET** /symbols/{ticker} | Get details of a symbol by the ticker
|
|
134
134
|
*ReferenceDataApi* | [**listAllBrokerageAuthorizationType**](docs/ReferenceDataApi.md#listAllBrokerageAuthorizationType) | **GET** /brokerageAuthorizationTypes | List of all brokerage authorization types
|
|
135
|
-
*ReferenceDataApi* | [**listAllBrokerages**](docs/ReferenceDataApi.md#listAllBrokerages) | **GET** /brokerages | List
|
|
136
|
-
*ReferenceDataApi* | [**listAllCurrencies**](docs/ReferenceDataApi.md#listAllCurrencies) | **GET** /currencies | List
|
|
137
|
-
*ReferenceDataApi* | [**listAllCurrenciesRates**](docs/ReferenceDataApi.md#listAllCurrenciesRates) | **GET** /currencies/rates |
|
|
138
|
-
*ReferenceDataApi* | [**symbolSearchUserAccount**](docs/ReferenceDataApi.md#symbolSearchUserAccount) | **POST** /accounts/{accountId}/symbols | Search for symbols
|
|
135
|
+
*ReferenceDataApi* | [**listAllBrokerages**](docs/ReferenceDataApi.md#listAllBrokerages) | **GET** /brokerages | List brokerages
|
|
136
|
+
*ReferenceDataApi* | [**listAllCurrencies**](docs/ReferenceDataApi.md#listAllCurrencies) | **GET** /currencies | List currencies
|
|
137
|
+
*ReferenceDataApi* | [**listAllCurrenciesRates**](docs/ReferenceDataApi.md#listAllCurrenciesRates) | **GET** /currencies/rates | List currency exchange rates
|
|
138
|
+
*ReferenceDataApi* | [**symbolSearchUserAccount**](docs/ReferenceDataApi.md#symbolSearchUserAccount) | **POST** /accounts/{accountId}/symbols | Search for symbols available in an account
|
|
139
139
|
*TradingApi* | [**cancelUserAccountOrder**](docs/TradingApi.md#cancelUserAccountOrder) | **POST** /accounts/{accountId}/orders/cancel | Cancel open order in account
|
|
140
140
|
*TradingApi* | [**getOrderImpact**](docs/TradingApi.md#getOrderImpact) | **POST** /trade/impact | Check impact of trades on account.
|
|
141
141
|
*TradingApi* | [**getUserAccountQuotes**](docs/TradingApi.md#getUserAccountQuotes) | **GET** /accounts/{accountId}/quotes | Get symbol quotes
|
|
@@ -0,0 +1,525 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* SnapTrade
|
|
3
|
+
* Connect brokerage accounts to your app for live positions and trading
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
* Contact: api@snaptrade.com
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This file is auto generated by Konfig (https://konfigthis.com).
|
|
9
|
+
* Do not edit the class manually.
|
|
10
|
+
*/
|
|
11
|
+
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
12
|
+
import { Configuration } from '../configuration';
|
|
13
|
+
import { RequestArgs, BaseAPI } from '../base';
|
|
14
|
+
import { Account } from '../models';
|
|
15
|
+
import { AccountHoldings } from '../models';
|
|
16
|
+
import { AccountHoldingsAccount } from '../models';
|
|
17
|
+
import { AccountOrderRecord } from '../models';
|
|
18
|
+
import { Balance } from '../models';
|
|
19
|
+
import { Position } from '../models';
|
|
20
|
+
/**
|
|
21
|
+
* AccountInformationApi - axios parameter creator
|
|
22
|
+
* @export
|
|
23
|
+
*/
|
|
24
|
+
export declare const AccountInformationApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
25
|
+
/**
|
|
26
|
+
*
|
|
27
|
+
* @summary List all accounts for the user, plus balances, positions, and orders for each account.
|
|
28
|
+
* @param {string} userId
|
|
29
|
+
* @param {string} userSecret
|
|
30
|
+
* @param {string} [brokerageAuthorizations] Optional. Comma seperated list of authorization IDs (only use if filtering is needed on one or more authorizations).
|
|
31
|
+
* @param {*} [options] Override http request option.
|
|
32
|
+
* @throws {RequiredError}
|
|
33
|
+
*/
|
|
34
|
+
getAllUserHoldings: (userId: string, userSecret: string, brokerageAuthorizations?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
35
|
+
/**
|
|
36
|
+
*
|
|
37
|
+
* @summary List account balances
|
|
38
|
+
* @param {string} userId
|
|
39
|
+
* @param {string} userSecret
|
|
40
|
+
* @param {string} accountId The ID of the account get positions.
|
|
41
|
+
* @param {*} [options] Override http request option.
|
|
42
|
+
* @throws {RequiredError}
|
|
43
|
+
*/
|
|
44
|
+
getUserAccountBalance: (userId: string, userSecret: string, accountId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
45
|
+
/**
|
|
46
|
+
*
|
|
47
|
+
* @summary Return details of a specific investment account
|
|
48
|
+
* @param {string} userId
|
|
49
|
+
* @param {string} userSecret
|
|
50
|
+
* @param {string} accountId The ID of the account to get detail of.
|
|
51
|
+
* @param {*} [options] Override http request option.
|
|
52
|
+
* @throws {RequiredError}
|
|
53
|
+
*/
|
|
54
|
+
getUserAccountDetails: (userId: string, userSecret: string, accountId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55
|
+
/**
|
|
56
|
+
*
|
|
57
|
+
* @summary Get all history of orders placed in account
|
|
58
|
+
* @param {string} userId
|
|
59
|
+
* @param {string} userSecret
|
|
60
|
+
* @param {string} accountId The ID of the account get positions.
|
|
61
|
+
* @param {'all' | 'open' | 'executed'} [state] defaults value is set to \"all\"
|
|
62
|
+
* @param {*} [options] Override http request option.
|
|
63
|
+
* @throws {RequiredError}
|
|
64
|
+
*/
|
|
65
|
+
getUserAccountOrders: (userId: string, userSecret: string, accountId: string, state?: 'all' | 'open' | 'executed', options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
66
|
+
/**
|
|
67
|
+
*
|
|
68
|
+
* @summary List account positions
|
|
69
|
+
* @param {string} userId
|
|
70
|
+
* @param {string} userSecret
|
|
71
|
+
* @param {string} accountId The ID of the account get positions.
|
|
72
|
+
* @param {*} [options] Override http request option.
|
|
73
|
+
* @throws {RequiredError}
|
|
74
|
+
*/
|
|
75
|
+
getUserAccountPositions: (userId: string, userSecret: string, accountId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
76
|
+
/**
|
|
77
|
+
*
|
|
78
|
+
* @summary List balances, positions and orders for the specified account.
|
|
79
|
+
* @param {string} accountId The ID of the account to fetch holdings for.
|
|
80
|
+
* @param {string} userId
|
|
81
|
+
* @param {string} userSecret
|
|
82
|
+
* @param {*} [options] Override http request option.
|
|
83
|
+
* @throws {RequiredError}
|
|
84
|
+
*/
|
|
85
|
+
getUserHoldings: (accountId: string, userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
86
|
+
/**
|
|
87
|
+
*
|
|
88
|
+
* @summary List accounts
|
|
89
|
+
* @param {string} userId
|
|
90
|
+
* @param {string} userSecret
|
|
91
|
+
* @param {*} [options] Override http request option.
|
|
92
|
+
* @throws {RequiredError}
|
|
93
|
+
*/
|
|
94
|
+
listUserAccounts: (userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
95
|
+
/**
|
|
96
|
+
*
|
|
97
|
+
* @summary Update details of an investment account
|
|
98
|
+
* @param {string} userId
|
|
99
|
+
* @param {string} userSecret
|
|
100
|
+
* @param {string} accountId The ID of the account to update.
|
|
101
|
+
* @param {*} [options] Override http request option.
|
|
102
|
+
* @throws {RequiredError}
|
|
103
|
+
*/
|
|
104
|
+
updateUserAccount: (userId: string, userSecret: string, accountId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
105
|
+
};
|
|
106
|
+
/**
|
|
107
|
+
* AccountInformationApi - functional programming interface
|
|
108
|
+
* @export
|
|
109
|
+
*/
|
|
110
|
+
export declare const AccountInformationApiFp: (configuration?: Configuration) => {
|
|
111
|
+
/**
|
|
112
|
+
*
|
|
113
|
+
* @summary List all accounts for the user, plus balances, positions, and orders for each account.
|
|
114
|
+
* @param {AccountInformationApiGetAllUserHoldingsRequest} requestParameters Request parameters.
|
|
115
|
+
* @param {*} [options] Override http request option.
|
|
116
|
+
* @throws {RequiredError}
|
|
117
|
+
*/
|
|
118
|
+
getAllUserHoldings(requestParameters: AccountInformationApiGetAllUserHoldingsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AccountHoldings>>>;
|
|
119
|
+
/**
|
|
120
|
+
*
|
|
121
|
+
* @summary List account balances
|
|
122
|
+
* @param {AccountInformationApiGetUserAccountBalanceRequest} requestParameters Request parameters.
|
|
123
|
+
* @param {*} [options] Override http request option.
|
|
124
|
+
* @throws {RequiredError}
|
|
125
|
+
*/
|
|
126
|
+
getUserAccountBalance(requestParameters: AccountInformationApiGetUserAccountBalanceRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Balance>>>;
|
|
127
|
+
/**
|
|
128
|
+
*
|
|
129
|
+
* @summary Return details of a specific investment account
|
|
130
|
+
* @param {AccountInformationApiGetUserAccountDetailsRequest} requestParameters Request parameters.
|
|
131
|
+
* @param {*} [options] Override http request option.
|
|
132
|
+
* @throws {RequiredError}
|
|
133
|
+
*/
|
|
134
|
+
getUserAccountDetails(requestParameters: AccountInformationApiGetUserAccountDetailsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Account>>;
|
|
135
|
+
/**
|
|
136
|
+
*
|
|
137
|
+
* @summary Get all history of orders placed in account
|
|
138
|
+
* @param {AccountInformationApiGetUserAccountOrdersRequest} requestParameters Request parameters.
|
|
139
|
+
* @param {*} [options] Override http request option.
|
|
140
|
+
* @throws {RequiredError}
|
|
141
|
+
*/
|
|
142
|
+
getUserAccountOrders(requestParameters: AccountInformationApiGetUserAccountOrdersRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AccountOrderRecord>>>;
|
|
143
|
+
/**
|
|
144
|
+
*
|
|
145
|
+
* @summary List account positions
|
|
146
|
+
* @param {AccountInformationApiGetUserAccountPositionsRequest} requestParameters Request parameters.
|
|
147
|
+
* @param {*} [options] Override http request option.
|
|
148
|
+
* @throws {RequiredError}
|
|
149
|
+
*/
|
|
150
|
+
getUserAccountPositions(requestParameters: AccountInformationApiGetUserAccountPositionsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Position>>>;
|
|
151
|
+
/**
|
|
152
|
+
*
|
|
153
|
+
* @summary List balances, positions and orders for the specified account.
|
|
154
|
+
* @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
|
|
155
|
+
* @param {*} [options] Override http request option.
|
|
156
|
+
* @throws {RequiredError}
|
|
157
|
+
*/
|
|
158
|
+
getUserHoldings(requestParameters: AccountInformationApiGetUserHoldingsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountHoldingsAccount>>;
|
|
159
|
+
/**
|
|
160
|
+
*
|
|
161
|
+
* @summary List accounts
|
|
162
|
+
* @param {AccountInformationApiListUserAccountsRequest} requestParameters Request parameters.
|
|
163
|
+
* @param {*} [options] Override http request option.
|
|
164
|
+
* @throws {RequiredError}
|
|
165
|
+
*/
|
|
166
|
+
listUserAccounts(requestParameters: AccountInformationApiListUserAccountsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Account>>>;
|
|
167
|
+
/**
|
|
168
|
+
*
|
|
169
|
+
* @summary Update details of an investment account
|
|
170
|
+
* @param {AccountInformationApiUpdateUserAccountRequest} requestParameters Request parameters.
|
|
171
|
+
* @param {*} [options] Override http request option.
|
|
172
|
+
* @throws {RequiredError}
|
|
173
|
+
*/
|
|
174
|
+
updateUserAccount(requestParameters: AccountInformationApiUpdateUserAccountRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Account>>>;
|
|
175
|
+
};
|
|
176
|
+
/**
|
|
177
|
+
* AccountInformationApi - factory interface
|
|
178
|
+
* @export
|
|
179
|
+
*/
|
|
180
|
+
export declare const AccountInformationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
181
|
+
/**
|
|
182
|
+
*
|
|
183
|
+
* @summary List all accounts for the user, plus balances, positions, and orders for each account.
|
|
184
|
+
* @param {AccountInformationApiGetAllUserHoldingsRequest} requestParameters Request parameters.
|
|
185
|
+
* @param {*} [options] Override http request option.
|
|
186
|
+
* @throws {RequiredError}
|
|
187
|
+
*/
|
|
188
|
+
getAllUserHoldings(requestParameters: AccountInformationApiGetAllUserHoldingsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<AccountHoldings>>;
|
|
189
|
+
/**
|
|
190
|
+
*
|
|
191
|
+
* @summary List account balances
|
|
192
|
+
* @param {AccountInformationApiGetUserAccountBalanceRequest} requestParameters Request parameters.
|
|
193
|
+
* @param {*} [options] Override http request option.
|
|
194
|
+
* @throws {RequiredError}
|
|
195
|
+
*/
|
|
196
|
+
getUserAccountBalance(requestParameters: AccountInformationApiGetUserAccountBalanceRequest, options?: AxiosRequestConfig): AxiosPromise<Array<Balance>>;
|
|
197
|
+
/**
|
|
198
|
+
*
|
|
199
|
+
* @summary Return details of a specific investment account
|
|
200
|
+
* @param {AccountInformationApiGetUserAccountDetailsRequest} requestParameters Request parameters.
|
|
201
|
+
* @param {*} [options] Override http request option.
|
|
202
|
+
* @throws {RequiredError}
|
|
203
|
+
*/
|
|
204
|
+
getUserAccountDetails(requestParameters: AccountInformationApiGetUserAccountDetailsRequest, options?: AxiosRequestConfig): AxiosPromise<Account>;
|
|
205
|
+
/**
|
|
206
|
+
*
|
|
207
|
+
* @summary Get all history of orders placed in account
|
|
208
|
+
* @param {AccountInformationApiGetUserAccountOrdersRequest} requestParameters Request parameters.
|
|
209
|
+
* @param {*} [options] Override http request option.
|
|
210
|
+
* @throws {RequiredError}
|
|
211
|
+
*/
|
|
212
|
+
getUserAccountOrders(requestParameters: AccountInformationApiGetUserAccountOrdersRequest, options?: AxiosRequestConfig): AxiosPromise<Array<AccountOrderRecord>>;
|
|
213
|
+
/**
|
|
214
|
+
*
|
|
215
|
+
* @summary List account positions
|
|
216
|
+
* @param {AccountInformationApiGetUserAccountPositionsRequest} requestParameters Request parameters.
|
|
217
|
+
* @param {*} [options] Override http request option.
|
|
218
|
+
* @throws {RequiredError}
|
|
219
|
+
*/
|
|
220
|
+
getUserAccountPositions(requestParameters: AccountInformationApiGetUserAccountPositionsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<Position>>;
|
|
221
|
+
/**
|
|
222
|
+
*
|
|
223
|
+
* @summary List balances, positions and orders for the specified account.
|
|
224
|
+
* @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
|
|
225
|
+
* @param {*} [options] Override http request option.
|
|
226
|
+
* @throws {RequiredError}
|
|
227
|
+
*/
|
|
228
|
+
getUserHoldings(requestParameters: AccountInformationApiGetUserHoldingsRequest, options?: AxiosRequestConfig): AxiosPromise<AccountHoldingsAccount>;
|
|
229
|
+
/**
|
|
230
|
+
*
|
|
231
|
+
* @summary List accounts
|
|
232
|
+
* @param {AccountInformationApiListUserAccountsRequest} requestParameters Request parameters.
|
|
233
|
+
* @param {*} [options] Override http request option.
|
|
234
|
+
* @throws {RequiredError}
|
|
235
|
+
*/
|
|
236
|
+
listUserAccounts(requestParameters: AccountInformationApiListUserAccountsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<Account>>;
|
|
237
|
+
/**
|
|
238
|
+
*
|
|
239
|
+
* @summary Update details of an investment account
|
|
240
|
+
* @param {AccountInformationApiUpdateUserAccountRequest} requestParameters Request parameters.
|
|
241
|
+
* @param {*} [options] Override http request option.
|
|
242
|
+
* @throws {RequiredError}
|
|
243
|
+
*/
|
|
244
|
+
updateUserAccount(requestParameters: AccountInformationApiUpdateUserAccountRequest, options?: AxiosRequestConfig): AxiosPromise<Array<Account>>;
|
|
245
|
+
};
|
|
246
|
+
/**
|
|
247
|
+
* Request parameters for getAllUserHoldings operation in AccountInformationApi.
|
|
248
|
+
* @export
|
|
249
|
+
* @interface AccountInformationApiGetAllUserHoldingsRequest
|
|
250
|
+
*/
|
|
251
|
+
export type AccountInformationApiGetAllUserHoldingsRequest = {
|
|
252
|
+
/**
|
|
253
|
+
*
|
|
254
|
+
* @type {string}
|
|
255
|
+
* @memberof AccountInformationApiGetAllUserHoldings
|
|
256
|
+
*/
|
|
257
|
+
readonly userId: string;
|
|
258
|
+
/**
|
|
259
|
+
*
|
|
260
|
+
* @type {string}
|
|
261
|
+
* @memberof AccountInformationApiGetAllUserHoldings
|
|
262
|
+
*/
|
|
263
|
+
readonly userSecret: string;
|
|
264
|
+
/**
|
|
265
|
+
* Optional. Comma seperated list of authorization IDs (only use if filtering is needed on one or more authorizations).
|
|
266
|
+
* @type {string}
|
|
267
|
+
* @memberof AccountInformationApiGetAllUserHoldings
|
|
268
|
+
*/
|
|
269
|
+
readonly brokerageAuthorizations?: string;
|
|
270
|
+
};
|
|
271
|
+
/**
|
|
272
|
+
* Request parameters for getUserAccountBalance operation in AccountInformationApi.
|
|
273
|
+
* @export
|
|
274
|
+
* @interface AccountInformationApiGetUserAccountBalanceRequest
|
|
275
|
+
*/
|
|
276
|
+
export type AccountInformationApiGetUserAccountBalanceRequest = {
|
|
277
|
+
/**
|
|
278
|
+
*
|
|
279
|
+
* @type {string}
|
|
280
|
+
* @memberof AccountInformationApiGetUserAccountBalance
|
|
281
|
+
*/
|
|
282
|
+
readonly userId: string;
|
|
283
|
+
/**
|
|
284
|
+
*
|
|
285
|
+
* @type {string}
|
|
286
|
+
* @memberof AccountInformationApiGetUserAccountBalance
|
|
287
|
+
*/
|
|
288
|
+
readonly userSecret: string;
|
|
289
|
+
/**
|
|
290
|
+
* The ID of the account get positions.
|
|
291
|
+
* @type {string}
|
|
292
|
+
* @memberof AccountInformationApiGetUserAccountBalance
|
|
293
|
+
*/
|
|
294
|
+
readonly accountId: string;
|
|
295
|
+
};
|
|
296
|
+
/**
|
|
297
|
+
* Request parameters for getUserAccountDetails operation in AccountInformationApi.
|
|
298
|
+
* @export
|
|
299
|
+
* @interface AccountInformationApiGetUserAccountDetailsRequest
|
|
300
|
+
*/
|
|
301
|
+
export type AccountInformationApiGetUserAccountDetailsRequest = {
|
|
302
|
+
/**
|
|
303
|
+
*
|
|
304
|
+
* @type {string}
|
|
305
|
+
* @memberof AccountInformationApiGetUserAccountDetails
|
|
306
|
+
*/
|
|
307
|
+
readonly userId: string;
|
|
308
|
+
/**
|
|
309
|
+
*
|
|
310
|
+
* @type {string}
|
|
311
|
+
* @memberof AccountInformationApiGetUserAccountDetails
|
|
312
|
+
*/
|
|
313
|
+
readonly userSecret: string;
|
|
314
|
+
/**
|
|
315
|
+
* The ID of the account to get detail of.
|
|
316
|
+
* @type {string}
|
|
317
|
+
* @memberof AccountInformationApiGetUserAccountDetails
|
|
318
|
+
*/
|
|
319
|
+
readonly accountId: string;
|
|
320
|
+
};
|
|
321
|
+
/**
|
|
322
|
+
* Request parameters for getUserAccountOrders operation in AccountInformationApi.
|
|
323
|
+
* @export
|
|
324
|
+
* @interface AccountInformationApiGetUserAccountOrdersRequest
|
|
325
|
+
*/
|
|
326
|
+
export type AccountInformationApiGetUserAccountOrdersRequest = {
|
|
327
|
+
/**
|
|
328
|
+
*
|
|
329
|
+
* @type {string}
|
|
330
|
+
* @memberof AccountInformationApiGetUserAccountOrders
|
|
331
|
+
*/
|
|
332
|
+
readonly userId: string;
|
|
333
|
+
/**
|
|
334
|
+
*
|
|
335
|
+
* @type {string}
|
|
336
|
+
* @memberof AccountInformationApiGetUserAccountOrders
|
|
337
|
+
*/
|
|
338
|
+
readonly userSecret: string;
|
|
339
|
+
/**
|
|
340
|
+
* The ID of the account get positions.
|
|
341
|
+
* @type {string}
|
|
342
|
+
* @memberof AccountInformationApiGetUserAccountOrders
|
|
343
|
+
*/
|
|
344
|
+
readonly accountId: string;
|
|
345
|
+
/**
|
|
346
|
+
* defaults value is set to \"all\"
|
|
347
|
+
* @type {'all' | 'open' | 'executed'}
|
|
348
|
+
* @memberof AccountInformationApiGetUserAccountOrders
|
|
349
|
+
*/
|
|
350
|
+
readonly state?: 'all' | 'open' | 'executed';
|
|
351
|
+
};
|
|
352
|
+
/**
|
|
353
|
+
* Request parameters for getUserAccountPositions operation in AccountInformationApi.
|
|
354
|
+
* @export
|
|
355
|
+
* @interface AccountInformationApiGetUserAccountPositionsRequest
|
|
356
|
+
*/
|
|
357
|
+
export type AccountInformationApiGetUserAccountPositionsRequest = {
|
|
358
|
+
/**
|
|
359
|
+
*
|
|
360
|
+
* @type {string}
|
|
361
|
+
* @memberof AccountInformationApiGetUserAccountPositions
|
|
362
|
+
*/
|
|
363
|
+
readonly userId: string;
|
|
364
|
+
/**
|
|
365
|
+
*
|
|
366
|
+
* @type {string}
|
|
367
|
+
* @memberof AccountInformationApiGetUserAccountPositions
|
|
368
|
+
*/
|
|
369
|
+
readonly userSecret: string;
|
|
370
|
+
/**
|
|
371
|
+
* The ID of the account get positions.
|
|
372
|
+
* @type {string}
|
|
373
|
+
* @memberof AccountInformationApiGetUserAccountPositions
|
|
374
|
+
*/
|
|
375
|
+
readonly accountId: string;
|
|
376
|
+
};
|
|
377
|
+
/**
|
|
378
|
+
* Request parameters for getUserHoldings operation in AccountInformationApi.
|
|
379
|
+
* @export
|
|
380
|
+
* @interface AccountInformationApiGetUserHoldingsRequest
|
|
381
|
+
*/
|
|
382
|
+
export type AccountInformationApiGetUserHoldingsRequest = {
|
|
383
|
+
/**
|
|
384
|
+
* The ID of the account to fetch holdings for.
|
|
385
|
+
* @type {string}
|
|
386
|
+
* @memberof AccountInformationApiGetUserHoldings
|
|
387
|
+
*/
|
|
388
|
+
readonly accountId: string;
|
|
389
|
+
/**
|
|
390
|
+
*
|
|
391
|
+
* @type {string}
|
|
392
|
+
* @memberof AccountInformationApiGetUserHoldings
|
|
393
|
+
*/
|
|
394
|
+
readonly userId: string;
|
|
395
|
+
/**
|
|
396
|
+
*
|
|
397
|
+
* @type {string}
|
|
398
|
+
* @memberof AccountInformationApiGetUserHoldings
|
|
399
|
+
*/
|
|
400
|
+
readonly userSecret: string;
|
|
401
|
+
};
|
|
402
|
+
/**
|
|
403
|
+
* Request parameters for listUserAccounts operation in AccountInformationApi.
|
|
404
|
+
* @export
|
|
405
|
+
* @interface AccountInformationApiListUserAccountsRequest
|
|
406
|
+
*/
|
|
407
|
+
export type AccountInformationApiListUserAccountsRequest = {
|
|
408
|
+
/**
|
|
409
|
+
*
|
|
410
|
+
* @type {string}
|
|
411
|
+
* @memberof AccountInformationApiListUserAccounts
|
|
412
|
+
*/
|
|
413
|
+
readonly userId: string;
|
|
414
|
+
/**
|
|
415
|
+
*
|
|
416
|
+
* @type {string}
|
|
417
|
+
* @memberof AccountInformationApiListUserAccounts
|
|
418
|
+
*/
|
|
419
|
+
readonly userSecret: string;
|
|
420
|
+
};
|
|
421
|
+
/**
|
|
422
|
+
* Request parameters for updateUserAccount operation in AccountInformationApi.
|
|
423
|
+
* @export
|
|
424
|
+
* @interface AccountInformationApiUpdateUserAccountRequest
|
|
425
|
+
*/
|
|
426
|
+
export type AccountInformationApiUpdateUserAccountRequest = {
|
|
427
|
+
/**
|
|
428
|
+
*
|
|
429
|
+
* @type {string}
|
|
430
|
+
* @memberof AccountInformationApiUpdateUserAccount
|
|
431
|
+
*/
|
|
432
|
+
readonly userId: string;
|
|
433
|
+
/**
|
|
434
|
+
*
|
|
435
|
+
* @type {string}
|
|
436
|
+
* @memberof AccountInformationApiUpdateUserAccount
|
|
437
|
+
*/
|
|
438
|
+
readonly userSecret: string;
|
|
439
|
+
/**
|
|
440
|
+
* The ID of the account to update.
|
|
441
|
+
* @type {string}
|
|
442
|
+
* @memberof AccountInformationApiUpdateUserAccount
|
|
443
|
+
*/
|
|
444
|
+
readonly accountId: string;
|
|
445
|
+
};
|
|
446
|
+
/**
|
|
447
|
+
* AccountInformationApiGenerated - object-oriented interface
|
|
448
|
+
* @export
|
|
449
|
+
* @class AccountInformationApiGenerated
|
|
450
|
+
* @extends {BaseAPI}
|
|
451
|
+
*/
|
|
452
|
+
export declare class AccountInformationApiGenerated extends BaseAPI {
|
|
453
|
+
/**
|
|
454
|
+
*
|
|
455
|
+
* @summary List all accounts for the user, plus balances, positions, and orders for each account.
|
|
456
|
+
* @param {AccountInformationApiGetAllUserHoldingsRequest} requestParameters Request parameters.
|
|
457
|
+
* @param {*} [options] Override http request option.
|
|
458
|
+
* @throws {RequiredError}
|
|
459
|
+
* @memberof AccountInformationApiGenerated
|
|
460
|
+
*/
|
|
461
|
+
getAllUserHoldings(requestParameters: AccountInformationApiGetAllUserHoldingsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountHoldings[], any>>;
|
|
462
|
+
/**
|
|
463
|
+
*
|
|
464
|
+
* @summary List account balances
|
|
465
|
+
* @param {AccountInformationApiGetUserAccountBalanceRequest} requestParameters Request parameters.
|
|
466
|
+
* @param {*} [options] Override http request option.
|
|
467
|
+
* @throws {RequiredError}
|
|
468
|
+
* @memberof AccountInformationApiGenerated
|
|
469
|
+
*/
|
|
470
|
+
getUserAccountBalance(requestParameters: AccountInformationApiGetUserAccountBalanceRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Balance[], any>>;
|
|
471
|
+
/**
|
|
472
|
+
*
|
|
473
|
+
* @summary Return details of a specific investment account
|
|
474
|
+
* @param {AccountInformationApiGetUserAccountDetailsRequest} requestParameters Request parameters.
|
|
475
|
+
* @param {*} [options] Override http request option.
|
|
476
|
+
* @throws {RequiredError}
|
|
477
|
+
* @memberof AccountInformationApiGenerated
|
|
478
|
+
*/
|
|
479
|
+
getUserAccountDetails(requestParameters: AccountInformationApiGetUserAccountDetailsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Account, any>>;
|
|
480
|
+
/**
|
|
481
|
+
*
|
|
482
|
+
* @summary Get all history of orders placed in account
|
|
483
|
+
* @param {AccountInformationApiGetUserAccountOrdersRequest} requestParameters Request parameters.
|
|
484
|
+
* @param {*} [options] Override http request option.
|
|
485
|
+
* @throws {RequiredError}
|
|
486
|
+
* @memberof AccountInformationApiGenerated
|
|
487
|
+
*/
|
|
488
|
+
getUserAccountOrders(requestParameters: AccountInformationApiGetUserAccountOrdersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord[], any>>;
|
|
489
|
+
/**
|
|
490
|
+
*
|
|
491
|
+
* @summary List account positions
|
|
492
|
+
* @param {AccountInformationApiGetUserAccountPositionsRequest} requestParameters Request parameters.
|
|
493
|
+
* @param {*} [options] Override http request option.
|
|
494
|
+
* @throws {RequiredError}
|
|
495
|
+
* @memberof AccountInformationApiGenerated
|
|
496
|
+
*/
|
|
497
|
+
getUserAccountPositions(requestParameters: AccountInformationApiGetUserAccountPositionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Position[], any>>;
|
|
498
|
+
/**
|
|
499
|
+
*
|
|
500
|
+
* @summary List balances, positions and orders for the specified account.
|
|
501
|
+
* @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
|
|
502
|
+
* @param {*} [options] Override http request option.
|
|
503
|
+
* @throws {RequiredError}
|
|
504
|
+
* @memberof AccountInformationApiGenerated
|
|
505
|
+
*/
|
|
506
|
+
getUserHoldings(requestParameters: AccountInformationApiGetUserHoldingsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountHoldingsAccount, any>>;
|
|
507
|
+
/**
|
|
508
|
+
*
|
|
509
|
+
* @summary List accounts
|
|
510
|
+
* @param {AccountInformationApiListUserAccountsRequest} requestParameters Request parameters.
|
|
511
|
+
* @param {*} [options] Override http request option.
|
|
512
|
+
* @throws {RequiredError}
|
|
513
|
+
* @memberof AccountInformationApiGenerated
|
|
514
|
+
*/
|
|
515
|
+
listUserAccounts(requestParameters: AccountInformationApiListUserAccountsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Account[], any>>;
|
|
516
|
+
/**
|
|
517
|
+
*
|
|
518
|
+
* @summary Update details of an investment account
|
|
519
|
+
* @param {AccountInformationApiUpdateUserAccountRequest} requestParameters Request parameters.
|
|
520
|
+
* @param {*} [options] Override http request option.
|
|
521
|
+
* @throws {RequiredError}
|
|
522
|
+
* @memberof AccountInformationApiGenerated
|
|
523
|
+
*/
|
|
524
|
+
updateUserAccount(requestParameters: AccountInformationApiUpdateUserAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Account[], any>>;
|
|
525
|
+
}
|