@orbis-systems/orbis-api-clients 0.8.8 → 0.8.10

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 (37) hide show
  1. package/dist/aesmidas/index.d.ts +501 -468
  2. package/dist/aesmidas/index.d.ts.map +1 -1
  3. package/dist/aesmidas/index.esm.js +1 -1
  4. package/dist/aesmidas/index.esm.js.map +1 -1
  5. package/dist/aesmidas/index.js +1 -1
  6. package/dist/aesmidas/index.js.map +1 -1
  7. package/dist/bridgewise/index.d.ts +681 -254
  8. package/dist/bridgewise/index.d.ts.map +1 -1
  9. package/dist/bridgewise/index.esm.js +1 -1
  10. package/dist/bridgewise/index.esm.js.map +1 -1
  11. package/dist/bridgewise/index.js +1 -1
  12. package/dist/bridgewise/index.js.map +1 -1
  13. package/dist/insight/index.d.ts +164 -164
  14. package/dist/insight/index.d.ts.map +1 -1
  15. package/dist/insight/index.esm.js +1 -1
  16. package/dist/insight/index.esm.js.map +1 -1
  17. package/dist/insight/index.js +1 -1
  18. package/dist/insight/index.js.map +1 -1
  19. package/dist/middleware/index.d.ts +83 -83
  20. package/dist/middleware/index.d.ts.map +1 -1
  21. package/dist/middleware/index.esm.js +1 -1
  22. package/dist/middleware/index.esm.js.map +1 -1
  23. package/dist/middleware/index.js +1 -1
  24. package/dist/middleware/index.js.map +1 -1
  25. package/dist/orbis/index.d.ts +1001 -972
  26. package/dist/orbis/index.d.ts.map +1 -1
  27. package/dist/orbis/index.esm.js +1 -1
  28. package/dist/orbis/index.esm.js.map +1 -1
  29. package/dist/orbis/index.js +1 -1
  30. package/dist/orbis/index.js.map +1 -1
  31. package/dist/uma/index.d.ts +490 -368
  32. package/dist/uma/index.d.ts.map +1 -1
  33. package/dist/uma/index.esm.js +1 -1
  34. package/dist/uma/index.esm.js.map +1 -1
  35. package/dist/uma/index.js +1 -1
  36. package/dist/uma/index.js.map +1 -1
  37. package/package.json +1 -1
