snaptrade-typescript-sdk 8.18.0 → 8.20.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.
Files changed (306) hide show
  1. package/README.md +147 -147
  2. package/dist/api/account-information-api-generated.d.ts +525 -0
  3. package/dist/api/account-information-api-generated.js +765 -0
  4. package/dist/api/account-information-api.d.ts +4 -526
  5. package/dist/api/account-information-api.js +22 -1049
  6. package/dist/api/api-status-api-generated.d.ts +69 -0
  7. package/dist/api/api-status-api-generated.js +131 -0
  8. package/dist/api/api-status-api.d.ts +4 -70
  9. package/dist/api/api-status-api.js +22 -203
  10. package/dist/api/authentication-api-generated.d.ts +266 -0
  11. package/dist/api/authentication-api-generated.js +461 -0
  12. package/dist/api/authentication-api.d.ts +4 -267
  13. package/dist/api/authentication-api.js +22 -661
  14. package/dist/api/connections-api-generated.d.ts +274 -0
  15. package/dist/api/connections-api-generated.js +411 -0
  16. package/dist/api/connections-api.d.ts +4 -275
  17. package/dist/api/connections-api.js +22 -583
  18. package/dist/api/error-logs-api-generated.d.ts +93 -0
  19. package/dist/api/error-logs-api-generated.js +152 -0
  20. package/dist/api/error-logs-api.d.ts +4 -94
  21. package/dist/api/error-logs-api.js +22 -240
  22. package/dist/api/options-api-generated.d.ts +368 -0
  23. package/dist/api/options-api-generated.js +530 -0
  24. package/dist/api/options-api.d.ts +4 -369
  25. package/dist/api/options-api.js +22 -730
  26. package/dist/api/reference-data-api-generated.d.ts +467 -0
  27. package/dist/api/reference-data-api-generated.js +872 -0
  28. package/dist/api/reference-data-api.d.ts +4 -468
  29. package/dist/api/reference-data-api.js +22 -1246
  30. package/dist/api/trading-api-generated.d.ts +402 -0
  31. package/dist/api/trading-api-generated.js +613 -0
  32. package/dist/api/trading-api.d.ts +4 -403
  33. package/dist/api/trading-api.js +22 -841
  34. package/dist/api/transactions-and-reporting-api-generated.d.ts +217 -0
  35. package/dist/api/transactions-and-reporting-api-generated.js +287 -0
  36. package/dist/api/transactions-and-reporting-api.d.ts +4 -218
  37. package/dist/api/transactions-and-reporting-api.js +22 -403
  38. package/dist/api.d.ts +19 -19
  39. package/dist/api.js +37 -37
  40. package/dist/base.d.ts +54 -54
  41. package/dist/base.js +60 -81
  42. package/dist/client-custom.d.ts +4 -4
  43. package/dist/client-custom.js +7 -9
  44. package/dist/client.d.ts +25 -25
  45. package/dist/client.js +32 -50
  46. package/dist/common.d.ts +67 -67
  47. package/dist/common.js +177 -236
  48. package/dist/configuration.d.ts +99 -99
  49. package/dist/configuration.js +53 -55
  50. package/dist/error.d.ts +56 -0
  51. package/dist/error.js +104 -0
  52. package/dist/index.d.ts +15 -14
  53. package/dist/index.js +33 -32
  54. package/dist/jest.config.d.ts +3 -3
  55. package/dist/jest.config.js +13 -13
  56. package/dist/models/account-holdings-account.d.ts +53 -53
  57. package/dist/models/account-holdings-account.js +14 -14
  58. package/dist/models/account-holdings.d.ts +46 -46
  59. package/dist/models/account-holdings.js +14 -14
  60. package/dist/models/account-order-record-status.d.ts +16 -16
  61. package/dist/models/account-order-record-status.js +14 -14
  62. package/dist/models/account-order-record.d.ts +132 -132
  63. package/dist/models/account-order-record.js +14 -14
  64. package/dist/models/account-simple.d.ts +43 -43
  65. package/dist/models/account-simple.js +14 -14
  66. package/dist/models/account-sync-status.d.ts +24 -24
  67. package/dist/models/account-sync-status.js +14 -14
  68. package/dist/models/account.d.ts +82 -82
  69. package/dist/models/account.js +14 -14
  70. package/dist/models/action.d.ts +16 -16
  71. package/dist/models/action.js +14 -14
  72. package/dist/models/authentication-login-snap-trade-user200-response.d.ts +17 -17
  73. package/dist/models/authentication-login-snap-trade-user200-response.js +14 -14
  74. package/dist/models/balance.d.ts +31 -31
  75. package/dist/models/balance.js +14 -14
  76. package/dist/models/brokerage-authorization-type-read-only-brokerage.d.ts +36 -36
  77. package/dist/models/brokerage-authorization-type-read-only-brokerage.js +14 -14
  78. package/dist/models/brokerage-authorization-type-read-only.d.ts +46 -46
  79. package/dist/models/brokerage-authorization-type-read-only.js +14 -14
  80. package/dist/models/brokerage-authorization-type.d.ts +26 -26
  81. package/dist/models/brokerage-authorization-type.js +14 -14
  82. package/dist/models/brokerage-authorization.d.ts +75 -75
  83. package/dist/models/brokerage-authorization.js +14 -14
  84. package/dist/models/brokerage-symbol.d.ts +50 -50
  85. package/dist/models/brokerage-symbol.js +14 -14
  86. package/dist/models/brokerage-type.d.ts +30 -30
  87. package/dist/models/brokerage-type.js +14 -14
  88. package/dist/models/brokerage.d.ts +127 -127
  89. package/dist/models/brokerage.js +14 -14
  90. package/dist/models/calculated-trade.d.ts +31 -31
  91. package/dist/models/calculated-trade.js +14 -14
  92. package/dist/models/cash-restriction.d.ts +50 -50
  93. package/dist/models/cash-restriction.js +14 -14
  94. package/dist/models/connections-session-events200-response-inner.d.ts +16 -16
  95. package/dist/models/connections-session-events200-response-inner.js +14 -14
  96. package/dist/models/currency.d.ts +36 -36
  97. package/dist/models/currency.js +14 -14
  98. package/dist/models/delete-user-response.d.ts +30 -30
  99. package/dist/models/delete-user-response.js +14 -14
  100. package/dist/models/dividend-at-date.d.ts +36 -36
  101. package/dist/models/dividend-at-date.js +14 -14
  102. package/dist/models/encrypted-response-encrypted-message-data.d.ts +36 -36
  103. package/dist/models/encrypted-response-encrypted-message-data.js +14 -14
  104. package/dist/models/encrypted-response.d.ts +30 -30
  105. package/dist/models/encrypted-response.js +14 -14
  106. package/dist/models/exchange-rate-pairs.d.ts +37 -37
  107. package/dist/models/exchange-rate-pairs.js +14 -14
  108. package/dist/models/exchange.d.ts +66 -66
  109. package/dist/models/exchange.js +14 -14
  110. package/dist/models/excluded-asset.d.ts +25 -25
  111. package/dist/models/excluded-asset.js +14 -14
  112. package/dist/models/index.d.ts +108 -108
  113. package/dist/models/index.js +124 -124
  114. package/dist/models/jwt.d.ts +24 -24
  115. package/dist/models/jwt.js +14 -14
  116. package/dist/models/login-redirect-uri.d.ts +29 -29
  117. package/dist/models/login-redirect-uri.js +14 -14
  118. package/dist/models/manual-trade-and-impact.d.ts +38 -38
  119. package/dist/models/manual-trade-and-impact.js +14 -14
  120. package/dist/models/manual-trade-balance.d.ts +38 -38
  121. package/dist/models/manual-trade-balance.js +14 -14
  122. package/dist/models/manual-trade-form.d.ts +68 -68
  123. package/dist/models/manual-trade-form.js +14 -14
  124. package/dist/models/manual-trade-symbol.d.ts +55 -55
  125. package/dist/models/manual-trade-symbol.js +14 -14
  126. package/dist/models/manual-trade.d.ts +70 -70
  127. package/dist/models/manual-trade.js +14 -14
  128. package/dist/models/model-asset-class-details.d.ts +32 -32
  129. package/dist/models/model-asset-class-details.js +14 -14
  130. package/dist/models/model-asset-class-target.d.ts +25 -25
  131. package/dist/models/model-asset-class-target.js +14 -14
  132. package/dist/models/model-asset-class.d.ts +30 -30
  133. package/dist/models/model-asset-class.js +14 -14
  134. package/dist/models/model-portfolio-asset-class.d.ts +31 -31
  135. package/dist/models/model-portfolio-asset-class.js +14 -14
  136. package/dist/models/model-portfolio-details.d.ts +39 -39
  137. package/dist/models/model-portfolio-details.js +14 -14
  138. package/dist/models/model-portfolio-security.d.ts +31 -31
  139. package/dist/models/model-portfolio-security.js +14 -14
  140. package/dist/models/model-portfolio.d.ts +38 -38
  141. package/dist/models/model-portfolio.js +14 -14
  142. package/dist/models/model400-failed-request-response.d.ts +30 -30
  143. package/dist/models/model400-failed-request-response.js +14 -14
  144. package/dist/models/model401-failed-request-response.d.ts +30 -30
  145. package/dist/models/model401-failed-request-response.js +14 -14
  146. package/dist/models/model403-failed-request-response.d.ts +30 -30
  147. package/dist/models/model403-failed-request-response.js +14 -14
  148. package/dist/models/model404-failed-request-response.d.ts +30 -30
  149. package/dist/models/model404-failed-request-response.js +14 -14
  150. package/dist/models/monthly-dividends.d.ts +31 -31
  151. package/dist/models/monthly-dividends.js +14 -14
  152. package/dist/models/net-contributions.d.ts +36 -36
  153. package/dist/models/net-contributions.js +14 -14
  154. package/dist/models/net-dividend.d.ts +37 -37
  155. package/dist/models/net-dividend.js +14 -14
  156. package/dist/models/option-chain-inner-chain-per-root-inner-chain-per-strike-price-inner.d.ts +36 -36
  157. package/dist/models/option-chain-inner-chain-per-root-inner-chain-per-strike-price-inner.js +14 -14
  158. package/dist/models/option-chain-inner-chain-per-root-inner.d.ts +37 -37
  159. package/dist/models/option-chain-inner-chain-per-root-inner.js +14 -14
  160. package/dist/models/option-chain-inner.d.ts +49 -49
  161. package/dist/models/option-chain-inner.js +14 -14
  162. package/dist/models/option-leg.d.ts +38 -38
  163. package/dist/models/option-leg.js +14 -14
  164. package/dist/models/option-strategy-legs-inner.d.ts +41 -41
  165. package/dist/models/option-strategy-legs-inner.js +14 -14
  166. package/dist/models/option-strategy.d.ts +50 -50
  167. package/dist/models/option-strategy.js +14 -14
  168. package/dist/models/options-get-option-strategy-request.d.ts +38 -38
  169. package/dist/models/options-get-option-strategy-request.js +14 -14
  170. package/dist/models/options-holdings.d.ts +56 -56
  171. package/dist/models/options-holdings.js +14 -14
  172. package/dist/models/options-place-option-strategy-request.d.ts +38 -38
  173. package/dist/models/options-place-option-strategy-request.js +14 -14
  174. package/dist/models/options-position.d.ts +62 -62
  175. package/dist/models/options-position.js +14 -14
  176. package/dist/models/options-symbol.d.ts +85 -85
  177. package/dist/models/options-symbol.js +14 -14
  178. package/dist/models/order-type.d.ts +16 -16
  179. package/dist/models/order-type.js +14 -14
  180. package/dist/models/partner-data.d.ts +91 -91
  181. package/dist/models/partner-data.js +14 -14
  182. package/dist/models/past-value.d.ts +36 -36
  183. package/dist/models/past-value.js +14 -14
  184. package/dist/models/performance-custom.d.ts +137 -137
  185. package/dist/models/performance-custom.js +14 -14
  186. package/dist/models/portfolio-group-info.d.ts +92 -92
  187. package/dist/models/portfolio-group-info.js +14 -14
  188. package/dist/models/portfolio-group-position.d.ts +37 -37
  189. package/dist/models/portfolio-group-position.js +14 -14
  190. package/dist/models/portfolio-group-settings.d.ts +49 -49
  191. package/dist/models/portfolio-group-settings.js +14 -14
  192. package/dist/models/portfolio-group.d.ts +30 -30
  193. package/dist/models/portfolio-group.js +14 -14
  194. package/dist/models/position-symbol.d.ts +55 -55
  195. package/dist/models/position-symbol.js +14 -14
  196. package/dist/models/position.d.ts +55 -55
  197. package/dist/models/position.js +14 -14
  198. package/dist/models/redirect-tokenand-pin.d.ts +30 -30
  199. package/dist/models/redirect-tokenand-pin.js +14 -14
  200. package/dist/models/security-type.d.ts +42 -42
  201. package/dist/models/security-type.js +14 -14
  202. package/dist/models/session-event.d.ts +62 -62
  203. package/dist/models/session-event.js +14 -14
  204. package/dist/models/snap-trade-apidisclaimer-accept-status.d.ts +30 -30
  205. package/dist/models/snap-trade-apidisclaimer-accept-status.js +14 -14
  206. package/dist/models/snap-trade-holdings-account-account-id.d.ts +75 -75
  207. package/dist/models/snap-trade-holdings-account-account-id.js +14 -14
  208. package/dist/models/snap-trade-holdings-account.d.ts +70 -70
  209. package/dist/models/snap-trade-holdings-account.js +14 -14
  210. package/dist/models/snap-trade-holdings-total-value.d.ts +30 -30
  211. package/dist/models/snap-trade-holdings-total-value.js +14 -14
  212. package/dist/models/snap-trade-login-user-request-body.d.ts +49 -49
  213. package/dist/models/snap-trade-login-user-request-body.js +14 -14
  214. package/dist/models/snap-trade-register-user-request-body.d.ts +29 -29
  215. package/dist/models/snap-trade-register-user-request-body.js +14 -14
  216. package/dist/models/status.d.ts +36 -36
  217. package/dist/models/status.js +14 -14
  218. package/dist/models/strategy-impact-legs-inner.d.ts +60 -60
  219. package/dist/models/strategy-impact-legs-inner.js +14 -14
  220. package/dist/models/strategy-impact.d.ts +85 -85
  221. package/dist/models/strategy-impact.js +14 -14
  222. package/dist/models/strategy-order-place-orders-inner-legs-inner.d.ts +60 -60
  223. package/dist/models/strategy-order-place-orders-inner-legs-inner.js +14 -14
  224. package/dist/models/strategy-order-place-orders-inner.d.ts +277 -277
  225. package/dist/models/strategy-order-place-orders-inner.js +14 -14
  226. package/dist/models/strategy-order-place.d.ts +31 -31
  227. package/dist/models/strategy-order-place.js +14 -14
  228. package/dist/models/strategy-order-record.d.ts +89 -89
  229. package/dist/models/strategy-order-record.js +14 -14
  230. package/dist/models/strategy-quotes-greek.d.ts +48 -48
  231. package/dist/models/strategy-quotes-greek.js +14 -14
  232. package/dist/models/strategy-quotes.d.ts +56 -56
  233. package/dist/models/strategy-quotes.js +14 -14
  234. package/dist/models/sub-period-return-rate.d.ts +36 -36
  235. package/dist/models/sub-period-return-rate.js +14 -14
  236. package/dist/models/symbol-query.d.ts +23 -23
  237. package/dist/models/symbol-query.js +14 -14
  238. package/dist/models/symbol.d.ts +63 -63
  239. package/dist/models/symbol.js +14 -14
  240. package/dist/models/symbols-quotes-inner.d.ts +54 -54
  241. package/dist/models/symbols-quotes-inner.js +14 -14
  242. package/dist/models/target-asset.d.ts +57 -57
  243. package/dist/models/target-asset.js +14 -14
  244. package/dist/models/time-in-force.d.ts +16 -16
  245. package/dist/models/time-in-force.js +14 -14
  246. package/dist/models/trade-execution-status.d.ts +80 -80
  247. package/dist/models/trade-execution-status.js +14 -14
  248. package/dist/models/trade-impact.d.ts +50 -50
  249. package/dist/models/trade-impact.js +14 -14
  250. package/dist/models/trade.d.ts +71 -71
  251. package/dist/models/trade.js +14 -14
  252. package/dist/models/trading-cancel-user-account-order-request.d.ts +23 -23
  253. package/dist/models/trading-cancel-user-account-order-request.js +14 -14
  254. package/dist/models/trading-place-ocoorder-request.d.ts +29 -29
  255. package/dist/models/trading-place-ocoorder-request.js +14 -14
  256. package/dist/models/transactions-status.d.ts +29 -29
  257. package/dist/models/transactions-status.js +14 -14
  258. package/dist/models/underlying-symbol.d.ts +63 -63
  259. package/dist/models/underlying-symbol.js +14 -14
  260. package/dist/models/universal-activity.d.ts +118 -118
  261. package/dist/models/universal-activity.js +14 -14
  262. package/dist/models/universal-symbol-ticker.d.ts +69 -69
  263. package/dist/models/universal-symbol-ticker.js +14 -14
  264. package/dist/models/universal-symbol.d.ts +69 -69
  265. package/dist/models/universal-symbol.js +14 -14
  266. package/dist/models/user-error-log.d.ts +54 -54
  267. package/dist/models/user-error-log.js +14 -14
  268. package/dist/models/user-idand-secret.d.ts +30 -30
  269. package/dist/models/user-idand-secret.js +14 -14
  270. package/dist/models/user-settings.d.ts +79 -79
  271. package/dist/models/user-settings.js +14 -14
  272. package/dist/models/usexchange.d.ts +72 -72
  273. package/dist/models/usexchange.js +14 -14
  274. package/dist/pagination/page-types.d.ts +26 -26
  275. package/dist/pagination/page-types.js +12 -12
  276. package/dist/pagination/page.d.ts +35 -35
  277. package/dist/pagination/page.js +32 -60
  278. package/dist/pagination/pageable.d.ts +57 -57
  279. package/dist/pagination/pageable.js +70 -126
  280. package/dist/pagination/paginate.d.ts +16 -16
  281. package/dist/pagination/paginate.js +39 -77
  282. package/dist/requestAfterHook.d.ts +8 -8
  283. package/dist/requestAfterHook.js +45 -45
  284. package/dist/requestBeforeHook.d.ts +9 -9
  285. package/dist/requestBeforeHook.js +8 -8
  286. package/dist/requestBeforeUrlHook.d.ts +7 -0
  287. package/dist/requestBeforeUrlHook.js +5 -0
  288. package/package.json +42 -42
  289. package/dist/api/account-information-api-custom.d.ts +0 -3
  290. package/dist/api/account-information-api-custom.js +0 -27
  291. package/dist/api/api-status-api-custom.d.ts +0 -3
  292. package/dist/api/api-status-api-custom.js +0 -27
  293. package/dist/api/authentication-api-custom.d.ts +0 -3
  294. package/dist/api/authentication-api-custom.js +0 -27
  295. package/dist/api/connections-api-custom.d.ts +0 -3
  296. package/dist/api/connections-api-custom.js +0 -27
  297. package/dist/api/error-logs-api-custom.d.ts +0 -3
  298. package/dist/api/error-logs-api-custom.js +0 -27
  299. package/dist/api/options-api-custom.d.ts +0 -3
  300. package/dist/api/options-api-custom.js +0 -27
  301. package/dist/api/reference-data-api-custom.d.ts +0 -3
  302. package/dist/api/reference-data-api-custom.js +0 -27
  303. package/dist/api/trading-api-custom.d.ts +0 -3
  304. package/dist/api/trading-api-custom.js +0 -27
  305. package/dist/api/transactions-and-reporting-api-custom.d.ts +0 -3
  306. package/dist/api/transactions-and-reporting-api-custom.js +0 -27
