@orbis-systems/orbis-api-clients 0.6.8 → 0.6.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 (43) hide show
  1. package/dist/aesmidas/index.d.ts +104 -95
  2. package/dist/aesmidas/index.d.ts.map +1 -1
  3. package/dist/aesmidas/index.esm.js +1 -2806
  4. package/dist/aesmidas/index.esm.js.map +1 -1
  5. package/dist/aesmidas/index.js +1 -2811
  6. package/dist/aesmidas/index.js.map +1 -1
  7. package/dist/bridgewise/index.d.ts +169 -174
  8. package/dist/bridgewise/index.d.ts.map +1 -1
  9. package/dist/bridgewise/index.esm.js +1 -1888
  10. package/dist/bridgewise/index.esm.js.map +1 -1
  11. package/dist/bridgewise/index.js +1 -1893
  12. package/dist/bridgewise/index.js.map +1 -1
  13. package/dist/index.d.ts +1 -2
  14. package/dist/index.d.ts.map +1 -1
  15. package/dist/index.esm.js +1 -257
  16. package/dist/index.esm.js.map +1 -1
  17. package/dist/index.js +1 -280
  18. package/dist/index.js.map +1 -1
  19. package/dist/insight/index.d.ts +503 -305
  20. package/dist/insight/index.d.ts.map +1 -1
  21. package/dist/insight/index.esm.js +1 -3754
  22. package/dist/insight/index.esm.js.map +1 -1
  23. package/dist/insight/index.js +1 -3759
  24. package/dist/insight/index.js.map +1 -1
  25. package/dist/middleware/index.d.ts +1 -2
  26. package/dist/middleware/index.d.ts.map +1 -1
  27. package/dist/middleware/index.esm.js +1 -1066
  28. package/dist/middleware/index.esm.js.map +1 -1
  29. package/dist/middleware/index.js +1 -1071
  30. package/dist/middleware/index.js.map +1 -1
  31. package/dist/orbis/index.d.ts +1161 -1162
  32. package/dist/orbis/index.d.ts.map +1 -1
  33. package/dist/orbis/index.esm.js +1 -7009
  34. package/dist/orbis/index.esm.js.map +1 -1
  35. package/dist/orbis/index.js +1 -7014
  36. package/dist/orbis/index.js.map +1 -1
  37. package/dist/uma/index.d.ts +361 -349
  38. package/dist/uma/index.d.ts.map +1 -1
  39. package/dist/uma/index.esm.js +1 -3993
  40. package/dist/uma/index.esm.js.map +1 -1
  41. package/dist/uma/index.js +1 -3998
  42. package/dist/uma/index.js.map +1 -1
  43. package/package.json +9 -1
@@ -4,10 +4,9 @@ interface BaseClientConfig<HandleError extends boolean = boolean> {
4
4
  baseUrl: string;
5
5
  handleError?: HandleError;
6
6
  storage?: Storage;
7
- defaultHeaders?: Record<string, string>;
8
7
  defaultSecure?: boolean;
9
8
  authDataStorageKey?: string;
10
- withCredentials?: boolean;
9
+ axiosConfig?: AxiosRequestConfig;
11
10
  onAxiosError?: (error: AxiosError) => void;
12
11
  onError?: (error: unknown) => void;
13
12
  }