@@ -306,26 +306,6 @@ export class OrdersV2Equities<HandleError extends boolean = boolean> {
306
306
  */
307
307
  previewSnapshot(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
308
308
  }
309
- export class OrdersV2FixedIncome<HandleError extends boolean = boolean> {
310
- protected readonly apiClient: JwtClient<HandleError>;
311
- constructor(apiClient: JwtClient<HandleError>);
312
- /**
313
- * @tags Orders V2 Fixed Income
314
- * @name BondPlacement
315
- * @summary Bond placement
316
- * @request POST:/orders/v2/bonds/place
317
- * @secure
318
- */
319
- bondPlacement(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
320
- /**
321
- * @tags Orders V2 Fixed Income
322
- * @name BondOrderPreview
323
- * @summary Bond order preview
324
- * @request POST:/orders/v2/bonds/preview
325
- * @secure
326
- */
327
- bondOrderPreview(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
328
- }
329
309
  export class OrdersV2Options<HandleError extends boolean = boolean> {
330
310
  protected readonly apiClient: JwtClient<HandleError>;
331
311
  constructor(apiClient: JwtClient<HandleError>);
@@ -469,6 +449,26 @@ export class OrdersV2Options<HandleError extends boolean = boolean> {
469
449
  };
470
450
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
471
451
  }
452
+ export class OrdersV2FixedIncome<HandleError extends boolean = boolean> {
453
+ protected readonly apiClient: JwtClient<HandleError>;
454
+ constructor(apiClient: JwtClient<HandleError>);
455
+ /**
456
+ * @tags Orders V2 Fixed Income
457
+ * @name BondPlacement
458
+ * @summary Bond placement
459
+ * @request POST:/orders/v2/bonds/place
460
+ * @secure
461
+ */
462
+ bondPlacement(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
463
+ /**
464
+ * @tags Orders V2 Fixed Income
465
+ * @name BondOrderPreview
466
+ * @summary Bond order preview
467
+ * @request POST:/orders/v2/bonds/preview
468
+ * @secure
469
+ */
470
+ bondOrderPreview(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
471
+ }
472
472
  export class OrdersV2Crypto<HandleError extends boolean = boolean> {
473
473
  protected readonly apiClient: JwtClient<HandleError>;
474
474
  constructor(apiClient: JwtClient<HandleError>);
@@ -872,599 +872,599 @@ export class OrdersArchived<HandleError extends boolean = boolean> {
872
872
  orderRef?: string;
873
873
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
874
874
  }
875
- export class Orders<HandleError extends boolean = boolean> {
875
+ export class Quotes<HandleError extends boolean = boolean> {
876
876
  protected readonly apiClient: JwtClient<HandleError>;
877
- violationManagement: OrdersViolationManagement<HandleError>;
878
- archived: OrdersArchived<HandleError>;
879
- v2: OrdersV2<HandleError>;
880
877
  constructor(apiClient: JwtClient<HandleError>);
881
878
  /**
882
- * @tags Orders
883
- * @name Listing
884
- * @summary Listing
885
- * @request GET:/orders/{type}
879
+ * @tags Quotes
880
+ * @name Equity
881
+ * @summary Equity
882
+ * @request GET:/quotes/equity
886
883
  * @secure
887
884
  */
888
- listing(type: string, query?: {
889
- /**
890
- * `true|false` (optional)
891
- * @example "false"
892
- */
893
- loadQuotes?: any;
894
- /** Account ID (optional) */
895
- accountId?: any;
896
- /** Account number (optional) */
897
- account?: any;
898
- /** Ticker symbol (optional) */
899
- symbol?: any;
900
- /**
901
- * Return bond pricing type in `Percentage|Decimal` (optional)
902
- * @example "Decimal"
903
- */
904
- bondPriceType?: any;
885
+ equity(query?: {
905
886
  /**
906
- * Return bond quantity in `Par|Unit` (optional)
907
- * @example "Par"
887
+ * Comma separated list of symbols
888
+ * @example "IBM"
908
889
  */
909
- bondQuantityType?: any;
890
+ symbols?: any;
910
891
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
911
892
  /**
912
- * @tags Orders
913
- * @name ListingForModel
914
- * @summary Listing for model
915
- * @request GET:/orders/model/{modelId}/{type}
893
+ * @tags Quotes
894
+ * @name Search
895
+ * @summary Search
896
+ * @request GET:/quotes/search
916
897
  * @secure
917
898
  */
918
- listingForModel(modelId: string, type: string, query?: {
899
+ search(query?: {
919
900
  /**
920
- * true|false
921
- * @example "false"
901
+ * String to search for
902
+ * @example "Apple"
922
903
  */
923
- loadQuotes?: any;
904
+ criteria?: any;
924
905
  /**
925
- * Return bond pricing type in `Percentage|Decimal` (optional)
926
- * @example "Decimal"
906
+ * Maximum number of results to return (default is 20)
907
+ * @example "3"
927
908
  */
928
- bondPriceType?: any;
909
+ limit?: any;
910
+ /**
911
+ * Whether to load quotes for the results or not
912
+ * @example "false"
913
+ */
914
+ loadQuotes?: any;
929
915
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
930
916
  /**
931
- * @tags Orders
932
- * @name ListingForBranch
933
- * @summary Listing for branch
934
- * @request GET:/orders/branch/{type}
917
+ * @tags Quotes
918
+ * @name Option
919
+ * @summary Option
920
+ * @request GET:/quotes/option
935
921
  * @secure
936
922
  */
937
- listingForBranch(type: string, query?: {
938
- /** Return bond pricing type in `Percentage|Decimal` (optional) */
939
- bondPriceType?: any;
923
+ option(query?: {
924
+ /** Comma separated list of symbols */
925
+ symbols?: any;
926
+ /**
927
+ * `true|false` - whether to load option greeks
928
+ * @example ""
929
+ */
930
+ greeks?: any;
940
931
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
941
932
  /**
942
- * @tags Orders
943
- * @name Status
944
- * @summary Status
945
- * @request GET:/orders/status/{orderRef}
933
+ * @tags Quotes
934
+ * @name OptionPricingType
935
+ * @summary Option pricing type
936
+ * @request GET:/quotes/option/pricing/type
946
937
  * @secure
947
938
  */
948
- status(orderRef: string, query?: {
949
- /** [optional] `true` or `false` to load quotes */
950
- loadQuotes?: any;
951
- /** [optional] Account number order belongs to */
952
- account?: any;
953
- /** [optional] AccountId as known in the system */
954
- accountId?: any;
939
+ optionPricingType(query?: {
955
940
  /**
956
- * Return bond quantity in `Par|Unit` (optional)
957
- * @example "Decimal"
941
+ * [optional]
942
+ * @example "MSFT"
958
943
  */
959
- bondPriceType?: any;
944
+ underlying?: any;
960
945
  /**
961
- * Return bond quantity in `Par|Unit` (optional)
962
- * @example "Par"
946
+ * [optional]
947
+ * @example "F 130927C00014500"
963
948
  */
964
- bondQuantityType?: any;
949
+ symbol?: any;
965
950
  /**
966
- * [optional] Specifies market code for the order
967
- * @example "U"
951
+ * [optional]
952
+ * @example "1.23"
968
953
  */
969
- market?: any;
954
+ expectedPx?: any;
970
955
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
971
956
  /**
972
- * @tags Orders
973
- * @name OrderLookup
974
- * @summary Order lookup
975
- * @request GET:/orders/lookup
957
+ * @tags Quotes
958
+ * @name Bonds
959
+ * @summary Bonds
960
+ * @request GET:/quotes/bonds
976
961
  * @secure
977
962
  */
978
- orderLookup(query?: {
979
- /**
980
- * Required
981
- * @example "{your order reference}"
982
- */
983
- clientRef?: any;
984
- /**
985
- * `true|false` (optional)
986
- * @example "false"
987
- */
988
- loadQuotes?: any;
963
+ bonds(query?: {
989
964
  /**
990
- * Return bond pricing type in `Percentage|Decimal` (optional)
991
- * @example "Decimal"
965
+ * Comma separated list of ISINs
966
+ * @example "SK4120012691"
992
967
  */
993
- bondPriceType?: any;
968
+ isin?: any;
994
969
  /**
995
- * Return bond quantity in `Par|Unit` (optional)
996
- * @example "Par"
970
+ * Comma separated list of CUSIPs
971
+ * @example "412001269"
997
972
  */
998
- bondQuantityType?: any;
973
+ cusip?: any;
999
974
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1000
- }
1001
- export class ResearchTipranks<HandleError extends boolean = boolean> {
1002
- protected readonly apiClient: JwtClient<HandleError>;
1003
- constructor(apiClient: JwtClient<HandleError>);
1004
975
  /**
1005
- * @tags Research Tipranks
1006
- * @name Livefeed
1007
- * @summary Livefeed
1008
- * @request GET:/research/tipranks/livefeed
976
+ * @tags Quotes
977
+ * @name BondsSearch
978
+ * @summary Bonds Search
979
+ * @request GET:/quotes/bonds/search
1009
980
  * @secure
1010
981
  */
1011
- livefeed(query?: {
1012
- /**
1013
- * Amount to include. Defaults to 20.
1014
- * @example "20"
1015
- */
1016
- count?: any;
982
+ bondsSearch(query?: {
983
+ /** @example "SearchString" */
984
+ criteria?: any;
985
+ /** @example "20" */
986
+ limit?: any;
987
+ /** @example "false" */
988
+ loadQuotes?: any;
1017
989
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1018
990
  /**
1019
- * @tags Research Tipranks
1020
- * @name AnalystPortfolio
1021
- * @summary Analyst Portfolio
1022
- * @request GET:/research/tipranks/analyst/portfolio/{expertUID}
991
+ * @tags Quotes
992
+ * @name Historical
993
+ * @summary Historical
994
+ * @request GET:/quotes/equity/historical
1023
995
  * @secure
1024
996
  */
1025
- analystPortfolio(expertUid: string, query?: {
997
+ historical(query?: {
1026
998
  /**
1027
- * Total number of entries
1028
- * @example "5"
999
+ * Ticker
1000
+ * @example "AAPL"
1029
1001
  */
1030
- count?: any;
1002
+ symbol?: any;
1031
1003
  /**
1032
- * Optional. Defaults to false
1033
- * @example "true"
1004
+ * Start date (mm/dd/yyyy)
1005
+ * @example "01/01/2017"
1034
1006
  */
1035
- loadQuotes?: any;
1007
+ start?: any;
1008
+ /**
1009
+ * End date (mm/dd/yyyy)
1010
+ * @example "06/01/2017"
1011
+ */
1012
+ end?: any;
1013
+ /** If `start` and `end` are not specified, then range needs to be given. Format: [num][y/m] (y – year, m – months). `num` specifies number of (y/m) back from current date */
1014
+ range?: any;
1015
+ /** Set `true` to load weekly data points. Defaults to false. */
1016
+ setWeekly?: any;
1017
+ /** Include RSI data by setting a span. Value must be > 0 */
1018
+ rsiSpan?: any;
1036
1019
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1037
1020
  /**
1038
- * @tags Research Tipranks
1039
- * @name AnalystProfile
1040
- * @summary Analyst Profile
1041
- * @request GET:/research/tipranks/analyst/profile/{expertUID}
1021
+ * @tags Quotes
1022
+ * @name IntradayChartData
1023
+ * @summary Intraday chart data
1024
+ * @request GET:/quotes/equity/intraday
1042
1025
  * @secure
1043
1026
  */
1044
- analystProfile(expertUid: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1045
- /**
1046
- * @tags Research Tipranks
1047
- * @name TopAnalysts
1048
- * @summary Top Analysts
1049
- * @request GET:/research/tipranks/analyst/top
1050
- * @secure
1051
- */
1052
- topAnalysts(query?: {
1027
+ intradayChartData(query?: {
1053
1028
  /**
1054
- * Total entries. Defaults to 20.
1055
- * @example "25"
1029
+ * Ticker
1030
+ * @example "IBM"
1056
1031
  */
1057
- count?: any;
1058
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1059
- /**
1060
- * @tags Research Tipranks
1061
- * @name RatingsBySymbol
1062
- * @summary Ratings by Symbol
1063
- * @request GET:/research/tipranks/analyst/{symbol}
1064
- * @secure
1065
- */
1066
- ratingsBySymbol(symbol: string, query?: {
1032
+ symbol?: any;
1033
+ /** Include RSI data by setting a span. Value must be > 0 */
1034
+ rsiSpan?: any;
1035
+ /** `optional` timestamp format for multiday charts */
1036
+ from?: any;
1037
+ /** `optional` timestamp format for multiday charts */
1038
+ to?: any;
1067
1039
  /**
1068
- * Number of analysts to include. Defaults to 20
1069
- * @example "10"
1040
+ * `optional` whether to adjust volumes or not
1041
+ * @example "false"
1070
1042
  */
1071
- count?: any;
1043
+ rawVolumes?: any;
1072
1044
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1073
1045
  /**
1074
- * @tags Research Tipranks
1075
- * @name Insiders
1076
- * @summary Insiders
1077
- * @request GET:/research/tipranks/insiders
1046
+ * @tags Quotes
1047
+ * @name EquityTicks
1048
+ * @summary Equity Ticks
1049
+ * @request GET:/quotes/equity/ticks
1078
1050
  * @secure
1079
1051
  */
1080
- insiders(query?: {
1052
+ equityTicks(query?: {
1081
1053
  /**
1082
- * Comma seperated for multiple symbols
1083
- * @example "AAPL,GOOGL"
1054
+ * Ticker
1055
+ * @example "GOOG"
1084
1056
  */
1085
- symbols?: any;
1086
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1087
- /**
1088
- * @tags Research Tipranks
1089
- * @name InsiderTransactions
1090
- * @summary Insider Transactions
1091
- * @request GET:/research/tipranks/insiders/transactions
1092
- * @secure
1093
- */
1094
- insiderTransactions(query?: {
1057
+ symbol?: any;
1095
1058
  /**
1096
- * Symbols (comma seperated)
1097
- * @example "FB"
1059
+ * Timestamp for start of the data. Format: MM/DD/YYYY HH:MM or MM/DD/YYYY
1060
+ * @example "11/27/2016"
1098
1061
  */
1099
- symbols?: any;
1062
+ startTime?: any;
1100
1063
  /**
1101
- * Number of entries (defaults to 20)
1102
- * @example "10"
1064
+ * Timestamp for end of the data. Format: MM/DD/YYYY HH:MM or MM/DD/YYYY
1065
+ * @example "11/28/2016"
1103
1066
  */
1104
- count?: any;
1067
+ endTime?: any;
1105
1068
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1106
1069
  /**
1107
- * @tags Research Tipranks
1108
- * @name SimilarStocks
1109
- * @summary Similar Stocks
1110
- * @request GET:/research/tipranks/stocks/similar/{symbol}
1111
- * @secure
1112
- */
1113
- similarStocks(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1114
- /**
1115
- * @tags Research Tipranks
1116
- * @name Overview
1117
- * @summary Overview
1118
- * @request GET:/research/tipranks/stocks/overview/{symbols}
1119
- * @secure
1120
- */
1121
- overview(symbols: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1122
- /**
1123
- * @tags Research Tipranks
1124
- * @name ConsensusBySector
1125
- * @summary Consensus by Sector
1126
- * @request GET:/research/tipranks/consensus/sector
1127
- * @secure
1128
- */
1129
- consensusBySector(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1130
- /**
1131
- * @tags Research Tipranks
1132
- * @name ConsensusByBlogger
1133
- * @summary Consensus by Blogger
1134
- * @request GET:/research/tipranks/consensus/blogger/{symbol}
1070
+ * @tags Quotes
1071
+ * @name Shortability
1072
+ * @summary Shortability
1073
+ * @request GET:/quotes/equity/shortability/{symbol}
1135
1074
  * @secure
1136
1075
  */
1137
- consensusByBlogger(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1076
+ shortability(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1138
1077
  /**
1139
- * @tags Research Tipranks
1140
- * @name Trending
1141
- * @summary Trending
1142
- * @request GET:/research/tipranks/trending
1078
+ * @tags Quotes
1079
+ * @name MarginSuitability
1080
+ * @summary Margin Suitability
1081
+ * @request GET:/quotes/equity/marginability
1143
1082
  * @secure
1144
1083
  */
1145
- trending(query?: {
1084
+ marginSuitability(query?: {
1146
1085
  /**
1147
- * Total entries. Defaults to 20.
1148
- * @example "10"
1086
+ * Equity ticker
1087
+ * @example "TSLA"
1149
1088
  */
1150
- count?: any;
1089
+ symbol?: any;
1151
1090
  /**
1152
- * Days to go back. Can be 3, 7, or 30 only. Defaults to 7.
1153
- * @example "7"
1091
+ * Account number requesting the information
1092
+ * @example "AB654321"
1154
1093
  */
1155
- period?: any;
1094
+ account?: any;
1095
+ accountId?: any;
1156
1096
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1157
1097
  /**
1158
- * @tags Research Tipranks
1159
- * @name Hedgefunds
1160
- * @summary Hedgefunds
1161
- * @request GET:/research/tipranks/hedgefunds/{symbol}
1162
- * @secure
1163
- */
1164
- hedgefunds(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1165
- /**
1166
- * @tags Research Tipranks
1167
- * @name StockSentiment
1168
- * @summary Stock Sentiment
1169
- * @request GET:/research/tipranks/news/sentiment/{symbol}
1170
- * @secure
1171
- */
1172
- stockSentiment(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1173
- /**
1174
- * @tags Research Tipranks
1175
- * @name BloggerRatings
1176
- * @summary Blogger Ratings
1177
- * @request GET:/research/tipranks/rating/blogger/{symbol}
1098
+ * @tags Quotes
1099
+ * @name OptionChainDates
1100
+ * @summary Option chain (dates)
1101
+ * @request GET:/quotes/option/chain/dates/{symbol}
1178
1102
  * @secure
1179
1103
  */
1180
- bloggerRatings(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1181
- }
1182
- export class Quotes<HandleError extends boolean = boolean> {
1183
- protected readonly apiClient: JwtClient<HandleError>;
1184
- constructor(apiClient: JwtClient<HandleError>);
1104
+ optionChainDates(symbol: string, query?: {
1105
+ /**
1106
+ * Comma separated list of symbols
1107
+ * @example "AAPL"
1108
+ */
1109
+ symbols?: any;
1110
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1185
1111
  /**
1186
1112
  * @tags Quotes
1187
- * @name Equity
1188
- * @summary Equity
1189
- * @request GET:/quotes/equity
1113
+ * @name OptionChain
1114
+ * @summary Option chain
1115
+ * @request GET:/quotes/option/chain/{symbol}/{date}
1190
1116
  * @secure
1191
1117
  */
1192
- equity(query?: {
1118
+ optionChain(symbol: string, date: string, query?: {
1193
1119
  /**
1194
1120
  * Comma separated list of symbols
1195
- * @example "IBM"
1121
+ * @example "AAPL"
1196
1122
  */
1197
1123
  symbols?: any;
1198
1124
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1199
1125
  /**
1200
1126
  * @tags Quotes
1201
- * @name Search
1202
- * @summary Search
1203
- * @request GET:/quotes/search
1127
+ * @name OptionChainGreeks
1128
+ * @summary Option chain (greeks)
1129
+ * @request GET:/quotes/option/greeks/{symbol}/{date}
1204
1130
  * @secure
1205
1131
  */
1206
- search(query?: {
1207
- /**
1208
- * String to search for
1209
- * @example "Apple"
1210
- */
1211
- criteria?: any;
1212
- /**
1213
- * Maximum number of results to return (default is 20)
1214
- * @example "3"
1215
- */
1216
- limit?: any;
1132
+ optionChainGreeks(symbol: string, date: string, query?: {
1217
1133
  /**
1218
- * Whether to load quotes for the results or not
1219
- * @example "false"
1134
+ * Comma separated list of symbols
1135
+ * @example "AAPL"
1220
1136
  */
1221
- loadQuotes?: any;
1137
+ symbols?: any;
1222
1138
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1223
1139
  /**
1224
1140
  * @tags Quotes
1225
- * @name Option
1226
- * @summary Option
1227
- * @request GET:/quotes/option
1141
+ * @name Crypto
1142
+ * @summary Crypto
1143
+ * @request GET:/quotes/crypto
1228
1144
  * @secure
1229
1145
  */
1230
- option(query?: {
1231
- /** Comma separated list of symbols */
1146
+ crypto(query?: {
1147
+ /** @example "" */
1232
1148
  symbols?: any;
1233
- /**
1234
- * `true|false` - whether to load option greeks
1235
- * @example ""
1236
- */
1237
- greeks?: any;
1238
1149
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1239
1150
  /**
1240
1151
  * @tags Quotes
1241
- * @name OptionPricingType
1242
- * @summary Option pricing type
1243
- * @request GET:/quotes/option/pricing/type
1152
+ * @name FxRate
1153
+ * @summary FX rate
1154
+ * @request GET:/quotes/fx
1244
1155
  * @secure
1245
1156
  */
1246
- optionPricingType(query?: {
1157
+ fxRate(query?: {
1158
+ /** @example "EUR/USD,GBP/USD" */
1159
+ symbols?: any;
1160
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1161
+ }
1162
+ export class Orders<HandleError extends boolean = boolean> {
1163
+ protected readonly apiClient: JwtClient<HandleError>;
1164
+ violationManagement: OrdersViolationManagement<HandleError>;
1165
+ archived: OrdersArchived<HandleError>;
1166
+ v2: OrdersV2<HandleError>;
1167
+ constructor(apiClient: JwtClient<HandleError>);
1168
+ /**
1169
+ * @tags Orders
1170
+ * @name Listing
1171
+ * @summary Listing
1172
+ * @request GET:/orders/{type}
1173
+ * @secure
1174
+ */
1175
+ listing(type: string, query?: {
1247
1176
  /**
1248
- * [optional]
1249
- * @example "MSFT"
1177
+ * `true|false` (optional)
1178
+ * @example "false"
1250
1179
  */
1251
- underlying?: any;
1180
+ loadQuotes?: any;
1181
+ /** Account ID (optional) */
1182
+ accountId?: any;
1183
+ /** Account number (optional) */
1184
+ account?: any;
1185
+ /** Ticker symbol (optional) */
1186
+ symbol?: any;
1252
1187
  /**
1253
- * [optional]
1254
- * @example "F 130927C00014500"
1188
+ * Return bond pricing type in `Percentage|Decimal` (optional)
1189
+ * @example "Decimal"
1255
1190
  */
1256
- symbol?: any;
1191
+ bondPriceType?: any;
1257
1192
  /**
1258
- * [optional]
1259
- * @example "1.23"
1193
+ * Return bond quantity in `Par|Unit` (optional)
1194
+ * @example "Par"
1260
1195
  */
1261
- expectedPx?: any;
1196
+ bondQuantityType?: any;
1262
1197
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1263
1198
  /**
1264
- * @tags Quotes
1265
- * @name Bonds
1266
- * @summary Bonds
1267
- * @request GET:/quotes/bonds
1199
+ * @tags Orders
1200
+ * @name ListingForModel
1201
+ * @summary Listing for model
1202
+ * @request GET:/orders/model/{modelId}/{type}
1268
1203
  * @secure
1269
1204
  */
1270
- bonds(query?: {
1205
+ listingForModel(modelId: string, type: string, query?: {
1271
1206
  /**
1272
- * Comma separated list of ISINs
1273
- * @example "SK4120012691"
1207
+ * true|false
1208
+ * @example "false"
1274
1209
  */
1275
- isin?: any;
1210
+ loadQuotes?: any;
1276
1211
  /**
1277
- * Comma separated list of CUSIPs
1278
- * @example "412001269"
1212
+ * Return bond pricing type in `Percentage|Decimal` (optional)
1213
+ * @example "Decimal"
1279
1214
  */
1280
- cusip?: any;
1215
+ bondPriceType?: any;
1281
1216
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1282
1217
  /**
1283
- * @tags Quotes
1284
- * @name BondsSearch
1285
- * @summary Bonds Search
1286
- * @request GET:/quotes/bonds/search
1218
+ * @tags Orders
1219
+ * @name ListingForBranch
1220
+ * @summary Listing for branch
1221
+ * @request GET:/orders/branch/{type}
1287
1222
  * @secure
1288
1223
  */
1289
- bondsSearch(query?: {
1290
- /** @example "SearchString" */
1291
- criteria?: any;
1292
- /** @example "20" */
1293
- limit?: any;
1294
- /** @example "false" */
1295
- loadQuotes?: any;
1224
+ listingForBranch(type: string, query?: {
1225
+ /** Return bond pricing type in `Percentage|Decimal` (optional) */
1226
+ bondPriceType?: any;
1296
1227
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1297
1228
  /**
1298
- * @tags Quotes
1299
- * @name Historical
1300
- * @summary Historical
1301
- * @request GET:/quotes/equity/historical
1229
+ * @tags Orders
1230
+ * @name Status
1231
+ * @summary Status
1232
+ * @request GET:/orders/status/{orderRef}
1302
1233
  * @secure
1303
1234
  */
1304
- historical(query?: {
1235
+ status(orderRef: string, query?: {
1236
+ /** [optional] `true` or `false` to load quotes */
1237
+ loadQuotes?: any;
1238
+ /** [optional] Account number order belongs to */
1239
+ account?: any;
1240
+ /** [optional] AccountId as known in the system */
1241
+ accountId?: any;
1305
1242
  /**
1306
- * Ticker
1307
- * @example "AAPL"
1243
+ * Return bond quantity in `Par|Unit` (optional)
1244
+ * @example "Decimal"
1308
1245
  */
1309
- symbol?: any;
1246
+ bondPriceType?: any;
1310
1247
  /**
1311
- * Start date (mm/dd/yyyy)
1312
- * @example "01/01/2017"
1248
+ * Return bond quantity in `Par|Unit` (optional)
1249
+ * @example "Par"
1313
1250
  */
1314
- start?: any;
1251
+ bondQuantityType?: any;
1315
1252
  /**
1316
- * End date (mm/dd/yyyy)
1317
- * @example "06/01/2017"
1253
+ * [optional] Specifies market code for the order
1254
+ * @example "U"
1318
1255
  */
1319
- end?: any;
1320
- /** If `start` and `end` are not specified, then range needs to be given. Format: [num][y/m] (y – year, m – months). `num` specifies number of (y/m) back from current date */
1321
- range?: any;
1322
- /** Set `true` to load weekly data points. Defaults to false. */
1323
- setWeekly?: any;
1324
- /** Include RSI data by setting a span. Value must be > 0 */
1325
- rsiSpan?: any;
1256
+ market?: any;
1326
1257
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1327
1258
  /**
1328
- * @tags Quotes
1329
- * @name IntradayChartData
1330
- * @summary Intraday chart data
1331
- * @request GET:/quotes/equity/intraday
1259
+ * @tags Orders
1260
+ * @name OrderLookup
1261
+ * @summary Order lookup
1262
+ * @request GET:/orders/lookup
1332
1263
  * @secure
1333
1264
  */
1334
- intradayChartData(query?: {
1265
+ orderLookup(query?: {
1335
1266
  /**
1336
- * Ticker
1337
- * @example "IBM"
1267
+ * Required
1268
+ * @example "{your order reference}"
1338
1269
  */
1339
- symbol?: any;
1340
- /** Include RSI data by setting a span. Value must be > 0 */
1341
- rsiSpan?: any;
1342
- /** `optional` timestamp format for multiday charts */
1343
- from?: any;
1344
- /** `optional` timestamp format for multiday charts */
1345
- to?: any;
1270
+ clientRef?: any;
1346
1271
  /**
1347
- * `optional` whether to adjust volumes or not
1272
+ * `true|false` (optional)
1348
1273
  * @example "false"
1349
1274
  */
1350
- rawVolumes?: any;
1275
+ loadQuotes?: any;
1276
+ /**
1277
+ * Return bond pricing type in `Percentage|Decimal` (optional)
1278
+ * @example "Decimal"
1279
+ */
1280
+ bondPriceType?: any;
1281
+ /**
1282
+ * Return bond quantity in `Par|Unit` (optional)
1283
+ * @example "Par"
1284
+ */
1285
+ bondQuantityType?: any;
1351
1286
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1287
+ }
1288
+ export class ResearchTipranks<HandleError extends boolean = boolean> {
1289
+ protected readonly apiClient: JwtClient<HandleError>;
1290
+ constructor(apiClient: JwtClient<HandleError>);
1352
1291
  /**
1353
- * @tags Quotes
1354
- * @name EquityTicks
1355
- * @summary Equity Ticks
1356
- * @request GET:/quotes/equity/ticks
1292
+ * @tags Research Tipranks
1293
+ * @name Livefeed
1294
+ * @summary Livefeed
1295
+ * @request GET:/research/tipranks/livefeed
1357
1296
  * @secure
1358
1297
  */
1359
- equityTicks(query?: {
1298
+ livefeed(query?: {
1360
1299
  /**
1361
- * Ticker
1362
- * @example "GOOG"
1300
+ * Amount to include. Defaults to 20.
1301
+ * @example "20"
1363
1302
  */
1364
- symbol?: any;
1303
+ count?: any;
1304
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1305
+ /**
1306
+ * @tags Research Tipranks
1307
+ * @name AnalystPortfolio
1308
+ * @summary Analyst Portfolio
1309
+ * @request GET:/research/tipranks/analyst/portfolio/{expertUID}
1310
+ * @secure
1311
+ */
1312
+ analystPortfolio(expertUid: string, query?: {
1365
1313
  /**
1366
- * Timestamp for start of the data. Format: MM/DD/YYYY HH:MM or MM/DD/YYYY
1367
- * @example "11/27/2016"
1314
+ * Total number of entries
1315
+ * @example "5"
1368
1316
  */
1369
- startTime?: any;
1317
+ count?: any;
1370
1318
  /**
1371
- * Timestamp for end of the data. Format: MM/DD/YYYY HH:MM or MM/DD/YYYY
1372
- * @example "11/28/2016"
1319
+ * Optional. Defaults to false
1320
+ * @example "true"
1373
1321
  */
1374
- endTime?: any;
1322
+ loadQuotes?: any;
1375
1323
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1376
1324
  /**
1377
- * @tags Quotes
1378
- * @name Shortability
1379
- * @summary Shortability
1380
- * @request GET:/quotes/equity/shortability/{symbol}
1325
+ * @tags Research Tipranks
1326
+ * @name AnalystProfile
1327
+ * @summary Analyst Profile
1328
+ * @request GET:/research/tipranks/analyst/profile/{expertUID}
1381
1329
  * @secure
1382
1330
  */
1383
- shortability(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1331
+ analystProfile(expertUid: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1384
1332
  /**
1385
- * @tags Quotes
1386
- * @name MarginSuitability
1387
- * @summary Margin Suitability
1388
- * @request GET:/quotes/equity/marginability
1333
+ * @tags Research Tipranks
1334
+ * @name TopAnalysts
1335
+ * @summary Top Analysts
1336
+ * @request GET:/research/tipranks/analyst/top
1389
1337
  * @secure
1390
1338
  */
1391
- marginSuitability(query?: {
1339
+ topAnalysts(query?: {
1392
1340
  /**
1393
- * Equity ticker
1394
- * @example "TSLA"
1341
+ * Total entries. Defaults to 20.
1342
+ * @example "25"
1395
1343
  */
1396
- symbol?: any;
1344
+ count?: any;
1345
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1346
+ /**
1347
+ * @tags Research Tipranks
1348
+ * @name RatingsBySymbol
1349
+ * @summary Ratings by Symbol
1350
+ * @request GET:/research/tipranks/analyst/{symbol}
1351
+ * @secure
1352
+ */
1353
+ ratingsBySymbol(symbol: string, query?: {
1397
1354
  /**
1398
- * Account number requesting the information
1399
- * @example "AB654321"
1355
+ * Number of analysts to include. Defaults to 20
1356
+ * @example "10"
1400
1357
  */
1401
- account?: any;
1402
- accountId?: any;
1358
+ count?: any;
1403
1359
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1404
1360
  /**
1405
- * @tags Quotes
1406
- * @name OptionChainDates
1407
- * @summary Option chain (dates)
1408
- * @request GET:/quotes/option/chain/dates/{symbol}
1361
+ * @tags Research Tipranks
1362
+ * @name Insiders
1363
+ * @summary Insiders
1364
+ * @request GET:/research/tipranks/insiders
1409
1365
  * @secure
1410
1366
  */
1411
- optionChainDates(symbol: string, query?: {
1367
+ insiders(query?: {
1412
1368
  /**
1413
- * Comma separated list of symbols
1414
- * @example "AAPL"
1369
+ * Comma seperated for multiple symbols
1370
+ * @example "AAPL,GOOGL"
1415
1371
  */
1416
1372
  symbols?: any;
1417
1373
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1418
1374
  /**
1419
- * @tags Quotes
1420
- * @name OptionChain
1421
- * @summary Option chain
1422
- * @request GET:/quotes/option/chain/{symbol}/{date}
1375
+ * @tags Research Tipranks
1376
+ * @name InsiderTransactions
1377
+ * @summary Insider Transactions
1378
+ * @request GET:/research/tipranks/insiders/transactions
1423
1379
  * @secure
1424
1380
  */
1425
- optionChain(symbol: string, date: string, query?: {
1381
+ insiderTransactions(query?: {
1426
1382
  /**
1427
- * Comma separated list of symbols
1428
- * @example "AAPL"
1383
+ * Symbols (comma seperated)
1384
+ * @example "FB"
1429
1385
  */
1430
1386
  symbols?: any;
1387
+ /**
1388
+ * Number of entries (defaults to 20)
1389
+ * @example "10"
1390
+ */
1391
+ count?: any;
1431
1392
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1432
1393
  /**
1433
- * @tags Quotes
1434
- * @name OptionChainGreeks
1435
- * @summary Option chain (greeks)
1436
- * @request GET:/quotes/option/greeks/{symbol}/{date}
1394
+ * @tags Research Tipranks
1395
+ * @name SimilarStocks
1396
+ * @summary Similar Stocks
1397
+ * @request GET:/research/tipranks/stocks/similar/{symbol}
1437
1398
  * @secure
1438
1399
  */
1439
- optionChainGreeks(symbol: string, date: string, query?: {
1400
+ similarStocks(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1401
+ /**
1402
+ * @tags Research Tipranks
1403
+ * @name Overview
1404
+ * @summary Overview
1405
+ * @request GET:/research/tipranks/stocks/overview/{symbols}
1406
+ * @secure
1407
+ */
1408
+ overview(symbols: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1409
+ /**
1410
+ * @tags Research Tipranks
1411
+ * @name ConsensusBySector
1412
+ * @summary Consensus by Sector
1413
+ * @request GET:/research/tipranks/consensus/sector
1414
+ * @secure
1415
+ */
1416
+ consensusBySector(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1417
+ /**
1418
+ * @tags Research Tipranks
1419
+ * @name ConsensusByBlogger
1420
+ * @summary Consensus by Blogger
1421
+ * @request GET:/research/tipranks/consensus/blogger/{symbol}
1422
+ * @secure
1423
+ */
1424
+ consensusByBlogger(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1425
+ /**
1426
+ * @tags Research Tipranks
1427
+ * @name Trending
1428
+ * @summary Trending
1429
+ * @request GET:/research/tipranks/trending
1430
+ * @secure
1431
+ */
1432
+ trending(query?: {
1440
1433
  /**
1441
- * Comma separated list of symbols
1442
- * @example "AAPL"
1434
+ * Total entries. Defaults to 20.
1435
+ * @example "10"
1443
1436
  */
1444
- symbols?: any;
1437
+ count?: any;
1438
+ /**
1439
+ * Days to go back. Can be 3, 7, or 30 only. Defaults to 7.
1440
+ * @example "7"
1441
+ */
1442
+ period?: any;
1445
1443
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1446
1444
  /**
1447
- * @tags Quotes
1448
- * @name Crypto
1449
- * @summary Crypto
1450
- * @request GET:/quotes/crypto
1445
+ * @tags Research Tipranks
1446
+ * @name Hedgefunds
1447
+ * @summary Hedgefunds
1448
+ * @request GET:/research/tipranks/hedgefunds/{symbol}
1451
1449
  * @secure
1452
1450
  */
1453
- crypto(query?: {
1454
- /** @example "" */
1455
- symbols?: any;
1456
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1451
+ hedgefunds(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1457
1452
  /**
1458
- * @tags Quotes
1459
- * @name FxRate
1460
- * @summary FX rate
1461
- * @request GET:/quotes/fx
1453
+ * @tags Research Tipranks
1454
+ * @name StockSentiment
1455
+ * @summary Stock Sentiment
1456
+ * @request GET:/research/tipranks/news/sentiment/{symbol}
1462
1457
  * @secure
1463
1458
  */
1464
- fxRate(query?: {
1465
- /** @example "EUR/USD,GBP/USD" */
1466
- symbols?: any;
1467
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1459
+ stockSentiment(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1460
+ /**
1461
+ * @tags Research Tipranks
1462
+ * @name BloggerRatings
1463
+ * @summary Blogger Ratings
1464
+ * @request GET:/research/tipranks/rating/blogger/{symbol}
1465
+ * @secure
1466
+ */
1467
+ bloggerRatings(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1468
1468
  }
1469
1469
  export class ResearchEtfs<HandleError extends boolean = boolean> {
1470
1470
  protected readonly apiClient: JwtClient<HandleError>;
@@ -2212,7 +2212,109 @@ export class UserWatchlists<HandleError extends boolean = boolean> {
2212
2212
  * @request POST:/user/v2/watchlist/removeEntry
2213
2213
  * @secure
2214
2214
  */
2215
- removeFromWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2215
+ removeFromWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2216
+ }
2217
+ export class UserAttachedBanks<HandleError extends boolean = boolean> {
2218
+ protected readonly apiClient: JwtClient<HandleError>;
2219
+ constructor(apiClient: JwtClient<HandleError>);
2220
+ /**
2221
+ * @tags User Attached Banks
2222
+ * @name Accounts
2223
+ * @summary Accounts
2224
+ * @request GET:/user/bank/accounts
2225
+ * @secure
2226
+ */
2227
+ accounts(query?: {
2228
+ /**
2229
+ * Brokerage account number
2230
+ * @example "AC123456"
2231
+ */
2232
+ account?: any;
2233
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2234
+ /**
2235
+ * @tags User Attached Banks
2236
+ * @name Balances
2237
+ * @summary Balances
2238
+ * @request GET:/user/bank/balances
2239
+ * @secure
2240
+ */
2241
+ balances(query?: {
2242
+ /**
2243
+ * Brokerage account number
2244
+ * @example "AC123456"
2245
+ */
2246
+ account?: any;
2247
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2248
+ }
2249
+ export class UserTradingLimitManagement<HandleError extends boolean = boolean> {
2250
+ protected readonly apiClient: JwtClient<HandleError>;
2251
+ constructor(apiClient: JwtClient<HandleError>);
2252
+ /**
2253
+ * @tags User Trading Limit Management
2254
+ * @name Update
2255
+ * @summary Update
2256
+ * @request POST:/user/balance/adjust
2257
+ * @secure
2258
+ */
2259
+ update(data: {
2260
+ account?: {
2261
+ /** @example "AB123456" */
2262
+ accountNumber?: string;
2263
+ };
2264
+ /** @example 100 */
2265
+ adjustment?: any;
2266
+ /** @example "USD" */
2267
+ currency?: any;
2268
+ /** @example "something nice" */
2269
+ note?: any;
2270
+ /** @example "tbd" */
2271
+ reason?: any;
2272
+ /** @example "" */
2273
+ referenceNo?: any;
2274
+ /** @example "Delta|Absolute" */
2275
+ type?: any;
2276
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2277
+ }
2278
+ export class UserProfitLoss<HandleError extends boolean = boolean> {
2279
+ protected readonly apiClient: JwtClient<HandleError>;
2280
+ constructor(apiClient: JwtClient<HandleError>);
2281
+ /**
2282
+ * @tags User Profit Loss
2283
+ * @name ReportRequest
2284
+ * @summary Report Request
2285
+ * @request POST:/user/pal/submit
2286
+ * @secure
2287
+ */
2288
+ reportRequest(data: {
2289
+ /** @example "{account number}" */
2290
+ account?: any;
2291
+ /** @example "{timestamp}" */
2292
+ from?: any;
2293
+ /** @example "{timestamp}" */
2294
+ until?: any;
2295
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2296
+ /**
2297
+ * @tags User Profit Loss
2298
+ * @name StatusCheck
2299
+ * @summary Status check
2300
+ * @request GET:/user/pal/status
2301
+ * @secure
2302
+ */
2303
+ statusCheck(query?: {
2304
+ /** @example "643eaa24e00691406cbaa72f" */
2305
+ requestId?: any;
2306
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2307
+ /**
2308
+ * @tags User Profit Loss
2309
+ * @name Report
2310
+ * @summary Report
2311
+ * @request GET:/user/pal/report
2312
+ * @secure
2313
+ */
2314
+ report(query?: {
2315
+ /** @example "643eaa24e00691406cbaa72f" */
2316
+ requestId?: any;
2317
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2216
2318
  }
2217
2319
  export class UserDevice<HandleError extends boolean = boolean> {
2218
2320
  protected readonly apiClient: JwtClient<HandleError>;
@@ -2320,108 +2422,6 @@ export class UserAgreements<HandleError extends boolean = boolean> {
2320
2422
  */
2321
2423
  cryptoSign(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2322
2424
  }
2323
- export class UserAttachedBanks<HandleError extends boolean = boolean> {
2324
- protected readonly apiClient: JwtClient<HandleError>;
2325
- constructor(apiClient: JwtClient<HandleError>);
2326
- /**
2327
- * @tags User Attached Banks
2328
- * @name Accounts
2329
- * @summary Accounts
2330
- * @request GET:/user/bank/accounts
2331
- * @secure
2332
- */
2333
- accounts(query?: {
2334
- /**
2335
- * Brokerage account number
2336
- * @example "AC123456"
2337
- */
2338
- account?: any;
2339
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2340
- /**
2341
- * @tags User Attached Banks
2342
- * @name Balances
2343
- * @summary Balances
2344
- * @request GET:/user/bank/balances
2345
- * @secure
2346
- */
2347
- balances(query?: {
2348
- /**
2349
- * Brokerage account number
2350
- * @example "AC123456"
2351
- */
2352
- account?: any;
2353
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2354
- }
2355
- export class UserTradingLimitManagement<HandleError extends boolean = boolean> {
2356
- protected readonly apiClient: JwtClient<HandleError>;
2357
- constructor(apiClient: JwtClient<HandleError>);
2358
- /**
2359
- * @tags User Trading Limit Management
2360
- * @name Update
2361
- * @summary Update
2362
- * @request POST:/user/balance/adjust
2363
- * @secure
2364
- */
2365
- update(data: {
2366
- account?: {
2367
- /** @example "AB123456" */
2368
- accountNumber?: string;
2369
- };
2370
- /** @example 100 */
2371
- adjustment?: any;
2372
- /** @example "USD" */
2373
- currency?: any;
2374
- /** @example "something nice" */
2375
- note?: any;
2376
- /** @example "tbd" */
2377
- reason?: any;
2378
- /** @example "" */
2379
- referenceNo?: any;
2380
- /** @example "Delta|Absolute" */
2381
- type?: any;
2382
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2383
- }
2384
- export class UserProfitLoss<HandleError extends boolean = boolean> {
2385
- protected readonly apiClient: JwtClient<HandleError>;
2386
- constructor(apiClient: JwtClient<HandleError>);
2387
- /**
2388
- * @tags User Profit Loss
2389
- * @name ReportRequest
2390
- * @summary Report Request
2391
- * @request POST:/user/pal/submit
2392
- * @secure
2393
- */
2394
- reportRequest(data: {
2395
- /** @example "{account number}" */
2396
- account?: any;
2397
- /** @example "{timestamp}" */
2398
- from?: any;
2399
- /** @example "{timestamp}" */
2400
- until?: any;
2401
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2402
- /**
2403
- * @tags User Profit Loss
2404
- * @name StatusCheck
2405
- * @summary Status check
2406
- * @request GET:/user/pal/status
2407
- * @secure
2408
- */
2409
- statusCheck(query?: {
2410
- /** @example "643eaa24e00691406cbaa72f" */
2411
- requestId?: any;
2412
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2413
- /**
2414
- * @tags User Profit Loss
2415
- * @name Report
2416
- * @summary Report
2417
- * @request GET:/user/pal/report
2418
- * @secure
2419
- */
2420
- report(query?: {
2421
- /** @example "643eaa24e00691406cbaa72f" */
2422
- requestId?: any;
2423
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2424
- }
2425
2425
  export class User<HandleError extends boolean = boolean> {
2426
2426
  protected readonly apiClient: JwtClient<HandleError>;
2427
2427
  watchlists: UserWatchlists<HandleError>;
@@ -3387,76 +3387,82 @@ export class AdvisoryModels<HandleError extends boolean = boolean> {
3387
3387
  */
3388
3388
  allocations(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3389
3389
  }
3390
- export class AdvisoryUserAccountManagement<HandleError extends boolean = boolean> {
3390
+ export class AdvisoryGroups<HandleError extends boolean = boolean> {
3391
3391
  protected readonly apiClient: JwtClient<HandleError>;
3392
3392
  constructor(apiClient: JwtClient<HandleError>);
3393
3393
  /**
3394
- * @tags Advisory User Account Management
3395
- * @name List
3396
- * @summary /list
3397
- * @request GET:/v2/advisory/users/list
3394
+ * @tags Advisory Groups
3395
+ * @name GroupsManage
3396
+ * @request POST:/v1/groups/manage/{action}
3398
3397
  * @secure
3399
3398
  */
3400
- list(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3399
+ groupsManage(action: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3401
3400
  /**
3402
- * @tags Advisory User Account Management
3403
- * @name Accounts
3404
- * @summary /accounts
3405
- * @request GET:/v2/advisory/users/accounts
3401
+ * @tags Advisory Groups
3402
+ * @name GroupsList
3403
+ * @request GET:/v1/groups/list
3406
3404
  * @secure
3407
3405
  */
3408
- accounts(query?: {
3409
- /** @example "1234" */
3410
- uid?: any;
3411
- /**
3412
- * true|false
3413
- * @example "false"
3414
- */
3415
- loadRtb?: any;
3416
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3406
+ groupsList(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3417
3407
  /**
3418
- * @tags Advisory User Account Management
3419
- * @name AccountsStats
3420
- * @summary /accounts/stats
3421
- * @request GET:/v2/advisory/users/accounts/stats
3408
+ * @tags Advisory Groups
3409
+ * @name GroupAccountsStats
3410
+ * @request GET:/v2/advisory/group/accounts/stats/{groupsId}
3422
3411
  * @secure
3423
3412
  */
3424
- accountsStats(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3413
+ groupAccountsStats(groupsId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3425
3414
  /**
3426
- * @tags Advisory User Account Management
3427
- * @name AccountNotes
3428
- * @summary /account/notes
3429
- * @request GET:/v2/advisory/users/account/notes
3415
+ * @tags Advisory Groups
3416
+ * @name GroupPortfolios
3417
+ * @request GET:/v2/advisory/group/portfolios/{groupId}
3430
3418
  * @secure
3431
3419
  */
3432
- accountNotes(query?: {
3420
+ groupPortfolios(groupId: string, query?: {
3433
3421
  /**
3434
- * Account's ID
3435
- * @example "1234"
3422
+ * Should load quotes or not.
3423
+ * @example "false"
3436
3424
  */
3437
- aid?: any;
3425
+ loadQuotes?: any;
3426
+ /**
3427
+ * Whether to return combined portfolio (no accounts, with approximate prices)
3428
+ * @example "false"
3429
+ */
3430
+ combined?: any;
3431
+ /** @example "false" */
3432
+ loadIndustries?: any;
3433
+ /** @example "false" */
3434
+ loadUpgrades?: any;
3435
+ /** @example "false" */
3436
+ loadEarnings?: any;
3437
+ /**
3438
+ * Whether or not to include orders comprising each position's cost
3439
+ * @example "false"
3440
+ */
3441
+ loadCost?: any;
3442
+ /**
3443
+ * Analyze market caps and get `marketCapWeights`. To be used in conjuction with `loadQuotes`
3444
+ * @example "false"
3445
+ */
3446
+ marketCapWeights?: any;
3447
+ /** @example "1" */
3448
+ pageNum?: any;
3449
+ /** @example "100" */
3450
+ pageSize?: any;
3438
3451
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3439
3452
  /**
3440
- * @tags Advisory User Account Management
3441
- * @name Notes
3442
- * @summary /notes
3443
- * @request GET:/v2/advisory/users/notes
3453
+ * @tags Advisory Groups
3454
+ * @name GroupRtb
3455
+ * @request GET:/v2/advisory/group/rtb/{groupId}
3444
3456
  * @secure
3445
3457
  */
3446
- notes(query?: {
3447
- /**
3448
- * User's ID
3449
- * @example "1234"
3450
- */
3451
- uid?: any;
3452
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3458
+ groupRtb(groupId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3453
3459
  /**
3454
- * @tags Advisory User Account Management
3455
- * @name NotesPost
3456
- * @request POST:/v2/advisory/users/notes/{action}
3460
+ * @tags Advisory Groups
3461
+ * @name GroupRtbs
3462
+ * @request GET:/v2/advisory/group/rtbs/{groupId}
3457
3463
  * @secure
3458
3464
  */
3459
- notesPost(action: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3465
+ groupRtbs(groupId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3460
3466
  }
3461
3467
  export class AdvisoryAnalytics<HandleError extends boolean = boolean> {
3462
3468
  protected readonly apiClient: JwtClient<HandleError>;
@@ -3826,82 +3832,175 @@ export class TransfersRelationships<HandleError extends boolean = boolean> {
3826
3832
  };
3827
3833
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3828
3834
  }
3829
- export class AdvisoryGroups<HandleError extends boolean = boolean> {
3835
+ export class TransfersInstantAccountVerification<HandleError extends boolean = boolean> {
3836
+ protected readonly apiClient: JwtClient<HandleError>;
3837
+ constructor(apiClient: JwtClient<HandleError>);
3838
+ /**
3839
+ * @tags Transfers Instant Account Verification
3840
+ * @name Initiate
3841
+ * @summary Initiate
3842
+ * @request GET:/iav/init
3843
+ * @secure
3844
+ */
3845
+ initiate(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3846
+ /**
3847
+ * @tags Transfers Instant Account Verification
3848
+ * @name InitiatePost
3849
+ * @summary Initiate Post
3850
+ * @request POST:/iav/init
3851
+ * @secure
3852
+ */
3853
+ initiatePost(query: object, data: {
3854
+ /** @example "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" */
3855
+ subject?: string;
3856
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3857
+ /**
3858
+ * @tags Transfers Instant Account Verification
3859
+ * @name Complete
3860
+ * @summary Complete
3861
+ * @request POST:/iav/complete
3862
+ * @secure
3863
+ */
3864
+ complete(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3865
+ /**
3866
+ * @tags Transfers Instant Account Verification
3867
+ * @name ListBankAccounts
3868
+ * @summary List Bank Accounts
3869
+ * @request POST:/iav/list
3870
+ * @secure
3871
+ */
3872
+ listBankAccounts(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3873
+ /**
3874
+ * @tags Transfers Instant Account Verification
3875
+ * @name LinkBankAccount
3876
+ * @summary Link Bank Account
3877
+ * @request POST:/iav/link
3878
+ * @secure
3879
+ */
3880
+ linkBankAccount(data: {
3881
+ /** @example "5VXXXXX" */
3882
+ account?: any;
3883
+ /** @example "XXXXXXX" */
3884
+ bankAccountId?: any;
3885
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3886
+ /**
3887
+ * @tags Transfers Instant Account Verification
3888
+ * @name ImportWithPlaid
3889
+ * @summary Import With Plaid
3890
+ * @request POST:/iav/import
3891
+ * @secure
3892
+ */
3893
+ importWithPlaid(data: {
3894
+ /** @example "3AB123456" */
3895
+ account?: any;
3896
+ /** @example "123456" */
3897
+ bankAccountNumber?: any;
3898
+ /** @example "John Smith" */
3899
+ bankAccountOwnerName?: any;
3900
+ /** @example "checking" */
3901
+ bankAccountType?: any;
3902
+ /** @example "122105155" */
3903
+ bankRoutingNumber?: any;
3904
+ /** @example "Checking x456" */
3905
+ nickname?: any;
3906
+ /** @example "{optional}" */
3907
+ note?: any;
3908
+ /** @example "{optional}" */
3909
+ remoteAddr?: any;
3910
+ /** @example "{optional}" */
3911
+ remoteDevice?: any;
3912
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3913
+ }
3914
+ export class AdvisoryUserAccountManagement<HandleError extends boolean = boolean> {
3830
3915
  protected readonly apiClient: JwtClient<HandleError>;
3831
3916
  constructor(apiClient: JwtClient<HandleError>);
3832
3917
  /**
3833
- * @tags Advisory Groups
3834
- * @name GroupsManage
3835
- * @request POST:/v1/groups/manage/{action}
3918
+ * @tags Advisory User Account Management
3919
+ * @name List
3920
+ * @summary /list
3921
+ * @request GET:/v2/advisory/users/list
3836
3922
  * @secure
3837
3923
  */
3838
- groupsManage(action: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3924
+ list(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3839
3925
  /**
3840
- * @tags Advisory Groups
3841
- * @name GroupsList
3842
- * @request GET:/v1/groups/list
3926
+ * @tags Advisory User Account Management
3927
+ * @name Accounts
3928
+ * @summary /accounts
3929
+ * @request GET:/v2/advisory/users/accounts
3843
3930
  * @secure
3844
3931
  */
3845
- groupsList(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3932
+ accounts(query?: {
3933
+ /** @example "1234" */
3934
+ uid?: any;
3935
+ /**
3936
+ * true|false
3937
+ * @example "false"
3938
+ */
3939
+ loadRtb?: any;
3940
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3846
3941
  /**
3847
- * @tags Advisory Groups
3848
- * @name GroupAccountsStats
3849
- * @request GET:/v2/advisory/group/accounts/stats/{groupsId}
3942
+ * @tags Advisory User Account Management
3943
+ * @name AccountsStats
3944
+ * @summary /accounts/stats
3945
+ * @request GET:/v2/advisory/users/accounts/stats
3850
3946
  * @secure
3851
3947
  */
3852
- groupAccountsStats(groupsId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3948
+ accountsStats(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3853
3949
  /**
3854
- * @tags Advisory Groups
3855
- * @name GroupPortfolios
3856
- * @request GET:/v2/advisory/group/portfolios/{groupId}
3950
+ * @tags Advisory User Account Management
3951
+ * @name AccountNotes
3952
+ * @summary /account/notes
3953
+ * @request GET:/v2/advisory/users/account/notes
3857
3954
  * @secure
3858
3955
  */
3859
- groupPortfolios(groupId: string, query?: {
3860
- /**
3861
- * Should load quotes or not.
3862
- * @example "false"
3863
- */
3864
- loadQuotes?: any;
3865
- /**
3866
- * Whether to return combined portfolio (no accounts, with approximate prices)
3867
- * @example "false"
3868
- */
3869
- combined?: any;
3870
- /** @example "false" */
3871
- loadIndustries?: any;
3872
- /** @example "false" */
3873
- loadUpgrades?: any;
3874
- /** @example "false" */
3875
- loadEarnings?: any;
3956
+ accountNotes(query?: {
3876
3957
  /**
3877
- * Whether or not to include orders comprising each position's cost
3878
- * @example "false"
3958
+ * Account's ID
3959
+ * @example "1234"
3879
3960
  */
3880
- loadCost?: any;
3961
+ aid?: any;
3962
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3963
+ /**
3964
+ * @tags Advisory User Account Management
3965
+ * @name Notes
3966
+ * @summary /notes
3967
+ * @request GET:/v2/advisory/users/notes
3968
+ * @secure
3969
+ */
3970
+ notes(query?: {
3881
3971
  /**
3882
- * Analyze market caps and get `marketCapWeights`. To be used in conjuction with `loadQuotes`
3883
- * @example "false"
3972
+ * User's ID
3973
+ * @example "1234"
3884
3974
  */
3885
- marketCapWeights?: any;
3886
- /** @example "1" */
3887
- pageNum?: any;
3888
- /** @example "100" */
3889
- pageSize?: any;
3975
+ uid?: any;
3890
3976
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3891
3977
  /**
3892
- * @tags Advisory Groups
3893
- * @name GroupRtb
3894
- * @request GET:/v2/advisory/group/rtb/{groupId}
3978
+ * @tags Advisory User Account Management
3979
+ * @name NotesPost
3980
+ * @request POST:/v2/advisory/users/notes/{action}
3895
3981
  * @secure
3896
3982
  */
3897
- groupRtb(groupId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3983
+ notesPost(action: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3984
+ }
3985
+ export class TransfersAch<HandleError extends boolean = boolean> {
3986
+ protected readonly apiClient: JwtClient<HandleError>;
3987
+ constructor(apiClient: JwtClient<HandleError>);
3898
3988
  /**
3899
- * @tags Advisory Groups
3900
- * @name GroupRtbs
3901
- * @request GET:/v2/advisory/group/rtbs/{groupId}
3989
+ * @tags Transfers Ach
3990
+ * @name Deposit
3991
+ * @summary Deposit
3992
+ * @request POST:/transfer/ach/deposit
3902
3993
  * @secure
3903
3994
  */
3904
- groupRtbs(groupId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3995
+ deposit(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3996
+ /**
3997
+ * @tags Transfers Ach
3998
+ * @name Withdraw
3999
+ * @summary Withdraw
4000
+ * @request POST:/transfer/ach/withdraw
4001
+ * @secure
4002
+ */
4003
+ withdraw(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3905
4004
  }
3906
4005
  export class TransfersAcats<HandleError extends boolean = boolean> {
3907
4006
  protected readonly apiClient: JwtClient<HandleError>;
@@ -4041,7 +4140,13 @@ export class TransfersAcats<HandleError extends boolean = boolean> {
4041
4140
  comment?: string;
4042
4141
  /** @example "" */
4043
4142
  contraAccount?: string;
4044
- /** @example "COLLEGE_TAX_ADVANTAGE_529|PENSION_PLAN_401K|TAX_SHELTERED_ANNUITY_403B|AGENCY|BANK_CUSTODY|BENEFICIARY|BENEFICIARY_ROTH_IRA|CORPORATE|CO_TRUSTEE|CUSTODIAN_UGMA|DIRECT_ROLLOVER|COVERDELL_IRA|ESTATE|HEALTH_SAVINGS_ACCOUNT|IRA|JOINT|MEDICAL_SAVINGS_ACCOUNT|OTHER|QUALIFIED_PROFIT_SHARING_PENSION|ROTH_IRA|SIMPLE_IRA|SARSEP|SINGLE|TRUST" */
4143
+ /**
4144
+ * @example "COLLEGE_TAX_ADVANTAGE_529|PENSION_PLAN_401K
4145
+ * |TAX_SHELTERED_ANNUITY_403B|AGENCY|BANK_CUSTODY|BENEFICIARY
4146
+ * |BENEFICIARY_ROTH_IRA|CORPORATE|CO_TRUSTEE|CUSTODIAN_UGMA|DIRECT_ROLLOVER|COVERDELL_IRA
4147
+ * |ESTATE|HEALTH_SAVINGS_ACCOUNT|IRA|JOINT|MEDICAL_SAVINGS_ACCOUNT|OTHER
4148
+ * |QUALIFIED_PROFIT_SHARING_PENSION|ROTH_IRA|SIMPLE_IRA|SARSEP|SINGLE|TRUST"
4149
+ */
4045
4150
  contraAccountType?: string;
4046
4151
  /** @example "" */
4047
4152
  contraNumber?: string;
@@ -4057,7 +4162,12 @@ export class TransfersAcats<HandleError extends boolean = boolean> {
4057
4162
  remoteIp?: string;
4058
4163
  /** @example "" */
4059
4164
  secondaryTaxId?: string;
4060
- /** @example "{optional} (Leave blank to send out ACAT immediately)|RequestPlaced (Trigger Scheduled Acat Request)|Scheduled" */
4165
+ /**
4166
+ * @example "{optional}
4167
+ * (Leave blank to send out ACAT immediately)|
4168
+ * RequestPlaced (Trigger Scheduled Acat Request)
4169
+ * |Scheduled"
4170
+ */
4061
4171
  status?: string;
4062
4172
  /** @example "Full|Partial" */
4063
4173
  type?: string;
@@ -4265,18 +4375,6 @@ export class TransfersPositions<HandleError extends boolean = boolean> {
4265
4375
  remoteDevice?: any;
4266
4376
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4267
4377
  }
4268
- export class TransfersBank<HandleError extends boolean = boolean> {
4269
- protected readonly apiClient: JwtClient<HandleError>;
4270
- constructor(apiClient: JwtClient<HandleError>);
4271
- /**
4272
- * @tags Transfers Bank
4273
- * @name FundTransfer
4274
- * @summary Fund transfer
4275
- * @request POST:/transfer/bank/{direction}
4276
- * @secure
4277
- */
4278
- fundTransfer(direction: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4279
- }
4280
4378
  export class TransfersInstantCashTransfers<HandleError extends boolean = boolean> {
4281
4379
  protected readonly apiClient: JwtClient<HandleError>;
4282
4380
  constructor(apiClient: JwtClient<HandleError>);
@@ -4345,153 +4443,66 @@ export class TransfersInstantCashTransfers<HandleError extends boolean = boolean
4345
4443
  /** @example "James" */
4346
4444
  firstName?: string;
4347
4445
  institution?: {
4348
- /** @example "123456" */
4349
- accountNumber?: string;
4350
- /** @example "Royal Central Bank" */
4351
- name?: string;
4352
- };
4353
- /** @example "Bond" */
4354
- lastName?: string;
4355
- };
4356
- /** @example "USD" */
4357
- currency?: any;
4358
- /** @example "1.1.1.1" */
4359
- remoteAddr?: any;
4360
- /** @example "Droid Phone" */
4361
- remoteDevice?: any;
4362
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4363
- /**
4364
- * @tags Transfers Instant Cash Transfers
4365
- * @name ObtainTheReport
4366
- * @summary Obtain the report
4367
- * @request POST:/transfer/reports/obtain
4368
- * @secure
4369
- */
4370
- obtainTheReport(data: {
4371
- /** @example "MM/DD/YYYY HH:MM:SS ZZZ" */
4372
- date?: any;
4373
- /** @example "RETAIL_BANKING" */
4374
- reportType?: any;
4375
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4376
- /**
4377
- * @tags Transfers Instant Cash Transfers
4378
- * @name ListReports
4379
- * @summary List reports
4380
- * @request GET:/transfer/reports
4381
- * @secure
4382
- */
4383
- listReports(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4384
- }
4385
- export class TransfersCheques<HandleError extends boolean = boolean> {
4386
- protected readonly apiClient: JwtClient<HandleError>;
4387
- constructor(apiClient: JwtClient<HandleError>);
4388
- /**
4389
- * @tags Transfers Cheques
4390
- * @name Withdrawal
4391
- * @summary Withdrawal
4392
- * @request POST:/transfer/check/outgoing
4393
- * @secure
4394
- */
4395
- withdrawal(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4396
- }
4397
- export class TransfersInstantAccountVerification<HandleError extends boolean = boolean> {
4398
- protected readonly apiClient: JwtClient<HandleError>;
4399
- constructor(apiClient: JwtClient<HandleError>);
4400
- /**
4401
- * @tags Transfers Instant Account Verification
4402
- * @name Initiate
4403
- * @summary Initiate
4404
- * @request GET:/iav/init
4405
- * @secure
4406
- */
4407
- initiate(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4408
- /**
4409
- * @tags Transfers Instant Account Verification
4410
- * @name InitiatePost
4411
- * @summary Initiate Post
4412
- * @request POST:/iav/init
4413
- * @secure
4414
- */
4415
- initiatePost(query: object, data: {
4416
- /** @example "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" */
4417
- subject?: string;
4418
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4419
- /**
4420
- * @tags Transfers Instant Account Verification
4421
- * @name Complete
4422
- * @summary Complete
4423
- * @request POST:/iav/complete
4424
- * @secure
4425
- */
4426
- complete(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4427
- /**
4428
- * @tags Transfers Instant Account Verification
4429
- * @name ListBankAccounts
4430
- * @summary List Bank Accounts
4431
- * @request POST:/iav/list
4432
- * @secure
4433
- */
4434
- listBankAccounts(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4446
+ /** @example "123456" */
4447
+ accountNumber?: string;
4448
+ /** @example "Royal Central Bank" */
4449
+ name?: string;
4450
+ };
4451
+ /** @example "Bond" */
4452
+ lastName?: string;
4453
+ };
4454
+ /** @example "USD" */
4455
+ currency?: any;
4456
+ /** @example "1.1.1.1" */
4457
+ remoteAddr?: any;
4458
+ /** @example "Droid Phone" */
4459
+ remoteDevice?: any;
4460
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4435
4461
  /**
4436
- * @tags Transfers Instant Account Verification
4437
- * @name LinkBankAccount
4438
- * @summary Link Bank Account
4439
- * @request POST:/iav/link
4462
+ * @tags Transfers Instant Cash Transfers
4463
+ * @name ObtainTheReport
4464
+ * @summary Obtain the report
4465
+ * @request POST:/transfer/reports/obtain
4440
4466
  * @secure
4441
4467
  */
4442
- linkBankAccount(data: {
4443
- /** @example "5VXXXXX" */
4444
- account?: any;
4445
- /** @example "XXXXXXX" */
4446
- bankAccountId?: any;
4468
+ obtainTheReport(data: {
4469
+ /** @example "MM/DD/YYYY HH:MM:SS ZZZ" */
4470
+ date?: any;
4471
+ /** @example "RETAIL_BANKING" */
4472
+ reportType?: any;
4447
4473
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4448
4474
  /**
4449
- * @tags Transfers Instant Account Verification
4450
- * @name ImportWithPlaid
4451
- * @summary Import With Plaid
4452
- * @request POST:/iav/import
4475
+ * @tags Transfers Instant Cash Transfers
4476
+ * @name ListReports
4477
+ * @summary List reports
4478
+ * @request GET:/transfer/reports
4453
4479
  * @secure
4454
4480
  */
4455
- importWithPlaid(data: {
4456
- /** @example "3AB123456" */
4457
- account?: any;
4458
- /** @example "123456" */
4459
- bankAccountNumber?: any;
4460
- /** @example "John Smith" */
4461
- bankAccountOwnerName?: any;
4462
- /** @example "checking" */
4463
- bankAccountType?: any;
4464
- /** @example "122105155" */
4465
- bankRoutingNumber?: any;
4466
- /** @example "Checking x456" */
4467
- nickname?: any;
4468
- /** @example "{optional}" */
4469
- note?: any;
4470
- /** @example "{optional}" */
4471
- remoteAddr?: any;
4472
- /** @example "{optional}" */
4473
- remoteDevice?: any;
4474
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4481
+ listReports(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4475
4482
  }
4476
- export class TransfersAch<HandleError extends boolean = boolean> {
4483
+ export class TransfersCheques<HandleError extends boolean = boolean> {
4477
4484
  protected readonly apiClient: JwtClient<HandleError>;
4478
4485
  constructor(apiClient: JwtClient<HandleError>);
4479
4486
  /**
4480
- * @tags Transfers Ach
4481
- * @name Deposit
4482
- * @summary Deposit
4483
- * @request POST:/transfer/ach/deposit
4487
+ * @tags Transfers Cheques
4488
+ * @name Withdrawal
4489
+ * @summary Withdrawal
4490
+ * @request POST:/transfer/check/outgoing
4484
4491
  * @secure
4485
4492
  */
4486
- deposit(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4493
+ withdrawal(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4494
+ }
4495
+ export class TransfersBank<HandleError extends boolean = boolean> {
4496
+ protected readonly apiClient: JwtClient<HandleError>;
4497
+ constructor(apiClient: JwtClient<HandleError>);
4487
4498
  /**
4488
- * @tags Transfers Ach
4489
- * @name Withdraw
4490
- * @summary Withdraw
4491
- * @request POST:/transfer/ach/withdraw
4499
+ * @tags Transfers Bank
4500
+ * @name FundTransfer
4501
+ * @summary Fund transfer
4502
+ * @request POST:/transfer/bank/{direction}
4492
4503
  * @secure
4493
4504
  */
4494
- withdraw(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4505
+ fundTransfer(direction: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4495
4506
  }
4496
4507
  export class Transfers<HandleError extends boolean = boolean> {
4497
4508
  protected readonly apiClient: JwtClient<HandleError>;
@@ -5522,226 +5533,105 @@ export class BlacklistSearch<HandleError extends boolean = boolean> {
5522
5533
  */
5523
5534
  searchIndividual(data: {
5524
5535
  /** @example [{"distance":2,"name":"first_name","value":"Hyodan"},{"distance":0,"name":"alias_middle_name","value":"Hyodon"}] */
5525
- filters?: any;
5526
- /** @example "OR" */
5527
- match_type?: any;
5528
- pagination?: {
5529
- /** @example 1 */
5530
- page?: number;
5531
- /** @example 20 */
5532
- page_size?: number;
5533
- };
5534
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5535
- }
5536
- export class Blacklist<HandleError extends boolean = boolean> {
5537
- protected readonly apiClient: JwtClient<HandleError>;
5538
- adminBusinesses: BlacklistAdminBusinesses<HandleError>;
5539
- adminIndividuals: BlacklistAdminIndividuals<HandleError>;
5540
- search: BlacklistSearch<HandleError>;
5541
- constructor(apiClient: JwtClient<HandleError>);
5542
- /**
5543
- * @tags Blacklist
5544
- * @name UploadBlacklistCsv
5545
- * @summary Upload Blacklist CSV
5546
- * @request POST:/v1/csv/upload
5547
- * @secure
5548
- */
5549
- uploadBlacklistCsv(data: {
5550
- /**
5551
- * (Required) file with info to upload
5552
- * @format binary
5553
- */
5554
- file_field?: File;
5555
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5556
- /**
5557
- * @tags Blacklist
5558
- * @name GetHealth
5559
- * @summary Get Health
5560
- * @request GET:/v1/healthz
5561
- * @secure
5562
- */
5563
- getHealth(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5564
- }
5565
- export class Broker<HandleError extends boolean = boolean> {
5566
- protected readonly apiClient: JwtClient<HandleError>;
5567
- constructor(apiClient: JwtClient<HandleError>);
5568
- /**
5569
- * @tags Broker
5570
- * @name Portfolio
5571
- * @summary Portfolio
5572
- * @request GET:/v1/broker/portfolio
5573
- * @secure
5574
- */
5575
- portfolio(query?: {
5576
- /**
5577
- * (true or false) Allows for loading of quotes for each portfolio entry. Defaults to false.
5578
- * @example "false"
5579
- */
5580
- loadQuotes?: any;
5581
- /** @example "false" */
5582
- loadIndustries?: any;
5583
- /** @example "false" */
5584
- loadUpgrades?: any;
5585
- /** @example "false" */
5586
- loadEarnings?: any;
5587
- /**
5588
- * Load balances for weight
5589
- * @example "false"
5590
- */
5591
- loadRtb?: any;
5592
- /**
5593
- * Analyze market caps and get `marketCapWeights`. To be used in conjuction with `loadQuotes`
5594
- * @example "false"
5595
- */
5596
- marketCapBreakdown?: any;
5597
- /**
5598
- * Combined portfolio for the branch
5599
- * @example "false"
5600
- */
5601
- combined?: any;
5602
- /** @example "1" */
5603
- pageNum?: any;
5604
- /** @example "100" */
5605
- pageSize?: any;
5606
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5607
- }
5608
- export class WatchmenFfiUserAccountManagement<HandleError extends boolean = boolean> {
5609
- protected readonly apiClient: JwtClient<HandleError>;
5610
- constructor(apiClient: JwtClient<HandleError>);
5611
- /**
5612
- * @tags Watchmen Ffi User Account Management
5613
- * @name CreateUser
5614
- * @summary Create User
5615
- * @request POST:/rest/v1/uam/user/create
5616
- * @secure
5617
- */
5618
- createUser(data: {
5619
- /** @example "{optional} enable|disable - whether or not enable user for TipRanks" */
5620
- Tipranks?: any;
5621
- /** @example "{optional} true|false - defaults to false" */
5622
- algos?: any;
5623
- /** @example "{optional} true|false - defaults to false" */
5624
- allSession?: any;
5625
- /** @example "{optional} Full Name" */
5626
- associatedName?: any;
5627
- /** @example "{optional} true|false - defaults to false" */
5628
- buyWrite?: any;
5629
- /** @example "{optional} e-mail address" */
5630
- email?: any;
5631
- /** @example "{optional} true|false - defaults to true" */
5632
- isTradingEnabled?: any;
5633
- /** @example "{optional} Limit On Close - true|false - defaults to false" */
5634
- loc?: any;
5635
- /** @example "{optional} true|false - whether user is locked" */
5636
- locked?: any;
5637
- /** @example "{optional} Limit On Open - true|false - defaults to false" */
5638
- loo?: any;
5639
- /** @example "{optional} Market On Open - true|false - defaults to false" */
5640
- moc?: any;
5641
- /** @example "{optional} Market On Close - true|false - defaults to false" */
5642
- moo?: any;
5643
- /** @example "{optional} One Cancels Other - true|false - defaults to false" */
5644
- oco?: any;
5645
- /** @example "{optional} true|false - defaults to false" */
5646
- optionRoll?: any;
5647
- /** @example "{optional} true|false - defaults to false" */
5648
- options?: any;
5649
- /** @example "{optional}" */
5650
- password?: any;
5651
- /** @example "{optional} true|false - defaults to false" */
5652
- prePostTrading?: any;
5653
- /** @example "{optional} 1 - delayed, 0 - realtime, 4 - CBOE1, 3 - BATS" */
5654
- quoteType?: any;
5655
- /** @example "{optional} true|false - defaults to false" */
5656
- spreads?: any;
5657
- /** @example "A - active, S - suspended == initial user status" */
5658
- status?: any;
5659
- /** @example "{optional} true|false - defaults to false" */
5660
- trailingStops?: any;
5661
- /** @example "UNIQUE_USERNAME" */
5662
- username?: any;
5663
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5664
- /**
5665
- * @tags Watchmen Ffi User Account Management
5666
- * @name CreateAccount
5667
- * @summary Create Account
5668
- * @request POST:/rest/v1/uam/account/create
5669
- * @secure
5670
- */
5671
- createAccount(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5672
- /**
5673
- * @tags Watchmen Ffi User Account Management
5674
- * @name AccountInformation
5675
- * @summary Account Information
5676
- * @request GET:/rest/v1/uam/account/data
5677
- * @secure
5678
- */
5679
- accountInformation(query?: {
5680
- /** @example "AC123456" */
5681
- accountNumber?: any;
5682
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5683
- /**
5684
- * @tags Watchmen Ffi User Account Management
5685
- * @name UserInformation
5686
- * @summary User Information
5687
- * @request GET:/rest/v1/uam/user/data
5688
- * @secure
5689
- */
5690
- userInformation(query?: {
5691
- /** @example "USERNAME" */
5692
- username?: any;
5536
+ filters?: any;
5537
+ /** @example "OR" */
5538
+ match_type?: any;
5539
+ pagination?: {
5540
+ /** @example 1 */
5541
+ page?: number;
5542
+ /** @example 20 */
5543
+ page_size?: number;
5544
+ };
5693
5545
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5546
+ }
5547
+ export class Blacklist<HandleError extends boolean = boolean> {
5548
+ protected readonly apiClient: JwtClient<HandleError>;
5549
+ adminBusinesses: BlacklistAdminBusinesses<HandleError>;
5550
+ adminIndividuals: BlacklistAdminIndividuals<HandleError>;
5551
+ search: BlacklistSearch<HandleError>;
5552
+ constructor(apiClient: JwtClient<HandleError>);
5694
5553
  /**
5695
- * @tags Watchmen Ffi User Account Management
5696
- * @name ListLinkedAccounts
5697
- * @summary List Linked Accounts
5698
- * @request GET:/rest/v1/linkedaccounts/listAccounts
5554
+ * @tags Blacklist
5555
+ * @name UploadBlacklistCsv
5556
+ * @summary Upload Blacklist CSV
5557
+ * @request POST:/v1/csv/upload
5699
5558
  * @secure
5700
5559
  */
5701
- listLinkedAccounts(query?: {
5702
- /** @example "TEST.USER" */
5703
- username?: any;
5560
+ uploadBlacklistCsv(data: {
5561
+ /**
5562
+ * (Required) file with info to upload
5563
+ * @format binary
5564
+ */
5565
+ file_field?: File;
5704
5566
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5705
5567
  /**
5706
- * @tags Watchmen Ffi User Account Management
5707
- * @name LinkUnlinkAccount
5708
- * @summary Link/Unlink Account
5709
- * @request POST:/rest/v1/linkedaccounts/linkUnlinkAccount
5568
+ * @tags Blacklist
5569
+ * @name GetHealth
5570
+ * @summary Get Health
5571
+ * @request GET:/v1/healthz
5710
5572
  * @secure
5711
5573
  */
5712
- linkUnlinkAccount(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5574
+ getHealth(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5575
+ }
5576
+ export class Broker<HandleError extends boolean = boolean> {
5577
+ protected readonly apiClient: JwtClient<HandleError>;
5578
+ constructor(apiClient: JwtClient<HandleError>);
5713
5579
  /**
5714
- * @tags Watchmen Ffi User Account Management
5715
- * @name Visibility
5716
- * @summary Visibility
5717
- * @request POST:/rest/v1/linkedaccounts/visibility
5580
+ * @tags Broker
5581
+ * @name Portfolio
5582
+ * @summary Portfolio
5583
+ * @request GET:/v1/broker/portfolio
5718
5584
  * @secure
5719
5585
  */
5720
- visibility(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5586
+ portfolio(query?: {
5587
+ /**
5588
+ * (true or false) Allows for loading of quotes for each portfolio entry. Defaults to false.
5589
+ * @example "false"
5590
+ */
5591
+ loadQuotes?: any;
5592
+ /** @example "false" */
5593
+ loadIndustries?: any;
5594
+ /** @example "false" */
5595
+ loadUpgrades?: any;
5596
+ /** @example "false" */
5597
+ loadEarnings?: any;
5598
+ /**
5599
+ * Load balances for weight
5600
+ * @example "false"
5601
+ */
5602
+ loadRtb?: any;
5603
+ /**
5604
+ * Analyze market caps and get `marketCapWeights`. To be used in conjuction with `loadQuotes`
5605
+ * @example "false"
5606
+ */
5607
+ marketCapBreakdown?: any;
5608
+ /**
5609
+ * Combined portfolio for the branch
5610
+ * @example "false"
5611
+ */
5612
+ combined?: any;
5613
+ /** @example "1" */
5614
+ pageNum?: any;
5615
+ /** @example "100" */
5616
+ pageSize?: any;
5617
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5721
5618
  /**
5722
- * @tags Watchmen Ffi User Account Management
5723
- * @name UserAccountSearch
5724
- * @summary User/Account Search
5725
- * @request POST:/rest/v1/uam/user-account-search
5619
+ * @tags Broker
5620
+ * @name Orders
5621
+ * @summary Orders
5622
+ * @request GET:/orders/broker/{type}
5726
5623
  * @secure
5727
5624
  */
5728
- userAccountSearch(data: {
5729
- /** @example "desired account number" */
5730
- accountNumber?: any;
5731
- /** @example 100 */
5732
- limit?: any;
5733
- /** @example 0 */
5734
- lockedBit?: any;
5735
- /** @example "desired username" */
5736
- login?: any;
5737
- /** @example false */
5738
- noBrokers?: any;
5739
- /** @example "" */
5740
- omnibus?: any;
5741
- /** @example false */
5742
- onlyActiveAccount?: any;
5743
- /** @example false */
5744
- onlyActiveUser?: any;
5625
+ orders(type: string, query?: {
5626
+ /**
5627
+ * `true|false` (optional)
5628
+ * @example "false"
5629
+ */
5630
+ loadQuotes?: any;
5631
+ /** @example "Decimal" */
5632
+ bondPriceType?: any;
5633
+ /** @example "Par" */
5634
+ bondQuantityType?: any;
5745
5635
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5746
5636
  }
5747
5637
  export class WatchmenFfiFirmBranch<HandleError extends boolean = boolean> {
@@ -5919,6 +5809,145 @@ export class WatchmenFfiFirmBranch<HandleError extends boolean = boolean> {
5919
5809
  id?: any;
5920
5810
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5921
5811
  }
5812
+ export class WatchmenFfiUserAccountManagement<HandleError extends boolean = boolean> {
5813
+ protected readonly apiClient: JwtClient<HandleError>;
5814
+ constructor(apiClient: JwtClient<HandleError>);
5815
+ /**
5816
+ * @tags Watchmen Ffi User Account Management
5817
+ * @name CreateUser
5818
+ * @summary Create User
5819
+ * @request POST:/rest/v1/uam/user/create
5820
+ * @secure
5821
+ */
5822
+ createUser(data: {
5823
+ /** @example "{optional} enable|disable - whether or not enable user for TipRanks" */
5824
+ Tipranks?: any;
5825
+ /** @example "{optional} true|false - defaults to false" */
5826
+ algos?: any;
5827
+ /** @example "{optional} true|false - defaults to false" */
5828
+ allSession?: any;
5829
+ /** @example "{optional} Full Name" */
5830
+ associatedName?: any;
5831
+ /** @example "{optional} true|false - defaults to false" */
5832
+ buyWrite?: any;
5833
+ /** @example "{optional} e-mail address" */
5834
+ email?: any;
5835
+ /** @example "{optional} true|false - defaults to true" */
5836
+ isTradingEnabled?: any;
5837
+ /** @example "{optional} Limit On Close - true|false - defaults to false" */
5838
+ loc?: any;
5839
+ /** @example "{optional} true|false - whether user is locked" */
5840
+ locked?: any;
5841
+ /** @example "{optional} Limit On Open - true|false - defaults to false" */
5842
+ loo?: any;
5843
+ /** @example "{optional} Market On Open - true|false - defaults to false" */
5844
+ moc?: any;
5845
+ /** @example "{optional} Market On Close - true|false - defaults to false" */
5846
+ moo?: any;
5847
+ /** @example "{optional} One Cancels Other - true|false - defaults to false" */
5848
+ oco?: any;
5849
+ /** @example "{optional} true|false - defaults to false" */
5850
+ optionRoll?: any;
5851
+ /** @example "{optional} true|false - defaults to false" */
5852
+ options?: any;
5853
+ /** @example "{optional}" */
5854
+ password?: any;
5855
+ /** @example "{optional} true|false - defaults to false" */
5856
+ prePostTrading?: any;
5857
+ /** @example "{optional} 1 - delayed, 0 - realtime, 4 - CBOE1, 3 - BATS" */
5858
+ quoteType?: any;
5859
+ /** @example "{optional} true|false - defaults to false" */
5860
+ spreads?: any;
5861
+ /** @example "A - active, S - suspended == initial user status" */
5862
+ status?: any;
5863
+ /** @example "{optional} true|false - defaults to false" */
5864
+ trailingStops?: any;
5865
+ /** @example "UNIQUE_USERNAME" */
5866
+ username?: any;
5867
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5868
+ /**
5869
+ * @tags Watchmen Ffi User Account Management
5870
+ * @name CreateAccount
5871
+ * @summary Create Account
5872
+ * @request POST:/rest/v1/uam/account/create
5873
+ * @secure
5874
+ */
5875
+ createAccount(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5876
+ /**
5877
+ * @tags Watchmen Ffi User Account Management
5878
+ * @name AccountInformation
5879
+ * @summary Account Information
5880
+ * @request GET:/rest/v1/uam/account/data
5881
+ * @secure
5882
+ */
5883
+ accountInformation(query?: {
5884
+ /** @example "AC123456" */
5885
+ accountNumber?: any;
5886
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5887
+ /**
5888
+ * @tags Watchmen Ffi User Account Management
5889
+ * @name UserInformation
5890
+ * @summary User Information
5891
+ * @request GET:/rest/v1/uam/user/data
5892
+ * @secure
5893
+ */
5894
+ userInformation(query?: {
5895
+ /** @example "USERNAME" */
5896
+ username?: any;
5897
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5898
+ /**
5899
+ * @tags Watchmen Ffi User Account Management
5900
+ * @name ListLinkedAccounts
5901
+ * @summary List Linked Accounts
5902
+ * @request GET:/rest/v1/linkedaccounts/listAccounts
5903
+ * @secure
5904
+ */
5905
+ listLinkedAccounts(query?: {
5906
+ /** @example "TEST.USER" */
5907
+ username?: any;
5908
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5909
+ /**
5910
+ * @tags Watchmen Ffi User Account Management
5911
+ * @name LinkUnlinkAccount
5912
+ * @summary Link/Unlink Account
5913
+ * @request POST:/rest/v1/linkedaccounts/linkUnlinkAccount
5914
+ * @secure
5915
+ */
5916
+ linkUnlinkAccount(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5917
+ /**
5918
+ * @tags Watchmen Ffi User Account Management
5919
+ * @name Visibility
5920
+ * @summary Visibility
5921
+ * @request POST:/rest/v1/linkedaccounts/visibility
5922
+ * @secure
5923
+ */
5924
+ visibility(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5925
+ /**
5926
+ * @tags Watchmen Ffi User Account Management
5927
+ * @name UserAccountSearch
5928
+ * @summary User/Account Search
5929
+ * @request POST:/rest/v1/uam/user-account-search
5930
+ * @secure
5931
+ */
5932
+ userAccountSearch(data: {
5933
+ /** @example "desired account number" */
5934
+ accountNumber?: any;
5935
+ /** @example 100 */
5936
+ limit?: any;
5937
+ /** @example 0 */
5938
+ lockedBit?: any;
5939
+ /** @example "desired username" */
5940
+ login?: any;
5941
+ /** @example false */
5942
+ noBrokers?: any;
5943
+ /** @example "" */
5944
+ omnibus?: any;
5945
+ /** @example false */
5946
+ onlyActiveAccount?: any;
5947
+ /** @example false */
5948
+ onlyActiveUser?: any;
5949
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5950
+ }
5922
5951
  export class Advisory<HandleError extends boolean = boolean> {
5923
5952
  protected readonly apiClient: JwtClient<HandleError>;
5924
5953
  charges: AdvisoryCharges<HandleError>;