@@ -0,0 +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. 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. 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
+ }
@@ -0,0 +1,287 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * SnapTrade
6
+ * Connect brokerage accounts to your app for live positions and trading
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ * Contact: api@snaptrade.com
10
+ *
11
+ * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
12
+ * Do not edit the class manually.
13
+ */
14
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
15
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
16
+ return new (P || (P = Promise))(function (resolve, reject) {
17
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
18
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
19
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
20
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
21
+ });
22
+ };
23
+ Object.defineProperty(exports, "__esModule", { value: true });
24
+ exports.TransactionsAndReportingApiGenerated = exports.TransactionsAndReportingApiFactory = exports.TransactionsAndReportingApiFp = exports.TransactionsAndReportingApiAxiosParamCreator = void 0;
25
+ const axios_1 = require("axios");
26
+ // Some imports not used depending on template conditions
27
+ // @ts-ignore
28
+ const common_1 = require("../common");
29
+ // @ts-ignore
30
+ const base_1 = require("../base");
31
+ const requestBeforeHook_1 = require("../requestBeforeHook");
32
+ /**
33
+ * TransactionsAndReportingApi - axios parameter creator
34
+ * @export
35
+ */
36
+ const TransactionsAndReportingApiAxiosParamCreator = function (configuration) {
37
+ return {
38
+ /**
39
+ * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
40
+ * @summary Get transaction history for a user
41
+ * @param {string} userId
42
+ * @param {string} userSecret
43
+ * @param {string | Date} [startDate]
44
+ * @param {string | Date} [endDate]
45
+ * @param {string} [accounts] Optional comma seperated list of account IDs used to filter the request on specific accounts
46
+ * @param {string} [brokerageAuthorizations] Optional comma seperated list of brokerage authorization IDs used to filter the request on only accounts that belong to those authorizations
47
+ * @param {string} [type] Optional comma seperated list of types to filter activities by. 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
48
+ * @param {*} [options] Override http request option.
49
+ * @throws {RequiredError}
50
+ */
51
+ getActivities: (userId, userSecret, startDate, endDate, accounts, brokerageAuthorizations, type, options = {}) => __awaiter(this, void 0, void 0, function* () {
52
+ // verify required parameter 'userId' is not null or undefined
53
+ (0, common_1.assertParamExists)('getActivities', 'userId', userId);
54
+ // verify required parameter 'userSecret' is not null or undefined
55
+ (0, common_1.assertParamExists)('getActivities', 'userSecret', userSecret);
56
+ const localVarPath = `/activities`;
57
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
58
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
59
+ let baseOptions;
60
+ if (configuration) {
61
+ baseOptions = configuration.baseOptions;
62
+ }
63
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
64
+ const localVarHeaderParameter = configuration && !(0, common_1.isBrowser)() ? { "User-Agent": configuration.userAgent } : {};
65
+ const localVarQueryParameter = {};
66
+ // authentication PartnerClientId required
67
+ yield (0, common_1.setApiKeyToObject)({ object: localVarQueryParameter, keyParamName: "clientId", configuration });
68
+ // authentication PartnerSignature required
69
+ yield (0, common_1.setApiKeyToObject)({ object: localVarHeaderParameter, keyParamName: "Signature", configuration });
70
+ // authentication PartnerTimestamp required
71
+ yield (0, common_1.setApiKeyToObject)({ object: localVarQueryParameter, keyParamName: "timestamp", configuration });
72
+ if (startDate !== undefined) {
73
+ localVarQueryParameter['startDate'] = (startDate instanceof Date) ?
74
+ startDate.toISOString().substr(0, 10) :
75
+ startDate;
76
+ }
77
+ if (endDate !== undefined) {
78
+ localVarQueryParameter['endDate'] = (endDate instanceof Date) ?
79
+ endDate.toISOString().substr(0, 10) :
80
+ endDate;
81
+ }
82
+ if (accounts !== undefined) {
83
+ localVarQueryParameter['accounts'] = accounts;
84
+ }
85
+ if (brokerageAuthorizations !== undefined) {
86
+ localVarQueryParameter['brokerageAuthorizations'] = brokerageAuthorizations;
87
+ }
88
+ if (type !== undefined) {
89
+ localVarQueryParameter['type'] = type;
90
+ }
91
+ if (userId !== undefined) {
92
+ localVarQueryParameter['userId'] = userId;
93
+ }
94
+ if (userSecret !== undefined) {
95
+ localVarQueryParameter['userSecret'] = userSecret;
96
+ }
97
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
98
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
99
+ (0, requestBeforeHook_1.requestBeforeHook)({
100
+ queryParameters: localVarQueryParameter,
101
+ requestConfig: localVarRequestOptions,
102
+ path: localVarPath,
103
+ configuration
104
+ });
105
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
106
+ return {
107
+ url: (0, common_1.toPathString)(localVarUrlObj),
108
+ options: localVarRequestOptions,
109
+ };
110
+ }),
111
+ /**
112
+ * 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
113
+ * @summary Get performance information for a specific timeframe
114
+ * @param {string | Date} startDate
115
+ * @param {string | Date} endDate
116
+ * @param {string} userId
117
+ * @param {string} userSecret
118
+ * @param {string} [accounts] Optional comma seperated list of account IDs used to filter the request on specific accounts
119
+ * @param {boolean} [detailed] Optional, increases frequency of data points for the total value and contribution charts if set to true
120
+ * @param {string} [frequency] Optional frequency for the rate of return chart (defaults to monthly). Possible values are daily, weekly, monthly, quarterly, yearly.
121
+ * @param {*} [options] Override http request option.
122
+ * @throws {RequiredError}
123
+ */
124
+ getReportingCustomRange: (startDate, endDate, userId, userSecret, accounts, detailed, frequency, options = {}) => __awaiter(this, void 0, void 0, function* () {
125
+ // verify required parameter 'startDate' is not null or undefined
126
+ (0, common_1.assertParamExists)('getReportingCustomRange', 'startDate', startDate);
127
+ // verify required parameter 'endDate' is not null or undefined
128
+ (0, common_1.assertParamExists)('getReportingCustomRange', 'endDate', endDate);
129
+ // verify required parameter 'userId' is not null or undefined
130
+ (0, common_1.assertParamExists)('getReportingCustomRange', 'userId', userId);
131
+ // verify required parameter 'userSecret' is not null or undefined
132
+ (0, common_1.assertParamExists)('getReportingCustomRange', 'userSecret', userSecret);
133
+ const localVarPath = `/performance/custom`;
134
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
135
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
136
+ let baseOptions;
137
+ if (configuration) {
138
+ baseOptions = configuration.baseOptions;
139
+ }
140
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
141
+ const localVarHeaderParameter = configuration && !(0, common_1.isBrowser)() ? { "User-Agent": configuration.userAgent } : {};
142
+ const localVarQueryParameter = {};
143
+ // authentication PartnerClientId required
144
+ yield (0, common_1.setApiKeyToObject)({ object: localVarQueryParameter, keyParamName: "clientId", configuration });
145
+ // authentication PartnerSignature required
146
+ yield (0, common_1.setApiKeyToObject)({ object: localVarHeaderParameter, keyParamName: "Signature", configuration });
147
+ // authentication PartnerTimestamp required
148
+ yield (0, common_1.setApiKeyToObject)({ object: localVarQueryParameter, keyParamName: "timestamp", configuration });
149
+ if (startDate !== undefined) {
150
+ localVarQueryParameter['startDate'] = (startDate instanceof Date) ?
151
+ startDate.toISOString().substr(0, 10) :
152
+ startDate;
153
+ }
154
+ if (endDate !== undefined) {
155
+ localVarQueryParameter['endDate'] = (endDate instanceof Date) ?
156
+ endDate.toISOString().substr(0, 10) :
157
+ endDate;
158
+ }
159
+ if (accounts !== undefined) {
160
+ localVarQueryParameter['accounts'] = accounts;
161
+ }
162
+ if (detailed !== undefined) {
163
+ localVarQueryParameter['detailed'] = detailed;
164
+ }
165
+ if (frequency !== undefined) {
166
+ localVarQueryParameter['frequency'] = frequency;
167
+ }
168
+ if (userId !== undefined) {
169
+ localVarQueryParameter['userId'] = userId;
170
+ }
171
+ if (userSecret !== undefined) {
172
+ localVarQueryParameter['userSecret'] = userSecret;
173
+ }
174
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
175
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
176
+ (0, requestBeforeHook_1.requestBeforeHook)({
177
+ queryParameters: localVarQueryParameter,
178
+ requestConfig: localVarRequestOptions,
179
+ path: localVarPath,
180
+ configuration
181
+ });
182
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
183
+ return {
184
+ url: (0, common_1.toPathString)(localVarUrlObj),
185
+ options: localVarRequestOptions,
186
+ };
187
+ }),
188
+ };
189
+ };
190
+ exports.TransactionsAndReportingApiAxiosParamCreator = TransactionsAndReportingApiAxiosParamCreator;
191
+ /**
192
+ * TransactionsAndReportingApi - functional programming interface
193
+ * @export
194
+ */
195
+ const TransactionsAndReportingApiFp = function (configuration) {
196
+ const localVarAxiosParamCreator = (0, exports.TransactionsAndReportingApiAxiosParamCreator)(configuration);
197
+ return {
198
+ /**
199
+ * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
200
+ * @summary Get transaction history for a user
201
+ * @param {TransactionsAndReportingApiGetActivitiesRequest} requestParameters Request parameters.
202
+ * @param {*} [options] Override http request option.
203
+ * @throws {RequiredError}
204
+ */
205
+ getActivities(requestParameters, options) {
206
+ return __awaiter(this, void 0, void 0, function* () {
207
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getActivities(requestParameters.userId, requestParameters.userSecret, requestParameters.startDate, requestParameters.endDate, requestParameters.accounts, requestParameters.brokerageAuthorizations, requestParameters.type, options);
208
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
209
+ });
210
+ },
211
+ /**
212
+ * 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
213
+ * @summary Get performance information for a specific timeframe
214
+ * @param {TransactionsAndReportingApiGetReportingCustomRangeRequest} requestParameters Request parameters.
215
+ * @param {*} [options] Override http request option.
216
+ * @throws {RequiredError}
217
+ */
218
+ getReportingCustomRange(requestParameters, options) {
219
+ return __awaiter(this, void 0, void 0, function* () {
220
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getReportingCustomRange(requestParameters.startDate, requestParameters.endDate, requestParameters.userId, requestParameters.userSecret, requestParameters.accounts, requestParameters.detailed, requestParameters.frequency, options);
221
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
222
+ });
223
+ },
224
+ };
225
+ };
226
+ exports.TransactionsAndReportingApiFp = TransactionsAndReportingApiFp;
227
+ /**
228
+ * TransactionsAndReportingApi - factory interface
229
+ * @export
230
+ */
231
+ const TransactionsAndReportingApiFactory = function (configuration, basePath, axios) {
232
+ const localVarFp = (0, exports.TransactionsAndReportingApiFp)(configuration);
233
+ return {
234
+ /**
235
+ * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
236
+ * @summary Get transaction history for a user
237
+ * @param {TransactionsAndReportingApiGetActivitiesRequest} requestParameters Request parameters.
238
+ * @param {*} [options] Override http request option.
239
+ * @throws {RequiredError}
240
+ */
241
+ getActivities(requestParameters, options) {
242
+ return localVarFp.getActivities(requestParameters, options).then((request) => request(axios, basePath));
243
+ },
244
+ /**
245
+ * 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
246
+ * @summary Get performance information for a specific timeframe
247
+ * @param {TransactionsAndReportingApiGetReportingCustomRangeRequest} requestParameters Request parameters.
248
+ * @param {*} [options] Override http request option.
249
+ * @throws {RequiredError}
250
+ */
251
+ getReportingCustomRange(requestParameters, options) {
252
+ return localVarFp.getReportingCustomRange(requestParameters, options).then((request) => request(axios, basePath));
253
+ },
254
+ };
255
+ };
256
+ exports.TransactionsAndReportingApiFactory = TransactionsAndReportingApiFactory;
257
+ /**
258
+ * TransactionsAndReportingApiGenerated - object-oriented interface
259
+ * @export
260
+ * @class TransactionsAndReportingApiGenerated
261
+ * @extends {BaseAPI}
262
+ */
263
+ class TransactionsAndReportingApiGenerated extends base_1.BaseAPI {
264
+ /**
265
+ * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
266
+ * @summary Get transaction history for a user
267
+ * @param {TransactionsAndReportingApiGetActivitiesRequest} requestParameters Request parameters.
268
+ * @param {*} [options] Override http request option.
269
+ * @throws {RequiredError}
270
+ * @memberof TransactionsAndReportingApiGenerated
271
+ */
272
+ getActivities(requestParameters, options) {
273
+ return (0, exports.TransactionsAndReportingApiFp)(this.configuration).getActivities(requestParameters, options).then((request) => request(this.axios, this.basePath));
274
+ }
275
+ /**
276
+ * 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
277
+ * @summary Get performance information for a specific timeframe
278
+ * @param {TransactionsAndReportingApiGetReportingCustomRangeRequest} requestParameters Request parameters.
279
+ * @param {*} [options] Override http request option.
280
+ * @throws {RequiredError}
281
+ * @memberof TransactionsAndReportingApiGenerated
282
+ */
283
+ getReportingCustomRange(requestParameters, options) {
284
+ return (0, exports.TransactionsAndReportingApiFp)(this.configuration).getReportingCustomRange(requestParameters, options).then((request) => request(this.axios, this.basePath));
285
+ }
286
+ }
287
+ exports.TransactionsAndReportingApiGenerated = TransactionsAndReportingApiGenerated;