@orbis-systems/orbis-api-clients 0.6.7 → 0.6.9

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 (41) hide show
  1. package/dist/aesmidas/index.d.ts +1114 -1105
  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 +94 -93
  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.esm.js +1 -257
  14. package/dist/index.esm.js.map +1 -1
  15. package/dist/index.js +1 -280
  16. package/dist/index.js.map +1 -1
  17. package/dist/insight/index.d.ts +326 -325
  18. package/dist/insight/index.d.ts.map +1 -1
  19. package/dist/insight/index.esm.js +1 -3753
  20. package/dist/insight/index.esm.js.map +1 -1
  21. package/dist/insight/index.js +1 -3758
  22. package/dist/insight/index.js.map +1 -1
  23. package/dist/middleware/index.d.ts +34 -34
  24. package/dist/middleware/index.d.ts.map +1 -1
  25. package/dist/middleware/index.esm.js +1 -1066
  26. package/dist/middleware/index.esm.js.map +1 -1
  27. package/dist/middleware/index.js +1 -1071
  28. package/dist/middleware/index.js.map +1 -1
  29. package/dist/orbis/index.d.ts +1236 -1236
  30. package/dist/orbis/index.d.ts.map +1 -1
  31. package/dist/orbis/index.esm.js +1 -7009
  32. package/dist/orbis/index.esm.js.map +1 -1
  33. package/dist/orbis/index.js +1 -7014
  34. package/dist/orbis/index.js.map +1 -1
  35. package/dist/uma/index.d.ts +290 -290
  36. package/dist/uma/index.d.ts.map +1 -1
  37. package/dist/uma/index.esm.js +1 -3993
  38. package/dist/uma/index.esm.js.map +1 -1
  39. package/dist/uma/index.js +1 -3998
  40. package/dist/uma/index.js.map +1 -1
  41. package/package.json +9 -1
@@ -230,6 +230,84 @@ declare class OrbisClient<HandleError extends boolean = boolean> extends JwtClie
230
230
  protected readonly config: OrbisClientConfig<HandleError>;
231
231
  request<Data = unknown, Body = unknown>(config: RequestConfig<Body>): Promise<OrbisClientResponse<Data, HandleError>>;
232
232
  }