@@ -306,84 +305,6 @@ export class OrdersV2Equities<HandleError extends boolean = boolean> {
306
305
  */
307
306
  previewSnapshot(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
308
307
  }
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: {
320
- account?: {
321
- /** @example 123 */
322
- accountId?: number;
323
- /** @example "AC00123" */
324
- accountNumber?: string;
325
- };
326
- order?: {
327
- /** @example "LIMIT" */
328
- orderType?: string;
329
- /** @example 100 */
330
- price?: number;
331
- /** @example "Percentage|Decimal" */
332
- priceType?: string;
333
- /** @example 1000 */
334
- quantity?: number;
335
- /** @example "Par|Unit" */
336
- quantityType?: string;
337
- quote?: {
338
- /** @example "412001269" */
339
- cusip?: string;
340
- /** @example "CUSIP:ISIN" */
341
- identType?: string;
342
- /** @example "SK4120012691" */
343
- isin?: string;
344
- };
345
- /** @example "BUY|SELL" */
346
- transaction?: string;
347
- };
348
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
349
- /**
350
- * @tags Orders V2 Fixed Income
351
- * @name BondOrderPreview
352
- * @summary Bond order preview
353
- * @request POST:/orders/v2/bonds/preview
354
- * @secure
355
- */
356
- bondOrderPreview(data: {
357
- account?: {
358
- /** @example 123 */
359
- accountId?: number;
360
- /** @example "AC00123" */
361
- accountNumber?: string;
362
- };
363
- order?: {
364
- /** @example "LIMIT" */
365
- orderType?: string;
366
- /** @example 100 */
367
- price?: number;
368
- /** @example "Percentage|Decimal" */
369
- priceType?: string;
370
- /** @example 1000 */
371
- quantity?: number;
372
- /** @example "Par|Unit" */
373
- quantityType?: string;
374
- quote?: {
375
- /** @example "412001269" */
376
- cusip?: string;
377
- /** @example "CUSIP:ISIN" */
378
- identType?: string;
379
- /** @example "SK4120012691" */
380
- isin?: string;
381
- };
382
- /** @example "BUY|SELL" */
383
- transaction?: string;
384
- };
385
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
386
- }
387
308
  export class OrdersV2Options<HandleError extends boolean = boolean> {
388
309
  protected readonly apiClient: JwtClient<HandleError>;
389
310
  constructor(apiClient: JwtClient<HandleError>);
@@ -589,6 +510,84 @@ export class OrdersV2Options<HandleError extends boolean = boolean> {
589
510
  };
590
511
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
591
512
  }
513
+ export class OrdersV2FixedIncome<HandleError extends boolean = boolean> {
514
+ protected readonly apiClient: JwtClient<HandleError>;
515
+ constructor(apiClient: JwtClient<HandleError>);
516
+ /**
517
+ * @tags Orders V2 Fixed Income
518
+ * @name BondPlacement
519
+ * @summary Bond placement
520
+ * @request POST:/orders/v2/bonds/place
521
+ * @secure
522
+ */
523
+ bondPlacement(data: {
524
+ account?: {
525
+ /** @example 123 */
526
+ accountId?: number;
527
+ /** @example "AC00123" */
528
+ accountNumber?: string;
529
+ };
530
+ order?: {
531
+ /** @example "LIMIT" */
532
+ orderType?: string;
533
+ /** @example 100 */
534
+ price?: number;
535
+ /** @example "Percentage|Decimal" */
536
+ priceType?: string;
537
+ /** @example 1000 */
538
+ quantity?: number;
539
+ /** @example "Par|Unit" */
540
+ quantityType?: string;
541
+ quote?: {
542
+ /** @example "412001269" */
543
+ cusip?: string;
544
+ /** @example "CUSIP:ISIN" */
545
+ identType?: string;
546
+ /** @example "SK4120012691" */
547
+ isin?: string;
548
+ };
549
+ /** @example "BUY|SELL" */
550
+ transaction?: string;
551
+ };
552
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
553
+ /**
554
+ * @tags Orders V2 Fixed Income
555
+ * @name BondOrderPreview
556
+ * @summary Bond order preview
557
+ * @request POST:/orders/v2/bonds/preview
558
+ * @secure
559
+ */
560
+ bondOrderPreview(data: {
561
+ account?: {
562
+ /** @example 123 */
563
+ accountId?: number;
564
+ /** @example "AC00123" */
565
+ accountNumber?: string;
566
+ };
567
+ order?: {
568
+ /** @example "LIMIT" */
569
+ orderType?: string;
570
+ /** @example 100 */
571
+ price?: number;
572
+ /** @example "Percentage|Decimal" */
573
+ priceType?: string;
574
+ /** @example 1000 */
575
+ quantity?: number;
576
+ /** @example "Par|Unit" */
577
+ quantityType?: string;
578
+ quote?: {
579
+ /** @example "412001269" */
580
+ cusip?: string;
581
+ /** @example "CUSIP:ISIN" */
582
+ identType?: string;
583
+ /** @example "SK4120012691" */
584
+ isin?: string;
585
+ };
586
+ /** @example "BUY|SELL" */
587
+ transaction?: string;
588
+ };
589
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
590
+ }
592
591
  export class OrdersV2Crypto<HandleError extends boolean = boolean> {
593
592
  protected readonly apiClient: JwtClient<HandleError>;
594
593
  constructor(apiClient: JwtClient<HandleError>);
@@ -1024,253 +1023,540 @@ export class OrdersArchived<HandleError extends boolean = boolean> {
1024
1023
  orderRef?: string;
1025
1024
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1026
1025
  }
1027
- export class Orders<HandleError extends boolean = boolean> {
1026
+ export class Quotes<HandleError extends boolean = boolean> {
1028
1027
  protected readonly apiClient: JwtClient<HandleError>;
1029
- violationManagement: OrdersViolationManagement<HandleError>;
1030
- archived: OrdersArchived<HandleError>;
1031
- v2: OrdersV2<HandleError>;
1032
1028
  constructor(apiClient: JwtClient<HandleError>);
1033
1029
  /**
1034
- * @tags Orders
1035
- * @name Listing
1036
- * @summary Listing
1037
- * @request GET:/orders/{type}
1030
+ * @tags Quotes
1031
+ * @name Equity
1032
+ * @summary Equity
1033
+ * @request GET:/quotes/equity
1038
1034
  * @secure
1039
1035
  */
1040
- listing(type: string, query?: {
1041
- /**
1042
- * `true|false` (optional)
1043
- * @example "false"
1044
- */
1045
- loadQuotes?: any;
1046
- /** Account ID (optional) */
1047
- accountId?: any;
1048
- /** Account number (optional) */
1049
- account?: any;
1050
- /** Ticker symbol (optional) */
1051
- symbol?: any;
1052
- /**
1053
- * Return bond pricing type in `Percentage|Decimal` (optional)
1054
- * @example "Decimal"
1055
- */
1056
- bondPriceType?: any;
1036
+ equity(query?: {
1057
1037
  /**
1058
- * Return bond quantity in `Par|Unit` (optional)
1059
- * @example "Par"
1038
+ * Comma separated list of symbols
1039
+ * @example "IBM"
1060
1040
  */
1061
- bondQuantityType?: any;
1041
+ symbols?: any;
1062
1042
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1063
1043
  /**
1064
- * @tags Orders
1065
- * @name ListingForModel
1066
- * @summary Listing for model
1067
- * @request GET:/orders/model/{modelId}/{type}
1044
+ * @tags Quotes
1045
+ * @name Search
1046
+ * @summary Search
1047
+ * @request GET:/quotes/search
1068
1048
  * @secure
1069
1049
  */
1070
- listingForModel(modelId: string, type: string, query?: {
1050
+ search(query?: {
1071
1051
  /**
1072
- * true|false
1073
- * @example "false"
1052
+ * String to search for
1053
+ * @example "Apple"
1074
1054
  */
1075
- loadQuotes?: any;
1055
+ criteria?: any;
1076
1056
  /**
1077
- * Return bond pricing type in `Percentage|Decimal` (optional)
1078
- * @example "Decimal"
1057
+ * Maximum number of results to return (default is 20)
1058
+ * @example "3"
1079
1059
  */
1080
- bondPriceType?: any;
1060
+ limit?: any;
1061
+ /**
1062
+ * Whether to load quotes for the results or not
1063
+ * @example "false"
1064
+ */
1065
+ loadQuotes?: any;
1081
1066
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1082
1067
  /**
1083
- * @tags Orders
1084
- * @name ListingForBranch
1085
- * @summary Listing for branch
1086
- * @request GET:/orders/branch/{type}
1068
+ * @tags Quotes
1069
+ * @name Option
1070
+ * @summary Option
1071
+ * @request GET:/quotes/option
1087
1072
  * @secure
1088
1073
  */
1089
- listingForBranch(type: string, query?: {
1090
- /** Return bond pricing type in `Percentage|Decimal` (optional) */
1091
- bondPriceType?: any;
1074
+ option(query?: {
1075
+ /** Comma separated list of symbols */
1076
+ symbols?: any;
1077
+ /**
1078
+ * `true|false` - whether to load option greeks
1079
+ * @example ""
1080
+ */
1081
+ greeks?: any;
1092
1082
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1093
1083
  /**
1094
- * @tags Orders
1095
- * @name Status
1096
- * @summary Status
1097
- * @request GET:/orders/status/{orderRef}
1084
+ * @tags Quotes
1085
+ * @name OptionPricingType
1086
+ * @summary Option pricing type
1087
+ * @request GET:/quotes/option/pricing/type
1098
1088
  * @secure
1099
1089
  */
1100
- status(orderRef: string, query?: {
1101
- /** [optional] `true` or `false` to load quotes */
1102
- loadQuotes?: any;
1103
- /** [optional] Account number order belongs to */
1104
- account?: any;
1105
- /** [optional] AccountId as known in the system */
1106
- accountId?: any;
1090
+ optionPricingType(query?: {
1107
1091
  /**
1108
- * Return bond quantity in `Par|Unit` (optional)
1109
- * @example "Decimal"
1092
+ * [optional]
1093
+ * @example "MSFT"
1110
1094
  */
1111
- bondPriceType?: any;
1095
+ underlying?: any;
1112
1096
  /**
1113
- * Return bond quantity in `Par|Unit` (optional)
1114
- * @example "Par"
1097
+ * [optional]
1098
+ * @example "F 130927C00014500"
1115
1099
  */
1116
- bondQuantityType?: any;
1100
+ symbol?: any;
1117
1101
  /**
1118
- * [optional] Specifies market code for the order
1119
- * @example "U"
1102
+ * [optional]
1103
+ * @example "1.23"
1120
1104
  */
1121
- market?: any;
1105
+ expectedPx?: any;
1122
1106
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1123
1107
  /**
1124
- * @tags Orders
1125
- * @name OrderLookup
1126
- * @summary Order lookup
1127
- * @request GET:/orders/lookup
1108
+ * @tags Quotes
1109
+ * @name Bonds
1110
+ * @summary Bonds
1111
+ * @request GET:/quotes/bonds
1128
1112
  * @secure
1129
1113
  */
1130
- orderLookup(query?: {
1114
+ bonds(query?: {
1131
1115
  /**
1132
- * Required
1133
- * @example "{your order reference}"
1116
+ * Comma separated list of ISINs
1117
+ * @example "SK4120012691"
1134
1118
  */
1135
- clientRef?: any;
1119
+ isin?: any;
1136
1120
  /**
1137
- * `true|false` (optional)
1138
- * @example "false"
1121
+ * Comma separated list of CUSIPs
1122
+ * @example "412001269"
1139
1123
  */
1124
+ cusip?: any;
1125
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1126
+ /**
1127
+ * @tags Quotes
1128
+ * @name BondsSearch
1129
+ * @summary Bonds Search
1130
+ * @request GET:/quotes/bonds/search
1131
+ * @secure
1132
+ */
1133
+ bondsSearch(query?: {
1134
+ /** @example "SearchString" */
1135
+ criteria?: any;
1136
+ /** @example "20" */
1137
+ limit?: any;
1138
+ /** @example "false" */
1140
1139
  loadQuotes?: any;
1140
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1141
+ /**
1142
+ * @tags Quotes
1143
+ * @name Historical
1144
+ * @summary Historical
1145
+ * @request GET:/quotes/equity/historical
1146
+ * @secure
1147
+ */
1148
+ historical(query?: {
1141
1149
  /**
1142
- * Return bond pricing type in `Percentage|Decimal` (optional)
1143
- * @example "Decimal"
1150
+ * Ticker
1151
+ * @example "AAPL"
1144
1152
  */
1145
- bondPriceType?: any;
1153
+ symbol?: any;
1146
1154
  /**
1147
- * Return bond quantity in `Par|Unit` (optional)
1148
- * @example "Par"
1155
+ * Start date (mm/dd/yyyy)
1156
+ * @example "01/01/2017"
1149
1157
  */
1150
- bondQuantityType?: any;
1158
+ start?: any;
1159
+ /**
1160
+ * End date (mm/dd/yyyy)
1161
+ * @example "06/01/2017"
1162
+ */
1163
+ end?: any;
1164
+ /** 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 */
1165
+ range?: any;
1166
+ /** Set `true` to load weekly data points. Defaults to false. */
1167
+ setWeekly?: any;
1168
+ /** Include RSI data by setting a span. Value must be > 0 */
1169
+ rsiSpan?: any;
1151
1170
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1152
- }
1153
- export class ResearchTipranks<HandleError extends boolean = boolean> {
1154
- protected readonly apiClient: JwtClient<HandleError>;
1155
- constructor(apiClient: JwtClient<HandleError>);
1156
1171
  /**
1157
- * @tags Research Tipranks
1158
- * @name Livefeed
1159
- * @summary Livefeed
1160
- * @request GET:/research/tipranks/livefeed
1172
+ * @tags Quotes
1173
+ * @name IntradayChartData
1174
+ * @summary Intraday chart data
1175
+ * @request GET:/quotes/equity/intraday
1161
1176
  * @secure
1162
1177
  */
1163
- livefeed(query?: {
1178
+ intradayChartData(query?: {
1164
1179
  /**
1165
- * Amount to include. Defaults to 20.
1166
- * @example "20"
1180
+ * Ticker
1181
+ * @example "IBM"
1167
1182
  */
1168
- count?: any;
1183
+ symbol?: any;
1184
+ /** Include RSI data by setting a span. Value must be > 0 */
1185
+ rsiSpan?: any;
1186
+ /** `optional` timestamp format for multiday charts */
1187
+ from?: any;
1188
+ /** `optional` timestamp format for multiday charts */
1189
+ to?: any;
1190
+ /**
1191
+ * `optional` whether to adjust volumes or not
1192
+ * @example "false"
1193
+ */
1194
+ rawVolumes?: any;
1169
1195
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1170
1196
  /**
1171
- * @tags Research Tipranks
1172
- * @name AnalystPortfolio
1173
- * @summary Analyst Portfolio
1174
- * @request GET:/research/tipranks/analyst/portfolio/{expertUID}
1197
+ * @tags Quotes
1198
+ * @name EquityTicks
1199
+ * @summary Equity Ticks
1200
+ * @request GET:/quotes/equity/ticks
1175
1201
  * @secure
1176
1202
  */
1177
- analystPortfolio(expertUid: string, query?: {
1203
+ equityTicks(query?: {
1178
1204
  /**
1179
- * Total number of entries
1180
- * @example "5"
1205
+ * Ticker
1206
+ * @example "GOOG"
1181
1207
  */
1182
- count?: any;
1208
+ symbol?: any;
1183
1209
  /**
1184
- * Optional. Defaults to false
1185
- * @example "true"
1210
+ * Timestamp for start of the data. Format: MM/DD/YYYY HH:MM or MM/DD/YYYY
1211
+ * @example "11/27/2016"
1186
1212
  */
1187
- loadQuotes?: any;
1213
+ startTime?: any;
1214
+ /**
1215
+ * Timestamp for end of the data. Format: MM/DD/YYYY HH:MM or MM/DD/YYYY
1216
+ * @example "11/28/2016"
1217
+ */
1218
+ endTime?: any;
1188
1219
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1189
1220
  /**
1190
- * @tags Research Tipranks
1191
- * @name AnalystProfile
1192
- * @summary Analyst Profile
1193
- * @request GET:/research/tipranks/analyst/profile/{expertUID}
1221
+ * @tags Quotes
1222
+ * @name Shortability
1223
+ * @summary Shortability
1224
+ * @request GET:/quotes/equity/shortability/{symbol}
1194
1225
  * @secure
1195
1226
  */
1196
- analystProfile(expertUid: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1227
+ shortability(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1197
1228
  /**
1198
- * @tags Research Tipranks
1199
- * @name TopAnalysts
1200
- * @summary Top Analysts
1201
- * @request GET:/research/tipranks/analyst/top
1229
+ * @tags Quotes
1230
+ * @name MarginSuitability
1231
+ * @summary Margin Suitability
1232
+ * @request GET:/quotes/equity/marginability
1202
1233
  * @secure
1203
1234
  */
1204
- topAnalysts(query?: {
1235
+ marginSuitability(query?: {
1205
1236
  /**
1206
- * Total entries. Defaults to 20.
1207
- * @example "25"
1237
+ * Equity ticker
1238
+ * @example "TSLA"
1208
1239
  */
1209
- count?: any;
1240
+ symbol?: any;
1241
+ /**
1242
+ * Account number requesting the information
1243
+ * @example "AB654321"
1244
+ */
1245
+ account?: any;
1246
+ accountId?: any;
1210
1247
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1211
1248
  /**
1212
- * @tags Research Tipranks
1213
- * @name RatingsBySymbol
1214
- * @summary Ratings by Symbol
1215
- * @request GET:/research/tipranks/analyst/{symbol}
1249
+ * @tags Quotes
1250
+ * @name OptionChainDates
1251
+ * @summary Option chain (dates)
1252
+ * @request GET:/quotes/option/chain/dates/{symbol}
1216
1253
  * @secure
1217
1254
  */
1218
- ratingsBySymbol(symbol: string, query?: {
1255
+ optionChainDates(symbol: string, query?: {
1219
1256
  /**
1220
- * Number of analysts to include. Defaults to 20
1221
- * @example "10"
1257
+ * Comma separated list of symbols
1258
+ * @example "AAPL"
1222
1259
  */
1223
- count?: any;
1260
+ symbols?: any;
1224
1261
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1225
1262
  /**
1226
- * @tags Research Tipranks
1227
- * @name Insiders
1228
- * @summary Insiders
1229
- * @request GET:/research/tipranks/insiders
1263
+ * @tags Quotes
1264
+ * @name OptionChain
1265
+ * @summary Option chain
1266
+ * @request GET:/quotes/option/chain/{symbol}/{date}
1230
1267
  * @secure
1231
1268
  */
1232
- insiders(query?: {
1269
+ optionChain(symbol: string, date: string, query?: {
1233
1270
  /**
1234
- * Comma seperated for multiple symbols
1235
- * @example "AAPL,GOOGL"
1271
+ * Comma separated list of symbols
1272
+ * @example "AAPL"
1236
1273
  */
1237
1274
  symbols?: any;
1238
1275
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1239
1276
  /**
1240
- * @tags Research Tipranks
1241
- * @name InsiderTransactions
1242
- * @summary Insider Transactions
1243
- * @request GET:/research/tipranks/insiders/transactions
1277
+ * @tags Quotes
1278
+ * @name OptionChainGreeks
1279
+ * @summary Option chain (greeks)
1280
+ * @request GET:/quotes/option/greeks/{symbol}/{date}
1244
1281
  * @secure
1245
1282
  */
1246
- insiderTransactions(query?: {
1283
+ optionChainGreeks(symbol: string, date: string, query?: {
1247
1284
  /**
1248
- * Symbols (comma seperated)
1249
- * @example "FB"
1285
+ * Comma separated list of symbols
1286
+ * @example "AAPL"
1250
1287
  */
1251
1288
  symbols?: any;
1252
- /**
1253
- * Number of entries (defaults to 20)
1254
- * @example "10"
1255
- */
1256
- count?: any;
1257
1289
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1258
1290
  /**
1259
- * @tags Research Tipranks
1260
- * @name SimilarStocks
1261
- * @summary Similar Stocks
1262
- * @request GET:/research/tipranks/stocks/similar/{symbol}
1291
+ * @tags Quotes
1292
+ * @name Crypto
1293
+ * @summary Crypto
1294
+ * @request GET:/quotes/crypto
1263
1295
  * @secure
1264
1296
  */
1265
- similarStocks(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1297
+ crypto(query?: {
1298
+ /** @example "" */
1299
+ symbols?: any;
1300
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1266
1301
  /**
1267
- * @tags Research Tipranks
1268
- * @name Overview
1269
- * @summary Overview
1270
- * @request GET:/research/tipranks/stocks/overview/{symbols}
1302
+ * @tags Quotes
1303
+ * @name FxRate
1304
+ * @summary FX rate
1305
+ * @request GET:/quotes/fx
1271
1306
  * @secure
1272
1307
  */
1273
- overview(symbols: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1308
+ fxRate(query?: {
1309
+ /** @example "EUR/USD,GBP/USD" */
1310
+ symbols?: any;
1311
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1312
+ }
1313
+ export class Orders<HandleError extends boolean = boolean> {
1314
+ protected readonly apiClient: JwtClient<HandleError>;
1315
+ violationManagement: OrdersViolationManagement<HandleError>;
1316
+ archived: OrdersArchived<HandleError>;
1317
+ v2: OrdersV2<HandleError>;
1318
+ constructor(apiClient: JwtClient<HandleError>);
1319
+ /**
1320
+ * @tags Orders
1321
+ * @name Listing
1322
+ * @summary Listing
1323
+ * @request GET:/orders/{type}
1324
+ * @secure
1325
+ */
1326
+ listing(type: string, query?: {
1327
+ /**
1328
+ * `true|false` (optional)
1329
+ * @example "false"
1330
+ */
1331
+ loadQuotes?: any;
1332
+ /** Account ID (optional) */
1333
+ accountId?: any;
1334
+ /** Account number (optional) */
1335
+ account?: any;
1336
+ /** Ticker symbol (optional) */
1337
+ symbol?: any;
1338
+ /**
1339
+ * Return bond pricing type in `Percentage|Decimal` (optional)
1340
+ * @example "Decimal"
1341
+ */
1342
+ bondPriceType?: any;
1343
+ /**
1344
+ * Return bond quantity in `Par|Unit` (optional)
1345
+ * @example "Par"
1346
+ */
1347
+ bondQuantityType?: any;
1348
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1349
+ /**
1350
+ * @tags Orders
1351
+ * @name ListingForModel
1352
+ * @summary Listing for model
1353
+ * @request GET:/orders/model/{modelId}/{type}
1354
+ * @secure
1355
+ */
1356
+ listingForModel(modelId: string, type: string, query?: {
1357
+ /**
1358
+ * true|false
1359
+ * @example "false"
1360
+ */
1361
+ loadQuotes?: any;
1362
+ /**
1363
+ * Return bond pricing type in `Percentage|Decimal` (optional)
1364
+ * @example "Decimal"
1365
+ */
1366
+ bondPriceType?: any;
1367
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1368
+ /**
1369
+ * @tags Orders
1370
+ * @name ListingForBranch
1371
+ * @summary Listing for branch
1372
+ * @request GET:/orders/branch/{type}
1373
+ * @secure
1374
+ */
1375
+ listingForBranch(type: string, query?: {
1376
+ /** Return bond pricing type in `Percentage|Decimal` (optional) */
1377
+ bondPriceType?: any;
1378
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1379
+ /**
1380
+ * @tags Orders
1381
+ * @name Status
1382
+ * @summary Status
1383
+ * @request GET:/orders/status/{orderRef}
1384
+ * @secure
1385
+ */
1386
+ status(orderRef: string, query?: {
1387
+ /** [optional] `true` or `false` to load quotes */
1388
+ loadQuotes?: any;
1389
+ /** [optional] Account number order belongs to */
1390
+ account?: any;
1391
+ /** [optional] AccountId as known in the system */
1392
+ accountId?: any;
1393
+ /**
1394
+ * Return bond quantity in `Par|Unit` (optional)
1395
+ * @example "Decimal"
1396
+ */
1397
+ bondPriceType?: any;
1398
+ /**
1399
+ * Return bond quantity in `Par|Unit` (optional)
1400
+ * @example "Par"
1401
+ */
1402
+ bondQuantityType?: any;
1403
+ /**
1404
+ * [optional] Specifies market code for the order
1405
+ * @example "U"
1406
+ */
1407
+ market?: any;
1408
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1409
+ /**
1410
+ * @tags Orders
1411
+ * @name OrderLookup
1412
+ * @summary Order lookup
1413
+ * @request GET:/orders/lookup
1414
+ * @secure
1415
+ */
1416
+ orderLookup(query?: {
1417
+ /**
1418
+ * Required
1419
+ * @example "{your order reference}"
1420
+ */
1421
+ clientRef?: any;
1422
+ /**
1423
+ * `true|false` (optional)
1424
+ * @example "false"
1425
+ */
1426
+ loadQuotes?: any;
1427
+ /**
1428
+ * Return bond pricing type in `Percentage|Decimal` (optional)
1429
+ * @example "Decimal"
1430
+ */
1431
+ bondPriceType?: any;
1432
+ /**
1433
+ * Return bond quantity in `Par|Unit` (optional)
1434
+ * @example "Par"
1435
+ */
1436
+ bondQuantityType?: any;
1437
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1438
+ }
1439
+ export class ResearchTipranks<HandleError extends boolean = boolean> {
1440
+ protected readonly apiClient: JwtClient<HandleError>;
1441
+ constructor(apiClient: JwtClient<HandleError>);
1442
+ /**
1443
+ * @tags Research Tipranks
1444
+ * @name Livefeed
1445
+ * @summary Livefeed
1446
+ * @request GET:/research/tipranks/livefeed
1447
+ * @secure
1448
+ */
1449
+ livefeed(query?: {
1450
+ /**
1451
+ * Amount to include. Defaults to 20.
1452
+ * @example "20"
1453
+ */
1454
+ count?: any;
1455
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1456
+ /**
1457
+ * @tags Research Tipranks
1458
+ * @name AnalystPortfolio
1459
+ * @summary Analyst Portfolio
1460
+ * @request GET:/research/tipranks/analyst/portfolio/{expertUID}
1461
+ * @secure
1462
+ */
1463
+ analystPortfolio(expertUid: string, query?: {
1464
+ /**
1465
+ * Total number of entries
1466
+ * @example "5"
1467
+ */
1468
+ count?: any;
1469
+ /**
1470
+ * Optional. Defaults to false
1471
+ * @example "true"
1472
+ */
1473
+ loadQuotes?: any;
1474
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1475
+ /**
1476
+ * @tags Research Tipranks
1477
+ * @name AnalystProfile
1478
+ * @summary Analyst Profile
1479
+ * @request GET:/research/tipranks/analyst/profile/{expertUID}
1480
+ * @secure
1481
+ */
1482
+ analystProfile(expertUid: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1483
+ /**
1484
+ * @tags Research Tipranks
1485
+ * @name TopAnalysts
1486
+ * @summary Top Analysts
1487
+ * @request GET:/research/tipranks/analyst/top
1488
+ * @secure
1489
+ */
1490
+ topAnalysts(query?: {
1491
+ /**
1492
+ * Total entries. Defaults to 20.
1493
+ * @example "25"
1494
+ */
1495
+ count?: any;
1496
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1497
+ /**
1498
+ * @tags Research Tipranks
1499
+ * @name RatingsBySymbol
1500
+ * @summary Ratings by Symbol
1501
+ * @request GET:/research/tipranks/analyst/{symbol}
1502
+ * @secure
1503
+ */
1504
+ ratingsBySymbol(symbol: string, query?: {
1505
+ /**
1506
+ * Number of analysts to include. Defaults to 20
1507
+ * @example "10"
1508
+ */
1509
+ count?: any;
1510
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1511
+ /**
1512
+ * @tags Research Tipranks
1513
+ * @name Insiders
1514
+ * @summary Insiders
1515
+ * @request GET:/research/tipranks/insiders
1516
+ * @secure
1517
+ */
1518
+ insiders(query?: {
1519
+ /**
1520
+ * Comma seperated for multiple symbols
1521
+ * @example "AAPL,GOOGL"
1522
+ */
1523
+ symbols?: any;
1524
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1525
+ /**
1526
+ * @tags Research Tipranks
1527
+ * @name InsiderTransactions
1528
+ * @summary Insider Transactions
1529
+ * @request GET:/research/tipranks/insiders/transactions
1530
+ * @secure
1531
+ */
1532
+ insiderTransactions(query?: {
1533
+ /**
1534
+ * Symbols (comma seperated)
1535
+ * @example "FB"
1536
+ */
1537
+ symbols?: any;
1538
+ /**
1539
+ * Number of entries (defaults to 20)
1540
+ * @example "10"
1541
+ */
1542
+ count?: any;
1543
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1544
+ /**
1545
+ * @tags Research Tipranks
1546
+ * @name SimilarStocks
1547
+ * @summary Similar Stocks
1548
+ * @request GET:/research/tipranks/stocks/similar/{symbol}
1549
+ * @secure
1550
+ */
1551
+ similarStocks(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1552
+ /**
1553
+ * @tags Research Tipranks
1554
+ * @name Overview
1555
+ * @summary Overview
1556
+ * @request GET:/research/tipranks/stocks/overview/{symbols}
1557
+ * @secure
1558
+ */
1559
+ overview(symbols: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1274
1560
  /**
1275
1561
  * @tags Research Tipranks
1276
1562
  * @name ConsensusBySector
@@ -1898,428 +2184,141 @@ export class Research<HandleError extends boolean = boolean> {
1898
2184
  /**
1899
2185
  * @tags Research
1900
2186
  * @name OwnerDetails
1901
- * @summary Owner Details
1902
- * @request GET:/research/owner/details
1903
- * @secure
1904
- */
1905
- ownerDetails(query?: {
1906
- /**
1907
- * Comma separated list of owner IDs
1908
- * @example "PS000000YH,PS000004TI"
1909
- */
1910
- ids?: any;
1911
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1912
- /**
1913
- * @tags Research
1914
- * @name EarningsCalendar
1915
- * @summary Earnings Calendar
1916
- * @request GET:/research/earnings
1917
- * @secure
1918
- */
1919
- earningsCalendar(query?: {
1920
- /**
1921
- * (Optional) Exclude Otcs from data.
1922
- * @example "true"
1923
- */
1924
- excludeOtcs?: any;
1925
- /**
1926
- * (Optional) Number of days in the future. Default is 7.
1927
- * @example "90"
1928
- */
1929
- days?: any;
1930
- /**
1931
- * `true`|`false`
1932
- * @example "false"
1933
- */
1934
- loadQuotes?: any;
1935
- /**
1936
- * (Optional) Use to filter results only to selected symbols. Excluding this parameter gives all upcoming earnings.
1937
- * @example "AAPL,T,GOOGL"
1938
- */
1939
- symbols?: any;
1940
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1941
- /**
1942
- * @tags Research
1943
- * @name Fundamentals
1944
- * @summary Fundamentals
1945
- * @request GET:/research/fundamentals/{type}/{symbol}
1946
- * @secure
1947
- */
1948
- fundamentals(type: string, symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1949
- /**
1950
- * @tags Research
1951
- * @name FundamentalTypes
1952
- * @summary Fundamental Types
1953
- * @request GET:/research/fundamentals/types
1954
- * @secure
1955
- */
1956
- fundamentalTypes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1957
- /**
1958
- * @tags Research
1959
- * @name Screener
1960
- * @summary Screener
1961
- * @request POST:/research/screener
1962
- * @secure
1963
- */
1964
- screener(data: {
1965
- /** @example 2 */
1966
- limit?: any;
1967
- /** @example [{"comparator":"Equals","dateRange":{"lowerBound":"01-01-2020","upperBound":"10-05-2020"},"field":"Industry","value":10280010}] */
1968
- queries?: any;
1969
- /** @example 0 */
1970
- start?: any;
1971
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1972
- /**
1973
- * @tags Research
1974
- * @name IndustryHeatMap
1975
- * @summary Industry Heat Map
1976
- * @request GET:/research/heatMap/industryRanking
1977
- * @secure
1978
- */
1979
- industryHeatMap(query?: {
1980
- /**
1981
- * Can be one of the following:
1982
- * Sector| Group | Industry | SubIndustry
1983
- * @example "group"
1984
- */
1985
- industryType?: any;
1986
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1987
- /**
1988
- * @tags Research
1989
- * @name IndustryList
1990
- * @summary Industry List
1991
- * @request GET:/
1992
- * @secure
1993
- */
1994
- industryList(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1995
- /**
1996
- * @tags Research
1997
- * @name SymbolHeatMap
1998
- * @summary Symbol Heat Map
1999
- * @request GET:/research/heatMap/symbols
2000
- * @secure
2001
- */
2002
- symbolHeatMap(query?: {
2003
- /** filter out by last price. 0 = no filter; 1 = lastPrice < 5.0; 2 = lastPrice < 1.0; 3 = lastPrice < 1.0 or lastPrice > 5.0; 4 = lastPrice > 1.0; 5 = lastPrice > 5.0 */
2004
- amountLimit?: any;
2005
- /** 0 indicates no filter, 1 indicates only NYSE, NASDAQ, AMEX. */
2006
- exchangeFilter?: any;
2007
- /** obtain from research/heatMap/industryRanking */
2008
- industryCode?: any;
2009
- /** max number of symbols returned */
2010
- numSymbols?: any;
2011
- /**
2012
- * `true` or `false`. true = top symbols change by price;
2013
- * false = bottom symbols channged by price.
2014
- */
2015
- top?: any;
2016
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2017
- /**
2018
- * @tags Research
2019
- * @name IndexOverview
2020
- * @summary Index Overview
2021
- * @request GET:/research/marketOverview
2022
- * @secure
2023
- */
2024
- indexOverview(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2025
- /**
2026
- * @tags Research
2027
- * @name HistoricalData
2028
- * @summary Historical Data
2029
- * @request GET:/research/historicalPrices
2030
- * @secure
2031
- */
2032
- historicalData(query?: {
2033
- symbol?: any;
2034
- /** comma saperated values. each value is started with number, following `w`, `m`, or `y`. w=week, m=month, y=year. For example, to get historical price last year and last two month, dates=1y,2m */
2035
- dates?: any;
2036
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2037
- }
2038
- export class Quotes<HandleError extends boolean = boolean> {
2039
- protected readonly apiClient: JwtClient<HandleError>;
2040
- constructor(apiClient: JwtClient<HandleError>);
2041
- /**
2042
- * @tags Quotes
2043
- * @name Equity
2044
- * @summary Equity
2045
- * @request GET:/quotes/equity
2046
- * @secure
2047
- */
2048
- equity(query?: {
2049
- /**
2050
- * Comma separated list of symbols
2051
- * @example "IBM"
2052
- */
2053
- symbols?: any;
2054
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2055
- /**
2056
- * @tags Quotes
2057
- * @name Search
2058
- * @summary Search
2059
- * @request GET:/quotes/search
2060
- * @secure
2061
- */
2062
- search(query?: {
2063
- /**
2064
- * String to search for
2065
- * @example "Apple"
2066
- */
2067
- criteria?: any;
2068
- /**
2069
- * Maximum number of results to return (default is 20)
2070
- * @example "3"
2071
- */
2072
- limit?: any;
2073
- /**
2074
- * Whether to load quotes for the results or not
2075
- * @example "false"
2076
- */
2077
- loadQuotes?: any;
2078
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2079
- /**
2080
- * @tags Quotes
2081
- * @name Option
2082
- * @summary Option
2083
- * @request GET:/quotes/option
2084
- * @secure
2085
- */
2086
- option(query?: {
2087
- /** Comma separated list of symbols */
2088
- symbols?: any;
2089
- /**
2090
- * `true|false` - whether to load option greeks
2091
- * @example ""
2092
- */
2093
- greeks?: any;
2094
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2095
- /**
2096
- * @tags Quotes
2097
- * @name OptionPricingType
2098
- * @summary Option pricing type
2099
- * @request GET:/quotes/option/pricing/type
2100
- * @secure
2101
- */
2102
- optionPricingType(query?: {
2103
- /**
2104
- * [optional]
2105
- * @example "MSFT"
2106
- */
2107
- underlying?: any;
2108
- /**
2109
- * [optional]
2110
- * @example "F 130927C00014500"
2111
- */
2112
- symbol?: any;
2113
- /**
2114
- * [optional]
2115
- * @example "1.23"
2116
- */
2117
- expectedPx?: any;
2118
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2119
- /**
2120
- * @tags Quotes
2121
- * @name Bonds
2122
- * @summary Bonds
2123
- * @request GET:/quotes/bonds
2124
- * @secure
2125
- */
2126
- bonds(query?: {
2127
- /**
2128
- * Comma separated list of ISINs
2129
- * @example "SK4120012691"
2130
- */
2131
- isin?: any;
2132
- /**
2133
- * Comma separated list of CUSIPs
2134
- * @example "412001269"
2135
- */
2136
- cusip?: any;
2137
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2138
- /**
2139
- * @tags Quotes
2140
- * @name BondsSearch
2141
- * @summary Bonds Search
2142
- * @request GET:/quotes/bonds/search
2143
- * @secure
2144
- */
2145
- bondsSearch(query?: {
2146
- /** @example "SearchString" */
2147
- criteria?: any;
2148
- /** @example "20" */
2149
- limit?: any;
2150
- /** @example "false" */
2151
- loadQuotes?: any;
2152
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2153
- /**
2154
- * @tags Quotes
2155
- * @name Historical
2156
- * @summary Historical
2157
- * @request GET:/quotes/equity/historical
2158
- * @secure
2159
- */
2160
- historical(query?: {
2161
- /**
2162
- * Ticker
2163
- * @example "AAPL"
2164
- */
2165
- symbol?: any;
2166
- /**
2167
- * Start date (mm/dd/yyyy)
2168
- * @example "01/01/2017"
2169
- */
2170
- start?: any;
2171
- /**
2172
- * End date (mm/dd/yyyy)
2173
- * @example "06/01/2017"
2174
- */
2175
- end?: any;
2176
- /** 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 */
2177
- range?: any;
2178
- /** Set `true` to load weekly data points. Defaults to false. */
2179
- setWeekly?: any;
2180
- /** Include RSI data by setting a span. Value must be > 0 */
2181
- rsiSpan?: any;
2182
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2183
- /**
2184
- * @tags Quotes
2185
- * @name IntradayChartData
2186
- * @summary Intraday chart data
2187
- * @request GET:/quotes/equity/intraday
2187
+ * @summary Owner Details
2188
+ * @request GET:/research/owner/details
2188
2189
  * @secure
2189
2190
  */
2190
- intradayChartData(query?: {
2191
- /**
2192
- * Ticker
2193
- * @example "IBM"
2194
- */
2195
- symbol?: any;
2196
- /** Include RSI data by setting a span. Value must be > 0 */
2197
- rsiSpan?: any;
2198
- /** `optional` timestamp format for multiday charts */
2199
- from?: any;
2200
- /** `optional` timestamp format for multiday charts */
2201
- to?: any;
2191
+ ownerDetails(query?: {
2202
2192
  /**
2203
- * `optional` whether to adjust volumes or not
2204
- * @example "false"
2193
+ * Comma separated list of owner IDs
2194
+ * @example "PS000000YH,PS000004TI"
2205
2195
  */
2206
- rawVolumes?: any;
2196
+ ids?: any;
2207
2197
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2208
2198
  /**
2209
- * @tags Quotes
2210
- * @name EquityTicks
2211
- * @summary Equity Ticks
2212
- * @request GET:/quotes/equity/ticks
2199
+ * @tags Research
2200
+ * @name EarningsCalendar
2201
+ * @summary Earnings Calendar
2202
+ * @request GET:/research/earnings
2213
2203
  * @secure
2214
2204
  */
2215
- equityTicks(query?: {
2205
+ earningsCalendar(query?: {
2216
2206
  /**
2217
- * Ticker
2218
- * @example "GOOG"
2207
+ * (Optional) Exclude Otcs from data.
2208
+ * @example "true"
2219
2209
  */
2220
- symbol?: any;
2210
+ excludeOtcs?: any;
2221
2211
  /**
2222
- * Timestamp for start of the data. Format: MM/DD/YYYY HH:MM or MM/DD/YYYY
2223
- * @example "11/27/2016"
2212
+ * (Optional) Number of days in the future. Default is 7.
2213
+ * @example "90"
2224
2214
  */
2225
- startTime?: any;
2215
+ days?: any;
2226
2216
  /**
2227
- * Timestamp for end of the data. Format: MM/DD/YYYY HH:MM or MM/DD/YYYY
2228
- * @example "11/28/2016"
2217
+ * `true`|`false`
2218
+ * @example "false"
2229
2219
  */
2230
- endTime?: any;
2220
+ loadQuotes?: any;
2221
+ /**
2222
+ * (Optional) Use to filter results only to selected symbols. Excluding this parameter gives all upcoming earnings.
2223
+ * @example "AAPL,T,GOOGL"
2224
+ */
2225
+ symbols?: any;
2231
2226
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2232
2227
  /**
2233
- * @tags Quotes
2234
- * @name Shortability
2235
- * @summary Shortability
2236
- * @request GET:/quotes/equity/shortability/{symbol}
2228
+ * @tags Research
2229
+ * @name Fundamentals
2230
+ * @summary Fundamentals
2231
+ * @request GET:/research/fundamentals/{type}/{symbol}
2237
2232
  * @secure
2238
2233
  */
2239
- shortability(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2234
+ fundamentals(type: string, symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2240
2235
  /**
2241
- * @tags Quotes
2242
- * @name MarginSuitability
2243
- * @summary Margin Suitability
2244
- * @request GET:/quotes/equity/marginability
2236
+ * @tags Research
2237
+ * @name FundamentalTypes
2238
+ * @summary Fundamental Types
2239
+ * @request GET:/research/fundamentals/types
2245
2240
  * @secure
2246
2241
  */
2247
- marginSuitability(query?: {
2248
- /**
2249
- * Equity ticker
2250
- * @example "TSLA"
2251
- */
2252
- symbol?: any;
2253
- /**
2254
- * Account number requesting the information
2255
- * @example "AB654321"
2256
- */
2257
- account?: any;
2258
- accountId?: any;
2259
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2242
+ fundamentalTypes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2260
2243
  /**
2261
- * @tags Quotes
2262
- * @name OptionChainDates
2263
- * @summary Option chain (dates)
2264
- * @request GET:/quotes/option/chain/dates/{symbol}
2244
+ * @tags Research
2245
+ * @name Screener
2246
+ * @summary Screener
2247
+ * @request POST:/research/screener
2265
2248
  * @secure
2266
2249
  */
2267
- optionChainDates(symbol: string, query?: {
2268
- /**
2269
- * Comma separated list of symbols
2270
- * @example "AAPL"
2271
- */
2272
- symbols?: any;
2250
+ screener(data: {
2251
+ /** @example 2 */
2252
+ limit?: any;
2253
+ /** @example [{"comparator":"Equals","dateRange":{"lowerBound":"01-01-2020","upperBound":"10-05-2020"},"field":"Industry","value":10280010}] */
2254
+ queries?: any;
2255
+ /** @example 0 */
2256
+ start?: any;
2273
2257
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2274
2258
  /**
2275
- * @tags Quotes
2276
- * @name OptionChain
2277
- * @summary Option chain
2278
- * @request GET:/quotes/option/chain/{symbol}/{date}
2259
+ * @tags Research
2260
+ * @name IndustryHeatMap
2261
+ * @summary Industry Heat Map
2262
+ * @request GET:/research/heatMap/industryRanking
2279
2263
  * @secure
2280
2264
  */
2281
- optionChain(symbol: string, date: string, query?: {
2265
+ industryHeatMap(query?: {
2282
2266
  /**
2283
- * Comma separated list of symbols
2284
- * @example "AAPL"
2267
+ * Can be one of the following:
2268
+ * Sector| Group | Industry | SubIndustry
2269
+ * @example "group"
2285
2270
  */
2286
- symbols?: any;
2271
+ industryType?: any;
2287
2272
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2288
2273
  /**
2289
- * @tags Quotes
2290
- * @name OptionChainGreeks
2291
- * @summary Option chain (greeks)
2292
- * @request GET:/quotes/option/greeks/{symbol}/{date}
2274
+ * @tags Research
2275
+ * @name IndustryList
2276
+ * @summary Industry List
2277
+ * @request GET:/
2293
2278
  * @secure
2294
2279
  */
2295
- optionChainGreeks(symbol: string, date: string, query?: {
2280
+ industryList(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2281
+ /**
2282
+ * @tags Research
2283
+ * @name SymbolHeatMap
2284
+ * @summary Symbol Heat Map
2285
+ * @request GET:/research/heatMap/symbols
2286
+ * @secure
2287
+ */
2288
+ symbolHeatMap(query?: {
2289
+ /** filter out by last price. 0 = no filter; 1 = lastPrice < 5.0; 2 = lastPrice < 1.0; 3 = lastPrice < 1.0 or lastPrice > 5.0; 4 = lastPrice > 1.0; 5 = lastPrice > 5.0 */
2290
+ amountLimit?: any;
2291
+ /** 0 indicates no filter, 1 indicates only NYSE, NASDAQ, AMEX. */
2292
+ exchangeFilter?: any;
2293
+ /** obtain from research/heatMap/industryRanking */
2294
+ industryCode?: any;
2295
+ /** max number of symbols returned */
2296
+ numSymbols?: any;
2296
2297
  /**
2297
- * Comma separated list of symbols
2298
- * @example "AAPL"
2298
+ * `true` or `false`. true = top symbols change by price;
2299
+ * false = bottom symbols channged by price.
2299
2300
  */
2300
- symbols?: any;
2301
+ top?: any;
2301
2302
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2302
2303
  /**
2303
- * @tags Quotes
2304
- * @name Crypto
2305
- * @summary Crypto
2306
- * @request GET:/quotes/crypto
2304
+ * @tags Research
2305
+ * @name IndexOverview
2306
+ * @summary Index Overview
2307
+ * @request GET:/research/marketOverview
2307
2308
  * @secure
2308
2309
  */
2309
- crypto(query?: {
2310
- /** @example "" */
2311
- symbols?: any;
2312
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2310
+ indexOverview(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2313
2311
  /**
2314
- * @tags Quotes
2315
- * @name FxRate
2316
- * @summary FX rate
2317
- * @request GET:/quotes/fx
2312
+ * @tags Research
2313
+ * @name HistoricalData
2314
+ * @summary Historical Data
2315
+ * @request GET:/research/historicalPrices
2318
2316
  * @secure
2319
2317
  */
2320
- fxRate(query?: {
2321
- /** @example "EUR/USD,GBP/USD" */
2322
- symbols?: any;
2318
+ historicalData(query?: {
2319
+ symbol?: any;
2320
+ /** comma saperated values. each value is started with number, following `w`, `m`, or `y`. w=week, m=month, y=year. For example, to get historical price last year and last two month, dates=1y,2m */
2321
+ dates?: any;
2323
2322
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2324
2323
  }
2325
2324
  export class UserAgreements<HandleError extends boolean = boolean> {
@@ -3227,22 +3226,93 @@ export class AdvisoryCharges<HandleError extends boolean = boolean> {
3227
3226
  * @request POST:/v2/charges/apply
3228
3227
  * @secure
3229
3228
  */
3230
- apply(data: {
3231
- /** @example 1234 */
3232
- accountId?: any;
3233
- /** @example 7.11 */
3234
- amount?: any;
3235
- /** @example "{timestamp}" */
3236
- date?: any;
3229
+ apply(data: {
3230
+ /** @example 1234 */
3231
+ accountId?: any;
3232
+ /** @example 7.11 */
3233
+ amount?: any;
3234
+ /** @example "{timestamp}" */
3235
+ date?: any;
3236
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3237
+ /**
3238
+ * @tags Advisory Charges
3239
+ * @name Cancel
3240
+ * @summary /cancel
3241
+ * @request POST:/v2/charges/cancel
3242
+ * @secure
3243
+ */
3244
+ cancel(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3245
+ }
3246
+ export class AdvisoryUserAccountManagement<HandleError extends boolean = boolean> {
3247
+ protected readonly apiClient: JwtClient<HandleError>;
3248
+ constructor(apiClient: JwtClient<HandleError>);
3249
+ /**
3250
+ * @tags Advisory User Account Management
3251
+ * @name List
3252
+ * @summary /list
3253
+ * @request GET:/v2/advisory/users/list
3254
+ * @secure
3255
+ */
3256
+ list(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3257
+ /**
3258
+ * @tags Advisory User Account Management
3259
+ * @name Accounts
3260
+ * @summary /accounts
3261
+ * @request GET:/v2/advisory/users/accounts
3262
+ * @secure
3263
+ */
3264
+ accounts(query?: {
3265
+ /** @example "1234" */
3266
+ uid?: any;
3267
+ /**
3268
+ * true|false
3269
+ * @example "false"
3270
+ */
3271
+ loadRtb?: any;
3272
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3273
+ /**
3274
+ * @tags Advisory User Account Management
3275
+ * @name AccountsStats
3276
+ * @summary /accounts/stats
3277
+ * @request GET:/v2/advisory/users/accounts/stats
3278
+ * @secure
3279
+ */
3280
+ accountsStats(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3281
+ /**
3282
+ * @tags Advisory User Account Management
3283
+ * @name AccountNotes
3284
+ * @summary /account/notes
3285
+ * @request GET:/v2/advisory/users/account/notes
3286
+ * @secure
3287
+ */
3288
+ accountNotes(query?: {
3289
+ /**
3290
+ * Account's ID
3291
+ * @example "1234"
3292
+ */
3293
+ aid?: any;
3294
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3295
+ /**
3296
+ * @tags Advisory User Account Management
3297
+ * @name Notes
3298
+ * @summary /notes
3299
+ * @request GET:/v2/advisory/users/notes
3300
+ * @secure
3301
+ */
3302
+ notes(query?: {
3303
+ /**
3304
+ * User's ID
3305
+ * @example "1234"
3306
+ */
3307
+ uid?: any;
3237
3308
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3238
3309
  /**
3239
- * @tags Advisory Charges
3240
- * @name Cancel
3241
- * @summary /cancel
3242
- * @request POST:/v2/charges/cancel
3310
+ * @tags Advisory User Account Management
3311
+ * @name NotesPost
3312
+ * @request POST:/v2/advisory/users/notes/{action}
3243
3313
  * @secure
3244
3314
  */
3245
- cancel(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3315
+ notesPost(action: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3246
3316
  }
3247
3317
  export class AdvisoryModels<HandleError extends boolean = boolean> {
3248
3318
  protected readonly apiClient: JwtClient<HandleError>;
@@ -3519,77 +3589,6 @@ export class AdvisoryModels<HandleError extends boolean = boolean> {
3519
3589
  */
3520
3590
  allocations(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3521
3591
  }
3522
- export class AdvisoryUserAccountManagement<HandleError extends boolean = boolean> {
3523
- protected readonly apiClient: JwtClient<HandleError>;
3524
- constructor(apiClient: JwtClient<HandleError>);
3525
- /**
3526
- * @tags Advisory User Account Management
3527
- * @name List
3528
- * @summary /list
3529
- * @request GET:/v2/advisory/users/list
3530
- * @secure
3531
- */
3532
- list(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3533
- /**
3534
- * @tags Advisory User Account Management
3535
- * @name Accounts
3536
- * @summary /accounts
3537
- * @request GET:/v2/advisory/users/accounts
3538
- * @secure
3539
- */
3540
- accounts(query?: {
3541
- /** @example "1234" */
3542
- uid?: any;
3543
- /**
3544
- * true|false
3545
- * @example "false"
3546
- */
3547
- loadRtb?: any;
3548
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3549
- /**
3550
- * @tags Advisory User Account Management
3551
- * @name AccountsStats
3552
- * @summary /accounts/stats
3553
- * @request GET:/v2/advisory/users/accounts/stats
3554
- * @secure
3555
- */
3556
- accountsStats(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3557
- /**
3558
- * @tags Advisory User Account Management
3559
- * @name AccountNotes
3560
- * @summary /account/notes
3561
- * @request GET:/v2/advisory/users/account/notes
3562
- * @secure
3563
- */
3564
- accountNotes(query?: {
3565
- /**
3566
- * Account's ID
3567
- * @example "1234"
3568
- */
3569
- aid?: any;
3570
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3571
- /**
3572
- * @tags Advisory User Account Management
3573
- * @name Notes
3574
- * @summary /notes
3575
- * @request GET:/v2/advisory/users/notes
3576
- * @secure
3577
- */
3578
- notes(query?: {
3579
- /**
3580
- * User's ID
3581
- * @example "1234"
3582
- */
3583
- uid?: any;
3584
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3585
- /**
3586
- * @tags Advisory User Account Management
3587
- * @name NotesPost
3588
- * @request POST:/v2/advisory/users/notes/{action}
3589
- * @secure
3590
- */
3591
- notesPost(action: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3592
- }
3593
3592
  export class AdvisoryGroups<HandleError extends boolean = boolean> {
3594
3593
  protected readonly apiClient: JwtClient<HandleError>;
3595
3594
  constructor(apiClient: JwtClient<HandleError>);
@@ -4134,6 +4133,81 @@ export class TransfersAch<HandleError extends boolean = boolean> {
4134
4133
  */
4135
4134
  withdraw(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4136
4135
  }
4136
+ export class TransfersWires<HandleError extends boolean = boolean> {
4137
+ protected readonly apiClient: JwtClient<HandleError>;
4138
+ constructor(apiClient: JwtClient<HandleError>);
4139
+ /**
4140
+ * @tags Transfers Wires
4141
+ * @name Outgoing
4142
+ * @summary Outgoing
4143
+ * @request POST:/transfer/wire/outgoing
4144
+ * @secure
4145
+ */
4146
+ outgoing(data: {
4147
+ /** @example "TRACCOUNT" */
4148
+ account?: any;
4149
+ /** @example 200 */
4150
+ amount?: any;
4151
+ beneficiary?: {
4152
+ /** @example "AAA012345" */
4153
+ account?: string;
4154
+ /** @example "CHECKING|SAVINGS" */
4155
+ accountType?: string;
4156
+ address?: {
4157
+ /** @example "Central City" */
4158
+ city?: string;
4159
+ /** @example "USA" */
4160
+ country?: string;
4161
+ /** @example "11235" */
4162
+ postalCode?: string;
4163
+ /** @example "ST" */
4164
+ stateProvince?: string;
4165
+ /** @example ["123 Main St"] */
4166
+ streetAddress?: string[];
4167
+ };
4168
+ /** @example "John Smith" */
4169
+ name?: string;
4170
+ /** @example false */
4171
+ thirdParty?: boolean;
4172
+ };
4173
+ /** @example "Partial|Full" */
4174
+ disbursementType?: any;
4175
+ /** @example 1234 */
4176
+ entryId?: any;
4177
+ /** @example false */
4178
+ international?: any;
4179
+ iraDetails?: {
4180
+ /** @example "" */
4181
+ contributionType?: string;
4182
+ /** @example 2020 */
4183
+ contributionYear?: number;
4184
+ };
4185
+ recipientBank?: {
4186
+ /** @example "" */
4187
+ additionalInformation?: string;
4188
+ /** @example "" */
4189
+ city?: string;
4190
+ /** @example "" */
4191
+ country?: string;
4192
+ identifier?: {
4193
+ /** @example "021202162" */
4194
+ id?: string;
4195
+ /** @example "ABA|BIC" */
4196
+ type?: string;
4197
+ };
4198
+ /** @example "" */
4199
+ name?: string;
4200
+ /** @example "" */
4201
+ postalCode?: string;
4202
+ /** @example "" */
4203
+ stateProvince?: string;
4204
+ };
4205
+ /** @example "0.0.0.0" */
4206
+ remoteAddr?: any;
4207
+ /** @example "ultra fast browser 1.1" */
4208
+ remoteDevice?: any;
4209
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4210
+ }
4137
4211
  export class TransfersAcats<HandleError extends boolean = boolean> {
4138
4212
  protected readonly apiClient: JwtClient<HandleError>;
4139
4213
  constructor(apiClient: JwtClient<HandleError>);
@@ -4254,93 +4328,18 @@ export class TransfersAcats<HandleError extends boolean = boolean> {
4254
4328
  /** @example "" */
4255
4329
  contraTitle?: string;
4256
4330
  /** @example "" */
4257
- participantNumber?: string;
4258
- /** @example "" */
4259
- primaryTaxId?: string;
4260
- /** @example "{optional}" */
4261
- remoteDevice?: string;
4262
- /** @example "{optional}" */
4263
- remoteIp?: string;
4264
- /** @example "" */
4265
- secondaryTaxId?: string;
4266
- /** @example "Full|Partial" */
4267
- type?: string;
4268
- }[], config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4269
- }
4270
- export class TransfersWires<HandleError extends boolean = boolean> {
4271
- protected readonly apiClient: JwtClient<HandleError>;
4272
- constructor(apiClient: JwtClient<HandleError>);
4273
- /**
4274
- * @tags Transfers Wires
4275
- * @name Outgoing
4276
- * @summary Outgoing
4277
- * @request POST:/transfer/wire/outgoing
4278
- * @secure
4279
- */
4280
- outgoing(data: {
4281
- /** @example "TRACCOUNT" */
4282
- account?: any;
4283
- /** @example 200 */
4284
- amount?: any;
4285
- beneficiary?: {
4286
- /** @example "AAA012345" */
4287
- account?: string;
4288
- /** @example "CHECKING|SAVINGS" */
4289
- accountType?: string;
4290
- address?: {
4291
- /** @example "Central City" */
4292
- city?: string;
4293
- /** @example "USA" */
4294
- country?: string;
4295
- /** @example "11235" */
4296
- postalCode?: string;
4297
- /** @example "ST" */
4298
- stateProvince?: string;
4299
- /** @example ["123 Main St"] */
4300
- streetAddress?: string[];
4301
- };
4302
- /** @example "John Smith" */
4303
- name?: string;
4304
- /** @example false */
4305
- thirdParty?: boolean;
4306
- };
4307
- /** @example "Partial|Full" */
4308
- disbursementType?: any;
4309
- /** @example 1234 */
4310
- entryId?: any;
4311
- /** @example false */
4312
- international?: any;
4313
- iraDetails?: {
4314
- /** @example "" */
4315
- contributionType?: string;
4316
- /** @example 2020 */
4317
- contributionYear?: number;
4318
- };
4319
- recipientBank?: {
4320
- /** @example "" */
4321
- additionalInformation?: string;
4322
- /** @example "" */
4323
- city?: string;
4324
- /** @example "" */
4325
- country?: string;
4326
- identifier?: {
4327
- /** @example "021202162" */
4328
- id?: string;
4329
- /** @example "ABA|BIC" */
4330
- type?: string;
4331
- };
4332
- /** @example "" */
4333
- name?: string;
4334
- /** @example "" */
4335
- postalCode?: string;
4336
- /** @example "" */
4337
- stateProvince?: string;
4338
- };
4339
- /** @example "0.0.0.0" */
4340
- remoteAddr?: any;
4341
- /** @example "ultra fast browser 1.1" */
4342
- remoteDevice?: any;
4343
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4331
+ participantNumber?: string;
4332
+ /** @example "" */
4333
+ primaryTaxId?: string;
4334
+ /** @example "{optional}" */
4335
+ remoteDevice?: string;
4336
+ /** @example "{optional}" */
4337
+ remoteIp?: string;
4338
+ /** @example "" */
4339
+ secondaryTaxId?: string;
4340
+ /** @example "Full|Partial" */
4341
+ type?: string;
4342
+ }[], config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4344
4343
  }
4345
4344
  export class TransfersJournals<HandleError extends boolean = boolean> {
4346
4345
  protected readonly apiClient: JwtClient<HandleError>;
@@ -4559,26 +4558,260 @@ export class TransfersInstantCashTransfers<HandleError extends boolean = boolean
4559
4558
  /** @example "RETAIL_BANKING" */
4560
4559
  reportType?: any;
4561
4560
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4562
- /**
4563
- * @tags Transfers Instant Cash Transfers
4564
- * @name ListReports
4565
- * @summary List reports
4566
- * @request GET:/transfer/reports
4567
- * @secure
4568
- */
4569
- listReports(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4570
- }
4571
- export class TransfersCheques<HandleError extends boolean = boolean> {
4572
- protected readonly apiClient: JwtClient<HandleError>;
4573
- constructor(apiClient: JwtClient<HandleError>);
4574
- /**
4575
- * @tags Transfers Cheques
4576
- * @name Withdrawal
4577
- * @summary Withdrawal
4578
- * @request POST:/transfer/check/outgoing
4579
- * @secure
4580
- */
4581
- withdrawal(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4561
+ /**
4562
+ * @tags Transfers Instant Cash Transfers
4563
+ * @name ListReports
4564
+ * @summary List reports
4565
+ * @request GET:/transfer/reports
4566
+ * @secure
4567
+ */
4568
+ listReports(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4569
+ }
4570
+ export class TransfersCheques<HandleError extends boolean = boolean> {
4571
+ protected readonly apiClient: JwtClient<HandleError>;
4572
+ constructor(apiClient: JwtClient<HandleError>);
4573
+ /**
4574
+ * @tags Transfers Cheques
4575
+ * @name Withdrawal
4576
+ * @summary Withdrawal
4577
+ * @request POST:/transfer/check/outgoing
4578
+ * @secure
4579
+ */
4580
+ withdrawal(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4581
+ }
4582
+ export class Transfers<HandleError extends boolean = boolean> {
4583
+ protected readonly apiClient: JwtClient<HandleError>;
4584
+ relationships: TransfersRelationships<HandleError>;
4585
+ instantAccountVerification: TransfersInstantAccountVerification<HandleError>;
4586
+ ach: TransfersAch<HandleError>;
4587
+ acats: TransfersAcats<HandleError>;
4588
+ wires: TransfersWires<HandleError>;
4589
+ journals: TransfersJournals<HandleError>;
4590
+ positions: TransfersPositions<HandleError>;
4591
+ bank: TransfersBank<HandleError>;
4592
+ instantCashTransfers: TransfersInstantCashTransfers<HandleError>;
4593
+ cheques: TransfersCheques<HandleError>;
4594
+ constructor(apiClient: JwtClient<HandleError>);
4595
+ /**
4596
+ * @tags Transfers
4597
+ * @name TransferDetails
4598
+ * @summary Transfer Details
4599
+ * @request GET:/transfer/details/{account}/{transferId}
4600
+ * @secure
4601
+ */
4602
+ transferDetails(account: string, transferId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4603
+ /**
4604
+ * @tags Transfers
4605
+ * @name TransferStatus
4606
+ * @summary Transfer Status
4607
+ * @request GET:/transfer/status/{account}
4608
+ * @secure
4609
+ */
4610
+ transferStatus(account: string, query?: {
4611
+ /** INCOMING|OUTGOING */
4612
+ direction?: any;
4613
+ /** ACH|WIRE|CHECK|Bank|CustodyJournal|ALL */
4614
+ mechanism?: any;
4615
+ /** MM/DD/YYYY */
4616
+ dateFrom?: any;
4617
+ /** MM/DD/YYYY */
4618
+ dateTo?: any;
4619
+ /** Overrides `dateFrom` and `dateTo`. See description. */
4620
+ range?: any;
4621
+ start?: any;
4622
+ perPage?: any;
4623
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4624
+ /**
4625
+ * @tags Transfers
4626
+ * @name TransferStatusModel
4627
+ * @summary Transfer Status Model
4628
+ * @request GET:/transfer/status/model/{modelId}
4629
+ * @secure
4630
+ */
4631
+ transferStatusModel(modelId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4632
+ /**
4633
+ * @tags Transfers
4634
+ * @name TransferStatusBranch
4635
+ * @summary Transfer Status Branch
4636
+ * @request GET:/transfer/status/branch
4637
+ * @secure
4638
+ */
4639
+ transferStatusBranch(query?: {
4640
+ /**
4641
+ * INCOMING|OUTGOING|ALL
4642
+ * @example "ALL"
4643
+ */
4644
+ direction?: any;
4645
+ /**
4646
+ * ACH|WIRE|CHECK|Bank|CustodyJournal
4647
+ * @example "ALL"
4648
+ */
4649
+ mechanism?: any;
4650
+ dateFrom?: any;
4651
+ dateTo?: any;
4652
+ /** Per regex: \d+[ymdw]$ (will override `dateFrom` and `dateTo`) */
4653
+ range?: any;
4654
+ start?: any;
4655
+ perPage?: any;
4656
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4657
+ /**
4658
+ * @tags Transfers
4659
+ * @name AmountAvailable
4660
+ * @summary Amount Available
4661
+ * @request GET:/transfer/available/{account}
4662
+ * @secure
4663
+ */
4664
+ amountAvailable(account: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4665
+ /**
4666
+ * @tags Transfers
4667
+ * @name LegalDocumentTypes
4668
+ * @summary Legal document types
4669
+ * @request GET:/transfer/legal/types
4670
+ * @secure
4671
+ */
4672
+ legalDocumentTypes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4673
+ /**
4674
+ * @tags Transfers
4675
+ * @name LegalDocument
4676
+ * @summary Legal document
4677
+ * @request GET:/transfer/legal/content
4678
+ * @secure
4679
+ */
4680
+ legalDocument(query?: {
4681
+ /** Unique ID given in the types endpoint */
4682
+ id?: any;
4683
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4684
+ /**
4685
+ * @tags Transfers
4686
+ * @name Cancel
4687
+ * @summary Cancel
4688
+ * @request POST:/transfer/ach/cancel
4689
+ * @secure
4690
+ */
4691
+ cancel(data: {
4692
+ /** @example "5VA0XXXX" */
4693
+ account?: any;
4694
+ /** @example "0.0.0.0" */
4695
+ remoteAddr?: any;
4696
+ /** @example "ultra fast browser 1.1" */
4697
+ remoteDevice?: any;
4698
+ /** @example "CC123456" */
4699
+ transferId?: any;
4700
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4701
+ /**
4702
+ * @tags Transfers
4703
+ * @name FeesAndCredits
4704
+ * @summary Fees and Credits
4705
+ * @request POST:/transfer/fees/apply
4706
+ * @secure
4707
+ */
4708
+ feesAndCredits(data: {
4709
+ /** @example "5VA0XXXX" */
4710
+ account?: any;
4711
+ /** @example 100 */
4712
+ amount?: any;
4713
+ /** @example "FeeReversal|Promotion|WriteOff|Rebate|Courtesy|Advisory|Management|Admin|Exchange|Tech|Platform|Inactivity|MarginInterest|Custodian|CryptoGift" */
4714
+ classification?: any;
4715
+ /** @example "" */
4716
+ contraNote?: any;
4717
+ /** @example "USD" */
4718
+ currency?: any;
4719
+ /** @example "" */
4720
+ note?: any;
4721
+ /** @example 0.01 */
4722
+ quantity?: any;
4723
+ /** @example "0.0.0.0" */
4724
+ remoteAddr?: any;
4725
+ /** @example "ultra fast browser 1.1" */
4726
+ remoteDevice?: any;
4727
+ /** @example "BTC/USD" */
4728
+ symbol?: any;
4729
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4730
+ /**
4731
+ * @tags Transfers
4732
+ * @name ListFees
4733
+ * @summary List fees
4734
+ * @request GET:/transfer/fees/classifications/fees
4735
+ * @secure
4736
+ */
4737
+ listFees(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4738
+ /**
4739
+ * @tags Transfers
4740
+ * @name ListCredits
4741
+ * @summary List credits
4742
+ * @request GET:/transfer/fees/classifications/credits
4743
+ * @secure
4744
+ */
4745
+ listCredits(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4746
+ /**
4747
+ * @tags Transfers
4748
+ * @name CryptoDepositAddress
4749
+ * @summary Crypto Deposit Address
4750
+ * @request GET:/transfer/crypto/deposit/wallet/address
4751
+ * @secure
4752
+ */
4753
+ cryptoDepositAddress(data: {
4754
+ /** @example "AB123456" */
4755
+ account?: any;
4756
+ /** @example "BTC" */
4757
+ currency?: any;
4758
+ /** @example "{optional}" */
4759
+ network?: any;
4760
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4761
+ /**
4762
+ * @tags Transfers
4763
+ * @name CryptoWithdrawalEstimate
4764
+ * @summary Crypto Withdrawal Estimate
4765
+ * @request POST:/transfer/crypto/withdrawal/estimate
4766
+ * @secure
4767
+ */
4768
+ cryptoWithdrawalEstimate(data: {
4769
+ /** @example "BTC" */
4770
+ currency?: any;
4771
+ /** @example "{optional}" */
4772
+ network?: any;
4773
+ /** @example "0.1" */
4774
+ quantity?: any;
4775
+ /** @example "{optional}" */
4776
+ wallet?: any;
4777
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4778
+ /**
4779
+ * @tags Transfers
4780
+ * @name CryptoWithdrawal
4781
+ * @summary Crypto Withdrawal
4782
+ * @request POST:/transfer/crypto/withdraw
4783
+ * @secure
4784
+ */
4785
+ cryptoWithdrawal(data: {
4786
+ /** @example "AB123456" */
4787
+ account?: any;
4788
+ /** @example "BTC" */
4789
+ currency?: any;
4790
+ /** @example "{optional}" */
4791
+ estimateExtension?: any;
4792
+ /** @example "abc123" */
4793
+ estimateId?: any;
4794
+ /** @example "{optional}" */
4795
+ network?: any;
4796
+ /** @example 0.1 */
4797
+ quantity?: any;
4798
+ /** @example "{conditional}" */
4799
+ recipientFirstName?: any;
4800
+ /** @example "{conditional}" */
4801
+ recipientLastName?: any;
4802
+ /** @example "{optional} 1.1.1.1" */
4803
+ remoteAddr?: any;
4804
+ /** @example "{optional} Some phone" */
4805
+ remoteDevice?: any;
4806
+ /** @example "{optional} true|false" */
4807
+ selfHosted?: any;
4808
+ /** @example "{optional}" */
4809
+ tag?: any;
4810
+ /** @example "{conditional}" */
4811
+ vaspName?: any;
4812
+ /** @example "wallet address" */
4813
+ wallet?: any;
4814
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4582
4815
  }
4583
4816
  export class Documents<HandleError extends boolean = boolean> {
4584
4817
  protected readonly apiClient: JwtClient<HandleError>;
@@ -5003,345 +5236,111 @@ export class Branch<HandleError extends boolean = boolean> {
5003
5236
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5004
5237
  }
5005
5238
  export class LegalDocuments<HandleError extends boolean = boolean> {
5006
- protected readonly apiClient: JwtClient<HandleError>;
5007
- constructor(apiClient: JwtClient<HandleError>);
5008
- /**
5009
- * @tags Legal Documents
5010
- * @name DocumentClassifications
5011
- * @summary Document classifications
5012
- * @request GET:/user/legal/classifications
5013
- * @secure
5014
- */
5015
- documentClassifications(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5016
- /**
5017
- * @tags Legal Documents
5018
- * @name DocumentListing
5019
- * @summary Document listing
5020
- * @request GET:/user/legal/documents
5021
- * @secure
5022
- */
5023
- documentListing(query?: {
5024
- /**
5025
- * {optional}
5026
- * @example "TermsOfUse"
5027
- */
5028
- classification?: any;
5029
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5030
- /**
5031
- * @tags Legal Documents
5032
- * @name PolicyValues
5033
- * @summary Policy values
5034
- * @request GET:/user/legal/policies/listing/{type}
5035
- * @secure
5036
- */
5037
- policyValues(type: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5038
- /**
5039
- * @tags Legal Documents
5040
- * @name DocumentContent
5041
- * @summary Document content
5042
- * @request GET:/user/legal/document/content
5043
- * @secure
5044
- */
5045
- documentContent(query?: {
5046
- /** @example "{as provided}" */
5047
- id?: any;
5048
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5049
- /**
5050
- * @tags Legal Documents
5051
- * @name DocumentDownload
5052
- * @summary Document download
5053
- * @request GET:/user/legal/document/download
5054
- * @secure
5055
- */
5056
- documentDownload(query?: {
5057
- /** @example "{as provided}" */
5058
- id?: any;
5059
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5060
- /**
5061
- * @tags Legal Documents
5062
- * @name SignTheDocument
5063
- * @summary Sign the document
5064
- * @request POST:/user/legal/document/sign
5065
- * @secure
5066
- */
5067
- signTheDocument(data: {
5068
- account?: {
5069
- /** @example 1234 */
5070
- accountId?: number;
5071
- /** @example "AC123456" */
5072
- accountNumber?: string;
5073
- };
5074
- data?: {
5075
- /** @example "{conditional}" */
5076
- bankAccountNumber?: string;
5077
- };
5078
- /** @example "{required}" */
5079
- documentId?: any;
5080
- /** @example true */
5081
- esigned?: any;
5082
- /** @example "" */
5083
- remoteAddr?: any;
5084
- /** @example "{required}" */
5085
- remoteDevice?: any;
5086
- /** @example "{required}" */
5087
- signature?: any;
5088
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5089
- /**
5090
- * @tags Legal Documents
5091
- * @name UpdatesPolicyOnTheAccount
5092
- * @summary Updates policy on the account
5093
- * @request POST:/user/legal/policy/{type}
5094
- * @secure
5095
- */
5096
- updatesPolicyOnTheAccount(type: string, data: {
5097
- account?: {
5098
- /** @example 0 */
5099
- accountId?: number;
5100
- /** @example "{optional}" */
5101
- accountNumber?: string;
5102
- };
5103
- /** @example true */
5104
- esigned?: any;
5105
- /** @example "Allow" */
5106
- policy?: any;
5107
- /** @example "" */
5108
- remoteAddr?: any;
5109
- /** @example "" */
5110
- remoteDevice?: any;
5111
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5112
- }
5113
- export class Transfers<HandleError extends boolean = boolean> {
5114
- protected readonly apiClient: JwtClient<HandleError>;
5115
- relationships: TransfersRelationships<HandleError>;
5116
- instantAccountVerification: TransfersInstantAccountVerification<HandleError>;
5117
- ach: TransfersAch<HandleError>;
5118
- acats: TransfersAcats<HandleError>;
5119
- wires: TransfersWires<HandleError>;
5120
- journals: TransfersJournals<HandleError>;
5121
- positions: TransfersPositions<HandleError>;
5122
- bank: TransfersBank<HandleError>;
5123
- instantCashTransfers: TransfersInstantCashTransfers<HandleError>;
5124
- cheques: TransfersCheques<HandleError>;
5125
- constructor(apiClient: JwtClient<HandleError>);
5126
- /**
5127
- * @tags Transfers
5128
- * @name TransferDetails
5129
- * @summary Transfer Details
5130
- * @request GET:/transfer/details/{account}/{transferId}
5131
- * @secure
5132
- */
5133
- transferDetails(account: string, transferId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5134
- /**
5135
- * @tags Transfers
5136
- * @name TransferStatus
5137
- * @summary Transfer Status
5138
- * @request GET:/transfer/status/{account}
5139
- * @secure
5140
- */
5141
- transferStatus(account: string, query?: {
5142
- /** INCOMING|OUTGOING */
5143
- direction?: any;
5144
- /** ACH|WIRE|CHECK|Bank|CustodyJournal|ALL */
5145
- mechanism?: any;
5146
- /** MM/DD/YYYY */
5147
- dateFrom?: any;
5148
- /** MM/DD/YYYY */
5149
- dateTo?: any;
5150
- /** Overrides `dateFrom` and `dateTo`. See description. */
5151
- range?: any;
5152
- start?: any;
5153
- perPage?: any;
5154
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5155
- /**
5156
- * @tags Transfers
5157
- * @name TransferStatusModel
5158
- * @summary Transfer Status Model
5159
- * @request GET:/transfer/status/model/{modelId}
5160
- * @secure
5161
- */
5162
- transferStatusModel(modelId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5163
- /**
5164
- * @tags Transfers
5165
- * @name TransferStatusBranch
5166
- * @summary Transfer Status Branch
5167
- * @request GET:/transfer/status/branch
5168
- * @secure
5169
- */
5170
- transferStatusBranch(query?: {
5171
- /**
5172
- * INCOMING|OUTGOING|ALL
5173
- * @example "ALL"
5174
- */
5175
- direction?: any;
5176
- /**
5177
- * ACH|WIRE|CHECK|Bank|CustodyJournal
5178
- * @example "ALL"
5179
- */
5180
- mechanism?: any;
5181
- dateFrom?: any;
5182
- dateTo?: any;
5183
- /** Per regex: \d+[ymdw]$ (will override `dateFrom` and `dateTo`) */
5184
- range?: any;
5185
- start?: any;
5186
- perPage?: any;
5187
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5188
- /**
5189
- * @tags Transfers
5190
- * @name AmountAvailable
5191
- * @summary Amount Available
5192
- * @request GET:/transfer/available/{account}
5193
- * @secure
5194
- */
5195
- amountAvailable(account: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5196
- /**
5197
- * @tags Transfers
5198
- * @name LegalDocumentTypes
5199
- * @summary Legal document types
5200
- * @request GET:/transfer/legal/types
5201
- * @secure
5202
- */
5203
- legalDocumentTypes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5204
- /**
5205
- * @tags Transfers
5206
- * @name LegalDocument
5207
- * @summary Legal document
5208
- * @request GET:/transfer/legal/content
5209
- * @secure
5210
- */
5211
- legalDocument(query?: {
5212
- /** Unique ID given in the types endpoint */
5213
- id?: any;
5214
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5215
- /**
5216
- * @tags Transfers
5217
- * @name Cancel
5218
- * @summary Cancel
5219
- * @request POST:/transfer/ach/cancel
5220
- * @secure
5221
- */
5222
- cancel(data: {
5223
- /** @example "5VA0XXXX" */
5224
- account?: any;
5225
- /** @example "0.0.0.0" */
5226
- remoteAddr?: any;
5227
- /** @example "ultra fast browser 1.1" */
5228
- remoteDevice?: any;
5229
- /** @example "CC123456" */
5230
- transferId?: any;
5231
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5239
+ protected readonly apiClient: JwtClient<HandleError>;
5240
+ constructor(apiClient: JwtClient<HandleError>);
5232
5241
  /**
5233
- * @tags Transfers
5234
- * @name FeesAndCredits
5235
- * @summary Fees and Credits
5236
- * @request POST:/transfer/fees/apply
5242
+ * @tags Legal Documents
5243
+ * @name DocumentClassifications
5244
+ * @summary Document classifications
5245
+ * @request GET:/user/legal/classifications
5237
5246
  * @secure
5238
5247
  */
5239
- feesAndCredits(data: {
5240
- /** @example "5VA0XXXX" */
5241
- account?: any;
5242
- /** @example 100 */
5243
- amount?: any;
5244
- /** @example "FeeReversal|Promotion|WriteOff|Rebate|Courtesy|Advisory|Management|Admin|Exchange|Tech|Platform|Inactivity|MarginInterest|Custodian|CryptoGift" */
5248
+ documentClassifications(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5249
+ /**
5250
+ * @tags Legal Documents
5251
+ * @name DocumentListing
5252
+ * @summary Document listing
5253
+ * @request GET:/user/legal/documents
5254
+ * @secure
5255
+ */
5256
+ documentListing(query?: {
5257
+ /**
5258
+ * {optional}
5259
+ * @example "TermsOfUse"
5260
+ */
5245
5261
  classification?: any;
5246
- /** @example "" */
5247
- contraNote?: any;
5248
- /** @example "USD" */
5249
- currency?: any;
5250
- /** @example "" */
5251
- note?: any;
5252
- /** @example 0.01 */
5253
- quantity?: any;
5254
- /** @example "0.0.0.0" */
5255
- remoteAddr?: any;
5256
- /** @example "ultra fast browser 1.1" */
5257
- remoteDevice?: any;
5258
- /** @example "BTC/USD" */
5259
- symbol?: any;
5260
5262
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5261
5263
  /**
5262
- * @tags Transfers
5263
- * @name ListFees
5264
- * @summary List fees
5265
- * @request GET:/transfer/fees/classifications/fees
5264
+ * @tags Legal Documents
5265
+ * @name PolicyValues
5266
+ * @summary Policy values
5267
+ * @request GET:/user/legal/policies/listing/{type}
5266
5268
  * @secure
5267
5269
  */
5268
- listFees(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5270
+ policyValues(type: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5269
5271
  /**
5270
- * @tags Transfers
5271
- * @name ListCredits
5272
- * @summary List credits
5273
- * @request GET:/transfer/fees/classifications/credits
5272
+ * @tags Legal Documents
5273
+ * @name DocumentContent
5274
+ * @summary Document content
5275
+ * @request GET:/user/legal/document/content
5274
5276
  * @secure
5275
5277
  */
5276
- listCredits(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5278
+ documentContent(query?: {
5279
+ /** @example "{as provided}" */
5280
+ id?: any;
5281
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5277
5282
  /**
5278
- * @tags Transfers
5279
- * @name CryptoDepositAddress
5280
- * @summary Crypto Deposit Address
5281
- * @request GET:/transfer/crypto/deposit/wallet/address
5283
+ * @tags Legal Documents
5284
+ * @name DocumentDownload
5285
+ * @summary Document download
5286
+ * @request GET:/user/legal/document/download
5282
5287
  * @secure
5283
5288
  */
5284
- cryptoDepositAddress(data: {
5285
- /** @example "AB123456" */
5286
- account?: any;
5287
- /** @example "BTC" */
5288
- currency?: any;
5289
- /** @example "{optional}" */
5290
- network?: any;
5289
+ documentDownload(query?: {
5290
+ /** @example "{as provided}" */
5291
+ id?: any;
5291
5292
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5292
5293
  /**
5293
- * @tags Transfers
5294
- * @name CryptoWithdrawalEstimate
5295
- * @summary Crypto Withdrawal Estimate
5296
- * @request POST:/transfer/crypto/withdrawal/estimate
5294
+ * @tags Legal Documents
5295
+ * @name SignTheDocument
5296
+ * @summary Sign the document
5297
+ * @request POST:/user/legal/document/sign
5297
5298
  * @secure
5298
5299
  */
5299
- cryptoWithdrawalEstimate(data: {
5300
- /** @example "BTC" */
5301
- currency?: any;
5302
- /** @example "{optional}" */
5303
- network?: any;
5304
- /** @example "0.1" */
5305
- quantity?: any;
5306
- /** @example "{optional}" */
5307
- wallet?: any;
5300
+ signTheDocument(data: {
5301
+ account?: {
5302
+ /** @example 1234 */
5303
+ accountId?: number;
5304
+ /** @example "AC123456" */
5305
+ accountNumber?: string;
5306
+ };
5307
+ data?: {
5308
+ /** @example "{conditional}" */
5309
+ bankAccountNumber?: string;
5310
+ };
5311
+ /** @example "{required}" */
5312
+ documentId?: any;
5313
+ /** @example true */
5314
+ esigned?: any;
5315
+ /** @example "" */
5316
+ remoteAddr?: any;
5317
+ /** @example "{required}" */
5318
+ remoteDevice?: any;
5319
+ /** @example "{required}" */
5320
+ signature?: any;
5308
5321
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5309
5322
  /**
5310
- * @tags Transfers
5311
- * @name CryptoWithdrawal
5312
- * @summary Crypto Withdrawal
5313
- * @request POST:/transfer/crypto/withdraw
5323
+ * @tags Legal Documents
5324
+ * @name UpdatesPolicyOnTheAccount
5325
+ * @summary Updates policy on the account
5326
+ * @request POST:/user/legal/policy/{type}
5314
5327
  * @secure
5315
5328
  */
5316
- cryptoWithdrawal(data: {
5317
- /** @example "AB123456" */
5318
- account?: any;
5319
- /** @example "BTC" */
5320
- currency?: any;
5321
- /** @example "{optional}" */
5322
- estimateExtension?: any;
5323
- /** @example "abc123" */
5324
- estimateId?: any;
5325
- /** @example "{optional}" */
5326
- network?: any;
5327
- /** @example 0.1 */
5328
- quantity?: any;
5329
- /** @example "{conditional}" */
5330
- recipientFirstName?: any;
5331
- /** @example "{conditional}" */
5332
- recipientLastName?: any;
5333
- /** @example "{optional} 1.1.1.1" */
5329
+ updatesPolicyOnTheAccount(type: string, data: {
5330
+ account?: {
5331
+ /** @example 0 */
5332
+ accountId?: number;
5333
+ /** @example "{optional}" */
5334
+ accountNumber?: string;
5335
+ };
5336
+ /** @example true */
5337
+ esigned?: any;
5338
+ /** @example "Allow" */
5339
+ policy?: any;
5340
+ /** @example "" */
5334
5341
  remoteAddr?: any;
5335
- /** @example "{optional} Some phone" */
5342
+ /** @example "" */
5336
5343
  remoteDevice?: any;
5337
- /** @example "{optional} true|false" */
5338
- selfHosted?: any;
5339
- /** @example "{optional}" */
5340
- tag?: any;
5341
- /** @example "{conditional}" */
5342
- vaspName?: any;
5343
- /** @example "wallet address" */
5344
- wallet?: any;
5345
5344
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5346
5345
  }
5347
5346
  export class BlacklistAdminBusinesses<HandleError extends boolean = boolean> {
@@ -5649,6 +5648,49 @@ export class Blacklist<HandleError extends boolean = boolean> {
5649
5648
  */
5650
5649
  getHealth(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5651
5650
  }
5651
+ export class Broker<HandleError extends boolean = boolean> {
5652
+ protected readonly apiClient: JwtClient<HandleError>;
5653
+ constructor(apiClient: JwtClient<HandleError>);
5654
+ /**
5655
+ * @tags Broker
5656
+ * @name Portfolio
5657
+ * @summary Portfolio
5658
+ * @request GET:/v1/broker/portfolio
5659
+ * @secure
5660
+ */
5661
+ portfolio(query?: {
5662
+ /**
5663
+ * (true or false) Allows for loading of quotes for each portfolio entry. Defaults to false.
5664
+ * @example "false"
5665
+ */
5666
+ loadQuotes?: any;
5667
+ /** @example "false" */
5668
+ loadIndustries?: any;
5669
+ /** @example "false" */
5670
+ loadUpgrades?: any;
5671
+ /** @example "false" */
5672
+ loadEarnings?: any;
5673
+ /**
5674
+ * Load balances for weight
5675
+ * @example "false"
5676
+ */
5677
+ loadRtb?: any;
5678
+ /**
5679
+ * Analyze market caps and get `marketCapWeights`. To be used in conjuction with `loadQuotes`
5680
+ * @example "false"
5681
+ */
5682
+ marketCapBreakdown?: any;
5683
+ /**
5684
+ * Combined portfolio for the branch
5685
+ * @example "false"
5686
+ */
5687
+ combined?: any;
5688
+ /** @example "1" */
5689
+ pageNum?: any;
5690
+ /** @example "100" */
5691
+ pageSize?: any;
5692
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5693
+ }
5652
5694
  export class WatchmenFfiUserAccountManagement<HandleError extends boolean = boolean> {
5653
5695
  protected readonly apiClient: JwtClient<HandleError>;
5654
5696
  constructor(apiClient: JwtClient<HandleError>);
@@ -5763,49 +5805,6 @@ export class WatchmenFfiUserAccountManagement<HandleError extends boolean = bool
5763
5805
  */
5764
5806
  visibility(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5765
5807
  }
5766
- export class Broker<HandleError extends boolean = boolean> {
5767
- protected readonly apiClient: JwtClient<HandleError>;
5768
- constructor(apiClient: JwtClient<HandleError>);
5769
- /**
5770
- * @tags Broker
5771
- * @name Portfolio
5772
- * @summary Portfolio
5773
- * @request GET:/v1/broker/portfolio
5774
- * @secure
5775
- */
5776
- portfolio(query?: {
5777
- /**
5778
- * (true or false) Allows for loading of quotes for each portfolio entry. Defaults to false.
5779
- * @example "false"
5780
- */
5781
- loadQuotes?: any;
5782
- /** @example "false" */
5783
- loadIndustries?: any;
5784
- /** @example "false" */
5785
- loadUpgrades?: any;
5786
- /** @example "false" */
5787
- loadEarnings?: any;
5788
- /**
5789
- * Load balances for weight
5790
- * @example "false"
5791
- */
5792
- loadRtb?: any;
5793
- /**
5794
- * Analyze market caps and get `marketCapWeights`. To be used in conjuction with `loadQuotes`
5795
- * @example "false"
5796
- */
5797
- marketCapBreakdown?: any;
5798
- /**
5799
- * Combined portfolio for the branch
5800
- * @example "false"
5801
- */
5802
- combined?: any;
5803
- /** @example "1" */
5804
- pageNum?: any;
5805
- /** @example "100" */
5806
- pageSize?: any;
5807
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5808
- }
5809
5808
  export class WatchmenFfiFirmBranch<HandleError extends boolean = boolean> {
5810
5809
  protected readonly apiClient: JwtClient<HandleError>;
5811
5810
  constructor(apiClient: JwtClient<HandleError>);