snaptrade-typescript-sdk 8.24.0 → 8.26.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 +147 -147
- package/dist/api/account-information-api-generated.d.ts +525 -525
- package/dist/api/account-information-api-generated.js +765 -765
- package/dist/api/account-information-api.d.ts +4 -4
- package/dist/api/account-information-api.js +22 -22
- package/dist/api/api-status-api-generated.d.ts +69 -69
- package/dist/api/api-status-api-generated.js +131 -131
- package/dist/api/api-status-api.d.ts +4 -4
- package/dist/api/api-status-api.js +22 -22
- package/dist/api/authentication-api-generated.d.ts +266 -266
- package/dist/api/authentication-api-generated.js +461 -461
- package/dist/api/authentication-api.d.ts +4 -4
- package/dist/api/authentication-api.js +22 -22
- package/dist/api/connections-api-generated.d.ts +274 -274
- package/dist/api/connections-api-generated.js +411 -411
- package/dist/api/connections-api.d.ts +4 -4
- package/dist/api/connections-api.js +22 -22
- package/dist/api/error-logs-api-generated.d.ts +93 -93
- package/dist/api/error-logs-api-generated.js +152 -152
- package/dist/api/error-logs-api.d.ts +4 -4
- package/dist/api/error-logs-api.js +22 -22
- package/dist/api/options-api-generated.d.ts +368 -368
- package/dist/api/options-api-generated.js +530 -530
- package/dist/api/options-api.d.ts +4 -4
- package/dist/api/options-api.js +22 -22
- package/dist/api/reference-data-api-generated.d.ts +467 -467
- package/dist/api/reference-data-api-generated.js +872 -872
- package/dist/api/reference-data-api.d.ts +4 -4
- package/dist/api/reference-data-api.js +22 -22
- package/dist/api/trading-api-generated.d.ts +402 -402
- package/dist/api/trading-api-generated.js +613 -613
- package/dist/api/trading-api.d.ts +4 -4
- package/dist/api/trading-api.js +22 -22
- package/dist/api/transactions-and-reporting-api-generated.d.ts +217 -217
- package/dist/api/transactions-and-reporting-api-generated.js +287 -287
- package/dist/api/transactions-and-reporting-api.d.ts +4 -4
- package/dist/api/transactions-and-reporting-api.js +22 -22
- package/dist/api.d.ts +19 -19
- package/dist/api.js +37 -37
- package/dist/base.d.ts +54 -54
- package/dist/base.js +60 -60
- package/dist/client-custom.d.ts +4 -4
- package/dist/client-custom.js +7 -7
- package/dist/client.d.ts +25 -25
- package/dist/client.js +32 -32
- package/dist/common.d.ts +67 -67
- package/dist/common.js +191 -177
- package/dist/configuration.d.ts +99 -99
- package/dist/configuration.js +53 -53
- package/dist/error.d.ts +56 -56
- package/dist/error.js +104 -104
- package/dist/index.d.ts +15 -15
- package/dist/index.js +33 -33
- package/dist/jest.config.d.ts +3 -3
- package/dist/jest.config.js +13 -13
- package/dist/models/account-holdings-account.d.ts +53 -53
- package/dist/models/account-holdings-account.js +14 -14
- package/dist/models/account-holdings.d.ts +46 -46
- package/dist/models/account-holdings.js +14 -14
- package/dist/models/account-order-record-status.d.ts +16 -16
- package/dist/models/account-order-record-status.js +14 -14
- package/dist/models/account-order-record.d.ts +132 -132
- package/dist/models/account-order-record.js +14 -14
- package/dist/models/account-simple.d.ts +43 -43
- package/dist/models/account-simple.js +14 -14
- package/dist/models/account-sync-status.d.ts +24 -24
- package/dist/models/account-sync-status.js +14 -14
- package/dist/models/account.d.ts +82 -82
- package/dist/models/account.js +14 -14
- package/dist/models/action.d.ts +16 -16
- package/dist/models/action.js +14 -14
- package/dist/models/authentication-login-snap-trade-user200-response.d.ts +17 -17
- package/dist/models/authentication-login-snap-trade-user200-response.js +14 -14
- package/dist/models/balance.d.ts +31 -31
- package/dist/models/balance.js +14 -14
- package/dist/models/brokerage-authorization-type-read-only-brokerage.d.ts +36 -36
- package/dist/models/brokerage-authorization-type-read-only-brokerage.js +14 -14
- package/dist/models/brokerage-authorization-type-read-only.d.ts +46 -46
- package/dist/models/brokerage-authorization-type-read-only.js +14 -14
- package/dist/models/brokerage-authorization-type.d.ts +26 -26
- package/dist/models/brokerage-authorization-type.js +14 -14
- package/dist/models/brokerage-authorization.d.ts +75 -75
- package/dist/models/brokerage-authorization.js +14 -14
- package/dist/models/brokerage-symbol-option-symbol.d.ts +66 -84
- package/dist/models/brokerage-symbol-option-symbol.js +14 -14
- package/dist/models/brokerage-symbol-symbol.d.ts +68 -68
- package/dist/models/brokerage-symbol-symbol.js +14 -14
- package/dist/models/brokerage-symbol.d.ts +57 -57
- package/dist/models/brokerage-symbol.js +14 -14
- package/dist/models/brokerage-type.d.ts +30 -30
- package/dist/models/brokerage-type.js +14 -14
- package/dist/models/brokerage.d.ts +127 -127
- package/dist/models/brokerage.js +14 -14
- package/dist/models/calculated-trade.d.ts +31 -31
- package/dist/models/calculated-trade.js +14 -14
- package/dist/models/cash-restriction.d.ts +50 -50
- package/dist/models/cash-restriction.js +14 -14
- package/dist/models/connections-session-events200-response-inner.d.ts +16 -16
- package/dist/models/connections-session-events200-response-inner.js +14 -14
- package/dist/models/currency.d.ts +36 -36
- package/dist/models/currency.js +14 -14
- package/dist/models/delete-user-response.d.ts +30 -30
- package/dist/models/delete-user-response.js +14 -14
- package/dist/models/dividend-at-date.d.ts +36 -36
- package/dist/models/dividend-at-date.js +14 -14
- package/dist/models/encrypted-response-encrypted-message-data.d.ts +36 -36
- package/dist/models/encrypted-response-encrypted-message-data.js +14 -14
- package/dist/models/encrypted-response.d.ts +30 -30
- package/dist/models/encrypted-response.js +14 -14
- package/dist/models/exchange-rate-pairs.d.ts +37 -37
- package/dist/models/exchange-rate-pairs.js +14 -14
- package/dist/models/exchange.d.ts +66 -66
- package/dist/models/exchange.js +14 -14
- package/dist/models/excluded-asset.d.ts +25 -25
- package/dist/models/excluded-asset.js +14 -14
- package/dist/models/index.d.ts +111 -110
- package/dist/models/index.js +127 -126
- package/dist/models/jwt.d.ts +24 -24
- package/dist/models/jwt.js +14 -14
- package/dist/models/login-redirect-uri.d.ts +29 -29
- package/dist/models/login-redirect-uri.js +14 -14
- package/dist/models/manual-trade-and-impact.d.ts +38 -38
- package/dist/models/manual-trade-and-impact.js +14 -14
- package/dist/models/manual-trade-balance.d.ts +38 -38
- package/dist/models/manual-trade-balance.js +14 -14
- package/dist/models/manual-trade-form.d.ts +68 -68
- package/dist/models/manual-trade-form.js +14 -14
- package/dist/models/manual-trade-symbol.d.ts +55 -55
- package/dist/models/manual-trade-symbol.js +14 -14
- package/dist/models/manual-trade.d.ts +70 -70
- package/dist/models/manual-trade.js +14 -14
- package/dist/models/model-asset-class-details.d.ts +32 -32
- package/dist/models/model-asset-class-details.js +14 -14
- package/dist/models/model-asset-class-target.d.ts +25 -25
- package/dist/models/model-asset-class-target.js +14 -14
- package/dist/models/model-asset-class.d.ts +30 -30
- package/dist/models/model-asset-class.js +14 -14
- package/dist/models/model-portfolio-asset-class.d.ts +31 -31
- package/dist/models/model-portfolio-asset-class.js +14 -14
- package/dist/models/model-portfolio-details.d.ts +39 -39
- package/dist/models/model-portfolio-details.js +14 -14
- package/dist/models/model-portfolio-security.d.ts +31 -31
- package/dist/models/model-portfolio-security.js +14 -14
- package/dist/models/model-portfolio.d.ts +38 -38
- package/dist/models/model-portfolio.js +14 -14
- package/dist/models/model400-failed-request-response.d.ts +30 -30
- package/dist/models/model400-failed-request-response.js +14 -14
- package/dist/models/model401-failed-request-response.d.ts +30 -30
- package/dist/models/model401-failed-request-response.js +14 -14
- package/dist/models/model403-failed-request-response.d.ts +30 -30
- package/dist/models/model403-failed-request-response.js +14 -14
- package/dist/models/model404-failed-request-response.d.ts +30 -30
- package/dist/models/model404-failed-request-response.js +14 -14
- package/dist/models/monthly-dividends.d.ts +31 -31
- package/dist/models/monthly-dividends.js +14 -14
- package/dist/models/net-contributions.d.ts +36 -36
- package/dist/models/net-contributions.js +14 -14
- package/dist/models/net-dividend.d.ts +37 -37
- package/dist/models/net-dividend.js +14 -14
- package/dist/models/option-chain-inner-chain-per-root-inner-chain-per-strike-price-inner.d.ts +36 -36
- package/dist/models/option-chain-inner-chain-per-root-inner-chain-per-strike-price-inner.js +14 -14
- package/dist/models/option-chain-inner-chain-per-root-inner.d.ts +37 -37
- package/dist/models/option-chain-inner-chain-per-root-inner.js +14 -14
- package/dist/models/option-chain-inner.d.ts +49 -49
- package/dist/models/option-chain-inner.js +14 -14
- package/dist/models/option-leg.d.ts +38 -38
- package/dist/models/option-leg.js +14 -14
- package/dist/models/option-strategy-legs-inner.d.ts +41 -41
- package/dist/models/option-strategy-legs-inner.js +14 -14
- package/dist/models/option-strategy.d.ts +50 -50
- package/dist/models/option-strategy.js +14 -14
- package/dist/models/options-get-option-strategy-request.d.ts +38 -38
- package/dist/models/options-get-option-strategy-request.js +14 -14
- package/dist/models/options-holdings.d.ts +56 -56
- package/dist/models/options-holdings.js +14 -14
- package/dist/models/options-place-option-strategy-request.d.ts +38 -38
- package/dist/models/options-place-option-strategy-request.js +14 -14
- package/dist/models/options-position-currency.d.ts +35 -0
- package/dist/models/options-position-currency.js +14 -0
- package/dist/models/options-position.d.ts +68 -62
- package/dist/models/options-position.js +14 -14
- package/dist/models/options-symbol.d.ts +67 -85
- package/dist/models/options-symbol.js +14 -14
- package/dist/models/order-type.d.ts +16 -16
- package/dist/models/order-type.js +14 -14
- package/dist/models/partner-data.d.ts +91 -91
- package/dist/models/partner-data.js +14 -14
- package/dist/models/past-value.d.ts +36 -36
- package/dist/models/past-value.js +14 -14
- package/dist/models/performance-custom.d.ts +137 -137
- package/dist/models/performance-custom.js +14 -14
- package/dist/models/portfolio-group-info.d.ts +92 -92
- package/dist/models/portfolio-group-info.js +14 -14
- package/dist/models/portfolio-group-position.d.ts +37 -37
- package/dist/models/portfolio-group-position.js +14 -14
- package/dist/models/portfolio-group-settings.d.ts +49 -49
- package/dist/models/portfolio-group-settings.js +14 -14
- package/dist/models/portfolio-group.d.ts +30 -30
- package/dist/models/portfolio-group.js +14 -14
- package/dist/models/position-symbol.d.ts +55 -55
- package/dist/models/position-symbol.js +14 -14
- package/dist/models/position.d.ts +61 -55
- package/dist/models/position.js +14 -14
- package/dist/models/redirect-tokenand-pin.d.ts +30 -30
- package/dist/models/redirect-tokenand-pin.js +14 -14
- package/dist/models/security-type.d.ts +42 -42
- package/dist/models/security-type.js +14 -14
- package/dist/models/session-event.d.ts +62 -62
- package/dist/models/session-event.js +14 -14
- package/dist/models/snap-trade-apidisclaimer-accept-status.d.ts +30 -30
- package/dist/models/snap-trade-apidisclaimer-accept-status.js +14 -14
- package/dist/models/snap-trade-holdings-account-account-id.d.ts +75 -75
- package/dist/models/snap-trade-holdings-account-account-id.js +14 -14
- package/dist/models/snap-trade-holdings-account.d.ts +70 -70
- package/dist/models/snap-trade-holdings-account.js +14 -14
- package/dist/models/snap-trade-holdings-total-value.d.ts +30 -30
- package/dist/models/snap-trade-holdings-total-value.js +14 -14
- package/dist/models/snap-trade-login-user-request-body.d.ts +49 -49
- package/dist/models/snap-trade-login-user-request-body.js +14 -14
- package/dist/models/snap-trade-register-user-request-body.d.ts +29 -29
- package/dist/models/snap-trade-register-user-request-body.js +14 -14
- package/dist/models/status.d.ts +36 -36
- package/dist/models/status.js +14 -14
- package/dist/models/strategy-impact-legs-inner.d.ts +60 -60
- package/dist/models/strategy-impact-legs-inner.js +14 -14
- package/dist/models/strategy-impact.d.ts +85 -85
- package/dist/models/strategy-impact.js +14 -14
- package/dist/models/strategy-order-place-orders-inner-legs-inner.d.ts +60 -60
- package/dist/models/strategy-order-place-orders-inner-legs-inner.js +14 -14
- package/dist/models/strategy-order-place-orders-inner.d.ts +277 -277
- package/dist/models/strategy-order-place-orders-inner.js +14 -14
- package/dist/models/strategy-order-place.d.ts +31 -31
- package/dist/models/strategy-order-place.js +14 -14
- package/dist/models/strategy-order-record.d.ts +89 -89
- package/dist/models/strategy-order-record.js +14 -14
- package/dist/models/strategy-quotes-greek.d.ts +48 -48
- package/dist/models/strategy-quotes-greek.js +14 -14
- package/dist/models/strategy-quotes.d.ts +56 -56
- package/dist/models/strategy-quotes.js +14 -14
- package/dist/models/sub-period-return-rate.d.ts +36 -36
- package/dist/models/sub-period-return-rate.js +14 -14
- package/dist/models/symbol-query.d.ts +23 -23
- package/dist/models/symbol-query.js +14 -14
- package/dist/models/symbol.d.ts +63 -63
- package/dist/models/symbol.js +14 -14
- package/dist/models/symbols-quotes-inner.d.ts +54 -54
- package/dist/models/symbols-quotes-inner.js +14 -14
- package/dist/models/target-asset.d.ts +57 -57
- package/dist/models/target-asset.js +14 -14
- package/dist/models/time-in-force.d.ts +16 -16
- package/dist/models/time-in-force.js +14 -14
- package/dist/models/trade-execution-status.d.ts +80 -80
- package/dist/models/trade-execution-status.js +14 -14
- package/dist/models/trade-impact.d.ts +50 -50
- package/dist/models/trade-impact.js +14 -14
- package/dist/models/trade.d.ts +71 -71
- package/dist/models/trade.js +14 -14
- package/dist/models/trading-cancel-user-account-order-request.d.ts +23 -23
- package/dist/models/trading-cancel-user-account-order-request.js +14 -14
- package/dist/models/trading-place-ocoorder-request.d.ts +29 -29
- package/dist/models/trading-place-ocoorder-request.js +14 -14
- package/dist/models/transactions-status.d.ts +29 -29
- package/dist/models/transactions-status.js +14 -14
- package/dist/models/underlying-symbol.d.ts +63 -63
- package/dist/models/underlying-symbol.js +14 -14
- package/dist/models/universal-activity.d.ts +118 -118
- package/dist/models/universal-activity.js +14 -14
- package/dist/models/universal-symbol-ticker.d.ts +69 -69
- package/dist/models/universal-symbol-ticker.js +14 -14
- package/dist/models/universal-symbol.d.ts +69 -69
- package/dist/models/universal-symbol.js +14 -14
- package/dist/models/user-error-log.d.ts +54 -54
- package/dist/models/user-error-log.js +14 -14
- package/dist/models/user-idand-secret.d.ts +30 -30
- package/dist/models/user-idand-secret.js +14 -14
- package/dist/models/user-settings.d.ts +79 -79
- package/dist/models/user-settings.js +14 -14
- package/dist/models/usexchange.d.ts +72 -72
- package/dist/models/usexchange.js +14 -14
- package/dist/pagination/page-types.d.ts +26 -26
- package/dist/pagination/page-types.js +12 -12
- package/dist/pagination/page.d.ts +35 -35
- package/dist/pagination/page.js +32 -32
- package/dist/pagination/pageable.d.ts +57 -57
- package/dist/pagination/pageable.js +70 -70
- package/dist/pagination/paginate.d.ts +16 -16
- package/dist/pagination/paginate.js +39 -39
- package/dist/requestAfterHook.d.ts +8 -8
- package/dist/requestAfterHook.js +45 -45
- package/dist/requestBeforeHook.d.ts +9 -9
- package/dist/requestBeforeHook.js +8 -8
- package/dist/requestBeforeUrlHook.d.ts +7 -7
- package/dist/requestBeforeUrlHook.js +5 -5
- package/package.json +42 -42
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { TradingApiGenerated } from "./trading-api-generated";
|
|
2
|
-
export * from "./trading-api-generated";
|
|
3
|
-
export declare class TradingApi extends TradingApiGenerated {
|
|
4
|
-
}
|
|
1
|
+
import { TradingApiGenerated } from "./trading-api-generated";
|
|
2
|
+
export * from "./trading-api-generated";
|
|
3
|
+
export declare class TradingApi extends TradingApiGenerated {
|
|
4
|
+
}
|
package/dist/api/trading-api.js
CHANGED
|
@@ -1,22 +1,22 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
-
if (k2 === undefined) k2 = k;
|
|
4
|
-
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
-
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
-
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
-
}
|
|
8
|
-
Object.defineProperty(o, k2, desc);
|
|
9
|
-
}) : (function(o, m, k, k2) {
|
|
10
|
-
if (k2 === undefined) k2 = k;
|
|
11
|
-
o[k2] = m[k];
|
|
12
|
-
}));
|
|
13
|
-
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
-
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
-
};
|
|
16
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
-
exports.TradingApi = void 0;
|
|
18
|
-
const trading_api_generated_1 = require("./trading-api-generated");
|
|
19
|
-
__exportStar(require("./trading-api-generated"), exports);
|
|
20
|
-
class TradingApi extends trading_api_generated_1.TradingApiGenerated {
|
|
21
|
-
}
|
|
22
|
-
exports.TradingApi = TradingApi;
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
exports.TradingApi = void 0;
|
|
18
|
+
const trading_api_generated_1 = require("./trading-api-generated");
|
|
19
|
+
__exportStar(require("./trading-api-generated"), exports);
|
|
20
|
+
class TradingApi extends trading_api_generated_1.TradingApiGenerated {
|
|
21
|
+
}
|
|
22
|
+
exports.TradingApi = TradingApi;
|
|
@@ -1,217 +1,217 @@
|
|
|
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 { PerformanceCustom } from '../models';
|
|
15
|
-
import { UniversalActivity } from '../models';
|
|
16
|
-
/**
|
|
17
|
-
* TransactionsAndReportingApi - axios parameter creator
|
|
18
|
-
* @export
|
|
19
|
-
*/
|
|
20
|
-
export declare const TransactionsAndReportingApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
21
|
-
/**
|
|
22
|
-
* Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
|
|
23
|
-
* @summary Get transaction history for a user
|
|
24
|
-
* @param {string} userId
|
|
25
|
-
* @param {string} userSecret
|
|
26
|
-
* @param {string | Date} [startDate]
|
|
27
|
-
* @param {string | Date} [endDate]
|
|
28
|
-
* @param {string} [accounts] Optional comma seperated list of account IDs used to filter the request on specific accounts
|
|
29
|
-
* @param {string} [brokerageAuthorizations] Optional comma seperated list of brokerage authorization IDs used to filter the request on only accounts that belong to those authorizations
|
|
30
|
-
* @param {string} [type] Optional comma seperated list of types to filter activities by. This is not an exhaustive list, if we fail to match to these types, we will return the raw description from the brokerage. Potential values include - DIVIDEND - BUY - SELL - CONTRIBUTION - WITHDRAWAL - EXTERNAL_ASSET_TRANSFER_IN - EXTERNAL_ASSET_TRANSFER_OUT - INTERNAL_CASH_TRANSFER_IN - INTERNAL_CASH_TRANSFER_OUT - INTERNAL_ASSET_TRANSFER_IN - INTERNAL_ASSET_TRANSFER_OUT - INTEREST - REBATE - GOV_GRANT - TAX - FEE - REI - FXT
|
|
31
|
-
* @param {*} [options] Override http request option.
|
|
32
|
-
* @throws {RequiredError}
|
|
33
|
-
*/
|
|
34
|
-
getActivities: (userId: string, userSecret: string, startDate?: string | Date, endDate?: string | Date, accounts?: string, brokerageAuthorizations?: string, type?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
35
|
-
/**
|
|
36
|
-
* Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Total Equity Timeframe and Rate of Returns are experimental and should not be trusted to be 100% accurate
|
|
37
|
-
* @summary Get performance information for a specific timeframe
|
|
38
|
-
* @param {string | Date} startDate
|
|
39
|
-
* @param {string | Date} endDate
|
|
40
|
-
* @param {string} userId
|
|
41
|
-
* @param {string} userSecret
|
|
42
|
-
* @param {string} [accounts] Optional comma seperated list of account IDs used to filter the request on specific accounts
|
|
43
|
-
* @param {boolean} [detailed] Optional, increases frequency of data points for the total value and contribution charts if set to true
|
|
44
|
-
* @param {string} [frequency] Optional frequency for the rate of return chart (defaults to monthly). Possible values are daily, weekly, monthly, quarterly, yearly.
|
|
45
|
-
* @param {*} [options] Override http request option.
|
|
46
|
-
* @throws {RequiredError}
|
|
47
|
-
*/
|
|
48
|
-
getReportingCustomRange: (startDate: string | Date, endDate: string | Date, userId: string, userSecret: string, accounts?: string, detailed?: boolean, frequency?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
49
|
-
};
|
|
50
|
-
/**
|
|
51
|
-
* TransactionsAndReportingApi - functional programming interface
|
|
52
|
-
* @export
|
|
53
|
-
*/
|
|
54
|
-
export declare const TransactionsAndReportingApiFp: (configuration?: Configuration) => {
|
|
55
|
-
/**
|
|
56
|
-
* Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
|
|
57
|
-
* @summary Get transaction history for a user
|
|
58
|
-
* @param {TransactionsAndReportingApiGetActivitiesRequest} requestParameters Request parameters.
|
|
59
|
-
* @param {*} [options] Override http request option.
|
|
60
|
-
* @throws {RequiredError}
|
|
61
|
-
*/
|
|
62
|
-
getActivities(requestParameters: TransactionsAndReportingApiGetActivitiesRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UniversalActivity>>>;
|
|
63
|
-
/**
|
|
64
|
-
* Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Total Equity Timeframe and Rate of Returns are experimental and should not be trusted to be 100% accurate
|
|
65
|
-
* @summary Get performance information for a specific timeframe
|
|
66
|
-
* @param {TransactionsAndReportingApiGetReportingCustomRangeRequest} requestParameters Request parameters.
|
|
67
|
-
* @param {*} [options] Override http request option.
|
|
68
|
-
* @throws {RequiredError}
|
|
69
|
-
*/
|
|
70
|
-
getReportingCustomRange(requestParameters: TransactionsAndReportingApiGetReportingCustomRangeRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PerformanceCustom>>;
|
|
71
|
-
};
|
|
72
|
-
/**
|
|
73
|
-
* TransactionsAndReportingApi - factory interface
|
|
74
|
-
* @export
|
|
75
|
-
*/
|
|
76
|
-
export declare const TransactionsAndReportingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
77
|
-
/**
|
|
78
|
-
* Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
|
|
79
|
-
* @summary Get transaction history for a user
|
|
80
|
-
* @param {TransactionsAndReportingApiGetActivitiesRequest} requestParameters Request parameters.
|
|
81
|
-
* @param {*} [options] Override http request option.
|
|
82
|
-
* @throws {RequiredError}
|
|
83
|
-
*/
|
|
84
|
-
getActivities(requestParameters: TransactionsAndReportingApiGetActivitiesRequest, options?: AxiosRequestConfig): AxiosPromise<Array<UniversalActivity>>;
|
|
85
|
-
/**
|
|
86
|
-
* Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Total Equity Timeframe and Rate of Returns are experimental and should not be trusted to be 100% accurate
|
|
87
|
-
* @summary Get performance information for a specific timeframe
|
|
88
|
-
* @param {TransactionsAndReportingApiGetReportingCustomRangeRequest} requestParameters Request parameters.
|
|
89
|
-
* @param {*} [options] Override http request option.
|
|
90
|
-
* @throws {RequiredError}
|
|
91
|
-
*/
|
|
92
|
-
getReportingCustomRange(requestParameters: TransactionsAndReportingApiGetReportingCustomRangeRequest, options?: AxiosRequestConfig): AxiosPromise<PerformanceCustom>;
|
|
93
|
-
};
|
|
94
|
-
/**
|
|
95
|
-
* Request parameters for getActivities operation in TransactionsAndReportingApi.
|
|
96
|
-
* @export
|
|
97
|
-
* @interface TransactionsAndReportingApiGetActivitiesRequest
|
|
98
|
-
*/
|
|
99
|
-
export type TransactionsAndReportingApiGetActivitiesRequest = {
|
|
100
|
-
/**
|
|
101
|
-
*
|
|
102
|
-
* @type {string}
|
|
103
|
-
* @memberof TransactionsAndReportingApiGetActivities
|
|
104
|
-
*/
|
|
105
|
-
readonly userId: string;
|
|
106
|
-
/**
|
|
107
|
-
*
|
|
108
|
-
* @type {string}
|
|
109
|
-
* @memberof TransactionsAndReportingApiGetActivities
|
|
110
|
-
*/
|
|
111
|
-
readonly userSecret: string;
|
|
112
|
-
/**
|
|
113
|
-
*
|
|
114
|
-
* @type {string | Date}
|
|
115
|
-
* @memberof TransactionsAndReportingApiGetActivities
|
|
116
|
-
*/
|
|
117
|
-
readonly startDate?: string | Date;
|
|
118
|
-
/**
|
|
119
|
-
*
|
|
120
|
-
* @type {string | Date}
|
|
121
|
-
* @memberof TransactionsAndReportingApiGetActivities
|
|
122
|
-
*/
|
|
123
|
-
readonly endDate?: string | Date;
|
|
124
|
-
/**
|
|
125
|
-
* Optional comma seperated list of account IDs used to filter the request on specific accounts
|
|
126
|
-
* @type {string}
|
|
127
|
-
* @memberof TransactionsAndReportingApiGetActivities
|
|
128
|
-
*/
|
|
129
|
-
readonly accounts?: string;
|
|
130
|
-
/**
|
|
131
|
-
* Optional comma seperated list of brokerage authorization IDs used to filter the request on only accounts that belong to those authorizations
|
|
132
|
-
* @type {string}
|
|
133
|
-
* @memberof TransactionsAndReportingApiGetActivities
|
|
134
|
-
*/
|
|
135
|
-
readonly brokerageAuthorizations?: string;
|
|
136
|
-
/**
|
|
137
|
-
* Optional comma seperated list of types to filter activities by. This is not an exhaustive list, if we fail to match to these types, we will return the raw description from the brokerage. Potential values include - DIVIDEND - BUY - SELL - CONTRIBUTION - WITHDRAWAL - EXTERNAL_ASSET_TRANSFER_IN - EXTERNAL_ASSET_TRANSFER_OUT - INTERNAL_CASH_TRANSFER_IN - INTERNAL_CASH_TRANSFER_OUT - INTERNAL_ASSET_TRANSFER_IN - INTERNAL_ASSET_TRANSFER_OUT - INTEREST - REBATE - GOV_GRANT - TAX - FEE - REI - FXT
|
|
138
|
-
* @type {string}
|
|
139
|
-
* @memberof TransactionsAndReportingApiGetActivities
|
|
140
|
-
*/
|
|
141
|
-
readonly type?: string;
|
|
142
|
-
};
|
|
143
|
-
/**
|
|
144
|
-
* Request parameters for getReportingCustomRange operation in TransactionsAndReportingApi.
|
|
145
|
-
* @export
|
|
146
|
-
* @interface TransactionsAndReportingApiGetReportingCustomRangeRequest
|
|
147
|
-
*/
|
|
148
|
-
export type TransactionsAndReportingApiGetReportingCustomRangeRequest = {
|
|
149
|
-
/**
|
|
150
|
-
*
|
|
151
|
-
* @type {string | Date}
|
|
152
|
-
* @memberof TransactionsAndReportingApiGetReportingCustomRange
|
|
153
|
-
*/
|
|
154
|
-
readonly startDate: string | Date;
|
|
155
|
-
/**
|
|
156
|
-
*
|
|
157
|
-
* @type {string | Date}
|
|
158
|
-
* @memberof TransactionsAndReportingApiGetReportingCustomRange
|
|
159
|
-
*/
|
|
160
|
-
readonly endDate: string | Date;
|
|
161
|
-
/**
|
|
162
|
-
*
|
|
163
|
-
* @type {string}
|
|
164
|
-
* @memberof TransactionsAndReportingApiGetReportingCustomRange
|
|
165
|
-
*/
|
|
166
|
-
readonly userId: string;
|
|
167
|
-
/**
|
|
168
|
-
*
|
|
169
|
-
* @type {string}
|
|
170
|
-
* @memberof TransactionsAndReportingApiGetReportingCustomRange
|
|
171
|
-
*/
|
|
172
|
-
readonly userSecret: string;
|
|
173
|
-
/**
|
|
174
|
-
* Optional comma seperated list of account IDs used to filter the request on specific accounts
|
|
175
|
-
* @type {string}
|
|
176
|
-
* @memberof TransactionsAndReportingApiGetReportingCustomRange
|
|
177
|
-
*/
|
|
178
|
-
readonly accounts?: string;
|
|
179
|
-
/**
|
|
180
|
-
* Optional, increases frequency of data points for the total value and contribution charts if set to true
|
|
181
|
-
* @type {boolean}
|
|
182
|
-
* @memberof TransactionsAndReportingApiGetReportingCustomRange
|
|
183
|
-
*/
|
|
184
|
-
readonly detailed?: boolean;
|
|
185
|
-
/**
|
|
186
|
-
* Optional frequency for the rate of return chart (defaults to monthly). Possible values are daily, weekly, monthly, quarterly, yearly.
|
|
187
|
-
* @type {string}
|
|
188
|
-
* @memberof TransactionsAndReportingApiGetReportingCustomRange
|
|
189
|
-
*/
|
|
190
|
-
readonly frequency?: string;
|
|
191
|
-
};
|
|
192
|
-
/**
|
|
193
|
-
* TransactionsAndReportingApiGenerated - object-oriented interface
|
|
194
|
-
* @export
|
|
195
|
-
* @class TransactionsAndReportingApiGenerated
|
|
196
|
-
* @extends {BaseAPI}
|
|
197
|
-
*/
|
|
198
|
-
export declare class TransactionsAndReportingApiGenerated extends BaseAPI {
|
|
199
|
-
/**
|
|
200
|
-
* Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
|
|
201
|
-
* @summary Get transaction history for a user
|
|
202
|
-
* @param {TransactionsAndReportingApiGetActivitiesRequest} requestParameters Request parameters.
|
|
203
|
-
* @param {*} [options] Override http request option.
|
|
204
|
-
* @throws {RequiredError}
|
|
205
|
-
* @memberof TransactionsAndReportingApiGenerated
|
|
206
|
-
*/
|
|
207
|
-
getActivities(requestParameters: TransactionsAndReportingApiGetActivitiesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UniversalActivity[], any>>;
|
|
208
|
-
/**
|
|
209
|
-
* Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Total Equity Timeframe and Rate of Returns are experimental and should not be trusted to be 100% accurate
|
|
210
|
-
* @summary Get performance information for a specific timeframe
|
|
211
|
-
* @param {TransactionsAndReportingApiGetReportingCustomRangeRequest} requestParameters Request parameters.
|
|
212
|
-
* @param {*} [options] Override http request option.
|
|
213
|
-
* @throws {RequiredError}
|
|
214
|
-
* @memberof TransactionsAndReportingApiGenerated
|
|
215
|
-
*/
|
|
216
|
-
getReportingCustomRange(requestParameters: TransactionsAndReportingApiGetReportingCustomRangeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PerformanceCustom, any>>;
|
|
217
|
-
}
|
|
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 { PerformanceCustom } from '../models';
|
|
15
|
+
import { UniversalActivity } from '../models';
|
|
16
|
+
/**
|
|
17
|
+
* TransactionsAndReportingApi - axios parameter creator
|
|
18
|
+
* @export
|
|
19
|
+
*/
|
|
20
|
+
export declare const TransactionsAndReportingApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
21
|
+
/**
|
|
22
|
+
* Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
|
|
23
|
+
* @summary Get transaction history for a user
|
|
24
|
+
* @param {string} userId
|
|
25
|
+
* @param {string} userSecret
|
|
26
|
+
* @param {string | Date} [startDate]
|
|
27
|
+
* @param {string | Date} [endDate]
|
|
28
|
+
* @param {string} [accounts] Optional comma seperated list of account IDs used to filter the request on specific accounts
|
|
29
|
+
* @param {string} [brokerageAuthorizations] Optional comma seperated list of brokerage authorization IDs used to filter the request on only accounts that belong to those authorizations
|
|
30
|
+
* @param {string} [type] Optional comma seperated list of types to filter activities by. This is not an exhaustive list, if we fail to match to these types, we will return the raw description from the brokerage. Potential values include - DIVIDEND - BUY - SELL - CONTRIBUTION - WITHDRAWAL - EXTERNAL_ASSET_TRANSFER_IN - EXTERNAL_ASSET_TRANSFER_OUT - INTERNAL_CASH_TRANSFER_IN - INTERNAL_CASH_TRANSFER_OUT - INTERNAL_ASSET_TRANSFER_IN - INTERNAL_ASSET_TRANSFER_OUT - INTEREST - REBATE - GOV_GRANT - TAX - FEE - REI - FXT
|
|
31
|
+
* @param {*} [options] Override http request option.
|
|
32
|
+
* @throws {RequiredError}
|
|
33
|
+
*/
|
|
34
|
+
getActivities: (userId: string, userSecret: string, startDate?: string | Date, endDate?: string | Date, accounts?: string, brokerageAuthorizations?: string, type?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
35
|
+
/**
|
|
36
|
+
* Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Total Equity Timeframe and Rate of Returns are experimental and should not be trusted to be 100% accurate
|
|
37
|
+
* @summary Get performance information for a specific timeframe
|
|
38
|
+
* @param {string | Date} startDate
|
|
39
|
+
* @param {string | Date} endDate
|
|
40
|
+
* @param {string} userId
|
|
41
|
+
* @param {string} userSecret
|
|
42
|
+
* @param {string} [accounts] Optional comma seperated list of account IDs used to filter the request on specific accounts
|
|
43
|
+
* @param {boolean} [detailed] Optional, increases frequency of data points for the total value and contribution charts if set to true
|
|
44
|
+
* @param {string} [frequency] Optional frequency for the rate of return chart (defaults to monthly). Possible values are daily, weekly, monthly, quarterly, yearly.
|
|
45
|
+
* @param {*} [options] Override http request option.
|
|
46
|
+
* @throws {RequiredError}
|
|
47
|
+
*/
|
|
48
|
+
getReportingCustomRange: (startDate: string | Date, endDate: string | Date, userId: string, userSecret: string, accounts?: string, detailed?: boolean, frequency?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
49
|
+
};
|
|
50
|
+
/**
|
|
51
|
+
* TransactionsAndReportingApi - functional programming interface
|
|
52
|
+
* @export
|
|
53
|
+
*/
|
|
54
|
+
export declare const TransactionsAndReportingApiFp: (configuration?: Configuration) => {
|
|
55
|
+
/**
|
|
56
|
+
* Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
|
|
57
|
+
* @summary Get transaction history for a user
|
|
58
|
+
* @param {TransactionsAndReportingApiGetActivitiesRequest} requestParameters Request parameters.
|
|
59
|
+
* @param {*} [options] Override http request option.
|
|
60
|
+
* @throws {RequiredError}
|
|
61
|
+
*/
|
|
62
|
+
getActivities(requestParameters: TransactionsAndReportingApiGetActivitiesRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UniversalActivity>>>;
|
|
63
|
+
/**
|
|
64
|
+
* Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Total Equity Timeframe and Rate of Returns are experimental and should not be trusted to be 100% accurate
|
|
65
|
+
* @summary Get performance information for a specific timeframe
|
|
66
|
+
* @param {TransactionsAndReportingApiGetReportingCustomRangeRequest} requestParameters Request parameters.
|
|
67
|
+
* @param {*} [options] Override http request option.
|
|
68
|
+
* @throws {RequiredError}
|
|
69
|
+
*/
|
|
70
|
+
getReportingCustomRange(requestParameters: TransactionsAndReportingApiGetReportingCustomRangeRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PerformanceCustom>>;
|
|
71
|
+
};
|
|
72
|
+
/**
|
|
73
|
+
* TransactionsAndReportingApi - factory interface
|
|
74
|
+
* @export
|
|
75
|
+
*/
|
|
76
|
+
export declare const TransactionsAndReportingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
77
|
+
/**
|
|
78
|
+
* Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
|
|
79
|
+
* @summary Get transaction history for a user
|
|
80
|
+
* @param {TransactionsAndReportingApiGetActivitiesRequest} requestParameters Request parameters.
|
|
81
|
+
* @param {*} [options] Override http request option.
|
|
82
|
+
* @throws {RequiredError}
|
|
83
|
+
*/
|
|
84
|
+
getActivities(requestParameters: TransactionsAndReportingApiGetActivitiesRequest, options?: AxiosRequestConfig): AxiosPromise<Array<UniversalActivity>>;
|
|
85
|
+
/**
|
|
86
|
+
* Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Total Equity Timeframe and Rate of Returns are experimental and should not be trusted to be 100% accurate
|
|
87
|
+
* @summary Get performance information for a specific timeframe
|
|
88
|
+
* @param {TransactionsAndReportingApiGetReportingCustomRangeRequest} requestParameters Request parameters.
|
|
89
|
+
* @param {*} [options] Override http request option.
|
|
90
|
+
* @throws {RequiredError}
|
|
91
|
+
*/
|
|
92
|
+
getReportingCustomRange(requestParameters: TransactionsAndReportingApiGetReportingCustomRangeRequest, options?: AxiosRequestConfig): AxiosPromise<PerformanceCustom>;
|
|
93
|
+
};
|
|
94
|
+
/**
|
|
95
|
+
* Request parameters for getActivities operation in TransactionsAndReportingApi.
|
|
96
|
+
* @export
|
|
97
|
+
* @interface TransactionsAndReportingApiGetActivitiesRequest
|
|
98
|
+
*/
|
|
99
|
+
export type TransactionsAndReportingApiGetActivitiesRequest = {
|
|
100
|
+
/**
|
|
101
|
+
*
|
|
102
|
+
* @type {string}
|
|
103
|
+
* @memberof TransactionsAndReportingApiGetActivities
|
|
104
|
+
*/
|
|
105
|
+
readonly userId: string;
|
|
106
|
+
/**
|
|
107
|
+
*
|
|
108
|
+
* @type {string}
|
|
109
|
+
* @memberof TransactionsAndReportingApiGetActivities
|
|
110
|
+
*/
|
|
111
|
+
readonly userSecret: string;
|
|
112
|
+
/**
|
|
113
|
+
*
|
|
114
|
+
* @type {string | Date}
|
|
115
|
+
* @memberof TransactionsAndReportingApiGetActivities
|
|
116
|
+
*/
|
|
117
|
+
readonly startDate?: string | Date;
|
|
118
|
+
/**
|
|
119
|
+
*
|
|
120
|
+
* @type {string | Date}
|
|
121
|
+
* @memberof TransactionsAndReportingApiGetActivities
|
|
122
|
+
*/
|
|
123
|
+
readonly endDate?: string | Date;
|
|
124
|
+
/**
|
|
125
|
+
* Optional comma seperated list of account IDs used to filter the request on specific accounts
|
|
126
|
+
* @type {string}
|
|
127
|
+
* @memberof TransactionsAndReportingApiGetActivities
|
|
128
|
+
*/
|
|
129
|
+
readonly accounts?: string;
|
|
130
|
+
/**
|
|
131
|
+
* Optional comma seperated list of brokerage authorization IDs used to filter the request on only accounts that belong to those authorizations
|
|
132
|
+
* @type {string}
|
|
133
|
+
* @memberof TransactionsAndReportingApiGetActivities
|
|
134
|
+
*/
|
|
135
|
+
readonly brokerageAuthorizations?: string;
|
|
136
|
+
/**
|
|
137
|
+
* Optional comma seperated list of types to filter activities by. This is not an exhaustive list, if we fail to match to these types, we will return the raw description from the brokerage. Potential values include - DIVIDEND - BUY - SELL - CONTRIBUTION - WITHDRAWAL - EXTERNAL_ASSET_TRANSFER_IN - EXTERNAL_ASSET_TRANSFER_OUT - INTERNAL_CASH_TRANSFER_IN - INTERNAL_CASH_TRANSFER_OUT - INTERNAL_ASSET_TRANSFER_IN - INTERNAL_ASSET_TRANSFER_OUT - INTEREST - REBATE - GOV_GRANT - TAX - FEE - REI - FXT
|
|
138
|
+
* @type {string}
|
|
139
|
+
* @memberof TransactionsAndReportingApiGetActivities
|
|
140
|
+
*/
|
|
141
|
+
readonly type?: string;
|
|
142
|
+
};
|
|
143
|
+
/**
|
|
144
|
+
* Request parameters for getReportingCustomRange operation in TransactionsAndReportingApi.
|
|
145
|
+
* @export
|
|
146
|
+
* @interface TransactionsAndReportingApiGetReportingCustomRangeRequest
|
|
147
|
+
*/
|
|
148
|
+
export type TransactionsAndReportingApiGetReportingCustomRangeRequest = {
|
|
149
|
+
/**
|
|
150
|
+
*
|
|
151
|
+
* @type {string | Date}
|
|
152
|
+
* @memberof TransactionsAndReportingApiGetReportingCustomRange
|
|
153
|
+
*/
|
|
154
|
+
readonly startDate: string | Date;
|
|
155
|
+
/**
|
|
156
|
+
*
|
|
157
|
+
* @type {string | Date}
|
|
158
|
+
* @memberof TransactionsAndReportingApiGetReportingCustomRange
|
|
159
|
+
*/
|
|
160
|
+
readonly endDate: string | Date;
|
|
161
|
+
/**
|
|
162
|
+
*
|
|
163
|
+
* @type {string}
|
|
164
|
+
* @memberof TransactionsAndReportingApiGetReportingCustomRange
|
|
165
|
+
*/
|
|
166
|
+
readonly userId: string;
|
|
167
|
+
/**
|
|
168
|
+
*
|
|
169
|
+
* @type {string}
|
|
170
|
+
* @memberof TransactionsAndReportingApiGetReportingCustomRange
|
|
171
|
+
*/
|
|
172
|
+
readonly userSecret: string;
|
|
173
|
+
/**
|
|
174
|
+
* Optional comma seperated list of account IDs used to filter the request on specific accounts
|
|
175
|
+
* @type {string}
|
|
176
|
+
* @memberof TransactionsAndReportingApiGetReportingCustomRange
|
|
177
|
+
*/
|
|
178
|
+
readonly accounts?: string;
|
|
179
|
+
/**
|
|
180
|
+
* Optional, increases frequency of data points for the total value and contribution charts if set to true
|
|
181
|
+
* @type {boolean}
|
|
182
|
+
* @memberof TransactionsAndReportingApiGetReportingCustomRange
|
|
183
|
+
*/
|
|
184
|
+
readonly detailed?: boolean;
|
|
185
|
+
/**
|
|
186
|
+
* Optional frequency for the rate of return chart (defaults to monthly). Possible values are daily, weekly, monthly, quarterly, yearly.
|
|
187
|
+
* @type {string}
|
|
188
|
+
* @memberof TransactionsAndReportingApiGetReportingCustomRange
|
|
189
|
+
*/
|
|
190
|
+
readonly frequency?: string;
|
|
191
|
+
};
|
|
192
|
+
/**
|
|
193
|
+
* TransactionsAndReportingApiGenerated - object-oriented interface
|
|
194
|
+
* @export
|
|
195
|
+
* @class TransactionsAndReportingApiGenerated
|
|
196
|
+
* @extends {BaseAPI}
|
|
197
|
+
*/
|
|
198
|
+
export declare class TransactionsAndReportingApiGenerated extends BaseAPI {
|
|
199
|
+
/**
|
|
200
|
+
* Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
|
|
201
|
+
* @summary Get transaction history for a user
|
|
202
|
+
* @param {TransactionsAndReportingApiGetActivitiesRequest} requestParameters Request parameters.
|
|
203
|
+
* @param {*} [options] Override http request option.
|
|
204
|
+
* @throws {RequiredError}
|
|
205
|
+
* @memberof TransactionsAndReportingApiGenerated
|
|
206
|
+
*/
|
|
207
|
+
getActivities(requestParameters: TransactionsAndReportingApiGetActivitiesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UniversalActivity[], any>>;
|
|
208
|
+
/**
|
|
209
|
+
* Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Total Equity Timeframe and Rate of Returns are experimental and should not be trusted to be 100% accurate
|
|
210
|
+
* @summary Get performance information for a specific timeframe
|
|
211
|
+
* @param {TransactionsAndReportingApiGetReportingCustomRangeRequest} requestParameters Request parameters.
|
|
212
|
+
* @param {*} [options] Override http request option.
|
|
213
|
+
* @throws {RequiredError}
|
|
214
|
+
* @memberof TransactionsAndReportingApiGenerated
|
|
215
|
+
*/
|
|
216
|
+
getReportingCustomRange(requestParameters: TransactionsAndReportingApiGetReportingCustomRangeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PerformanceCustom, any>>;
|
|
217
|
+
}
|