233
+ export class OrdersV2FixedIncome<HandleError extends boolean = boolean> {
234
+ protected readonly apiClient: JwtClient<HandleError>;
235
+ constructor(apiClient: JwtClient<HandleError>);
236
+ /**
237
+ * @tags Orders V2 Fixed Income
238
+ * @name BondPlacement
239
+ * @summary Bond placement
240
+ * @request POST:/orders/v2/bonds/place
241
+ * @secure
242
+ */
243
+ bondPlacement(data: {
244
+ account?: {
245
+ /** @example 123 */
246
+ accountId?: number;
247
+ /** @example "AC00123" */
248
+ accountNumber?: string;
249
+ };
250
+ order?: {
251
+ /** @example "LIMIT" */
252
+ orderType?: string;
253
+ /** @example 100 */
254
+ price?: number;
255
+ /** @example "Percentage|Decimal" */
256
+ priceType?: string;
257
+ /** @example 1000 */
258
+ quantity?: number;
259
+ /** @example "Par|Unit" */
260
+ quantityType?: string;
261
+ quote?: {
262
+ /** @example "412001269" */
263
+ cusip?: string;
264
+ /** @example "CUSIP:ISIN" */
265
+ identType?: string;
266
+ /** @example "SK4120012691" */
267
+ isin?: string;
268
+ };
269
+ /** @example "BUY|SELL" */
270
+ transaction?: string;
271
+ };
272
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
273
+ /**
274
+ * @tags Orders V2 Fixed Income
275
+ * @name BondOrderPreview
276
+ * @summary Bond order preview
277
+ * @request POST:/orders/v2/bonds/preview
278
+ * @secure
279
+ */
280
+ bondOrderPreview(data: {
281
+ account?: {
282
+ /** @example 123 */
283
+ accountId?: number;
284
+ /** @example "AC00123" */
285
+ accountNumber?: string;
286
+ };
287
+ order?: {
288
+ /** @example "LIMIT" */
289
+ orderType?: string;
290
+ /** @example 100 */
291
+ price?: number;
292
+ /** @example "Percentage|Decimal" */
293
+ priceType?: string;
294
+ /** @example 1000 */
295
+ quantity?: number;
296
+ /** @example "Par|Unit" */
297
+ quantityType?: string;
298
+ quote?: {
299
+ /** @example "412001269" */
300
+ cusip?: string;
301
+ /** @example "CUSIP:ISIN" */
302
+ identType?: string;
303
+ /** @example "SK4120012691" */
304
+ isin?: string;
305
+ };
306
+ /** @example "BUY|SELL" */
307
+ transaction?: string;
308
+ };
309
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
310
+ }
233
311
  export class OrdersV2Equities<HandleError extends boolean = boolean> {
234
312
  protected readonly apiClient: JwtClient<HandleError>;
235
313
  constructor(apiClient: JwtClient<HandleError>);
@@ -306,6 +384,124 @@ export class OrdersV2Equities<HandleError extends boolean = boolean> {
306
384
  */
307
385
  previewSnapshot(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
308
386
  }
387
+ export class OrdersV2MutualFunds<HandleError extends boolean = boolean> {
388
+ protected readonly apiClient: JwtClient<HandleError>;
389
+ constructor(apiClient: JwtClient<HandleError>);
390
+ /**
391
+ * @tags Orders V2 Mutual Funds
392
+ * @name ListMutualFunds
393
+ * @summary List Mutual Funds
394
+ * @request GET:/quotes/mf/allowed
395
+ * @secure
396
+ */
397
+ listMutualFunds(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
398
+ /**
399
+ * @tags Orders V2 Mutual Funds
400
+ * @name MutualFundDetails
401
+ * @summary Mutual Fund Details
402
+ * @request GET:/quotes/mf/allowed/details/{symbol}
403
+ * @secure
404
+ */
405
+ mutualFundDetails(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
406
+ /**
407
+ * @tags Orders V2 Mutual Funds
408
+ * @name CheckMutualFund
409
+ * @summary Check Mutual Fund
410
+ * @request GET:/quotes/mf/check/{symbol}
411
+ * @secure
412
+ */
413
+ checkMutualFund(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
414
+ /**
415
+ * @tags Orders V2 Mutual Funds
416
+ * @name MutualFundPlacement
417
+ * @summary Mutual fund placement
418
+ * @request POST:/orders/v2/mf/place
419
+ * @secure
420
+ */
421
+ mutualFundPlacement(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
422
+ /**
423
+ * @tags Orders V2 Mutual Funds
424
+ * @name MutualFundPreview
425
+ * @summary Mutual fund preview
426
+ * @request POST:/orders/v2/mf/preview
427
+ * @secure
428
+ */
429
+ mutualFundPreview(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
430
+ }
431
+ export class OrdersV2Crypto<HandleError extends boolean = boolean> {
432
+ protected readonly apiClient: JwtClient<HandleError>;
433
+ constructor(apiClient: JwtClient<HandleError>);
434
+ /**
435
+ * @tags Orders V2 Crypto
436
+ * @name OrderPreview
437
+ * @summary Order Preview
438
+ * @request POST:/orders/v2/crypto/preview
439
+ * @secure
440
+ */
441
+ orderPreview(data: {
442
+ account?: {
443
+ /** @example "ABC123" */
444
+ accountNumber?: string;
445
+ };
446
+ order?: {
447
+ /** @example 100 */
448
+ expectedValue?: number;
449
+ /** @example 1.123 */
450
+ limitPx?: number;
451
+ /** @example "MARKET|LIMIT|STOP|STOP_LIMIG|Notional|NotionalLimit" */
452
+ orderType?: string;
453
+ /** @example 0.0123 */
454
+ quantity?: number;
455
+ quote?: {
456
+ /** @example "BTC/USD" */
457
+ symbol?: string;
458
+ };
459
+ /** @example 1.123 */
460
+ stopPx?: number;
461
+ /** @example "BUY|SELL" */
462
+ transaction?: string;
463
+ /** @example "DAY|GTC" */
464
+ validity?: string;
465
+ };
466
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
467
+ /**
468
+ * @tags Orders V2 Crypto
469
+ * @name OrderPlace
470
+ * @summary Order Place
471
+ * @request POST:/orders/v2/crypto/place
472
+ * @secure
473
+ */
474
+ orderPlace(data: {
475
+ account?: {
476
+ /** @example "ABC123" */
477
+ accountNumber?: string;
478
+ };
479
+ order?: {
480
+ /** @example "{your own order reference number}" */
481
+ clientRef?: string;
482
+ /** @example "ABC" */
483
+ clientSourceId?: string;
484
+ /** @example 100 */
485
+ expectedValue?: number;
486
+ /** @example 1.123 */
487
+ limitPx?: number;
488
+ /** @example "MARKET|LIMIT|STOP|STOP_LIMIT|Notional|NotionalLimit" */
489
+ orderType?: string;
490
+ /** @example 0.0123 */
491
+ quantity?: number;
492
+ quote?: {
493
+ /** @example "BTC/USD" */
494
+ symbol?: string;
495
+ };
496
+ /** @example 1.123 */
497
+ stopPx?: number;
498
+ /** @example "BUY|SELL" */
499
+ transaction?: string;
500
+ /** @example "DAY|GTC" */
501
+ validity?: string;
502
+ };
503
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
504
+ }
309
505
  export class OrdersV2Options<HandleError extends boolean = boolean> {
310
506
  protected readonly apiClient: JwtClient<HandleError>;
311
507
  constructor(apiClient: JwtClient<HandleError>);
@@ -511,244 +707,48 @@ export class OrdersV2Options<HandleError extends boolean = boolean> {
511
707
  };
512
708
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
513
709
  }
514
- export class OrdersV2FixedIncome<HandleError extends boolean = boolean> {
710
+ export class OrdersV2Offerings<HandleError extends boolean = boolean> {
515
711
  protected readonly apiClient: JwtClient<HandleError>;
516
712
  constructor(apiClient: JwtClient<HandleError>);
517
713
  /**
518
- * @tags Orders V2 Fixed Income
519
- * @name BondPlacement
520
- * @summary Bond placement
521
- * @request POST:/orders/v2/bonds/place
714
+ * @tags Orders V2 Offerings
715
+ * @name OfferingListing
716
+ * @summary Offering listing
717
+ * @request GET:/research/ipo/offerings
522
718
  * @secure
523
719
  */
524
- bondPlacement(data: {
720
+ offeringListing(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
721
+ /**
722
+ * @tags Orders V2 Offerings
723
+ * @name ParticipationPreview
724
+ * @summary Participation preview
725
+ * @request POST:/orders/ipo/preview
726
+ * @secure
727
+ */
728
+ participationPreview(data: {
525
729
  account?: {
526
- /** @example 123 */
527
- accountId?: number;
528
- /** @example "AC00123" */
730
+ /** @example "" */
529
731
  accountNumber?: string;
530
732
  };
531
733
  order?: {
532
- /** @example "LIMIT" */
533
- orderType?: string;
534
- /** @example 100 */
535
- price?: number;
536
- /** @example "Percentage|Decimal" */
537
- priceType?: string;
538
- /** @example 1000 */
539
- quantity?: number;
540
- /** @example "Par|Unit" */
541
- quantityType?: string;
734
+ /** @example 0 */
735
+ expectedValue?: number;
542
736
  quote?: {
543
- /** @example "412001269" */
544
- cusip?: string;
545
- /** @example "CUSIP:ISIN" */
546
- identType?: string;
547
- /** @example "SK4120012691" */
548
- isin?: string;
737
+ /** @example "{offering identifier}" */
738
+ identifier?: string;
549
739
  };
550
- /** @example "BUY|SELL" */
551
- transaction?: string;
740
+ /** @example true */
741
+ rule5130And5131Attestation?: boolean;
552
742
  };
553
743
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
554
744
  /**
555
- * @tags Orders V2 Fixed Income
556
- * @name BondOrderPreview
557
- * @summary Bond order preview
558
- * @request POST:/orders/v2/bonds/preview
745
+ * @tags Orders V2 Offerings
746
+ * @name Participate
747
+ * @summary Participate
748
+ * @request POST:/orders/ipo/participate
559
749
  * @secure
560
750
  */
561
- bondOrderPreview(data: {
562
- account?: {
563
- /** @example 123 */
564
- accountId?: number;
565
- /** @example "AC00123" */
566
- accountNumber?: string;
567
- };
568
- order?: {
569
- /** @example "LIMIT" */
570
- orderType?: string;
571
- /** @example 100 */
572
- price?: number;
573
- /** @example "Percentage|Decimal" */
574
- priceType?: string;
575
- /** @example 1000 */
576
- quantity?: number;
577
- /** @example "Par|Unit" */
578
- quantityType?: string;
579
- quote?: {
580
- /** @example "412001269" */
581
- cusip?: string;
582
- /** @example "CUSIP:ISIN" */
583
- identType?: string;
584
- /** @example "SK4120012691" */
585
- isin?: string;
586
- };
587
- /** @example "BUY|SELL" */
588
- transaction?: string;
589
- };
590
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
591
- }
592
- export class OrdersV2MutualFunds<HandleError extends boolean = boolean> {
593
- protected readonly apiClient: JwtClient<HandleError>;
594
- constructor(apiClient: JwtClient<HandleError>);
595
- /**
596
- * @tags Orders V2 Mutual Funds
597
- * @name ListMutualFunds
598
- * @summary List Mutual Funds
599
- * @request GET:/quotes/mf/allowed
600
- * @secure
601
- */
602
- listMutualFunds(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
603
- /**
604
- * @tags Orders V2 Mutual Funds
605
- * @name MutualFundDetails
606
- * @summary Mutual Fund Details
607
- * @request GET:/quotes/mf/allowed/details/{symbol}
608
- * @secure
609
- */
610
- mutualFundDetails(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
611
- /**
612
- * @tags Orders V2 Mutual Funds
613
- * @name CheckMutualFund
614
- * @summary Check Mutual Fund
615
- * @request GET:/quotes/mf/check/{symbol}
616
- * @secure
617
- */
618
- checkMutualFund(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
619
- /**
620
- * @tags Orders V2 Mutual Funds
621
- * @name MutualFundPlacement
622
- * @summary Mutual fund placement
623
- * @request POST:/orders/v2/mf/place
624
- * @secure
625
- */
626
- mutualFundPlacement(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
627
- /**
628
- * @tags Orders V2 Mutual Funds
629
- * @name MutualFundPreview
630
- * @summary Mutual fund preview
631
- * @request POST:/orders/v2/mf/preview
632
- * @secure
633
- */
634
- mutualFundPreview(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
635
- }
636
- export class OrdersV2Crypto<HandleError extends boolean = boolean> {
637
- protected readonly apiClient: JwtClient<HandleError>;
638
- constructor(apiClient: JwtClient<HandleError>);
639
- /**
640
- * @tags Orders V2 Crypto
641
- * @name OrderPreview
642
- * @summary Order Preview
643
- * @request POST:/orders/v2/crypto/preview
644
- * @secure
645
- */
646
- orderPreview(data: {
647
- account?: {
648
- /** @example "ABC123" */
649
- accountNumber?: string;
650
- };
651
- order?: {
652
- /** @example 100 */
653
- expectedValue?: number;
654
- /** @example 1.123 */
655
- limitPx?: number;
656
- /** @example "MARKET|LIMIT|STOP|STOP_LIMIG|Notional|NotionalLimit" */
657
- orderType?: string;
658
- /** @example 0.0123 */
659
- quantity?: number;
660
- quote?: {
661
- /** @example "BTC/USD" */
662
- symbol?: string;
663
- };
664
- /** @example 1.123 */
665
- stopPx?: number;
666
- /** @example "BUY|SELL" */
667
- transaction?: string;
668
- /** @example "DAY|GTC" */
669
- validity?: string;
670
- };
671
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
672
- /**
673
- * @tags Orders V2 Crypto
674
- * @name OrderPlace
675
- * @summary Order Place
676
- * @request POST:/orders/v2/crypto/place
677
- * @secure
678
- */
679
- orderPlace(data: {
680
- account?: {
681
- /** @example "ABC123" */
682
- accountNumber?: string;
683
- };
684
- order?: {
685
- /** @example "{your own order reference number}" */
686
- clientRef?: string;
687
- /** @example "ABC" */
688
- clientSourceId?: string;
689
- /** @example 100 */
690
- expectedValue?: number;
691
- /** @example 1.123 */
692
- limitPx?: number;
693
- /** @example "MARKET|LIMIT|STOP|STOP_LIMIT|Notional|NotionalLimit" */
694
- orderType?: string;
695
- /** @example 0.0123 */
696
- quantity?: number;
697
- quote?: {
698
- /** @example "BTC/USD" */
699
- symbol?: string;
700
- };
701
- /** @example 1.123 */
702
- stopPx?: number;
703
- /** @example "BUY|SELL" */
704
- transaction?: string;
705
- /** @example "DAY|GTC" */
706
- validity?: string;
707
- };
708
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
709
- }
710
- export class OrdersV2Offerings<HandleError extends boolean = boolean> {
711
- protected readonly apiClient: JwtClient<HandleError>;
712
- constructor(apiClient: JwtClient<HandleError>);
713
- /**
714
- * @tags Orders V2 Offerings
715
- * @name OfferingListing
716
- * @summary Offering listing
717
- * @request GET:/research/ipo/offerings
718
- * @secure
719
- */
720
- offeringListing(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
721
- /**
722
- * @tags Orders V2 Offerings
723
- * @name ParticipationPreview
724
- * @summary Participation preview
725
- * @request POST:/orders/ipo/preview
726
- * @secure
727
- */
728
- participationPreview(data: {
729
- account?: {
730
- /** @example "" */
731
- accountNumber?: string;
732
- };
733
- order?: {
734
- /** @example 0 */
735
- expectedValue?: number;
736
- quote?: {
737
- /** @example "{offering identifier}" */
738
- identifier?: string;
739
- };
740
- /** @example true */
741
- rule5130And5131Attestation?: boolean;
742
- };
743
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
744
- /**
745
- * @tags Orders V2 Offerings
746
- * @name Participate
747
- * @summary Participate
748
- * @request POST:/orders/ipo/participate
749
- * @secure
750
- */
751
- participate(data: {
751
+ participate(data: {
752
752
  account?: {
753
753
  /** @example "" */
754
754
  accountNumber?: string;
@@ -1150,241 +1150,60 @@ export class Orders<HandleError extends boolean = boolean> {
1150
1150
  bondQuantityType?: any;
1151
1151
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1152
1152
  }
1153
- export class ResearchTipranks<HandleError extends boolean = boolean> {
1153
+ export class Quotes<HandleError extends boolean = boolean> {
1154
1154
  protected readonly apiClient: JwtClient<HandleError>;
1155
1155
  constructor(apiClient: JwtClient<HandleError>);
1156
1156
  /**
1157
- * @tags Research Tipranks
1158
- * @name Livefeed
1159
- * @summary Livefeed
1160
- * @request GET:/research/tipranks/livefeed
1157
+ * @tags Quotes
1158
+ * @name Equity
1159
+ * @summary Equity
1160
+ * @request GET:/quotes/equity
1161
1161
  * @secure
1162
1162
  */
1163
- livefeed(query?: {
1163
+ equity(query?: {
1164
1164
  /**
1165
- * Amount to include. Defaults to 20.
1166
- * @example "20"
1165
+ * Comma separated list of symbols
1166
+ * @example "IBM"
1167
1167
  */
1168
- count?: any;
1168
+ symbols?: any;
1169
1169
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1170
1170
  /**
1171
- * @tags Research Tipranks
1172
- * @name AnalystPortfolio
1173
- * @summary Analyst Portfolio
1174
- * @request GET:/research/tipranks/analyst/portfolio/{expertUID}
1171
+ * @tags Quotes
1172
+ * @name Search
1173
+ * @summary Search
1174
+ * @request GET:/quotes/search
1175
1175
  * @secure
1176
1176
  */
1177
- analystPortfolio(expertUid: string, query?: {
1177
+ search(query?: {
1178
1178
  /**
1179
- * Total number of entries
1180
- * @example "5"
1179
+ * String to search for
1180
+ * @example "Apple"
1181
1181
  */
1182
- count?: any;
1182
+ criteria?: any;
1183
1183
  /**
1184
- * Optional. Defaults to false
1185
- * @example "true"
1184
+ * Maximum number of results to return (default is 20)
1185
+ * @example "3"
1186
+ */
1187
+ limit?: any;
1188
+ /**
1189
+ * Whether to load quotes for the results or not
1190
+ * @example "false"
1186
1191
  */
1187
1192
  loadQuotes?: any;
1188
1193
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1189
1194
  /**
1190
- * @tags Research Tipranks
1191
- * @name AnalystProfile
1192
- * @summary Analyst Profile
1193
- * @request GET:/research/tipranks/analyst/profile/{expertUID}
1194
- * @secure
1195
- */
1196
- analystProfile(expertUid: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1197
- /**
1198
- * @tags Research Tipranks
1199
- * @name TopAnalysts
1200
- * @summary Top Analysts
1201
- * @request GET:/research/tipranks/analyst/top
1195
+ * @tags Quotes
1196
+ * @name Option
1197
+ * @summary Option
1198
+ * @request GET:/quotes/option
1202
1199
  * @secure
1203
1200
  */
1204
- topAnalysts(query?: {
1201
+ option(query?: {
1202
+ /** Comma separated list of symbols */
1203
+ symbols?: any;
1205
1204
  /**
1206
- * Total entries. Defaults to 20.
1207
- * @example "25"
1208
- */
1209
- count?: any;
1210
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1211
- /**
1212
- * @tags Research Tipranks
1213
- * @name RatingsBySymbol
1214
- * @summary Ratings by Symbol
1215
- * @request GET:/research/tipranks/analyst/{symbol}
1216
- * @secure
1217
- */
1218
- ratingsBySymbol(symbol: string, query?: {
1219
- /**
1220
- * Number of analysts to include. Defaults to 20
1221
- * @example "10"
1222
- */
1223
- count?: any;
1224
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1225
- /**
1226
- * @tags Research Tipranks
1227
- * @name Insiders
1228
- * @summary Insiders
1229
- * @request GET:/research/tipranks/insiders
1230
- * @secure
1231
- */
1232
- insiders(query?: {
1233
- /**
1234
- * Comma seperated for multiple symbols
1235
- * @example "AAPL,GOOGL"
1236
- */
1237
- symbols?: any;
1238
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1239
- /**
1240
- * @tags Research Tipranks
1241
- * @name InsiderTransactions
1242
- * @summary Insider Transactions
1243
- * @request GET:/research/tipranks/insiders/transactions
1244
- * @secure
1245
- */
1246
- insiderTransactions(query?: {
1247
- /**
1248
- * Symbols (comma seperated)
1249
- * @example "FB"
1250
- */
1251
- symbols?: any;
1252
- /**
1253
- * Number of entries (defaults to 20)
1254
- * @example "10"
1255
- */
1256
- count?: any;
1257
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1258
- /**
1259
- * @tags Research Tipranks
1260
- * @name SimilarStocks
1261
- * @summary Similar Stocks
1262
- * @request GET:/research/tipranks/stocks/similar/{symbol}
1263
- * @secure
1264
- */
1265
- similarStocks(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1266
- /**
1267
- * @tags Research Tipranks
1268
- * @name Overview
1269
- * @summary Overview
1270
- * @request GET:/research/tipranks/stocks/overview/{symbols}
1271
- * @secure
1272
- */
1273
- overview(symbols: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1274
- /**
1275
- * @tags Research Tipranks
1276
- * @name ConsensusBySector
1277
- * @summary Consensus by Sector
1278
- * @request GET:/research/tipranks/consensus/sector
1279
- * @secure
1280
- */
1281
- consensusBySector(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1282
- /**
1283
- * @tags Research Tipranks
1284
- * @name ConsensusByBlogger
1285
- * @summary Consensus by Blogger
1286
- * @request GET:/research/tipranks/consensus/blogger/{symbol}
1287
- * @secure
1288
- */
1289
- consensusByBlogger(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1290
- /**
1291
- * @tags Research Tipranks
1292
- * @name Trending
1293
- * @summary Trending
1294
- * @request GET:/research/tipranks/trending
1295
- * @secure
1296
- */
1297
- trending(query?: {
1298
- /**
1299
- * Total entries. Defaults to 20.
1300
- * @example "10"
1301
- */
1302
- count?: any;
1303
- /**
1304
- * Days to go back. Can be 3, 7, or 30 only. Defaults to 7.
1305
- * @example "7"
1306
- */
1307
- period?: any;
1308
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1309
- /**
1310
- * @tags Research Tipranks
1311
- * @name Hedgefunds
1312
- * @summary Hedgefunds
1313
- * @request GET:/research/tipranks/hedgefunds/{symbol}
1314
- * @secure
1315
- */
1316
- hedgefunds(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1317
- /**
1318
- * @tags Research Tipranks
1319
- * @name StockSentiment
1320
- * @summary Stock Sentiment
1321
- * @request GET:/research/tipranks/news/sentiment/{symbol}
1322
- * @secure
1323
- */
1324
- stockSentiment(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1325
- /**
1326
- * @tags Research Tipranks
1327
- * @name BloggerRatings
1328
- * @summary Blogger Ratings
1329
- * @request GET:/research/tipranks/rating/blogger/{symbol}
1330
- * @secure
1331
- */
1332
- bloggerRatings(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1333
- }
1334
- export class Quotes<HandleError extends boolean = boolean> {
1335
- protected readonly apiClient: JwtClient<HandleError>;
1336
- constructor(apiClient: JwtClient<HandleError>);
1337
- /**
1338
- * @tags Quotes
1339
- * @name Equity
1340
- * @summary Equity
1341
- * @request GET:/quotes/equity
1342
- * @secure
1343
- */
1344
- equity(query?: {
1345
- /**
1346
- * Comma separated list of symbols
1347
- * @example "IBM"
1348
- */
1349
- symbols?: any;
1350
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1351
- /**
1352
- * @tags Quotes
1353
- * @name Search
1354
- * @summary Search
1355
- * @request GET:/quotes/search
1356
- * @secure
1357
- */
1358
- search(query?: {
1359
- /**
1360
- * String to search for
1361
- * @example "Apple"
1362
- */
1363
- criteria?: any;
1364
- /**
1365
- * Maximum number of results to return (default is 20)
1366
- * @example "3"
1367
- */
1368
- limit?: any;
1369
- /**
1370
- * Whether to load quotes for the results or not
1371
- * @example "false"
1372
- */
1373
- loadQuotes?: any;
1374
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1375
- /**
1376
- * @tags Quotes
1377
- * @name Option
1378
- * @summary Option
1379
- * @request GET:/quotes/option
1380
- * @secure
1381
- */
1382
- option(query?: {
1383
- /** Comma separated list of symbols */
1384
- symbols?: any;
1385
- /**
1386
- * `true|false` - whether to load option greeks
1387
- * @example ""
1205
+ * `true|false` - whether to load option greeks
1206
+ * @example ""
1388
1207
  */
1389
1208
  greeks?: any;
1390
1209
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
@@ -1618,74 +1437,255 @@ export class Quotes<HandleError extends boolean = boolean> {
1618
1437
  symbols?: any;
1619
1438
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1620
1439
  }
1621
- export class ResearchEtfs<HandleError extends boolean = boolean> {
1440
+ export class ResearchTipranks<HandleError extends boolean = boolean> {
1622
1441
  protected readonly apiClient: JwtClient<HandleError>;
1623
1442
  constructor(apiClient: JwtClient<HandleError>);
1624
1443
  /**
1625
- * @tags Research Etfs
1626
- * @name InitScreener
1627
- * @summary Init Screener
1628
- * @request GET:/research/etf/init
1444
+ * @tags Research Tipranks
1445
+ * @name Livefeed
1446
+ * @summary Livefeed
1447
+ * @request GET:/research/tipranks/livefeed
1629
1448
  * @secure
1630
1449
  */
1631
- initScreener(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1450
+ livefeed(query?: {
1451
+ /**
1452
+ * Amount to include. Defaults to 20.
1453
+ * @example "20"
1454
+ */
1455
+ count?: any;
1456
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1632
1457
  /**
1633
- * @tags Research Etfs
1634
- * @name Screener
1635
- * @summary Screener
1636
- * @request GET:/research/etf/screener
1458
+ * @tags Research Tipranks
1459
+ * @name AnalystPortfolio
1460
+ * @summary Analyst Portfolio
1461
+ * @request GET:/research/tipranks/analyst/portfolio/{expertUID}
1637
1462
  * @secure
1638
1463
  */
1639
- screener(query?: {
1640
- /** * see init */
1641
- inverseType?: any;
1642
- /** * see init */
1643
- leverageType?: any;
1644
- /** * see init */
1645
- assetId?: any;
1646
- /** * see init */
1647
- categoryId?: any;
1648
- /** * see init */
1649
- sponsorId?: any;
1650
- /** Entry to start at */
1651
- start?: any;
1652
- /** Entries per page */
1653
- num?: any;
1654
- /** Sort by: symbol, last, change, volume, marketcap, expense, asset, sponsor, category, leverage, countrypct, countinentpct, sectorpct, exposure */
1655
- sort?: any;
1656
- /** True/false */
1657
- asc?: any;
1658
- /**
1659
- * True/false
1660
- * @example "false"
1661
- */
1662
- loadIndustries?: any;
1663
- /**
1664
- * True/false
1665
- * @example "false"
1666
- */
1667
- loadUpgrades?: any;
1464
+ analystPortfolio(expertUid: string, query?: {
1668
1465
  /**
1669
- * True/false
1670
- * @example "false"
1466
+ * Total number of entries
1467
+ * @example "5"
1671
1468
  */
1672
- loadEarnings?: any;
1469
+ count?: any;
1673
1470
  /**
1674
- * Repeating set of:
1675
- * * paying dividend
1676
- * * 5pct - paying at least 5% dividend
1677
- * * 3pct
1678
- * * mcbelow2b – market cap under 2B
1679
- * * mcbetween2and10b
1680
- * * mcbetween10and200b
1681
- * * mcabove200b
1471
+ * Optional. Defaults to false
1472
+ * @example "true"
1682
1473
  */
1683
- filters?: any;
1474
+ loadQuotes?: any;
1684
1475
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1685
1476
  /**
1686
- * @tags Research Etfs
1687
- * @name Top10
1688
- * @summary Top 10
1477
+ * @tags Research Tipranks
1478
+ * @name AnalystProfile
1479
+ * @summary Analyst Profile
1480
+ * @request GET:/research/tipranks/analyst/profile/{expertUID}
1481
+ * @secure
1482
+ */
1483
+ analystProfile(expertUid: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1484
+ /**
1485
+ * @tags Research Tipranks
1486
+ * @name TopAnalysts
1487
+ * @summary Top Analysts
1488
+ * @request GET:/research/tipranks/analyst/top
1489
+ * @secure
1490
+ */
1491
+ topAnalysts(query?: {
1492
+ /**
1493
+ * Total entries. Defaults to 20.
1494
+ * @example "25"
1495
+ */
1496
+ count?: any;
1497
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1498
+ /**
1499
+ * @tags Research Tipranks
1500
+ * @name RatingsBySymbol
1501
+ * @summary Ratings by Symbol
1502
+ * @request GET:/research/tipranks/analyst/{symbol}
1503
+ * @secure
1504
+ */
1505
+ ratingsBySymbol(symbol: string, query?: {
1506
+ /**
1507
+ * Number of analysts to include. Defaults to 20
1508
+ * @example "10"
1509
+ */
1510
+ count?: any;
1511
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1512
+ /**
1513
+ * @tags Research Tipranks
1514
+ * @name Insiders
1515
+ * @summary Insiders
1516
+ * @request GET:/research/tipranks/insiders
1517
+ * @secure
1518
+ */
1519
+ insiders(query?: {
1520
+ /**
1521
+ * Comma seperated for multiple symbols
1522
+ * @example "AAPL,GOOGL"
1523
+ */
1524
+ symbols?: any;
1525
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1526
+ /**
1527
+ * @tags Research Tipranks
1528
+ * @name InsiderTransactions
1529
+ * @summary Insider Transactions
1530
+ * @request GET:/research/tipranks/insiders/transactions
1531
+ * @secure
1532
+ */
1533
+ insiderTransactions(query?: {
1534
+ /**
1535
+ * Symbols (comma seperated)
1536
+ * @example "FB"
1537
+ */
1538
+ symbols?: any;
1539
+ /**
1540
+ * Number of entries (defaults to 20)
1541
+ * @example "10"
1542
+ */
1543
+ count?: any;
1544
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1545
+ /**
1546
+ * @tags Research Tipranks
1547
+ * @name SimilarStocks
1548
+ * @summary Similar Stocks
1549
+ * @request GET:/research/tipranks/stocks/similar/{symbol}
1550
+ * @secure
1551
+ */
1552
+ similarStocks(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1553
+ /**
1554
+ * @tags Research Tipranks
1555
+ * @name Overview
1556
+ * @summary Overview
1557
+ * @request GET:/research/tipranks/stocks/overview/{symbols}
1558
+ * @secure
1559
+ */
1560
+ overview(symbols: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1561
+ /**
1562
+ * @tags Research Tipranks
1563
+ * @name ConsensusBySector
1564
+ * @summary Consensus by Sector
1565
+ * @request GET:/research/tipranks/consensus/sector
1566
+ * @secure
1567
+ */
1568
+ consensusBySector(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1569
+ /**
1570
+ * @tags Research Tipranks
1571
+ * @name ConsensusByBlogger
1572
+ * @summary Consensus by Blogger
1573
+ * @request GET:/research/tipranks/consensus/blogger/{symbol}
1574
+ * @secure
1575
+ */
1576
+ consensusByBlogger(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1577
+ /**
1578
+ * @tags Research Tipranks
1579
+ * @name Trending
1580
+ * @summary Trending
1581
+ * @request GET:/research/tipranks/trending
1582
+ * @secure
1583
+ */
1584
+ trending(query?: {
1585
+ /**
1586
+ * Total entries. Defaults to 20.
1587
+ * @example "10"
1588
+ */
1589
+ count?: any;
1590
+ /**
1591
+ * Days to go back. Can be 3, 7, or 30 only. Defaults to 7.
1592
+ * @example "7"
1593
+ */
1594
+ period?: any;
1595
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1596
+ /**
1597
+ * @tags Research Tipranks
1598
+ * @name Hedgefunds
1599
+ * @summary Hedgefunds
1600
+ * @request GET:/research/tipranks/hedgefunds/{symbol}
1601
+ * @secure
1602
+ */
1603
+ hedgefunds(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1604
+ /**
1605
+ * @tags Research Tipranks
1606
+ * @name StockSentiment
1607
+ * @summary Stock Sentiment
1608
+ * @request GET:/research/tipranks/news/sentiment/{symbol}
1609
+ * @secure
1610
+ */
1611
+ stockSentiment(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1612
+ /**
1613
+ * @tags Research Tipranks
1614
+ * @name BloggerRatings
1615
+ * @summary Blogger Ratings
1616
+ * @request GET:/research/tipranks/rating/blogger/{symbol}
1617
+ * @secure
1618
+ */
1619
+ bloggerRatings(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1620
+ }
1621
+ export class ResearchEtfs<HandleError extends boolean = boolean> {
1622
+ protected readonly apiClient: JwtClient<HandleError>;
1623
+ constructor(apiClient: JwtClient<HandleError>);
1624
+ /**
1625
+ * @tags Research Etfs
1626
+ * @name InitScreener
1627
+ * @summary Init Screener
1628
+ * @request GET:/research/etf/init
1629
+ * @secure
1630
+ */
1631
+ initScreener(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1632
+ /**
1633
+ * @tags Research Etfs
1634
+ * @name Screener
1635
+ * @summary Screener
1636
+ * @request GET:/research/etf/screener
1637
+ * @secure
1638
+ */
1639
+ screener(query?: {
1640
+ /** * see init */
1641
+ inverseType?: any;
1642
+ /** * see init */
1643
+ leverageType?: any;
1644
+ /** * see init */
1645
+ assetId?: any;
1646
+ /** * see init */
1647
+ categoryId?: any;
1648
+ /** * see init */
1649
+ sponsorId?: any;
1650
+ /** Entry to start at */
1651
+ start?: any;
1652
+ /** Entries per page */
1653
+ num?: any;
1654
+ /** Sort by: symbol, last, change, volume, marketcap, expense, asset, sponsor, category, leverage, countrypct, countinentpct, sectorpct, exposure */
1655
+ sort?: any;
1656
+ /** True/false */
1657
+ asc?: any;
1658
+ /**
1659
+ * True/false
1660
+ * @example "false"
1661
+ */
1662
+ loadIndustries?: any;
1663
+ /**
1664
+ * True/false
1665
+ * @example "false"
1666
+ */
1667
+ loadUpgrades?: any;
1668
+ /**
1669
+ * True/false
1670
+ * @example "false"
1671
+ */
1672
+ loadEarnings?: any;
1673
+ /**
1674
+ * Repeating set of:
1675
+ * * paying dividend
1676
+ * * 5pct - paying at least 5% dividend
1677
+ * * 3pct
1678
+ * * mcbelow2b – market cap under 2B
1679
+ * * mcbetween2and10b
1680
+ * * mcbetween10and200b
1681
+ * * mcabove200b
1682
+ */
1683
+ filters?: any;
1684
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1685
+ /**
1686
+ * @tags Research Etfs
1687
+ * @name Top10
1688
+ * @summary Top 10
1689
1689
  * @request GET:/research/etf/top10
1690
1690
  * @secure
1691
1691
  */
@@ -2322,6 +2322,50 @@ export class Research<HandleError extends boolean = boolean> {
2322
2322
  dates?: any;
2323
2323
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2324
2324
  }
2325
+ export class UserWatchlists<HandleError extends boolean = boolean> {
2326
+ protected readonly apiClient: JwtClient<HandleError>;
2327
+ constructor(apiClient: JwtClient<HandleError>);
2328
+ /**
2329
+ * @tags User Watchlists
2330
+ * @name CreateWatchlist
2331
+ * @summary Create Watchlist
2332
+ * @request POST:/user/v2/watchlist/create
2333
+ * @secure
2334
+ */
2335
+ createWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2336
+ /**
2337
+ * @tags User Watchlists
2338
+ * @name RenameWatchlist
2339
+ * @summary Rename Watchlist
2340
+ * @request POST:/user/v2/watchlist/rename
2341
+ * @secure
2342
+ */
2343
+ renameWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2344
+ /**
2345
+ * @tags User Watchlists
2346
+ * @name DeleteWatchlist
2347
+ * @summary Delete Watchlist
2348
+ * @request POST:/user/v2/watchlist/delete
2349
+ * @secure
2350
+ */
2351
+ deleteWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2352
+ /**
2353
+ * @tags User Watchlists
2354
+ * @name AddToWatchlist
2355
+ * @summary Add to Watchlist
2356
+ * @request POST:/user/v2/watchlist/addEntry
2357
+ * @secure
2358
+ */
2359
+ addToWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2360
+ /**
2361
+ * @tags User Watchlists
2362
+ * @name RemoveFromWatchlist
2363
+ * @summary Remove from Watchlist
2364
+ * @request POST:/user/v2/watchlist/removeEntry
2365
+ * @secure
2366
+ */
2367
+ removeFromWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2368
+ }
2325
2369
  export class UserAgreements<HandleError extends boolean = boolean> {
2326
2370
  protected readonly apiClient: JwtClient<HandleError>;
2327
2371
  constructor(apiClient: JwtClient<HandleError>);
@@ -2382,67 +2426,6 @@ export class UserAgreements<HandleError extends boolean = boolean> {
2382
2426
  */
2383
2427
  cryptoSign(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2384
2428
  }
2385
- export class UserTradingLimitManagement<HandleError extends boolean = boolean> {
2386
- protected readonly apiClient: JwtClient<HandleError>;
2387
- constructor(apiClient: JwtClient<HandleError>);
2388
- /**
2389
- * @tags User Trading Limit Management
2390
- * @name Update
2391
- * @summary Update
2392
- * @request POST:/user/balance/adjust
2393
- * @secure
2394
- */
2395
- update(data: {
2396
- account?: {
2397
- /** @example "AB123456" */
2398
- accountNumber?: string;
2399
- };
2400
- /** @example 100 */
2401
- adjustment?: any;
2402
- /** @example "USD" */
2403
- currency?: any;
2404
- /** @example "something nice" */
2405
- note?: any;
2406
- /** @example "tbd" */
2407
- reason?: any;
2408
- /** @example "" */
2409
- referenceNo?: any;
2410
- /** @example "Delta|Absolute" */
2411
- type?: any;
2412
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2413
- }
2414
- export class UserAttachedBanks<HandleError extends boolean = boolean> {
2415
- protected readonly apiClient: JwtClient<HandleError>;
2416
- constructor(apiClient: JwtClient<HandleError>);
2417
- /**
2418
- * @tags User Attached Banks
2419
- * @name Accounts
2420
- * @summary Accounts
2421
- * @request GET:/user/bank/accounts
2422
- * @secure
2423
- */
2424
- accounts(query?: {
2425
- /**
2426
- * Brokerage account number
2427
- * @example "AC123456"
2428
- */
2429
- account?: any;
2430
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2431
- /**
2432
- * @tags User Attached Banks
2433
- * @name Balances
2434
- * @summary Balances
2435
- * @request GET:/user/bank/balances
2436
- * @secure
2437
- */
2438
- balances(query?: {
2439
- /**
2440
- * Brokerage account number
2441
- * @example "AC123456"
2442
- */
2443
- account?: any;
2444
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2445
- }
2446
2429
  export class UserProfitLoss<HandleError extends boolean = boolean> {
2447
2430
  protected readonly apiClient: JwtClient<HandleError>;
2448
2431
  constructor(apiClient: JwtClient<HandleError>);
@@ -2484,49 +2467,37 @@ export class UserProfitLoss<HandleError extends boolean = boolean> {
2484
2467
  requestId?: any;
2485
2468
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2486
2469
  }
2487
- export class UserWatchlists<HandleError extends boolean = boolean> {
2470
+ export class UserAttachedBanks<HandleError extends boolean = boolean> {
2488
2471
  protected readonly apiClient: JwtClient<HandleError>;
2489
2472
  constructor(apiClient: JwtClient<HandleError>);
2490
2473
  /**
2491
- * @tags User Watchlists
2492
- * @name CreateWatchlist
2493
- * @summary Create Watchlist
2494
- * @request POST:/user/v2/watchlist/create
2495
- * @secure
2496
- */
2497
- createWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2498
- /**
2499
- * @tags User Watchlists
2500
- * @name RenameWatchlist
2501
- * @summary Rename Watchlist
2502
- * @request POST:/user/v2/watchlist/rename
2503
- * @secure
2504
- */
2505
- renameWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2506
- /**
2507
- * @tags User Watchlists
2508
- * @name DeleteWatchlist
2509
- * @summary Delete Watchlist
2510
- * @request POST:/user/v2/watchlist/delete
2511
- * @secure
2512
- */
2513
- deleteWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2514
- /**
2515
- * @tags User Watchlists
2516
- * @name AddToWatchlist
2517
- * @summary Add to Watchlist
2518
- * @request POST:/user/v2/watchlist/addEntry
2474
+ * @tags User Attached Banks
2475
+ * @name Accounts
2476
+ * @summary Accounts
2477
+ * @request GET:/user/bank/accounts
2519
2478
  * @secure
2520
2479
  */
2521
- addToWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2480
+ accounts(query?: {
2481
+ /**
2482
+ * Brokerage account number
2483
+ * @example "AC123456"
2484
+ */
2485
+ account?: any;
2486
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2522
2487
  /**
2523
- * @tags User Watchlists
2524
- * @name RemoveFromWatchlist
2525
- * @summary Remove from Watchlist
2526
- * @request POST:/user/v2/watchlist/removeEntry
2488
+ * @tags User Attached Banks
2489
+ * @name Balances
2490
+ * @summary Balances
2491
+ * @request GET:/user/bank/balances
2527
2492
  * @secure
2528
2493
  */
2529
- removeFromWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2494
+ balances(query?: {
2495
+ /**
2496
+ * Brokerage account number
2497
+ * @example "AC123456"
2498
+ */
2499
+ account?: any;
2500
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2530
2501
  }
2531
2502
  export class UserDevice<HandleError extends boolean = boolean> {
2532
2503
  protected readonly apiClient: JwtClient<HandleError>;
@@ -2572,6 +2543,35 @@ export class UserDevice<HandleError extends boolean = boolean> {
2572
2543
  token?: any;
2573
2544
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2574
2545
  }
2546
+ export class UserTradingLimitManagement<HandleError extends boolean = boolean> {
2547
+ protected readonly apiClient: JwtClient<HandleError>;
2548
+ constructor(apiClient: JwtClient<HandleError>);
2549
+ /**
2550
+ * @tags User Trading Limit Management
2551
+ * @name Update
2552
+ * @summary Update
2553
+ * @request POST:/user/balance/adjust
2554
+ * @secure
2555
+ */
2556
+ update(data: {
2557
+ account?: {
2558
+ /** @example "AB123456" */
2559
+ accountNumber?: string;
2560
+ };
2561
+ /** @example 100 */
2562
+ adjustment?: any;
2563
+ /** @example "USD" */
2564
+ currency?: any;
2565
+ /** @example "something nice" */
2566
+ note?: any;
2567
+ /** @example "tbd" */
2568
+ reason?: any;
2569
+ /** @example "" */
2570
+ referenceNo?: any;
2571
+ /** @example "Delta|Absolute" */
2572
+ type?: any;
2573
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2574
+ }
2575
2575
  export class User<HandleError extends boolean = boolean> {
2576
2576
  protected readonly apiClient: JwtClient<HandleError>;
2577
2577
  watchlists: UserWatchlists<HandleError>;
@@ -3244,6 +3244,77 @@ export class AdvisoryCharges<HandleError extends boolean = boolean> {
3244
3244
  */
3245
3245
  cancel(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3246
3246
  }
3247
+ export class AdvisoryUserAccountManagement<HandleError extends boolean = boolean> {
3248
+ protected readonly apiClient: JwtClient<HandleError>;
3249
+ constructor(apiClient: JwtClient<HandleError>);
3250
+ /**
3251
+ * @tags Advisory User Account Management
3252
+ * @name List
3253
+ * @summary /list
3254
+ * @request GET:/v2/advisory/users/list
3255
+ * @secure
3256
+ */
3257
+ list(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3258
+ /**
3259
+ * @tags Advisory User Account Management
3260
+ * @name Accounts
3261
+ * @summary /accounts
3262
+ * @request GET:/v2/advisory/users/accounts
3263
+ * @secure
3264
+ */
3265
+ accounts(query?: {
3266
+ /** @example "1234" */
3267
+ uid?: any;
3268
+ /**
3269
+ * true|false
3270
+ * @example "false"
3271
+ */
3272
+ loadRtb?: any;
3273
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3274
+ /**
3275
+ * @tags Advisory User Account Management
3276
+ * @name AccountsStats
3277
+ * @summary /accounts/stats
3278
+ * @request GET:/v2/advisory/users/accounts/stats
3279
+ * @secure
3280
+ */
3281
+ accountsStats(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3282
+ /**
3283
+ * @tags Advisory User Account Management
3284
+ * @name AccountNotes
3285
+ * @summary /account/notes
3286
+ * @request GET:/v2/advisory/users/account/notes
3287
+ * @secure
3288
+ */
3289
+ accountNotes(query?: {
3290
+ /**
3291
+ * Account's ID
3292
+ * @example "1234"
3293
+ */
3294
+ aid?: any;
3295
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3296
+ /**
3297
+ * @tags Advisory User Account Management
3298
+ * @name Notes
3299
+ * @summary /notes
3300
+ * @request GET:/v2/advisory/users/notes
3301
+ * @secure
3302
+ */
3303
+ notes(query?: {
3304
+ /**
3305
+ * User's ID
3306
+ * @example "1234"
3307
+ */
3308
+ uid?: any;
3309
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3310
+ /**
3311
+ * @tags Advisory User Account Management
3312
+ * @name NotesPost
3313
+ * @request POST:/v2/advisory/users/notes/{action}
3314
+ * @secure
3315
+ */
3316
+ notesPost(action: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3317
+ }
3247
3318
  export class AdvisoryModels<HandleError extends boolean = boolean> {
3248
3319
  protected readonly apiClient: JwtClient<HandleError>;
3249
3320
  constructor(apiClient: JwtClient<HandleError>);
@@ -3519,101 +3590,30 @@ export class AdvisoryModels<HandleError extends boolean = boolean> {
3519
3590
  */
3520
3591
  allocations(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3521
3592
  }
3522
- export class AdvisoryUserAccountManagement<HandleError extends boolean = boolean> {
3593
+ export class AdvisoryGroups<HandleError extends boolean = boolean> {
3523
3594
  protected readonly apiClient: JwtClient<HandleError>;
3524
3595
  constructor(apiClient: JwtClient<HandleError>);
3525
3596
  /**
3526
- * @tags Advisory User Account Management
3527
- * @name List
3528
- * @summary /list
3529
- * @request GET:/v2/advisory/users/list
3597
+ * @tags Advisory Groups
3598
+ * @name GroupsManage
3599
+ * @request POST:/v1/groups/manage/{action}
3530
3600
  * @secure
3531
3601
  */
3532
- list(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3602
+ groupsManage(action: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3533
3603
  /**
3534
- * @tags Advisory User Account Management
3535
- * @name Accounts
3536
- * @summary /accounts
3537
- * @request GET:/v2/advisory/users/accounts
3604
+ * @tags Advisory Groups
3605
+ * @name GroupsList
3606
+ * @request GET:/v1/groups/list
3538
3607
  * @secure
3539
3608
  */
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>>;
3609
+ groupsList(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3549
3610
  /**
3550
- * @tags Advisory User Account Management
3551
- * @name AccountsStats
3552
- * @summary /accounts/stats
3553
- * @request GET:/v2/advisory/users/accounts/stats
3611
+ * @tags Advisory Groups
3612
+ * @name GroupAccountsStats
3613
+ * @request GET:/v2/advisory/group/accounts/stats/{groupsId}
3554
3614
  * @secure
3555
3615
  */
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
- export class AdvisoryGroups<HandleError extends boolean = boolean> {
3594
- protected readonly apiClient: JwtClient<HandleError>;
3595
- constructor(apiClient: JwtClient<HandleError>);
3596
- /**
3597
- * @tags Advisory Groups
3598
- * @name GroupsManage
3599
- * @request POST:/v1/groups/manage/{action}
3600
- * @secure
3601
- */
3602
- groupsManage(action: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3603
- /**
3604
- * @tags Advisory Groups
3605
- * @name GroupsList
3606
- * @request GET:/v1/groups/list
3607
- * @secure
3608
- */
3609
- groupsList(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3610
- /**
3611
- * @tags Advisory Groups
3612
- * @name GroupAccountsStats
3613
- * @request GET:/v2/advisory/group/accounts/stats/{groupsId}
3614
- * @secure
3615
- */
3616
- groupAccountsStats(groupsId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3616
+ groupAccountsStats(groupsId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3617
3617
  /**
3618
3618
  * @tags Advisory Groups
3619
3619
  * @name GroupPortfolios
@@ -3721,320 +3721,6 @@ export class AdvisoryAnalytics<HandleError extends boolean = boolean> {
3721
3721
  threshold?: any;
3722
3722
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3723
3723
  }
3724
- export class Device<HandleError extends boolean = boolean> {
3725
- protected readonly apiClient: JwtClient<HandleError>;
3726
- constructor(apiClient: JwtClient<HandleError>);
3727
- /**
3728
- * @tags Device
3729
- * @name DeviceDeactivate
3730
- * @summary /device/deactivate
3731
- * @request POST:/device/deactivate
3732
- * @secure
3733
- */
3734
- deviceDeactivate(data: {
3735
- /**
3736
- * Token previously registered
3737
- * @example "123456789"
3738
- */
3739
- Token?: string;
3740
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3741
- }
3742
- export class AdvisoryAllocations<HandleError extends boolean = boolean> {
3743
- protected readonly apiClient: JwtClient<HandleError>;
3744
- constructor(apiClient: JwtClient<HandleError>);
3745
- /**
3746
- * @tags Advisory Allocations
3747
- * @name SearchNa
3748
- * @summary Search (n/a)
3749
- * @request GET:/v2/allocations/search
3750
- * @secure
3751
- */
3752
- searchNa(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3753
- /**
3754
- * @tags Advisory Allocations
3755
- * @name Details
3756
- * @summary Details
3757
- * @request GET:/v2/allocations/details/{allocationRef}
3758
- * @secure
3759
- */
3760
- details(allocationRef: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3761
- /**
3762
- * @tags Advisory Allocations
3763
- * @name Cancel
3764
- * @summary Cancel
3765
- * @request POST:/v2/allocations/cancel
3766
- * @secure
3767
- */
3768
- cancel(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3769
- /**
3770
- * @tags Advisory Allocations
3771
- * @name Validation
3772
- * @summary Validation
3773
- * @request POST:/v2/allocations/validate
3774
- * @secure
3775
- */
3776
- validation(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3777
- /**
3778
- * @tags Advisory Allocations
3779
- * @name Scheduling
3780
- * @summary Scheduling
3781
- * @request POST:/v2/allocations/preallocate
3782
- * @secure
3783
- */
3784
- scheduling(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3785
- /**
3786
- * @tags Advisory Allocations
3787
- * @name Trigger
3788
- * @summary Trigger
3789
- * @request POST:/v2/allocations/trigger
3790
- * @secure
3791
- */
3792
- trigger(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3793
- }
3794
- export class TransfersRelationships<HandleError extends boolean = boolean> {
3795
- protected readonly apiClient: JwtClient<HandleError>;
3796
- constructor(apiClient: JwtClient<HandleError>);
3797
- /**
3798
- * @tags Transfers Relationships
3799
- * @name List
3800
- * @summary List
3801
- * @request GET:/transfer/relationship/list/{account}
3802
- * @secure
3803
- */
3804
- list(account: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3805
- /**
3806
- * @tags Transfers Relationships
3807
- * @name GetInfo
3808
- * @summary Get Info
3809
- * @request GET:/transfer/relationship/get
3810
- * @secure
3811
- */
3812
- getInfo(query?: {
3813
- /**
3814
- * Account number
3815
- * @example "ABC123"
3816
- */
3817
- account?: any;
3818
- /**
3819
- * Desired entry ID
3820
- * @example "123"
3821
- */
3822
- entryId?: any;
3823
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3824
- /**
3825
- * @tags Transfers Relationships
3826
- * @name PaymentMethods
3827
- * @summary Payment methods
3828
- * @request GET:/transfer/bank/paymentMethods
3829
- * @secure
3830
- */
3831
- paymentMethods(query?: {
3832
- /** @example "IND" */
3833
- country?: any;
3834
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3835
- /**
3836
- * @tags Transfers Relationships
3837
- * @name PaymentMethodsViaAddress
3838
- * @summary Payment methods (via address)
3839
- * @request POST:/transfer/bank/paymentMethods
3840
- * @secure
3841
- */
3842
- paymentMethodsViaAddress(data: {
3843
- /** @example "Mumbai" */
3844
- city?: any;
3845
- /** @example "IND" */
3846
- country?: any;
3847
- /** @example "400018" */
3848
- postalCode?: any;
3849
- /** @example "Maharashtra" */
3850
- stateProvince?: any;
3851
- /** @example ["716 /a, Poonam Chem, Dr.annie Besant Road, Opp.atre Mall, Worli"] */
3852
- streetAddress?: any;
3853
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3854
- /**
3855
- * @tags Transfers Relationships
3856
- * @name BankCodes
3857
- * @summary Bank Codes
3858
- * @request GET:/transfer/bank/bankCodes
3859
- * @secure
3860
- */
3861
- bankCodes(query?: {
3862
- /** @example "IND|MEX" */
3863
- country?: any;
3864
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3865
- /**
3866
- * @tags Transfers Relationships
3867
- * @name BankCodesViaAddress
3868
- * @summary Bank Codes (via address)
3869
- * @request POST:/transfer/bank/bankCodes
3870
- * @secure
3871
- */
3872
- bankCodesViaAddress(data: {
3873
- /** @example "Mumbai" */
3874
- city?: any;
3875
- /** @example "IND" */
3876
- country?: any;
3877
- /** @example "400018" */
3878
- postalCode?: any;
3879
- /** @example "Maharashtra" */
3880
- stateProvince?: any;
3881
- /** @example ["716 /a, Poonam Chem, Dr.annie Besant Road, Opp.atre Mall, Worli"] */
3882
- streetAddress?: any;
3883
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3884
- /**
3885
- * @tags Transfers Relationships
3886
- * @name Create
3887
- * @summary Create
3888
- * @request POST:/transfer/relationship/create
3889
- * @secure
3890
- */
3891
- create(data: {
3892
- /** @example "5VA0XXXX" */
3893
- account?: any;
3894
- /** @example "111111" */
3895
- bankAccount?: any;
3896
- /** @example "John Doe" */
3897
- bankAccountOwnerName?: any;
3898
- /** @example "CHECKING" */
3899
- bankAccountType?: any;
3900
- /** @example "010101010" */
3901
- bankRoutingNumber?: any;
3902
- /** @example "Test" */
3903
- nickname?: any;
3904
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3905
- /**
3906
- * @tags Transfers Relationships
3907
- * @name WireInformation
3908
- * @summary Wire information
3909
- * @request POST:/transfer/relationship/wire/create
3910
- * @secure
3911
- */
3912
- wireInformation(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3913
- /**
3914
- * @tags Transfers Relationships
3915
- * @name BankingRelationship
3916
- * @summary Banking relationship
3917
- * @request POST:/transfer/relationship/bank/create
3918
- * @secure
3919
- */
3920
- bankingRelationship(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3921
- /**
3922
- * @tags Transfers Relationships
3923
- * @name Approve
3924
- * @summary Approve
3925
- * @request POST:/transfer/relationship/approve
3926
- * @secure
3927
- */
3928
- approve(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3929
- /**
3930
- * @tags Transfers Relationships
3931
- * @name Cancel
3932
- * @summary Cancel
3933
- * @request POST:/transfer/relationship/cancel/{entryId}
3934
- * @secure
3935
- */
3936
- cancel(entryId: string, data: {
3937
- /** @example "2QC05208" */
3938
- account?: any;
3939
- /** @example "USER CANCELED" */
3940
- reason?: any;
3941
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3942
- /**
3943
- * @tags Transfers Relationships
3944
- * @name Rename
3945
- * @summary Rename
3946
- * @request POST:/transfer/relationship/rename/{entryId}
3947
- * @secure
3948
- */
3949
- rename(entryId: string, data: {
3950
- /** @example "Citi Checking 2" */
3951
- nickname?: any;
3952
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3953
- /**
3954
- * @tags Transfers Relationships
3955
- * @name AdvisorPolicyUpdate
3956
- * @summary Advisor Policy Update
3957
- * @request POST:/transfer/relationship/policy
3958
- * @secure
3959
- */
3960
- advisorPolicyUpdate(data: {
3961
- account?: {
3962
- /** @example 0 */
3963
- accountId?: number;
3964
- /** @example "{optional}" */
3965
- accountNumber?: string;
3966
- };
3967
- /** @example 123 */
3968
- entryId?: any;
3969
- /** @example true */
3970
- esigned?: any;
3971
- /** @example "AllowWithdrawal|Disallow" */
3972
- policy?: any;
3973
- /** @example "" */
3974
- remoteAddr?: any;
3975
- /** @example "" */
3976
- remoteDevice?: any;
3977
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3978
- /**
3979
- * @tags Transfers Relationships
3980
- * @name DocumentUpload
3981
- * @summary Document upload
3982
- * @request POST:/transfer/relationship/wire/upload
3983
- * @secure
3984
- */
3985
- documentUpload(data: {
3986
- /**
3987
- * Wire relationship ID
3988
- * @example ""
3989
- */
3990
- entryId?: string;
3991
- /**
3992
- * Document file
3993
- * @format binary
3994
- */
3995
- file?: File;
3996
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3997
- /**
3998
- * @tags Transfers Relationships
3999
- * @name MfaReInitiation
4000
- * @summary 2FA re-initiation
4001
- * @request POST:/transfer/relationship/wire/2fa/reinitiate
4002
- * @secure
4003
- */
4004
- mfaReInitiation(data: {
4005
- /** @example 123 */
4006
- entryId?: any;
4007
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4008
- /**
4009
- * @tags Transfers Relationships
4010
- * @name SupplementWire
4011
- * @summary Supplement wire
4012
- * @request POST:/transfer/relationship/wire/supplement
4013
- * @secure
4014
- */
4015
- supplementWire(data: {
4016
- /** @example 123456 */
4017
- entryId?: any;
4018
- recipientBank?: {
4019
- /** @example "Capital City" */
4020
- city?: string;
4021
- identifier?: {
4022
- /** @example "AAA-123-2587964" */
4023
- id?: string;
4024
- /** @example "BIC" */
4025
- type?: string;
4026
- };
4027
- /** @example "ABC 123" */
4028
- postalCode?: string;
4029
- /** @example "NJ" */
4030
- stateProvince?: string;
4031
- };
4032
- userAccount?: {
4033
- /** @example "AB12345" */
4034
- accountNumber?: string;
4035
- };
4036
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4037
- }
4038
3724
  export class TransfersInstantAccountVerification<HandleError extends boolean = boolean> {
4039
3725
  protected readonly apiClient: JwtClient<HandleError>;
4040
3726
  constructor(apiClient: JwtClient<HandleError>);
@@ -4114,6 +3800,76 @@ export class TransfersInstantAccountVerification<HandleError extends boolean = b
4114
3800
  remoteDevice?: any;
4115
3801
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4116
3802
  }
3803
+ export class AdvisoryAllocations<HandleError extends boolean = boolean> {
3804
+ protected readonly apiClient: JwtClient<HandleError>;
3805
+ constructor(apiClient: JwtClient<HandleError>);
3806
+ /**
3807
+ * @tags Advisory Allocations
3808
+ * @name SearchNa
3809
+ * @summary Search (n/a)
3810
+ * @request GET:/v2/allocations/search
3811
+ * @secure
3812
+ */
3813
+ searchNa(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3814
+ /**
3815
+ * @tags Advisory Allocations
3816
+ * @name Details
3817
+ * @summary Details
3818
+ * @request GET:/v2/allocations/details/{allocationRef}
3819
+ * @secure
3820
+ */
3821
+ details(allocationRef: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3822
+ /**
3823
+ * @tags Advisory Allocations
3824
+ * @name Cancel
3825
+ * @summary Cancel
3826
+ * @request POST:/v2/allocations/cancel
3827
+ * @secure
3828
+ */
3829
+ cancel(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3830
+ /**
3831
+ * @tags Advisory Allocations
3832
+ * @name Validation
3833
+ * @summary Validation
3834
+ * @request POST:/v2/allocations/validate
3835
+ * @secure
3836
+ */
3837
+ validation(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3838
+ /**
3839
+ * @tags Advisory Allocations
3840
+ * @name Scheduling
3841
+ * @summary Scheduling
3842
+ * @request POST:/v2/allocations/preallocate
3843
+ * @secure
3844
+ */
3845
+ scheduling(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3846
+ /**
3847
+ * @tags Advisory Allocations
3848
+ * @name Trigger
3849
+ * @summary Trigger
3850
+ * @request POST:/v2/allocations/trigger
3851
+ * @secure
3852
+ */
3853
+ trigger(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3854
+ }
3855
+ export class Device<HandleError extends boolean = boolean> {
3856
+ protected readonly apiClient: JwtClient<HandleError>;
3857
+ constructor(apiClient: JwtClient<HandleError>);
3858
+ /**
3859
+ * @tags Device
3860
+ * @name DeviceDeactivate
3861
+ * @summary /device/deactivate
3862
+ * @request POST:/device/deactivate
3863
+ * @secure
3864
+ */
3865
+ deviceDeactivate(data: {
3866
+ /**
3867
+ * Token previously registered
3868
+ * @example "123456789"
3869
+ */
3870
+ Token?: string;
3871
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3872
+ }
4117
3873
  export class TransfersAch<HandleError extends boolean = boolean> {
4118
3874
  protected readonly apiClient: JwtClient<HandleError>;
4119
3875
  constructor(apiClient: JwtClient<HandleError>);
@@ -4451,17 +4207,249 @@ export class TransfersPositions<HandleError extends boolean = boolean> {
4451
4207
  remoteDevice?: any;
4452
4208
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4453
4209
  }
4454
- export class TransfersBank<HandleError extends boolean = boolean> {
4210
+ export class TransfersRelationships<HandleError extends boolean = boolean> {
4455
4211
  protected readonly apiClient: JwtClient<HandleError>;
4456
4212
  constructor(apiClient: JwtClient<HandleError>);
4457
4213
  /**
4458
- * @tags Transfers Bank
4459
- * @name FundTransfer
4460
- * @summary Fund transfer
4461
- * @request POST:/transfer/bank/{direction}
4214
+ * @tags Transfers Relationships
4215
+ * @name List
4216
+ * @summary List
4217
+ * @request GET:/transfer/relationship/list/{account}
4462
4218
  * @secure
4463
4219
  */
4464
- fundTransfer(direction: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4220
+ list(account: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4221
+ /**
4222
+ * @tags Transfers Relationships
4223
+ * @name GetInfo
4224
+ * @summary Get Info
4225
+ * @request GET:/transfer/relationship/get
4226
+ * @secure
4227
+ */
4228
+ getInfo(query?: {
4229
+ /**
4230
+ * Account number
4231
+ * @example "ABC123"
4232
+ */
4233
+ account?: any;
4234
+ /**
4235
+ * Desired entry ID
4236
+ * @example "123"
4237
+ */
4238
+ entryId?: any;
4239
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4240
+ /**
4241
+ * @tags Transfers Relationships
4242
+ * @name PaymentMethods
4243
+ * @summary Payment methods
4244
+ * @request GET:/transfer/bank/paymentMethods
4245
+ * @secure
4246
+ */
4247
+ paymentMethods(query?: {
4248
+ /** @example "IND" */
4249
+ country?: any;
4250
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4251
+ /**
4252
+ * @tags Transfers Relationships
4253
+ * @name PaymentMethodsViaAddress
4254
+ * @summary Payment methods (via address)
4255
+ * @request POST:/transfer/bank/paymentMethods
4256
+ * @secure
4257
+ */
4258
+ paymentMethodsViaAddress(data: {
4259
+ /** @example "Mumbai" */
4260
+ city?: any;
4261
+ /** @example "IND" */
4262
+ country?: any;
4263
+ /** @example "400018" */
4264
+ postalCode?: any;
4265
+ /** @example "Maharashtra" */
4266
+ stateProvince?: any;
4267
+ /** @example ["716 /a, Poonam Chem, Dr.annie Besant Road, Opp.atre Mall, Worli"] */
4268
+ streetAddress?: any;
4269
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4270
+ /**
4271
+ * @tags Transfers Relationships
4272
+ * @name BankCodes
4273
+ * @summary Bank Codes
4274
+ * @request GET:/transfer/bank/bankCodes
4275
+ * @secure
4276
+ */
4277
+ bankCodes(query?: {
4278
+ /** @example "IND|MEX" */
4279
+ country?: any;
4280
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4281
+ /**
4282
+ * @tags Transfers Relationships
4283
+ * @name BankCodesViaAddress
4284
+ * @summary Bank Codes (via address)
4285
+ * @request POST:/transfer/bank/bankCodes
4286
+ * @secure
4287
+ */
4288
+ bankCodesViaAddress(data: {
4289
+ /** @example "Mumbai" */
4290
+ city?: any;
4291
+ /** @example "IND" */
4292
+ country?: any;
4293
+ /** @example "400018" */
4294
+ postalCode?: any;
4295
+ /** @example "Maharashtra" */
4296
+ stateProvince?: any;
4297
+ /** @example ["716 /a, Poonam Chem, Dr.annie Besant Road, Opp.atre Mall, Worli"] */
4298
+ streetAddress?: any;
4299
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4300
+ /**
4301
+ * @tags Transfers Relationships
4302
+ * @name Create
4303
+ * @summary Create
4304
+ * @request POST:/transfer/relationship/create
4305
+ * @secure
4306
+ */
4307
+ create(data: {
4308
+ /** @example "5VA0XXXX" */
4309
+ account?: any;
4310
+ /** @example "111111" */
4311
+ bankAccount?: any;
4312
+ /** @example "John Doe" */
4313
+ bankAccountOwnerName?: any;
4314
+ /** @example "CHECKING" */
4315
+ bankAccountType?: any;
4316
+ /** @example "010101010" */
4317
+ bankRoutingNumber?: any;
4318
+ /** @example "Test" */
4319
+ nickname?: any;
4320
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4321
+ /**
4322
+ * @tags Transfers Relationships
4323
+ * @name WireInformation
4324
+ * @summary Wire information
4325
+ * @request POST:/transfer/relationship/wire/create
4326
+ * @secure
4327
+ */
4328
+ wireInformation(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4329
+ /**
4330
+ * @tags Transfers Relationships
4331
+ * @name BankingRelationship
4332
+ * @summary Banking relationship
4333
+ * @request POST:/transfer/relationship/bank/create
4334
+ * @secure
4335
+ */
4336
+ bankingRelationship(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4337
+ /**
4338
+ * @tags Transfers Relationships
4339
+ * @name Approve
4340
+ * @summary Approve
4341
+ * @request POST:/transfer/relationship/approve
4342
+ * @secure
4343
+ */
4344
+ approve(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4345
+ /**
4346
+ * @tags Transfers Relationships
4347
+ * @name Cancel
4348
+ * @summary Cancel
4349
+ * @request POST:/transfer/relationship/cancel/{entryId}
4350
+ * @secure
4351
+ */
4352
+ cancel(entryId: string, data: {
4353
+ /** @example "2QC05208" */
4354
+ account?: any;
4355
+ /** @example "USER CANCELED" */
4356
+ reason?: any;
4357
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4358
+ /**
4359
+ * @tags Transfers Relationships
4360
+ * @name Rename
4361
+ * @summary Rename
4362
+ * @request POST:/transfer/relationship/rename/{entryId}
4363
+ * @secure
4364
+ */
4365
+ rename(entryId: string, data: {
4366
+ /** @example "Citi Checking 2" */
4367
+ nickname?: any;
4368
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4369
+ /**
4370
+ * @tags Transfers Relationships
4371
+ * @name AdvisorPolicyUpdate
4372
+ * @summary Advisor Policy Update
4373
+ * @request POST:/transfer/relationship/policy
4374
+ * @secure
4375
+ */
4376
+ advisorPolicyUpdate(data: {
4377
+ account?: {
4378
+ /** @example 0 */
4379
+ accountId?: number;
4380
+ /** @example "{optional}" */
4381
+ accountNumber?: string;
4382
+ };
4383
+ /** @example 123 */
4384
+ entryId?: any;
4385
+ /** @example true */
4386
+ esigned?: any;
4387
+ /** @example "AllowWithdrawal|Disallow" */
4388
+ policy?: any;
4389
+ /** @example "" */
4390
+ remoteAddr?: any;
4391
+ /** @example "" */
4392
+ remoteDevice?: any;
4393
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4394
+ /**
4395
+ * @tags Transfers Relationships
4396
+ * @name DocumentUpload
4397
+ * @summary Document upload
4398
+ * @request POST:/transfer/relationship/wire/upload
4399
+ * @secure
4400
+ */
4401
+ documentUpload(data: {
4402
+ /**
4403
+ * Wire relationship ID
4404
+ * @example ""
4405
+ */
4406
+ entryId?: string;
4407
+ /**
4408
+ * Document file
4409
+ * @format binary
4410
+ */
4411
+ file?: File;
4412
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4413
+ /**
4414
+ * @tags Transfers Relationships
4415
+ * @name MfaReInitiation
4416
+ * @summary 2FA re-initiation
4417
+ * @request POST:/transfer/relationship/wire/2fa/reinitiate
4418
+ * @secure
4419
+ */
4420
+ mfaReInitiation(data: {
4421
+ /** @example 123 */
4422
+ entryId?: any;
4423
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4424
+ /**
4425
+ * @tags Transfers Relationships
4426
+ * @name SupplementWire
4427
+ * @summary Supplement wire
4428
+ * @request POST:/transfer/relationship/wire/supplement
4429
+ * @secure
4430
+ */
4431
+ supplementWire(data: {
4432
+ /** @example 123456 */
4433
+ entryId?: any;
4434
+ recipientBank?: {
4435
+ /** @example "Capital City" */
4436
+ city?: string;
4437
+ identifier?: {
4438
+ /** @example "AAA-123-2587964" */
4439
+ id?: string;
4440
+ /** @example "BIC" */
4441
+ type?: string;
4442
+ };
4443
+ /** @example "ABC 123" */
4444
+ postalCode?: string;
4445
+ /** @example "NJ" */
4446
+ stateProvince?: string;
4447
+ };
4448
+ userAccount?: {
4449
+ /** @example "AB12345" */
4450
+ accountNumber?: string;
4451
+ };
4452
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4465
4453
  }
4466
4454
  export class TransfersInstantCashTransfers<HandleError extends boolean = boolean> {
4467
4455
  protected readonly apiClient: JwtClient<HandleError>;
@@ -4568,6 +4556,18 @@ export class TransfersInstantCashTransfers<HandleError extends boolean = boolean
4568
4556
  */
4569
4557
  listReports(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4570
4558
  }
4559
+ export class TransfersBank<HandleError extends boolean = boolean> {
4560
+ protected readonly apiClient: JwtClient<HandleError>;
4561
+ constructor(apiClient: JwtClient<HandleError>);
4562
+ /**
4563
+ * @tags Transfers Bank
4564
+ * @name FundTransfer
4565
+ * @summary Fund transfer
4566
+ * @request POST:/transfer/bank/{direction}
4567
+ * @secure
4568
+ */
4569
+ fundTransfer(direction: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4570
+ }
4571
4571
  export class TransfersCheques<HandleError extends boolean = boolean> {
4572
4572
  protected readonly apiClient: JwtClient<HandleError>;
4573
4573
  constructor(apiClient: JwtClient<HandleError>);
@@ -4814,155 +4814,6 @@ export class Transfers<HandleError extends boolean = boolean> {
4814
4814
  wallet?: any;
4815
4815
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4816
4816
  }
4817
- export class Documents<HandleError extends boolean = boolean> {
4818
- protected readonly apiClient: JwtClient<HandleError>;
4819
- constructor(apiClient: JwtClient<HandleError>);
4820
- /**
4821
- * @tags Documents
4822
- * @name Confirm
4823
- * @summary Confirm
4824
- * @request GET:/documents/confirm
4825
- * @secure
4826
- */
4827
- confirm(query?: {
4828
- /**
4829
- * *_accountNumber_ is accepted as well*
4830
- * @example "5VA0XXXX"
4831
- */
4832
- account?: any;
4833
- /**
4834
- * Date for the confirm. The required date format is: mm/dd/yyyy.
4835
- * @example "03/03/2018"
4836
- */
4837
- date?: any;
4838
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4839
- /**
4840
- * @tags Documents
4841
- * @name ListOfConfirms
4842
- * @summary List of Confirms
4843
- * @request GET:/documents/confirm/list
4844
- * @secure
4845
- */
4846
- listOfConfirms(query?: {
4847
- /**
4848
- * *_accountNumber_ is accepted as well*
4849
- * @example "5VA0XXXX"
4850
- */
4851
- account?: any;
4852
- /**
4853
- * Start date for the list of confirms. The required date format is: `mm/dd/yyyy`.
4854
- * @example "01/01/2017"
4855
- */
4856
- beginDate?: any;
4857
- /**
4858
- * End date for the list of confirms. The required date format is: `mm/dd/yyyy`.
4859
- * @example "03/01/2018"
4860
- */
4861
- endDate?: any;
4862
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4863
- /**
4864
- * @tags Documents
4865
- * @name ServiceDocs
4866
- * @summary Service Docs
4867
- * @request GET:/documents/service
4868
- * @secure
4869
- */
4870
- serviceDocs(query?: {
4871
- /** @example "5VA0XXXX" */
4872
- accountNumber?: any;
4873
- /** See table for details. Leave blank for all document types. */
4874
- docType?: any;
4875
- /**
4876
- * The beginning 2-digit month (MM) to be used as search criteria.
4877
- * @example "01"
4878
- */
4879
- beginMonth?: any;
4880
- /**
4881
- * The beginning 4-digit year (YYYY) to be used as search criteria.
4882
- * @example "2012"
4883
- */
4884
- beginYear?: any;
4885
- /**
4886
- * The ending 2-digit month (MM) to be used as search criteria.
4887
- * @example "12"
4888
- */
4889
- endMonth?: any;
4890
- /**
4891
- * The ending 4-digit year (YYYY) to be used as search criteria.
4892
- * @example "2017"
4893
- */
4894
- endYear?: any;
4895
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4896
- /**
4897
- * @tags Documents
4898
- * @name DocumentList
4899
- * @summary Document list
4900
- * @request GET:/documents/list
4901
- * @secure
4902
- */
4903
- documentList(query?: {
4904
- /** @example "5VA0XXXX" */
4905
- account?: any;
4906
- /**
4907
- * Omit for all document types.
4908
- * @example "All"
4909
- */
4910
- documentType?: any;
4911
- /**
4912
- * Indicates start month & year (day of month is not used)
4913
- * @example "1/1/2021"
4914
- */
4915
- fromMonth?: any;
4916
- /**
4917
- * Indicates end month & year (day of month is not used)
4918
- * @example "12/1/2021"
4919
- */
4920
- toMonth?: any;
4921
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4922
- /**
4923
- * @tags Documents
4924
- * @name AvailableDocumentTypes
4925
- * @summary Available document types
4926
- * @request GET:/documents/types
4927
- * @secure
4928
- */
4929
- availableDocumentTypes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4930
- /**
4931
- * @tags Documents
4932
- * @name AvailableDocumentTypesAndCodes
4933
- * @summary Available document types and codes
4934
- * @request GET:/documents/typesAndCodes
4935
- * @secure
4936
- */
4937
- availableDocumentTypesAndCodes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4938
- /**
4939
- * @tags Documents
4940
- * @name Download
4941
- * @summary Download
4942
- * @request GET:/documents/download
4943
- * @secure
4944
- */
4945
- download(query?: {
4946
- /**
4947
- * Account Number
4948
- * @example "{accountNumber}"
4949
- */
4950
- account?: any;
4951
- /**
4952
- * UUID for finding specific document
4953
- * @example "{key}"
4954
- */
4955
- key?: any;
4956
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4957
- /**
4958
- * @tags Documents
4959
- * @name GetAllBranchDocuments
4960
- * @summary Get all Branch Documents
4961
- * @request GET:/documents/branch/list
4962
- * @secure
4963
- */
4964
- getAllBranchDocuments(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4965
- }
4966
4817
  export class Miscellaneous<HandleError extends boolean = boolean> {
4967
4818
  protected readonly apiClient: JwtClient<HandleError>;
4968
4819
  constructor(apiClient: JwtClient<HandleError>);
@@ -5135,106 +4986,15 @@ export class Miscellaneous<HandleError extends boolean = boolean> {
5135
4986
  * @request GET:/general/options/strategyTypes
5136
4987
  * @secure
5137
4988
  */
5138
- optionStrategyTypes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5139
- /**
5140
- * @tags Miscellaneous
5141
- * @name OptionStrategyClassifications
5142
- * @summary Option Strategy Classifications
5143
- * @request GET:/general/options/strategyClassifications
5144
- * @secure
5145
- */
5146
- optionStrategyClassifications(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5147
- }
5148
- export class Branch<HandleError extends boolean = boolean> {
5149
- protected readonly apiClient: JwtClient<HandleError>;
5150
- constructor(apiClient: JwtClient<HandleError>);
5151
- /**
5152
- * @tags Branch
5153
- * @name BranchRtb
5154
- * @request GET:/v1/branch/rtb
5155
- * @secure
5156
- */
5157
- branchRtb(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5158
- /**
5159
- * @tags Branch
5160
- * @name BranchRtbs
5161
- * @request GET:/v1/branch/rtbs
5162
- * @secure
5163
- */
5164
- branchRtbs(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5165
- /**
5166
- * @tags Branch
5167
- * @name BranchInventory
5168
- * @request GET:/v1/branch/inventory
5169
- * @secure
5170
- */
5171
- branchInventory(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5172
- /**
5173
- * @tags Branch
5174
- * @name BranchRtbsTotal
5175
- * @request GET:/v1/branch/rtbs/total
5176
- * @secure
5177
- */
5178
- branchRtbsTotal(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5179
- /**
5180
- * @tags Branch
5181
- * @name BranchPortfolio
5182
- * @request GET:/v1/branch/portfolio
5183
- * @secure
5184
- */
5185
- branchPortfolio(query?: {
5186
- /**
5187
- * (true or false) Allows for loading of quotes for each portfolio entry. Defaults to false.
5188
- * @example "false"
5189
- */
5190
- loadQuotes?: any;
5191
- /** @example "false" */
5192
- loadIndustries?: any;
5193
- /** @example "false" */
5194
- loadUpgrades?: any;
5195
- /** @example "false" */
5196
- loadEarnings?: any;
5197
- /**
5198
- * Load balances for weight
5199
- * @example "false"
5200
- */
5201
- loadRtb?: any;
5202
- /**
5203
- * Analyze market caps and get `marketCapWeights`. To be used in conjuction with `loadQuotes`
5204
- * @example "false"
5205
- */
5206
- marketCapBreakdown?: any;
5207
- /**
5208
- * Combined portfolio for the branch
5209
- * @example "false"
5210
- */
5211
- combined?: any;
5212
- /** @example "1" */
5213
- pageNum?: any;
5214
- /** @example "100" */
5215
- pageSize?: any;
5216
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5217
- /**
5218
- * @tags Branch
5219
- * @name OptionExpirations
5220
- * @summary Option expirations
5221
- * @request GET:/v1/branch/portfolio/options/upcoming
5222
- * @secure
5223
- */
5224
- optionExpirations(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4989
+ optionStrategyTypes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5225
4990
  /**
5226
- * @tags Branch
5227
- * @name OptionExpirationsDetails
5228
- * @summary Option expirations details
5229
- * @request POST:/v1/branch/portfolio/options/upcoming/details
4991
+ * @tags Miscellaneous
4992
+ * @name OptionStrategyClassifications
4993
+ * @summary Option Strategy Classifications
4994
+ * @request GET:/general/options/strategyClassifications
5230
4995
  * @secure
5231
4996
  */
5232
- optionExpirationsDetails(data: {
5233
- /** @example "true|false" */
5234
- loadQuotes?: any;
5235
- /** @example "01/15/2021 00:00:00 EST" */
5236
- maturity?: any;
5237
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4997
+ optionStrategyClassifications(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5238
4998
  }
5239
4999
  export class LegalDocuments<HandleError extends boolean = boolean> {
5240
5000
  protected readonly apiClient: JwtClient<HandleError>;
@@ -5344,6 +5104,97 @@ export class LegalDocuments<HandleError extends boolean = boolean> {
5344
5104
  remoteDevice?: any;
5345
5105
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5346
5106
  }
5107
+ export class Branch<HandleError extends boolean = boolean> {
5108
+ protected readonly apiClient: JwtClient<HandleError>;
5109
+ constructor(apiClient: JwtClient<HandleError>);
5110
+ /**
5111
+ * @tags Branch
5112
+ * @name BranchRtb
5113
+ * @request GET:/v1/branch/rtb
5114
+ * @secure
5115
+ */
5116
+ branchRtb(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5117
+ /**
5118
+ * @tags Branch
5119
+ * @name BranchRtbs
5120
+ * @request GET:/v1/branch/rtbs
5121
+ * @secure
5122
+ */
5123
+ branchRtbs(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5124
+ /**
5125
+ * @tags Branch
5126
+ * @name BranchInventory
5127
+ * @request GET:/v1/branch/inventory
5128
+ * @secure
5129
+ */
5130
+ branchInventory(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5131
+ /**
5132
+ * @tags Branch
5133
+ * @name BranchRtbsTotal
5134
+ * @request GET:/v1/branch/rtbs/total
5135
+ * @secure
5136
+ */
5137
+ branchRtbsTotal(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5138
+ /**
5139
+ * @tags Branch
5140
+ * @name BranchPortfolio
5141
+ * @request GET:/v1/branch/portfolio
5142
+ * @secure
5143
+ */
5144
+ branchPortfolio(query?: {
5145
+ /**
5146
+ * (true or false) Allows for loading of quotes for each portfolio entry. Defaults to false.
5147
+ * @example "false"
5148
+ */
5149
+ loadQuotes?: any;
5150
+ /** @example "false" */
5151
+ loadIndustries?: any;
5152
+ /** @example "false" */
5153
+ loadUpgrades?: any;
5154
+ /** @example "false" */
5155
+ loadEarnings?: any;
5156
+ /**
5157
+ * Load balances for weight
5158
+ * @example "false"
5159
+ */
5160
+ loadRtb?: any;
5161
+ /**
5162
+ * Analyze market caps and get `marketCapWeights`. To be used in conjuction with `loadQuotes`
5163
+ * @example "false"
5164
+ */
5165
+ marketCapBreakdown?: any;
5166
+ /**
5167
+ * Combined portfolio for the branch
5168
+ * @example "false"
5169
+ */
5170
+ combined?: any;
5171
+ /** @example "1" */
5172
+ pageNum?: any;
5173
+ /** @example "100" */
5174
+ pageSize?: any;
5175
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5176
+ /**
5177
+ * @tags Branch
5178
+ * @name OptionExpirations
5179
+ * @summary Option expirations
5180
+ * @request GET:/v1/branch/portfolio/options/upcoming
5181
+ * @secure
5182
+ */
5183
+ optionExpirations(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5184
+ /**
5185
+ * @tags Branch
5186
+ * @name OptionExpirationsDetails
5187
+ * @summary Option expirations details
5188
+ * @request POST:/v1/branch/portfolio/options/upcoming/details
5189
+ * @secure
5190
+ */
5191
+ optionExpirationsDetails(data: {
5192
+ /** @example "true|false" */
5193
+ loadQuotes?: any;
5194
+ /** @example "01/15/2021 00:00:00 EST" */
5195
+ maturity?: any;
5196
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5197
+ }
5347
5198
  export class BlacklistAdminBusinesses<HandleError extends boolean = boolean> {
5348
5199
  protected readonly apiClient: JwtClient<HandleError>;
5349
5200
  constructor(apiClient: JwtClient<HandleError>);
@@ -5449,6 +5300,155 @@ export class BlacklistAdminBusinesses<HandleError extends boolean = boolean> {
5449
5300
  */
5450
5301
  deleteBusiness(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5451
5302
  }
5303
+ export class Documents<HandleError extends boolean = boolean> {
5304
+ protected readonly apiClient: JwtClient<HandleError>;
5305
+ constructor(apiClient: JwtClient<HandleError>);
5306
+ /**
5307
+ * @tags Documents
5308
+ * @name Confirm
5309
+ * @summary Confirm
5310
+ * @request GET:/documents/confirm
5311
+ * @secure
5312
+ */
5313
+ confirm(query?: {
5314
+ /**
5315
+ * *_accountNumber_ is accepted as well*
5316
+ * @example "5VA0XXXX"
5317
+ */
5318
+ account?: any;
5319
+ /**
5320
+ * Date for the confirm. The required date format is: mm/dd/yyyy.
5321
+ * @example "03/03/2018"
5322
+ */
5323
+ date?: any;
5324
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5325
+ /**
5326
+ * @tags Documents
5327
+ * @name ListOfConfirms
5328
+ * @summary List of Confirms
5329
+ * @request GET:/documents/confirm/list
5330
+ * @secure
5331
+ */
5332
+ listOfConfirms(query?: {
5333
+ /**
5334
+ * *_accountNumber_ is accepted as well*
5335
+ * @example "5VA0XXXX"
5336
+ */
5337
+ account?: any;
5338
+ /**
5339
+ * Start date for the list of confirms. The required date format is: `mm/dd/yyyy`.
5340
+ * @example "01/01/2017"
5341
+ */
5342
+ beginDate?: any;
5343
+ /**
5344
+ * End date for the list of confirms. The required date format is: `mm/dd/yyyy`.
5345
+ * @example "03/01/2018"
5346
+ */
5347
+ endDate?: any;
5348
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5349
+ /**
5350
+ * @tags Documents
5351
+ * @name ServiceDocs
5352
+ * @summary Service Docs
5353
+ * @request GET:/documents/service
5354
+ * @secure
5355
+ */
5356
+ serviceDocs(query?: {
5357
+ /** @example "5VA0XXXX" */
5358
+ accountNumber?: any;
5359
+ /** See table for details. Leave blank for all document types. */
5360
+ docType?: any;
5361
+ /**
5362
+ * The beginning 2-digit month (MM) to be used as search criteria.
5363
+ * @example "01"
5364
+ */
5365
+ beginMonth?: any;
5366
+ /**
5367
+ * The beginning 4-digit year (YYYY) to be used as search criteria.
5368
+ * @example "2012"
5369
+ */
5370
+ beginYear?: any;
5371
+ /**
5372
+ * The ending 2-digit month (MM) to be used as search criteria.
5373
+ * @example "12"
5374
+ */
5375
+ endMonth?: any;
5376
+ /**
5377
+ * The ending 4-digit year (YYYY) to be used as search criteria.
5378
+ * @example "2017"
5379
+ */
5380
+ endYear?: any;
5381
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5382
+ /**
5383
+ * @tags Documents
5384
+ * @name DocumentList
5385
+ * @summary Document list
5386
+ * @request GET:/documents/list
5387
+ * @secure
5388
+ */
5389
+ documentList(query?: {
5390
+ /** @example "5VA0XXXX" */
5391
+ account?: any;
5392
+ /**
5393
+ * Omit for all document types.
5394
+ * @example "All"
5395
+ */
5396
+ documentType?: any;
5397
+ /**
5398
+ * Indicates start month & year (day of month is not used)
5399
+ * @example "1/1/2021"
5400
+ */
5401
+ fromMonth?: any;
5402
+ /**
5403
+ * Indicates end month & year (day of month is not used)
5404
+ * @example "12/1/2021"
5405
+ */
5406
+ toMonth?: any;
5407
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5408
+ /**
5409
+ * @tags Documents
5410
+ * @name AvailableDocumentTypes
5411
+ * @summary Available document types
5412
+ * @request GET:/documents/types
5413
+ * @secure
5414
+ */
5415
+ availableDocumentTypes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5416
+ /**
5417
+ * @tags Documents
5418
+ * @name AvailableDocumentTypesAndCodes
5419
+ * @summary Available document types and codes
5420
+ * @request GET:/documents/typesAndCodes
5421
+ * @secure
5422
+ */
5423
+ availableDocumentTypesAndCodes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5424
+ /**
5425
+ * @tags Documents
5426
+ * @name Download
5427
+ * @summary Download
5428
+ * @request GET:/documents/download
5429
+ * @secure
5430
+ */
5431
+ download(query?: {
5432
+ /**
5433
+ * Account Number
5434
+ * @example "{accountNumber}"
5435
+ */
5436
+ account?: any;
5437
+ /**
5438
+ * UUID for finding specific document
5439
+ * @example "{key}"
5440
+ */
5441
+ key?: any;
5442
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5443
+ /**
5444
+ * @tags Documents
5445
+ * @name GetAllBranchDocuments
5446
+ * @summary Get all Branch Documents
5447
+ * @request GET:/documents/branch/list
5448
+ * @secure
5449
+ */
5450
+ getAllBranchDocuments(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5451
+ }
5452
5452
  export class BlacklistAdminIndividuals<HandleError extends boolean = boolean> {
5453
5453
  protected readonly apiClient: JwtClient<HandleError>;
5454
5454
  constructor(apiClient: JwtClient<HandleError>);