@orbis-systems/orbis-api-clients 0.7.10 → 0.7.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (43) hide show
  1. package/dist/aesmidas/index.d.ts +39 -39
  2. package/dist/aesmidas/index.d.ts.map +1 -1
  3. package/dist/aesmidas/index.esm.js +1 -1
  4. package/dist/aesmidas/index.esm.js.map +1 -1
  5. package/dist/aesmidas/index.js +1 -1
  6. package/dist/aesmidas/index.js.map +1 -1
  7. package/dist/bridgewise/index.d.ts +313 -304
  8. package/dist/bridgewise/index.d.ts.map +1 -1
  9. package/dist/bridgewise/index.esm.js +1 -1
  10. package/dist/bridgewise/index.esm.js.map +1 -1
  11. package/dist/bridgewise/index.js +1 -1
  12. package/dist/bridgewise/index.js.map +1 -1
  13. package/dist/insight/index.d.ts +774 -521
  14. package/dist/insight/index.d.ts.map +1 -1
  15. package/dist/insight/index.esm.js +1 -1
  16. package/dist/insight/index.esm.js.map +1 -1
  17. package/dist/insight/index.js +1 -1
  18. package/dist/insight/index.js.map +1 -1
  19. package/dist/middleware/index.d.ts +30 -30
  20. package/dist/middleware/index.d.ts.map +1 -1
  21. package/dist/middleware/index.esm.js +1 -1
  22. package/dist/middleware/index.esm.js.map +1 -1
  23. package/dist/middleware/index.js +1 -1
  24. package/dist/middleware/index.js.map +1 -1
  25. package/dist/orbis/index.d.ts +1501 -1501
  26. package/dist/orbis/index.d.ts.map +1 -1
  27. package/dist/orbis/index.esm.js +1 -1
  28. package/dist/orbis/index.esm.js.map +1 -1
  29. package/dist/orbis/index.js +1 -1
  30. package/dist/orbis/index.js.map +1 -1
  31. package/dist/uma/index.d.ts +452 -452
  32. package/dist/uma/index.d.ts.map +1 -1
  33. package/dist/uma/index.esm.js +1 -1
  34. package/dist/uma/index.esm.js.map +1 -1
  35. package/dist/uma/index.js +1 -1
  36. package/dist/uma/index.js.map +1 -1
  37. package/dist/zerohash/index.d.ts +563 -563
  38. package/dist/zerohash/index.d.ts.map +1 -1
  39. package/dist/zerohash/index.esm.js +1 -1
  40. package/dist/zerohash/index.esm.js.map +1 -1
  41. package/dist/zerohash/index.js +1 -1
  42. package/dist/zerohash/index.js.map +1 -1
  43. package/package.json +1 -1
@@ -222,7 +222,7 @@ interface OrbisErrorData {
222
222
  interface OrbisClientConfig<HandleError extends boolean = boolean> extends JwtClientConfig<HandleError> {
223
223
  onLoginTimeout?: VoidFunction;
224
224
  onUnauthorized?: VoidFunction;
225
- onErrorTranslate?: (code: string) => string;
225
+ onErrorTranslate?: (errorCode: string, reason?: string) => string;
226
226
  }
227
227
  type OrbisClientResponse<Data = unknown, HandleError extends boolean = boolean> = OrbisErrorData & ClientResponse<Data, HandleError>;
228
228
  declare class OrbisClient<HandleError extends boolean = boolean> extends JwtClient<HandleError> {
@@ -305,84 +305,6 @@ export class OrdersV2Equities<HandleError extends boolean = boolean> {
305
305
  */
306
306
  previewSnapshot(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
307
307
  }
308
- export class OrdersV2FixedIncome<HandleError extends boolean = boolean> {
309
- protected readonly apiClient: JwtClient<HandleError>;
310
- constructor(apiClient: JwtClient<HandleError>);
311
- /**
312
- * @tags Orders V2 Fixed Income
313
- * @name BondPlacement
314
- * @summary Bond placement
315
- * @request POST:/orders/v2/bonds/place
316
- * @secure
317
- */
318
- bondPlacement(data: {
319
- account?: {
320
- /** @example 123 */
321
- accountId?: number;
322
- /** @example "AC00123" */
323
- accountNumber?: string;
324
- };
325
- order?: {
326
- /** @example "LIMIT" */
327
- orderType?: string;
328
- /** @example 100 */
329
- price?: number;
330
- /** @example "Percentage|Decimal" */
331
- priceType?: string;
332
- /** @example 1000 */
333
- quantity?: number;
334
- /** @example "Par|Unit" */
335
- quantityType?: string;
336
- quote?: {
337
- /** @example "412001269" */
338
- cusip?: string;
339
- /** @example "CUSIP:ISIN" */
340
- identType?: string;
341
- /** @example "SK4120012691" */
342
- isin?: string;
343
- };
344
- /** @example "BUY|SELL" */
345
- transaction?: string;
346
- };
347
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
348
- /**
349
- * @tags Orders V2 Fixed Income
350
- * @name BondOrderPreview
351
- * @summary Bond order preview
352
- * @request POST:/orders/v2/bonds/preview
353
- * @secure
354
- */
355
- bondOrderPreview(data: {
356
- account?: {
357
- /** @example 123 */
358
- accountId?: number;
359
- /** @example "AC00123" */
360
- accountNumber?: string;
361
- };
362
- order?: {
363
- /** @example "LIMIT" */
364
- orderType?: string;
365
- /** @example 100 */
366
- price?: number;
367
- /** @example "Percentage|Decimal" */
368
- priceType?: string;
369
- /** @example 1000 */
370
- quantity?: number;
371
- /** @example "Par|Unit" */
372
- quantityType?: string;
373
- quote?: {
374
- /** @example "412001269" */
375
- cusip?: string;
376
- /** @example "CUSIP:ISIN" */
377
- identType?: string;
378
- /** @example "SK4120012691" */
379
- isin?: string;
380
- };
381
- /** @example "BUY|SELL" */
382
- transaction?: string;
383
- };
384
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
385
- }
386
308
  export class OrdersV2Options<HandleError extends boolean = boolean> {
387
309
  protected readonly apiClient: JwtClient<HandleError>;
388
310
  constructor(apiClient: JwtClient<HandleError>);
@@ -588,6 +510,84 @@ export class OrdersV2Options<HandleError extends boolean = boolean> {
588
510
  };
589
511
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
590
512
  }
513
+ export class OrdersV2FixedIncome<HandleError extends boolean = boolean> {
514
+ protected readonly apiClient: JwtClient<HandleError>;
515
+ constructor(apiClient: JwtClient<HandleError>);
516
+ /**
517
+ * @tags Orders V2 Fixed Income
518
+ * @name BondPlacement
519
+ * @summary Bond placement
520
+ * @request POST:/orders/v2/bonds/place
521
+ * @secure
522
+ */
523
+ bondPlacement(data: {
524
+ account?: {
525
+ /** @example 123 */
526
+ accountId?: number;
527
+ /** @example "AC00123" */
528
+ accountNumber?: string;
529
+ };
530
+ order?: {
531
+ /** @example "LIMIT" */
532
+ orderType?: string;
533
+ /** @example 100 */
534
+ price?: number;
535
+ /** @example "Percentage|Decimal" */
536
+ priceType?: string;
537
+ /** @example 1000 */
538
+ quantity?: number;
539
+ /** @example "Par|Unit" */
540
+ quantityType?: string;
541
+ quote?: {
542
+ /** @example "412001269" */
543
+ cusip?: string;
544
+ /** @example "CUSIP:ISIN" */
545
+ identType?: string;
546
+ /** @example "SK4120012691" */
547
+ isin?: string;
548
+ };
549
+ /** @example "BUY|SELL" */
550
+ transaction?: string;
551
+ };
552
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
553
+ /**
554
+ * @tags Orders V2 Fixed Income
555
+ * @name BondOrderPreview
556
+ * @summary Bond order preview
557
+ * @request POST:/orders/v2/bonds/preview
558
+ * @secure
559
+ */
560
+ bondOrderPreview(data: {
561
+ account?: {
562
+ /** @example 123 */
563
+ accountId?: number;
564
+ /** @example "AC00123" */
565
+ accountNumber?: string;
566
+ };
567
+ order?: {
568
+ /** @example "LIMIT" */
569
+ orderType?: string;
570
+ /** @example 100 */
571
+ price?: number;
572
+ /** @example "Percentage|Decimal" */
573
+ priceType?: string;
574
+ /** @example 1000 */
575
+ quantity?: number;
576
+ /** @example "Par|Unit" */
577
+ quantityType?: string;
578
+ quote?: {
579
+ /** @example "412001269" */
580
+ cusip?: string;
581
+ /** @example "CUSIP:ISIN" */
582
+ identType?: string;
583
+ /** @example "SK4120012691" */
584
+ isin?: string;
585
+ };
586
+ /** @example "BUY|SELL" */
587
+ transaction?: string;
588
+ };
589
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
590
+ }
591
591
  export class OrdersV2MutualFunds<HandleError extends boolean = boolean> {
592
592
  protected readonly apiClient: JwtClient<HandleError>;
593
593
  constructor(apiClient: JwtClient<HandleError>);
@@ -632,80 +632,6 @@ export class OrdersV2MutualFunds<HandleError extends boolean = boolean> {
632
632
  */
633
633
  mutualFundPreview(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
634
634
  }
635
- export class OrdersV2Crypto<HandleError extends boolean = boolean> {
636
- protected readonly apiClient: JwtClient<HandleError>;
637
- constructor(apiClient: JwtClient<HandleError>);
638
- /**
639
- * @tags Orders V2 Crypto
640
- * @name OrderPreview
641
- * @summary Order Preview
642
- * @request POST:/orders/v2/crypto/preview
643
- * @secure
644
- */
645
- orderPreview(data: {
646
- account?: {
647
- /** @example "ABC123" */
648
- accountNumber?: string;
649
- };
650
- order?: {
651
- /** @example 100 */
652
- expectedValue?: number;
653
- /** @example 1.123 */
654
- limitPx?: number;
655
- /** @example "MARKET|LIMIT|STOP|STOP_LIMIG|Notional|NotionalLimit" */
656
- orderType?: string;
657
- /** @example 0.0123 */
658
- quantity?: number;
659
- quote?: {
660
- /** @example "BTC/USD" */
661
- symbol?: string;
662
- };
663
- /** @example 1.123 */
664
- stopPx?: number;
665
- /** @example "BUY|SELL" */
666
- transaction?: string;
667
- /** @example "DAY|GTC" */
668
- validity?: string;
669
- };
670
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
671
- /**
672
- * @tags Orders V2 Crypto
673
- * @name OrderPlace
674
- * @summary Order Place
675
- * @request POST:/orders/v2/crypto/place
676
- * @secure
677
- */
678
- orderPlace(data: {
679
- account?: {
680
- /** @example "ABC123" */
681
- accountNumber?: string;
682
- };
683
- order?: {
684
- /** @example "{your own order reference number}" */
685
- clientRef?: string;
686
- /** @example "ABC" */
687
- clientSourceId?: string;
688
- /** @example 100 */
689
- expectedValue?: number;
690
- /** @example 1.123 */
691
- limitPx?: number;
692
- /** @example "MARKET|LIMIT|STOP|STOP_LIMIT|Notional|NotionalLimit" */
693
- orderType?: string;
694
- /** @example 0.0123 */
695
- quantity?: number;
696
- quote?: {
697
- /** @example "BTC/USD" */
698
- symbol?: string;
699
- };
700
- /** @example 1.123 */
701
- stopPx?: number;
702
- /** @example "BUY|SELL" */
703
- transaction?: string;
704
- /** @example "DAY|GTC" */
705
- validity?: string;
706
- };
707
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
708
- }
709
635
  export class OrdersV2Offerings<HandleError extends boolean = boolean> {
710
636
  protected readonly apiClient: JwtClient<HandleError>;
711
637
  constructor(apiClient: JwtClient<HandleError>);
@@ -865,34 +791,108 @@ export class OrdersV2Offerings<HandleError extends boolean = boolean> {
865
791
  };
866
792
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
867
793
  }
868
- export class OrdersV2<HandleError extends boolean = boolean> {
794
+ export class OrdersV2Crypto<HandleError extends boolean = boolean> {
869
795
  protected readonly apiClient: JwtClient<HandleError>;
870
- equities: OrdersV2Equities<HandleError>;
871
- options: OrdersV2Options<HandleError>;
872
- fixedIncome: OrdersV2FixedIncome<HandleError>;
873
- crypto: OrdersV2Crypto<HandleError>;
874
- mutualFunds: OrdersV2MutualFunds<HandleError>;
875
- offerings: OrdersV2Offerings<HandleError>;
876
796
  constructor(apiClient: JwtClient<HandleError>);
877
797
  /**
878
- * @tags Orders V2
879
- * @name CancelReplace
880
- * @summary Cancel/Replace
881
- * @request POST:/orders/v2/replace
798
+ * @tags Orders V2 Crypto
799
+ * @name OrderPreview
800
+ * @summary Order Preview
801
+ * @request POST:/orders/v2/crypto/preview
882
802
  * @secure
883
803
  */
884
- cancelReplace(data: {
804
+ orderPreview(data: {
885
805
  account?: {
886
- /** @example 123 */
887
- accountId?: number;
888
- /** @example "AC123456" */
806
+ /** @example "ABC123" */
889
807
  accountNumber?: string;
890
808
  };
891
809
  order?: {
892
- /** @example 11.1234 */
893
- limitPrice?: number;
894
- /** @example "U" */
895
- marketCode?: string;
810
+ /** @example 100 */
811
+ expectedValue?: number;
812
+ /** @example 1.123 */
813
+ limitPx?: number;
814
+ /** @example "MARKET|LIMIT|STOP|STOP_LIMIG|Notional|NotionalLimit" */
815
+ orderType?: string;
816
+ /** @example 0.0123 */
817
+ quantity?: number;
818
+ quote?: {
819
+ /** @example "BTC/USD" */
820
+ symbol?: string;
821
+ };
822
+ /** @example 1.123 */
823
+ stopPx?: number;
824
+ /** @example "BUY|SELL" */
825
+ transaction?: string;
826
+ /** @example "DAY|GTC" */
827
+ validity?: string;
828
+ };
829
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
830
+ /**
831
+ * @tags Orders V2 Crypto
832
+ * @name OrderPlace
833
+ * @summary Order Place
834
+ * @request POST:/orders/v2/crypto/place
835
+ * @secure
836
+ */
837
+ orderPlace(data: {
838
+ account?: {
839
+ /** @example "ABC123" */
840
+ accountNumber?: string;
841
+ };
842
+ order?: {
843
+ /** @example "{your own order reference number}" */
844
+ clientRef?: string;
845
+ /** @example "ABC" */
846
+ clientSourceId?: string;
847
+ /** @example 100 */
848
+ expectedValue?: number;
849
+ /** @example 1.123 */
850
+ limitPx?: number;
851
+ /** @example "MARKET|LIMIT|STOP|STOP_LIMIT|Notional|NotionalLimit" */
852
+ orderType?: string;
853
+ /** @example 0.0123 */
854
+ quantity?: number;
855
+ quote?: {
856
+ /** @example "BTC/USD" */
857
+ symbol?: string;
858
+ };
859
+ /** @example 1.123 */
860
+ stopPx?: number;
861
+ /** @example "BUY|SELL" */
862
+ transaction?: string;
863
+ /** @example "DAY|GTC" */
864
+ validity?: string;
865
+ };
866
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
867
+ }
868
+ export class OrdersV2<HandleError extends boolean = boolean> {
869
+ protected readonly apiClient: JwtClient<HandleError>;
870
+ equities: OrdersV2Equities<HandleError>;
871
+ options: OrdersV2Options<HandleError>;
872
+ fixedIncome: OrdersV2FixedIncome<HandleError>;
873
+ crypto: OrdersV2Crypto<HandleError>;
874
+ mutualFunds: OrdersV2MutualFunds<HandleError>;
875
+ offerings: OrdersV2Offerings<HandleError>;
876
+ constructor(apiClient: JwtClient<HandleError>);
877
+ /**
878
+ * @tags Orders V2
879
+ * @name CancelReplace
880
+ * @summary Cancel/Replace
881
+ * @request POST:/orders/v2/replace
882
+ * @secure
883
+ */
884
+ cancelReplace(data: {
885
+ account?: {
886
+ /** @example 123 */
887
+ accountId?: number;
888
+ /** @example "AC123456" */
889
+ accountNumber?: string;
890
+ };
891
+ order?: {
892
+ /** @example 11.1234 */
893
+ limitPrice?: number;
894
+ /** @example "U" */
895
+ marketCode?: string;
896
896
  /** @example "CC123456789" */
897
897
  orderRef?: string;
898
898
  /** @example 10 */
@@ -927,43 +927,6 @@ export class OrdersV2<HandleError extends boolean = boolean> {
927
927
  };
928
928
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
929
929
  }
930
- export class OrdersViolationManagement<HandleError extends boolean = boolean> {
931
- protected readonly apiClient: JwtClient<HandleError>;
932
- constructor(apiClient: JwtClient<HandleError>);
933
- /**
934
- * @tags Orders Violation Management
935
- * @name GfvEquities
936
- * @summary GFV (equities)
937
- * @request POST:/trading/violations/gfv/equity
938
- * @secure
939
- */
940
- gfvEquities(data: {
941
- account?: {
942
- /** @example "optional" */
943
- accountNumber?: string;
944
- };
945
- order?: {
946
- /** @example 101.5 */
947
- expectedValue?: number;
948
- /** @example 123.45 */
949
- limitPrice?: number;
950
- /** @example "PRE_MARKET|CORE_MARKET|POST_MARKET|ALL_MARKET|PRE_CORE|POST_CORE" */
951
- marketTime?: string;
952
- /** @example "MARKET|LIMIT|STOP|STOP_LIMIT|TRAILING_STOP|Notional|NotionalLimit" */
953
- orderType?: string;
954
- /** @example 123.45 */
955
- quantity?: number;
956
- quote?: {
957
- /** @example "ZVZZT" */
958
- symbol?: string;
959
- };
960
- /** @example 123.45 */
961
- stopPrice?: number;
962
- /** @example "BUY|SELL|SHORT_SELL|BUY_TO_COVER|Liquidate" */
963
- transaction?: string;
964
- };
965
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
966
- }
967
930
  export class OrdersArchived<HandleError extends boolean = boolean> {
968
931
  protected readonly apiClient: JwtClient<HandleError>;
969
932
  constructor(apiClient: JwtClient<HandleError>);
@@ -1045,6 +1008,43 @@ export class OrdersArchived<HandleError extends boolean = boolean> {
1045
1008
  orderRef?: string;
1046
1009
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1047
1010
  }
1011
+ export class OrdersViolationManagement<HandleError extends boolean = boolean> {
1012
+ protected readonly apiClient: JwtClient<HandleError>;
1013
+ constructor(apiClient: JwtClient<HandleError>);
1014
+ /**
1015
+ * @tags Orders Violation Management
1016
+ * @name GfvEquities
1017
+ * @summary GFV (equities)
1018
+ * @request POST:/trading/violations/gfv/equity
1019
+ * @secure
1020
+ */
1021
+ gfvEquities(data: {
1022
+ account?: {
1023
+ /** @example "optional" */
1024
+ accountNumber?: string;
1025
+ };
1026
+ order?: {
1027
+ /** @example 101.5 */
1028
+ expectedValue?: number;
1029
+ /** @example 123.45 */
1030
+ limitPrice?: number;
1031
+ /** @example "PRE_MARKET|CORE_MARKET|POST_MARKET|ALL_MARKET|PRE_CORE|POST_CORE" */
1032
+ marketTime?: string;
1033
+ /** @example "MARKET|LIMIT|STOP|STOP_LIMIT|TRAILING_STOP|Notional|NotionalLimit" */
1034
+ orderType?: string;
1035
+ /** @example 123.45 */
1036
+ quantity?: number;
1037
+ quote?: {
1038
+ /** @example "ZVZZT" */
1039
+ symbol?: string;
1040
+ };
1041
+ /** @example 123.45 */
1042
+ stopPrice?: number;
1043
+ /** @example "BUY|SELL|SHORT_SELL|BUY_TO_COVER|Liquidate" */
1044
+ transaction?: string;
1045
+ };
1046
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1047
+ }
1048
1048
  export class Orders<HandleError extends boolean = boolean> {
1049
1049
  protected readonly apiClient: JwtClient<HandleError>;
1050
1050
  violationManagement: OrdersViolationManagement<HandleError>;
@@ -1866,6 +1866,71 @@ export class ResearchCorporateActions<HandleError extends boolean = boolean> {
1866
1866
  usePayDate?: any;
1867
1867
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1868
1868
  }
1869
+ export class ResearchNews<HandleError extends boolean = boolean> {
1870
+ protected readonly apiClient: JwtClient<HandleError>;
1871
+ constructor(apiClient: JwtClient<HandleError>);
1872
+ /**
1873
+ * @tags Research News
1874
+ * @name List
1875
+ * @summary List
1876
+ * @request GET:/research/news
1877
+ * @secure
1878
+ */
1879
+ list(query?: {
1880
+ /** @example "0" */
1881
+ start?: any;
1882
+ /**
1883
+ * Defaults to 20
1884
+ * @example "100"
1885
+ */
1886
+ count?: any;
1887
+ /** @example "[[-](provider|aggregator):value1,valueN];" */
1888
+ filter?: any;
1889
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1890
+ /**
1891
+ * @tags Research News
1892
+ * @name NewsBySymbol
1893
+ * @summary News by Symbol
1894
+ * @request GET:/research/news/ticker/{symbol}
1895
+ * @secure
1896
+ */
1897
+ newsBySymbol(symbol: string, query?: {
1898
+ /**
1899
+ * Starting page (optional)
1900
+ * @example ""
1901
+ */
1902
+ start?: any;
1903
+ /** Defaults to 20 (optional) */
1904
+ count?: any;
1905
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1906
+ /**
1907
+ * @tags Research News
1908
+ * @name Sec
1909
+ * @summary SEC
1910
+ * @request GET:/research/news/sec/{symbol}
1911
+ * @secure
1912
+ */
1913
+ sec(symbol: string, query?: {
1914
+ /**
1915
+ * Starting point(optional)
1916
+ * @example "0"
1917
+ */
1918
+ start?: any;
1919
+ /**
1920
+ * Defaults to 20 (optional)
1921
+ * @example "2"
1922
+ */
1923
+ count?: any;
1924
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1925
+ /**
1926
+ * @tags Research News
1927
+ * @name Lookup
1928
+ * @summary Lookup
1929
+ * @request GET:/research/news/{newsId}
1930
+ * @secure
1931
+ */
1932
+ lookup(newsId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1933
+ }
1869
1934
  export class ResearchAlphaTools<HandleError extends boolean = boolean> {
1870
1935
  protected readonly apiClient: JwtClient<HandleError>;
1871
1936
  constructor(apiClient: JwtClient<HandleError>);
@@ -1952,70 +2017,331 @@ export class ResearchAlphaTools<HandleError extends boolean = boolean> {
1952
2017
  years?: any;
1953
2018
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1954
2019
  }
1955
- export class ResearchNews<HandleError extends boolean = boolean> {
2020
+ export class ResearchIpos<HandleError extends boolean = boolean> {
1956
2021
  protected readonly apiClient: JwtClient<HandleError>;
1957
2022
  constructor(apiClient: JwtClient<HandleError>);
1958
2023
  /**
1959
- * @tags Research News
1960
- * @name List
1961
- * @summary List
1962
- * @request GET:/research/news
2024
+ * @tags Research Ipos
2025
+ * @name Recent
2026
+ * @summary Recent
2027
+ * @request GET:/research/ipo/recent
1963
2028
  * @secure
1964
2029
  */
1965
- list(query?: {
1966
- /** @example "0" */
1967
- start?: any;
2030
+ recent(query?: {
1968
2031
  /**
1969
- * Defaults to 20
1970
- * @example "100"
2032
+ * `true` or `false` to load quotes
2033
+ * @example ""
1971
2034
  */
1972
- count?: any;
1973
- /** @example "[[-](provider|aggregator):value1,valueN];" */
1974
- filter?: any;
2035
+ loadQuotes?: any;
2036
+ /** 1m, 3m*, 6m, 1y */
2037
+ time?: any;
2038
+ /** symbol, ipoDate, offerPx, shares, day1Ret, ipoRet, last, change, offerSz */
2039
+ sort?: any;
1975
2040
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1976
2041
  /**
1977
- * @tags Research News
1978
- * @name NewsBySymbol
1979
- * @summary News by Symbol
1980
- * @request GET:/research/news/ticker/{symbol}
1981
- * @secure
2042
+ * @tags Research Ipos
2043
+ * @name Upcoming
2044
+ * @summary Upcoming
2045
+ * @request GET:/research/ipo/upcoming
2046
+ * @secure
1982
2047
  */
1983
- newsBySymbol(symbol: string, query?: {
2048
+ upcoming(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2049
+ /**
2050
+ * @tags Research Ipos
2051
+ * @name Performance
2052
+ * @summary Performance
2053
+ * @request GET:/research/ipo/performance
2054
+ * @secure
2055
+ */
2056
+ performance(query?: {
1984
2057
  /**
1985
- * Starting page (optional)
1986
- * @example ""
2058
+ * `true` or `false` to load quotes
2059
+ * @example "false"
2060
+ */
2061
+ loadQuotes?: any;
2062
+ /**
2063
+ * 1m, 3m*, 6m, 1y
2064
+ * @example "1m"
2065
+ */
2066
+ time?: any;
2067
+ /**
2068
+ * shares, day1Ret, ipoRet, last, change, offerSz
2069
+ * @example "day1Ret"
2070
+ */
2071
+ sort?: any;
2072
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2073
+ }
2074
+ export class Research<HandleError extends boolean = boolean> {
2075
+ protected readonly apiClient: JwtClient<HandleError>;
2076
+ tipranks: ResearchTipranks<HandleError>;
2077
+ etfs: ResearchEtfs<HandleError>;
2078
+ adrs: ResearchAdrs<HandleError>;
2079
+ corporateActions: ResearchCorporateActions<HandleError>;
2080
+ news: ResearchNews<HandleError>;
2081
+ alphaTools: ResearchAlphaTools<HandleError>;
2082
+ ipos: ResearchIpos<HandleError>;
2083
+ constructor(apiClient: JwtClient<HandleError>);
2084
+ /**
2085
+ * @tags Research
2086
+ * @name TopStocks
2087
+ * @summary Top Stocks
2088
+ * @request GET:/quotes/top10/{category}
2089
+ * @secure
2090
+ */
2091
+ topStocks(category: string, query?: {
2092
+ /**
2093
+ * See table above
2094
+ * @example "BIG3"
2095
+ */
2096
+ market?: any;
2097
+ /**
2098
+ * See table above
2099
+ * @example "H"
2100
+ */
2101
+ order?: any;
2102
+ /**
2103
+ * Optional. Defaults to 10
2104
+ * @example "10"
1987
2105
  */
1988
- start?: any;
1989
- /** Defaults to 20 (optional) */
1990
2106
  count?: any;
1991
2107
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1992
2108
  /**
1993
- * @tags Research News
1994
- * @name Sec
1995
- * @summary SEC
1996
- * @request GET:/research/news/sec/{symbol}
2109
+ * @tags Research
2110
+ * @name CompanyResearch
2111
+ * @summary Company Research
2112
+ * @request GET:/research/{symbol}
1997
2113
  * @secure
1998
2114
  */
1999
- sec(symbol: string, query?: {
2115
+ companyResearch(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2116
+ /**
2117
+ * @tags Research
2118
+ * @name OptionRatios
2119
+ * @summary Option Ratios
2120
+ * @request GET:/research/option/ratios
2121
+ * @secure
2122
+ */
2123
+ optionRatios(query?: {
2000
2124
  /**
2001
- * Starting point(optional)
2125
+ * Comma separated list of symbols.
2126
+ * @example "AAPL,BABA"
2127
+ */
2128
+ symbols?: any;
2129
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2130
+ /**
2131
+ * @tags Research
2132
+ * @name OptionRadar
2133
+ * @summary Option Radar
2134
+ * @request GET:/research/option/radar
2135
+ * @secure
2136
+ */
2137
+ optionRadar(query?: {
2138
+ /**
2139
+ * See table above. Leaving blank returns an overview of all of them.
2140
+ * @example ""
2141
+ */
2142
+ filter?: any;
2143
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2144
+ /**
2145
+ * @tags Research
2146
+ * @name IndexComponents
2147
+ * @summary Index Components
2148
+ * @request GET:/research/index/components/{index}
2149
+ * @secure
2150
+ */
2151
+ indexComponents(index: string, query?: {
2152
+ /**
2153
+ * `true` or `false` to load quotes
2154
+ * @example "true"
2155
+ */
2156
+ loadQuotes?: any;
2157
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2158
+ /**
2159
+ * @tags Research
2160
+ * @name StockUpgrades
2161
+ * @summary Stock Upgrades
2162
+ * @request GET:/research/upgrades
2163
+ * @secure
2164
+ */
2165
+ stockUpgrades(query?: {
2166
+ /**
2167
+ * Comma separated list of symbols
2168
+ * @example "AAPL"
2169
+ */
2170
+ symbols?: any;
2171
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2172
+ /**
2173
+ * @tags Research
2174
+ * @name OwnershipDetails
2175
+ * @summary Ownership Details
2176
+ * @request GET:/research/ownerships/details
2177
+ * @secure
2178
+ */
2179
+ ownershipDetails(query?: {
2180
+ /**
2181
+ * Comma separated list of tickers
2182
+ * @example "MSFT,GOOG"
2183
+ */
2184
+ symbols?: any;
2185
+ /**
2186
+ * One of `ALL`, `INSTITUTIONAL`, `FUND`, `INSIDER`
2187
+ * @example "ALL"
2188
+ */
2189
+ filter?: any;
2190
+ /**
2191
+ * One of `portfolio`, `ownership`, `market`
2192
+ * @example "portfolio"
2193
+ */
2194
+ sort?: any;
2195
+ /**
2196
+ * Number of items per page
2197
+ * @example "20"
2198
+ */
2199
+ count?: any;
2200
+ /**
2201
+ * Page num (first page is zero)
2002
2202
  * @example "0"
2003
2203
  */
2204
+ page?: any;
2205
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2206
+ /**
2207
+ * @tags Research
2208
+ * @name OwnerDetails
2209
+ * @summary Owner Details
2210
+ * @request GET:/research/owner/details
2211
+ * @secure
2212
+ */
2213
+ ownerDetails(query?: {
2214
+ /**
2215
+ * Comma separated list of owner IDs
2216
+ * @example "PS000000YH,PS000004TI"
2217
+ */
2218
+ ids?: any;
2219
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2220
+ /**
2221
+ * @tags Research
2222
+ * @name EarningsCalendar
2223
+ * @summary Earnings Calendar
2224
+ * @request GET:/research/earnings
2225
+ * @secure
2226
+ */
2227
+ earningsCalendar(query?: {
2228
+ /**
2229
+ * (Optional) Exclude Otcs from data.
2230
+ * @example "true"
2231
+ */
2232
+ excludeOtcs?: any;
2233
+ /**
2234
+ * (Optional) Number of days in the future. Default is 7.
2235
+ * @example "90"
2236
+ */
2237
+ days?: any;
2238
+ /**
2239
+ * `true`|`false`
2240
+ * @example "false"
2241
+ */
2242
+ loadQuotes?: any;
2243
+ /**
2244
+ * (Optional) Use to filter results only to selected symbols. Excluding this parameter gives all upcoming earnings.
2245
+ * @example "AAPL,T,GOOGL"
2246
+ */
2247
+ symbols?: any;
2248
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2249
+ /**
2250
+ * @tags Research
2251
+ * @name Fundamentals
2252
+ * @summary Fundamentals
2253
+ * @request GET:/research/fundamentals/{type}/{symbol}
2254
+ * @secure
2255
+ */
2256
+ fundamentals(type: string, symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2257
+ /**
2258
+ * @tags Research
2259
+ * @name FundamentalTypes
2260
+ * @summary Fundamental Types
2261
+ * @request GET:/research/fundamentals/types
2262
+ * @secure
2263
+ */
2264
+ fundamentalTypes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2265
+ /**
2266
+ * @tags Research
2267
+ * @name Screener
2268
+ * @summary Screener
2269
+ * @request POST:/research/screener
2270
+ * @secure
2271
+ */
2272
+ screener(data: {
2273
+ /** @example 2 */
2274
+ limit?: any;
2275
+ /** @example [{"comparator":"Equals","dateRange":{"lowerBound":"01-01-2020","upperBound":"10-05-2020"},"field":"Industry","value":10280010}] */
2276
+ queries?: any;
2277
+ /** @example 0 */
2004
2278
  start?: any;
2279
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2280
+ /**
2281
+ * @tags Research
2282
+ * @name IndustryHeatMap
2283
+ * @summary Industry Heat Map
2284
+ * @request GET:/research/heatMap/industryRanking
2285
+ * @secure
2286
+ */
2287
+ industryHeatMap(query?: {
2005
2288
  /**
2006
- * Defaults to 20 (optional)
2007
- * @example "2"
2289
+ * Can be one of the following:
2290
+ * Sector| Group | Industry | SubIndustry
2291
+ * @example "group"
2008
2292
  */
2009
- count?: any;
2293
+ industryType?: any;
2010
2294
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2011
2295
  /**
2012
- * @tags Research News
2013
- * @name Lookup
2014
- * @summary Lookup
2015
- * @request GET:/research/news/{newsId}
2296
+ * @tags Research
2297
+ * @name IndustryList
2298
+ * @summary Industry List
2299
+ * @request GET:/
2016
2300
  * @secure
2017
2301
  */
2018
- lookup(newsId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2302
+ industryList(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2303
+ /**
2304
+ * @tags Research
2305
+ * @name SymbolHeatMap
2306
+ * @summary Symbol Heat Map
2307
+ * @request GET:/research/heatMap/symbols
2308
+ * @secure
2309
+ */
2310
+ symbolHeatMap(query?: {
2311
+ /** filter out by last price. 0 = no filter; 1 = lastPrice < 5.0; 2 = lastPrice < 1.0; 3 = lastPrice < 1.0 or lastPrice > 5.0; 4 = lastPrice > 1.0; 5 = lastPrice > 5.0 */
2312
+ amountLimit?: any;
2313
+ /** 0 indicates no filter, 1 indicates only NYSE, NASDAQ, AMEX. */
2314
+ exchangeFilter?: any;
2315
+ /** obtain from research/heatMap/industryRanking */
2316
+ industryCode?: any;
2317
+ /** max number of symbols returned */
2318
+ numSymbols?: any;
2319
+ /**
2320
+ * `true` or `false`. true = top symbols change by price;
2321
+ * false = bottom symbols channged by price.
2322
+ */
2323
+ top?: any;
2324
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2325
+ /**
2326
+ * @tags Research
2327
+ * @name IndexOverview
2328
+ * @summary Index Overview
2329
+ * @request GET:/research/marketOverview
2330
+ * @secure
2331
+ */
2332
+ indexOverview(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2333
+ /**
2334
+ * @tags Research
2335
+ * @name HistoricalData
2336
+ * @summary Historical Data
2337
+ * @request GET:/research/historicalPrices
2338
+ * @secure
2339
+ */
2340
+ historicalData(query?: {
2341
+ symbol?: any;
2342
+ /** comma saperated values. each value is started with number, following `w`, `m`, or `y`. w=week, m=month, y=year. For example, to get historical price last year and last two month, dates=1y,2m */
2343
+ dates?: any;
2344
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2019
2345
  }
2020
2346
  export class UserDevice<HandleError extends boolean = boolean> {
2021
2347
  protected readonly apiClient: JwtClient<HandleError>;
@@ -2092,66 +2418,6 @@ export class UserTradingLimitManagement<HandleError extends boolean = boolean> {
2092
2418
  type?: any;
2093
2419
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2094
2420
  }
2095
- export class UserAgreements<HandleError extends boolean = boolean> {
2096
- protected readonly apiClient: JwtClient<HandleError>;
2097
- constructor(apiClient: JwtClient<HandleError>);
2098
- /**
2099
- * @tags User Agreements
2100
- * @name Available
2101
- * @summary Available
2102
- * @request GET:/user/agreements/all/active
2103
- * @secure
2104
- */
2105
- available(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2106
- /**
2107
- * @tags User Agreements
2108
- * @name Agreement
2109
- * @summary Agreement
2110
- * @request GET:/user/agreements/contents/{version}/{code}/body.html
2111
- * @secure
2112
- */
2113
- agreement(version: string, code: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2114
- /**
2115
- * @tags User Agreements
2116
- * @name Unsigned
2117
- * @summary Unsigned
2118
- * @request GET:/user/agreements/unsigned
2119
- * @secure
2120
- */
2121
- unsigned(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2122
- /**
2123
- * @tags User Agreements
2124
- * @name AttestStatus
2125
- * @summary Attest status
2126
- * @request POST:/user/professional/attest
2127
- * @secure
2128
- */
2129
- attestStatus(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2130
- /**
2131
- * @tags User Agreements
2132
- * @name Sign
2133
- * @summary Sign
2134
- * @request POST:/user/agreements/sign
2135
- * @secure
2136
- */
2137
- sign(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2138
- /**
2139
- * @tags User Agreements
2140
- * @name CryptoAgreement
2141
- * @summary Crypto Agreement
2142
- * @request GET:/user/agreements/crypto/Agreement
2143
- * @secure
2144
- */
2145
- cryptoAgreement(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2146
- /**
2147
- * @tags User Agreements
2148
- * @name CryptoSign
2149
- * @summary Crypto Sign
2150
- * @request POST:/user/agreements/crypto/sign
2151
- * @secure
2152
- */
2153
- cryptoSign(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2154
- }
2155
2421
  export class UserAttachedBanks<HandleError extends boolean = boolean> {
2156
2422
  protected readonly apiClient: JwtClient<HandleError>;
2157
2423
  constructor(apiClient: JwtClient<HandleError>);
@@ -2184,6 +2450,47 @@ export class UserAttachedBanks<HandleError extends boolean = boolean> {
2184
2450
  account?: any;
2185
2451
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2186
2452
  }
2453
+ export class UserProfitLoss<HandleError extends boolean = boolean> {
2454
+ protected readonly apiClient: JwtClient<HandleError>;
2455
+ constructor(apiClient: JwtClient<HandleError>);
2456
+ /**
2457
+ * @tags User Profit Loss
2458
+ * @name ReportRequest
2459
+ * @summary Report Request
2460
+ * @request POST:/user/pal/submit
2461
+ * @secure
2462
+ */
2463
+ reportRequest(data: {
2464
+ /** @example "{account number}" */
2465
+ account?: any;
2466
+ /** @example "{timestamp}" */
2467
+ from?: any;
2468
+ /** @example "{timestamp}" */
2469
+ until?: any;
2470
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2471
+ /**
2472
+ * @tags User Profit Loss
2473
+ * @name StatusCheck
2474
+ * @summary Status check
2475
+ * @request GET:/user/pal/status
2476
+ * @secure
2477
+ */
2478
+ statusCheck(query?: {
2479
+ /** @example "643eaa24e00691406cbaa72f" */
2480
+ requestId?: any;
2481
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2482
+ /**
2483
+ * @tags User Profit Loss
2484
+ * @name Report
2485
+ * @summary Report
2486
+ * @request GET:/user/pal/report
2487
+ * @secure
2488
+ */
2489
+ report(query?: {
2490
+ /** @example "643eaa24e00691406cbaa72f" */
2491
+ requestId?: any;
2492
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2493
+ }
2187
2494
  export class UserWatchlists<HandleError extends boolean = boolean> {
2188
2495
  protected readonly apiClient: JwtClient<HandleError>;
2189
2496
  constructor(apiClient: JwtClient<HandleError>);
@@ -2226,48 +2533,67 @@ export class UserWatchlists<HandleError extends boolean = boolean> {
2226
2533
  * @request POST:/user/v2/watchlist/removeEntry
2227
2534
  * @secure
2228
2535
  */
2229
- removeFromWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2230
- }
2231
- export class UserProfitLoss<HandleError extends boolean = boolean> {
2232
- protected readonly apiClient: JwtClient<HandleError>;
2233
- constructor(apiClient: JwtClient<HandleError>);
2536
+ removeFromWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2537
+ }
2538
+ export class UserAgreements<HandleError extends boolean = boolean> {
2539
+ protected readonly apiClient: JwtClient<HandleError>;
2540
+ constructor(apiClient: JwtClient<HandleError>);
2541
+ /**
2542
+ * @tags User Agreements
2543
+ * @name Available
2544
+ * @summary Available
2545
+ * @request GET:/user/agreements/all/active
2546
+ * @secure
2547
+ */
2548
+ available(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2549
+ /**
2550
+ * @tags User Agreements
2551
+ * @name Agreement
2552
+ * @summary Agreement
2553
+ * @request GET:/user/agreements/contents/{version}/{code}/body.html
2554
+ * @secure
2555
+ */
2556
+ agreement(version: string, code: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2557
+ /**
2558
+ * @tags User Agreements
2559
+ * @name Unsigned
2560
+ * @summary Unsigned
2561
+ * @request GET:/user/agreements/unsigned
2562
+ * @secure
2563
+ */
2564
+ unsigned(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2565
+ /**
2566
+ * @tags User Agreements
2567
+ * @name AttestStatus
2568
+ * @summary Attest status
2569
+ * @request POST:/user/professional/attest
2570
+ * @secure
2571
+ */
2572
+ attestStatus(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2234
2573
  /**
2235
- * @tags User Profit Loss
2236
- * @name ReportRequest
2237
- * @summary Report Request
2238
- * @request POST:/user/pal/submit
2574
+ * @tags User Agreements
2575
+ * @name Sign
2576
+ * @summary Sign
2577
+ * @request POST:/user/agreements/sign
2239
2578
  * @secure
2240
2579
  */
2241
- reportRequest(data: {
2242
- /** @example "{account number}" */
2243
- account?: any;
2244
- /** @example "{timestamp}" */
2245
- from?: any;
2246
- /** @example "{timestamp}" */
2247
- until?: any;
2248
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2580
+ sign(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2249
2581
  /**
2250
- * @tags User Profit Loss
2251
- * @name StatusCheck
2252
- * @summary Status check
2253
- * @request GET:/user/pal/status
2582
+ * @tags User Agreements
2583
+ * @name CryptoAgreement
2584
+ * @summary Crypto Agreement
2585
+ * @request GET:/user/agreements/crypto/Agreement
2254
2586
  * @secure
2255
2587
  */
2256
- statusCheck(query?: {
2257
- /** @example "643eaa24e00691406cbaa72f" */
2258
- requestId?: any;
2259
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2588
+ cryptoAgreement(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2260
2589
  /**
2261
- * @tags User Profit Loss
2262
- * @name Report
2263
- * @summary Report
2264
- * @request GET:/user/pal/report
2590
+ * @tags User Agreements
2591
+ * @name CryptoSign
2592
+ * @summary Crypto Sign
2593
+ * @request POST:/user/agreements/crypto/sign
2265
2594
  * @secure
2266
2595
  */
2267
- report(query?: {
2268
- /** @example "643eaa24e00691406cbaa72f" */
2269
- requestId?: any;
2270
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2596
+ cryptoSign(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2271
2597
  }
2272
2598
  export class User<HandleError extends boolean = boolean> {
2273
2599
  protected readonly apiClient: JwtClient<HandleError>;
@@ -2899,666 +3225,340 @@ export class User<HandleError extends boolean = boolean> {
2899
3225
  passwordChange(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2900
3226
  }
2901
3227
  export class AdvisoryCharges<HandleError extends boolean = boolean> {
2902
- protected readonly apiClient: JwtClient<HandleError>;
2903
- constructor(apiClient: JwtClient<HandleError>);
2904
- /**
2905
- * @tags Advisory Charges
2906
- * @name Search
2907
- * @summary /search
2908
- * @request GET:/v2/charges/search
2909
- * @secure
2910
- */
2911
- search(query?: {
2912
- /**
2913
- * Must be either this or `AccountNumber`
2914
- * @example "12345"
2915
- */
2916
- AccountId?: any;
2917
- /**
2918
- * Must be either this or `AccountId`
2919
- * @example "AB321654"
2920
- */
2921
- AccountNumber?: any;
2922
- /**
2923
- * `optional` - defaults to today
2924
- * @example "7/1/2018"
2925
- */
2926
- DateFrom?: any;
2927
- /**
2928
- * `optional`
2929
- * @example "7/1/2018"
2930
- */
2931
- DateTo?: any;
2932
- /**
2933
- * `optional`
2934
- * @example "CH321654"
2935
- */
2936
- ChargeRef?: any;
2937
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2938
- /**
2939
- * @tags Advisory Charges
2940
- * @name Apply
2941
- * @summary /apply
2942
- * @request POST:/v2/charges/apply
2943
- * @secure
2944
- */
2945
- apply(data: {
2946
- /** @example 1234 */
2947
- accountId?: any;
2948
- /** @example 7.11 */
2949
- amount?: any;
2950
- /** @example "{timestamp}" */
2951
- date?: any;
2952
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2953
- /**
2954
- * @tags Advisory Charges
2955
- * @name Cancel
2956
- * @summary /cancel
2957
- * @request POST:/v2/charges/cancel
2958
- * @secure
2959
- */
2960
- cancel(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2961
- }
2962
- export class AdvisoryModels<HandleError extends boolean = boolean> {
2963
- protected readonly apiClient: JwtClient<HandleError>;
2964
- constructor(apiClient: JwtClient<HandleError>);
2965
- /**
2966
- * @tags Advisory Models
2967
- * @name Listing
2968
- * @summary Listing
2969
- * @request GET:/v2/advisory/models
2970
- * @secure
2971
- */
2972
- listing(query?: {
2973
- /**
2974
- * true|false
2975
- * @example "false"
2976
- */
2977
- loadQuotes?: any;
2978
- /**
2979
- * true|false
2980
- * @example "false"
2981
- */
2982
- loadAccounts?: any;
2983
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2984
- /**
2985
- * @tags Advisory Models
2986
- * @name ModelsByAccount
2987
- * @summary Models by account
2988
- * @request GET:/v2/advisory/modelsOfAccount
2989
- * @secure
2990
- */
2991
- modelsByAccount(query?: {
2992
- /** @example "" */
2993
- accountId?: any;
2994
- /** @example "" */
2995
- account?: any;
2996
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2997
- /**
2998
- * @tags Advisory Models
2999
- * @name ComponentTags
3000
- * @summary Component tags
3001
- * @request GET:/v2/advisory/models/components/tags
3002
- * @secure
3003
- */
3004
- componentTags(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3005
- /**
3006
- * @tags Advisory Models
3007
- * @name BuyingPower
3008
- * @summary Buying power
3009
- * @request GET:/v2/advisory/model/balance/{currency}/{modelId}
3010
- * @secure
3011
- */
3012
- buyingPower(currency: string, modelId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3013
- /**
3014
- * @tags Advisory Models
3015
- * @name RealtimeBalance
3016
- * @summary Realtime balance
3017
- * @request GET:/v2/advisory/model/rtb/{modelId}
3018
- * @secure
3019
- */
3020
- realtimeBalance(modelId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3021
- /**
3022
- * @tags Advisory Models
3023
- * @name RealtimeBalanceHistory
3024
- * @summary Realtime balance history
3025
- * @request GET:/v2/advisory/model/rtb/history/{modelId}
3026
- * @secure
3027
- */
3028
- realtimeBalanceHistory(modelId: string, query?: {
3029
- /** First page is 0 */
3030
- page?: any;
3031
- /** Number of entries per page. Defaults to 1,000 */
3032
- count?: any;
3033
- dateFrom?: any;
3034
- dateTo?: any;
3035
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3036
- /**
3037
- * @tags Advisory Models
3038
- * @name Adjustments
3039
- * @summary Adjustments
3040
- * @request GET:/v2/advisory/model/adjustments/{modelId}
3041
- * @secure
3042
- */
3043
- adjustments(modelId: string, query?: {
3044
- /**
3045
- * true|false
3046
- * @example "false"
3047
- */
3048
- loadQuotes?: any;
3049
- /** Pending, Active, Complete, Rejected, Cancelled */
3050
- status?: any;
3051
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3052
- /**
3053
- * @tags Advisory Models
3054
- * @name AdjustmentPreview
3055
- * @summary Adjustment preview
3056
- * @request GET:/v2/advisory/model/adjustments/preview/{adjustmentId}
3057
- * @secure
3058
- */
3059
- adjustmentPreview(adjustmentId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3060
- /**
3061
- * @tags Advisory Models
3062
- * @name MemberAccounts
3063
- * @summary Member accounts
3064
- * @request GET:/v2/advisory/model/accounts/{modelId}
3065
- * @secure
3066
- */
3067
- memberAccounts(modelId: string, query?: {
3068
- /**
3069
- * `true`|`false` - whether or not to load account's realtime balance
3070
- * @example "false"
3071
- */
3072
- loadRtb?: any;
3073
- /**
3074
- * `true`|`false` - whether or not to load account's 3 months of balance history
3075
- * @example "false"
3076
- */
3077
- loadRtbHistory?: any;
3078
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3079
- /**
3080
- * @tags Advisory Models
3081
- * @name OrphanedAccounts
3082
- * @summary Orphaned accounts
3083
- * @request GET:/v2/advisory/model/accounts/orphaned
3084
- * @secure
3085
- */
3086
- orphanedAccounts(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3087
- /**
3088
- * @tags Advisory Models
3089
- * @name MemberAccountStatistics
3090
- * @summary Member account statistics
3091
- * @request GET:/v2/advisory/model/accounts/stats/{modelId}
3092
- * @secure
3093
- */
3094
- memberAccountStatistics(modelId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3095
- /**
3096
- * @tags Advisory Models
3097
- * @name MemberRealtimeBalances
3098
- * @summary Member realtime balances
3099
- * @request GET:/v2/advisory/model/rtbs/{modelId}
3100
- * @secure
3101
- */
3102
- memberRealtimeBalances(modelId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3103
- /**
3104
- * @tags Advisory Models
3105
- * @name Portfolio
3106
- * @summary Portfolio
3107
- * @request GET:/v2/advisory/model/portfolios/{modelId}
3228
+ protected readonly apiClient: JwtClient<HandleError>;
3229
+ constructor(apiClient: JwtClient<HandleError>);
3230
+ /**
3231
+ * @tags Advisory Charges
3232
+ * @name Search
3233
+ * @summary /search
3234
+ * @request GET:/v2/charges/search
3108
3235
  * @secure
3109
3236
  */
3110
- portfolio(modelId: string, query?: {
3237
+ search(query?: {
3111
3238
  /**
3112
- * Should load quotes or not.
3113
- * @example "false"
3239
+ * Must be either this or `AccountNumber`
3240
+ * @example "12345"
3114
3241
  */
3115
- loadQuotes?: any;
3242
+ AccountId?: any;
3116
3243
  /**
3117
- * Whether to return combined portfolio (no accounts, with approximate prices)
3118
- * @example "false"
3244
+ * Must be either this or `AccountId`
3245
+ * @example "AB321654"
3119
3246
  */
3120
- combined?: any;
3121
- /** @example "false" */
3122
- loadIndustries?: any;
3123
- /** @example "false" */
3124
- loadUpgrades?: any;
3125
- /** @example "false" */
3126
- loadEarnings?: any;
3247
+ AccountNumber?: any;
3127
3248
  /**
3128
- * Whether or not to include orders comprising each position's cost
3129
- * @example "false"
3249
+ * `optional` - defaults to today
3250
+ * @example "7/1/2018"
3130
3251
  */
3131
- loadCost?: any;
3252
+ DateFrom?: any;
3132
3253
  /**
3133
- * Analyze market caps and get `marketCapWeights`. To be used in conjuction with `loadQuotes`
3134
- * @example "false"
3254
+ * `optional`
3255
+ * @example "7/1/2018"
3135
3256
  */
3136
- marketCapWeights?: any;
3137
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3138
- /**
3139
- * @tags Advisory Models
3140
- * @name AllModelBuyingPower
3141
- * @summary All model buying power
3142
- * @request GET:/v2/advisory/model/balances/{currency}
3143
- * @secure
3144
- */
3145
- allModelBuyingPower(currency: string, query?: {
3257
+ DateTo?: any;
3146
3258
  /**
3147
- * [optional] when omitted defaults to system's setting.
3148
- * @example "USD"
3259
+ * `optional`
3260
+ * @example "CH321654"
3149
3261
  */
3150
- currency?: any;
3151
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3152
- /**
3153
- * @tags Advisory Models
3154
- * @name PositionLookup
3155
- * @summary Position lookup
3156
- * @request GET:/v2/advisory/model/position/equity/{modelId}
3157
- * @secure
3158
- */
3159
- positionLookup(modelId: string, query?: {
3160
- symbol?: any;
3262
+ ChargeRef?: any;
3161
3263
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3162
3264
  /**
3163
- * @tags Advisory Models
3164
- * @name PositionLookupOptions
3165
- * @summary Position lookup (options)
3166
- * @request GET:/v2/advisory/model/position/option/{modelId}
3265
+ * @tags Advisory Charges
3266
+ * @name Apply
3267
+ * @summary /apply
3268
+ * @request POST:/v2/charges/apply
3167
3269
  * @secure
3168
3270
  */
3169
- positionLookupOptions(modelId: string, query?: {
3170
- symbol?: any;
3271
+ apply(data: {
3272
+ /** @example 1234 */
3273
+ accountId?: any;
3274
+ /** @example 7.11 */
3275
+ amount?: any;
3276
+ /** @example "{timestamp}" */
3277
+ date?: any;
3171
3278
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3172
3279
  /**
3173
- * @tags Advisory Models
3174
- * @name AdjustmentUpdates
3175
- * @summary Adjustment updates
3176
- * @request POST:/v2/advisory/model/adjustments/modify/{action}
3177
- * @secure
3178
- */
3179
- adjustmentUpdates(action: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3180
- /**
3181
- * @tags Advisory Models
3182
- * @name Creation
3183
- * @summary Creation
3184
- * @request POST:/v2/advisory/model/create
3280
+ * @tags Advisory Charges
3281
+ * @name Cancel
3282
+ * @summary /cancel
3283
+ * @request POST:/v2/charges/cancel
3185
3284
  * @secure
3186
3285
  */
3187
- creation(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3286
+ cancel(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3287
+ }
3288
+ export class AdvisoryModels<HandleError extends boolean = boolean> {
3289
+ protected readonly apiClient: JwtClient<HandleError>;
3290
+ constructor(apiClient: JwtClient<HandleError>);
3188
3291
  /**
3189
3292
  * @tags Advisory Models
3190
- * @name Update
3191
- * @summary Update
3192
- * @request POST:/v2/advisory/model/update
3293
+ * @name Listing
3294
+ * @summary Listing
3295
+ * @request GET:/v2/advisory/models
3193
3296
  * @secure
3194
3297
  */
3195
- update(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3298
+ listing(query?: {
3299
+ /**
3300
+ * true|false
3301
+ * @example "false"
3302
+ */
3303
+ loadQuotes?: any;
3304
+ /**
3305
+ * true|false
3306
+ * @example "false"
3307
+ */
3308
+ loadAccounts?: any;
3309
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3196
3310
  /**
3197
3311
  * @tags Advisory Models
3198
- * @name Deletion
3199
- * @summary Deletion
3200
- * @request POST:/v2/advisory/model/delete
3312
+ * @name ModelsByAccount
3313
+ * @summary Models by account
3314
+ * @request GET:/v2/advisory/modelsOfAccount
3201
3315
  * @secure
3202
3316
  */
3203
- deletion(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3317
+ modelsByAccount(query?: {
3318
+ /** @example "" */
3319
+ accountId?: any;
3320
+ /** @example "" */
3321
+ account?: any;
3322
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3204
3323
  /**
3205
3324
  * @tags Advisory Models
3206
- * @name ComponentUpdate
3207
- * @summary Component update
3208
- * @request POST:/v2/advisory/model/component/update
3325
+ * @name ComponentTags
3326
+ * @summary Component tags
3327
+ * @request GET:/v2/advisory/models/components/tags
3209
3328
  * @secure
3210
3329
  */
3211
- componentUpdate(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3330
+ componentTags(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3212
3331
  /**
3213
3332
  * @tags Advisory Models
3214
- * @name LinkOfMemberAccounts
3215
- * @summary Link of member accounts
3216
- * @request POST:/v2/advisory/model/account/link
3333
+ * @name BuyingPower
3334
+ * @summary Buying power
3335
+ * @request GET:/v2/advisory/model/balance/{currency}/{modelId}
3217
3336
  * @secure
3218
3337
  */
3219
- linkOfMemberAccounts(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3338
+ buyingPower(currency: string, modelId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3220
3339
  /**
3221
3340
  * @tags Advisory Models
3222
- * @name UnlinkMemberAccount
3223
- * @summary Unlink member account
3224
- * @request POST:/v2/advisory/model/account/unlink
3341
+ * @name RealtimeBalance
3342
+ * @summary Realtime balance
3343
+ * @request GET:/v2/advisory/model/rtb/{modelId}
3225
3344
  * @secure
3226
3345
  */
3227
- unlinkMemberAccount(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3346
+ realtimeBalance(modelId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3228
3347
  /**
3229
3348
  * @tags Advisory Models
3230
- * @name Allocations
3231
- * @summary Allocations
3232
- * @request POST:/v2/advisory/model/orders/allocate
3233
- * @secure
3234
- */
3235
- allocations(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3236
- }
3237
- export class ResearchIpos<HandleError extends boolean = boolean> {
3238
- protected readonly apiClient: JwtClient<HandleError>;
3239
- constructor(apiClient: JwtClient<HandleError>);
3240
- /**
3241
- * @tags Research Ipos
3242
- * @name Recent
3243
- * @summary Recent
3244
- * @request GET:/research/ipo/recent
3245
- * @secure
3246
- */
3247
- recent(query?: {
3248
- /**
3249
- * `true` or `false` to load quotes
3250
- * @example ""
3251
- */
3252
- loadQuotes?: any;
3253
- /** 1m, 3m*, 6m, 1y */
3254
- time?: any;
3255
- /** symbol, ipoDate, offerPx, shares, day1Ret, ipoRet, last, change, offerSz */
3256
- sort?: any;
3257
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3258
- /**
3259
- * @tags Research Ipos
3260
- * @name Upcoming
3261
- * @summary Upcoming
3262
- * @request GET:/research/ipo/upcoming
3263
- * @secure
3264
- */
3265
- upcoming(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3266
- /**
3267
- * @tags Research Ipos
3268
- * @name Performance
3269
- * @summary Performance
3270
- * @request GET:/research/ipo/performance
3271
- * @secure
3272
- */
3273
- performance(query?: {
3274
- /**
3275
- * `true` or `false` to load quotes
3276
- * @example "false"
3277
- */
3278
- loadQuotes?: any;
3279
- /**
3280
- * 1m, 3m*, 6m, 1y
3281
- * @example "1m"
3282
- */
3283
- time?: any;
3284
- /**
3285
- * shares, day1Ret, ipoRet, last, change, offerSz
3286
- * @example "day1Ret"
3287
- */
3288
- sort?: any;
3289
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3290
- }
3291
- export class Research<HandleError extends boolean = boolean> {
3292
- protected readonly apiClient: JwtClient<HandleError>;
3293
- tipranks: ResearchTipranks<HandleError>;
3294
- etfs: ResearchEtfs<HandleError>;
3295
- adrs: ResearchAdrs<HandleError>;
3296
- corporateActions: ResearchCorporateActions<HandleError>;
3297
- news: ResearchNews<HandleError>;
3298
- alphaTools: ResearchAlphaTools<HandleError>;
3299
- ipos: ResearchIpos<HandleError>;
3300
- constructor(apiClient: JwtClient<HandleError>);
3301
- /**
3302
- * @tags Research
3303
- * @name TopStocks
3304
- * @summary Top Stocks
3305
- * @request GET:/quotes/top10/{category}
3349
+ * @name RealtimeBalanceHistory
3350
+ * @summary Realtime balance history
3351
+ * @request GET:/v2/advisory/model/rtb/history/{modelId}
3306
3352
  * @secure
3307
3353
  */
3308
- topStocks(category: string, query?: {
3309
- /**
3310
- * See table above
3311
- * @example "BIG3"
3312
- */
3313
- market?: any;
3314
- /**
3315
- * See table above
3316
- * @example "H"
3317
- */
3318
- order?: any;
3354
+ realtimeBalanceHistory(modelId: string, query?: {
3355
+ /** First page is 0 */
3356
+ page?: any;
3357
+ /** Number of entries per page. Defaults to 1,000 */
3358
+ count?: any;
3359
+ dateFrom?: any;
3360
+ dateTo?: any;
3361
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3362
+ /**
3363
+ * @tags Advisory Models
3364
+ * @name Adjustments
3365
+ * @summary Adjustments
3366
+ * @request GET:/v2/advisory/model/adjustments/{modelId}
3367
+ * @secure
3368
+ */
3369
+ adjustments(modelId: string, query?: {
3319
3370
  /**
3320
- * Optional. Defaults to 10
3321
- * @example "10"
3371
+ * true|false
3372
+ * @example "false"
3322
3373
  */
3323
- count?: any;
3374
+ loadQuotes?: any;
3375
+ /** Pending, Active, Complete, Rejected, Cancelled */
3376
+ status?: any;
3324
3377
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3325
3378
  /**
3326
- * @tags Research
3327
- * @name CompanyResearch
3328
- * @summary Company Research
3329
- * @request GET:/research/{symbol}
3379
+ * @tags Advisory Models
3380
+ * @name AdjustmentPreview
3381
+ * @summary Adjustment preview
3382
+ * @request GET:/v2/advisory/model/adjustments/preview/{adjustmentId}
3330
3383
  * @secure
3331
3384
  */
3332
- companyResearch(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3385
+ adjustmentPreview(adjustmentId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3333
3386
  /**
3334
- * @tags Research
3335
- * @name OptionRatios
3336
- * @summary Option Ratios
3337
- * @request GET:/research/option/ratios
3387
+ * @tags Advisory Models
3388
+ * @name MemberAccounts
3389
+ * @summary Member accounts
3390
+ * @request GET:/v2/advisory/model/accounts/{modelId}
3338
3391
  * @secure
3339
3392
  */
3340
- optionRatios(query?: {
3393
+ memberAccounts(modelId: string, query?: {
3341
3394
  /**
3342
- * Comma separated list of symbols.
3343
- * @example "AAPL,BABA"
3395
+ * `true`|`false` - whether or not to load account's realtime balance
3396
+ * @example "false"
3344
3397
  */
3345
- symbols?: any;
3398
+ loadRtb?: any;
3399
+ /**
3400
+ * `true`|`false` - whether or not to load account's 3 months of balance history
3401
+ * @example "false"
3402
+ */
3403
+ loadRtbHistory?: any;
3346
3404
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3347
3405
  /**
3348
- * @tags Research
3349
- * @name OptionRadar
3350
- * @summary Option Radar
3351
- * @request GET:/research/option/radar
3406
+ * @tags Advisory Models
3407
+ * @name OrphanedAccounts
3408
+ * @summary Orphaned accounts
3409
+ * @request GET:/v2/advisory/model/accounts/orphaned
3352
3410
  * @secure
3353
3411
  */
3354
- optionRadar(query?: {
3355
- /**
3356
- * See table above. Leaving blank returns an overview of all of them.
3357
- * @example ""
3358
- */
3359
- filter?: any;
3360
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3412
+ orphanedAccounts(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3361
3413
  /**
3362
- * @tags Research
3363
- * @name IndexComponents
3364
- * @summary Index Components
3365
- * @request GET:/research/index/components/{index}
3414
+ * @tags Advisory Models
3415
+ * @name MemberAccountStatistics
3416
+ * @summary Member account statistics
3417
+ * @request GET:/v2/advisory/model/accounts/stats/{modelId}
3366
3418
  * @secure
3367
3419
  */
3368
- indexComponents(index: string, query?: {
3369
- /**
3370
- * `true` or `false` to load quotes
3371
- * @example "true"
3372
- */
3373
- loadQuotes?: any;
3374
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3420
+ memberAccountStatistics(modelId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3375
3421
  /**
3376
- * @tags Research
3377
- * @name StockUpgrades
3378
- * @summary Stock Upgrades
3379
- * @request GET:/research/upgrades
3422
+ * @tags Advisory Models
3423
+ * @name MemberRealtimeBalances
3424
+ * @summary Member realtime balances
3425
+ * @request GET:/v2/advisory/model/rtbs/{modelId}
3380
3426
  * @secure
3381
3427
  */
3382
- stockUpgrades(query?: {
3383
- /**
3384
- * Comma separated list of symbols
3385
- * @example "AAPL"
3386
- */
3387
- symbols?: any;
3388
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3428
+ memberRealtimeBalances(modelId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3389
3429
  /**
3390
- * @tags Research
3391
- * @name OwnershipDetails
3392
- * @summary Ownership Details
3393
- * @request GET:/research/ownerships/details
3430
+ * @tags Advisory Models
3431
+ * @name Portfolio
3432
+ * @summary Portfolio
3433
+ * @request GET:/v2/advisory/model/portfolios/{modelId}
3394
3434
  * @secure
3395
3435
  */
3396
- ownershipDetails(query?: {
3397
- /**
3398
- * Comma separated list of tickers
3399
- * @example "MSFT,GOOG"
3400
- */
3401
- symbols?: any;
3436
+ portfolio(modelId: string, query?: {
3402
3437
  /**
3403
- * One of `ALL`, `INSTITUTIONAL`, `FUND`, `INSIDER`
3404
- * @example "ALL"
3438
+ * Should load quotes or not.
3439
+ * @example "false"
3405
3440
  */
3406
- filter?: any;
3441
+ loadQuotes?: any;
3407
3442
  /**
3408
- * One of `portfolio`, `ownership`, `market`
3409
- * @example "portfolio"
3443
+ * Whether to return combined portfolio (no accounts, with approximate prices)
3444
+ * @example "false"
3410
3445
  */
3411
- sort?: any;
3446
+ combined?: any;
3447
+ /** @example "false" */
3448
+ loadIndustries?: any;
3449
+ /** @example "false" */
3450
+ loadUpgrades?: any;
3451
+ /** @example "false" */
3452
+ loadEarnings?: any;
3412
3453
  /**
3413
- * Number of items per page
3414
- * @example "20"
3454
+ * Whether or not to include orders comprising each position's cost
3455
+ * @example "false"
3415
3456
  */
3416
- count?: any;
3457
+ loadCost?: any;
3417
3458
  /**
3418
- * Page num (first page is zero)
3419
- * @example "0"
3459
+ * Analyze market caps and get `marketCapWeights`. To be used in conjuction with `loadQuotes`
3460
+ * @example "false"
3420
3461
  */
3421
- page?: any;
3462
+ marketCapWeights?: any;
3422
3463
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3423
3464
  /**
3424
- * @tags Research
3425
- * @name OwnerDetails
3426
- * @summary Owner Details
3427
- * @request GET:/research/owner/details
3465
+ * @tags Advisory Models
3466
+ * @name AllModelBuyingPower
3467
+ * @summary All model buying power
3468
+ * @request GET:/v2/advisory/model/balances/{currency}
3428
3469
  * @secure
3429
3470
  */
3430
- ownerDetails(query?: {
3471
+ allModelBuyingPower(currency: string, query?: {
3431
3472
  /**
3432
- * Comma separated list of owner IDs
3433
- * @example "PS000000YH,PS000004TI"
3473
+ * [optional] when omitted defaults to system's setting.
3474
+ * @example "USD"
3434
3475
  */
3435
- ids?: any;
3476
+ currency?: any;
3436
3477
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3437
3478
  /**
3438
- * @tags Research
3439
- * @name EarningsCalendar
3440
- * @summary Earnings Calendar
3441
- * @request GET:/research/earnings
3479
+ * @tags Advisory Models
3480
+ * @name PositionLookup
3481
+ * @summary Position lookup
3482
+ * @request GET:/v2/advisory/model/position/equity/{modelId}
3442
3483
  * @secure
3443
3484
  */
3444
- earningsCalendar(query?: {
3445
- /**
3446
- * (Optional) Exclude Otcs from data.
3447
- * @example "true"
3448
- */
3449
- excludeOtcs?: any;
3450
- /**
3451
- * (Optional) Number of days in the future. Default is 7.
3452
- * @example "90"
3453
- */
3454
- days?: any;
3455
- /**
3456
- * `true`|`false`
3457
- * @example "false"
3458
- */
3459
- loadQuotes?: any;
3460
- /**
3461
- * (Optional) Use to filter results only to selected symbols. Excluding this parameter gives all upcoming earnings.
3462
- * @example "AAPL,T,GOOGL"
3463
- */
3464
- symbols?: any;
3485
+ positionLookup(modelId: string, query?: {
3486
+ symbol?: any;
3465
3487
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3466
3488
  /**
3467
- * @tags Research
3468
- * @name Fundamentals
3469
- * @summary Fundamentals
3470
- * @request GET:/research/fundamentals/{type}/{symbol}
3489
+ * @tags Advisory Models
3490
+ * @name PositionLookupOptions
3491
+ * @summary Position lookup (options)
3492
+ * @request GET:/v2/advisory/model/position/option/{modelId}
3471
3493
  * @secure
3472
3494
  */
3473
- fundamentals(type: string, symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3495
+ positionLookupOptions(modelId: string, query?: {
3496
+ symbol?: any;
3497
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3474
3498
  /**
3475
- * @tags Research
3476
- * @name FundamentalTypes
3477
- * @summary Fundamental Types
3478
- * @request GET:/research/fundamentals/types
3499
+ * @tags Advisory Models
3500
+ * @name AdjustmentUpdates
3501
+ * @summary Adjustment updates
3502
+ * @request POST:/v2/advisory/model/adjustments/modify/{action}
3479
3503
  * @secure
3480
3504
  */
3481
- fundamentalTypes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3505
+ adjustmentUpdates(action: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3482
3506
  /**
3483
- * @tags Research
3484
- * @name Screener
3485
- * @summary Screener
3486
- * @request POST:/research/screener
3507
+ * @tags Advisory Models
3508
+ * @name Creation
3509
+ * @summary Creation
3510
+ * @request POST:/v2/advisory/model/create
3487
3511
  * @secure
3488
3512
  */
3489
- screener(data: {
3490
- /** @example 2 */
3491
- limit?: any;
3492
- /** @example [{"comparator":"Equals","dateRange":{"lowerBound":"01-01-2020","upperBound":"10-05-2020"},"field":"Industry","value":10280010}] */
3493
- queries?: any;
3494
- /** @example 0 */
3495
- start?: any;
3496
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3513
+ creation(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3497
3514
  /**
3498
- * @tags Research
3499
- * @name IndustryHeatMap
3500
- * @summary Industry Heat Map
3501
- * @request GET:/research/heatMap/industryRanking
3515
+ * @tags Advisory Models
3516
+ * @name Update
3517
+ * @summary Update
3518
+ * @request POST:/v2/advisory/model/update
3502
3519
  * @secure
3503
3520
  */
3504
- industryHeatMap(query?: {
3505
- /**
3506
- * Can be one of the following:
3507
- * Sector| Group | Industry | SubIndustry
3508
- * @example "group"
3509
- */
3510
- industryType?: any;
3511
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3521
+ update(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3512
3522
  /**
3513
- * @tags Research
3514
- * @name IndustryList
3515
- * @summary Industry List
3516
- * @request GET:/
3523
+ * @tags Advisory Models
3524
+ * @name Deletion
3525
+ * @summary Deletion
3526
+ * @request POST:/v2/advisory/model/delete
3527
+ * @secure
3528
+ */
3529
+ deletion(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3530
+ /**
3531
+ * @tags Advisory Models
3532
+ * @name ComponentUpdate
3533
+ * @summary Component update
3534
+ * @request POST:/v2/advisory/model/component/update
3517
3535
  * @secure
3518
3536
  */
3519
- industryList(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3537
+ componentUpdate(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3520
3538
  /**
3521
- * @tags Research
3522
- * @name SymbolHeatMap
3523
- * @summary Symbol Heat Map
3524
- * @request GET:/research/heatMap/symbols
3539
+ * @tags Advisory Models
3540
+ * @name LinkOfMemberAccounts
3541
+ * @summary Link of member accounts
3542
+ * @request POST:/v2/advisory/model/account/link
3525
3543
  * @secure
3526
3544
  */
3527
- symbolHeatMap(query?: {
3528
- /** filter out by last price. 0 = no filter; 1 = lastPrice < 5.0; 2 = lastPrice < 1.0; 3 = lastPrice < 1.0 or lastPrice > 5.0; 4 = lastPrice > 1.0; 5 = lastPrice > 5.0 */
3529
- amountLimit?: any;
3530
- /** 0 indicates no filter, 1 indicates only NYSE, NASDAQ, AMEX. */
3531
- exchangeFilter?: any;
3532
- /** obtain from research/heatMap/industryRanking */
3533
- industryCode?: any;
3534
- /** max number of symbols returned */
3535
- numSymbols?: any;
3536
- /**
3537
- * `true` or `false`. true = top symbols change by price;
3538
- * false = bottom symbols channged by price.
3539
- */
3540
- top?: any;
3541
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3545
+ linkOfMemberAccounts(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3542
3546
  /**
3543
- * @tags Research
3544
- * @name IndexOverview
3545
- * @summary Index Overview
3546
- * @request GET:/research/marketOverview
3547
+ * @tags Advisory Models
3548
+ * @name UnlinkMemberAccount
3549
+ * @summary Unlink member account
3550
+ * @request POST:/v2/advisory/model/account/unlink
3547
3551
  * @secure
3548
3552
  */
3549
- indexOverview(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3553
+ unlinkMemberAccount(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3550
3554
  /**
3551
- * @tags Research
3552
- * @name HistoricalData
3553
- * @summary Historical Data
3554
- * @request GET:/research/historicalPrices
3555
+ * @tags Advisory Models
3556
+ * @name Allocations
3557
+ * @summary Allocations
3558
+ * @request POST:/v2/advisory/model/orders/allocate
3555
3559
  * @secure
3556
3560
  */
3557
- historicalData(query?: {
3558
- symbol?: any;
3559
- /** comma saperated values. each value is started with number, following `w`, `m`, or `y`. w=week, m=month, y=year. For example, to get historical price last year and last two month, dates=1y,2m */
3560
- dates?: any;
3561
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3561
+ allocations(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3562
3562
  }
3563
3563
  export class AdvisoryUserAccountManagement<HandleError extends boolean = boolean> {
3564
3564
  protected readonly apiClient: JwtClient<HandleError>;
@@ -3719,361 +3719,117 @@ export class AdvisoryAnalytics<HandleError extends boolean = boolean> {
3719
3719
  * @secure
3720
3720
  */
3721
3721
  overexposureAnalysis(type: string, scope: string, id: string, query?: {
3722
- /**
3723
- * Threshold of 70% or greater
3724
- * @example ".7"
3725
- */
3726
- threshold?: any;
3727
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3728
- /**
3729
- * @tags Advisory Analytics
3730
- * @name RealtimeBalanceBreakdown
3731
- * @summary Realtime balance breakdown
3732
- * @request GET:/v2/advisory/analytics/breakdown/rtbs/{modelId}
3733
- * @secure
3734
- */
3735
- realtimeBalanceBreakdown(modelId: string, query?: {
3736
- /**
3737
- * Bucket size
3738
- * @example "10000"
3739
- */
3740
- bucket?: any;
3741
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3742
- /**
3743
- * @tags Advisory Analytics
3744
- * @name ModelPerformance
3745
- * @summary Model performance
3746
- * @request GET:/v2/advisory/analytics/model/performance/{modelId}/{range}
3747
- * @secure
3748
- */
3749
- modelPerformance(modelId: string, range: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3750
- /**
3751
- * @tags Advisory Analytics
3752
- * @name ModelDriftReport
3753
- * @summary Model drift report
3754
- * @request GET:/v2/advisory/analytics/model/drift/{modelId}
3755
- * @secure
3756
- */
3757
- modelDriftReport(modelId: string, query?: {
3758
- /**
3759
- * `optional` - specifies threshold (10% default)
3760
- * @example ".1"
3761
- */
3762
- threshold?: any;
3763
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3764
- }
3765
- export class Device<HandleError extends boolean = boolean> {
3766
- protected readonly apiClient: JwtClient<HandleError>;
3767
- constructor(apiClient: JwtClient<HandleError>);
3768
- /**
3769
- * @tags Device
3770
- * @name DeviceDeactivate
3771
- * @summary /device/deactivate
3772
- * @request POST:/device/deactivate
3773
- * @secure
3774
- */
3775
- deviceDeactivate(data: {
3776
- /**
3777
- * Token previously registered
3778
- * @example "123456789"
3779
- */
3780
- Token?: string;
3781
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3782
- }
3783
- export class AdvisoryAllocations<HandleError extends boolean = boolean> {
3784
- protected readonly apiClient: JwtClient<HandleError>;
3785
- constructor(apiClient: JwtClient<HandleError>);
3786
- /**
3787
- * @tags Advisory Allocations
3788
- * @name SearchNa
3789
- * @summary Search (n/a)
3790
- * @request GET:/v2/allocations/search
3791
- * @secure
3792
- */
3793
- searchNa(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3794
- /**
3795
- * @tags Advisory Allocations
3796
- * @name Details
3797
- * @summary Details
3798
- * @request GET:/v2/allocations/details/{allocationRef}
3799
- * @secure
3800
- */
3801
- details(allocationRef: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3802
- /**
3803
- * @tags Advisory Allocations
3804
- * @name Cancel
3805
- * @summary Cancel
3806
- * @request POST:/v2/allocations/cancel
3807
- * @secure
3808
- */
3809
- cancel(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3810
- /**
3811
- * @tags Advisory Allocations
3812
- * @name Validation
3813
- * @summary Validation
3814
- * @request POST:/v2/allocations/validate
3815
- * @secure
3816
- */
3817
- validation(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3818
- /**
3819
- * @tags Advisory Allocations
3820
- * @name Scheduling
3821
- * @summary Scheduling
3822
- * @request POST:/v2/allocations/preallocate
3823
- * @secure
3824
- */
3825
- scheduling(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3826
- /**
3827
- * @tags Advisory Allocations
3828
- * @name Trigger
3829
- * @summary Trigger
3830
- * @request POST:/v2/allocations/trigger
3831
- * @secure
3832
- */
3833
- trigger(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3834
- }
3835
- export class TransfersRelationships<HandleError extends boolean = boolean> {
3836
- protected readonly apiClient: JwtClient<HandleError>;
3837
- constructor(apiClient: JwtClient<HandleError>);
3838
- /**
3839
- * @tags Transfers Relationships
3840
- * @name List
3841
- * @summary List
3842
- * @request GET:/transfer/relationship/list/{account}
3843
- * @secure
3844
- */
3845
- list(account: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3846
- /**
3847
- * @tags Transfers Relationships
3848
- * @name GetInfo
3849
- * @summary Get Info
3850
- * @request GET:/transfer/relationship/get
3851
- * @secure
3852
- */
3853
- getInfo(query?: {
3854
- /**
3855
- * Account number
3856
- * @example "ABC123"
3857
- */
3858
- account?: any;
3859
- /**
3860
- * Desired entry ID
3861
- * @example "123"
3862
- */
3863
- entryId?: any;
3864
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3865
- /**
3866
- * @tags Transfers Relationships
3867
- * @name PaymentMethods
3868
- * @summary Payment methods
3869
- * @request GET:/transfer/bank/paymentMethods
3870
- * @secure
3871
- */
3872
- paymentMethods(query?: {
3873
- /** @example "IND" */
3874
- country?: any;
3875
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3876
- /**
3877
- * @tags Transfers Relationships
3878
- * @name PaymentMethodsViaAddress
3879
- * @summary Payment methods (via address)
3880
- * @request POST:/transfer/bank/paymentMethods
3881
- * @secure
3882
- */
3883
- paymentMethodsViaAddress(data: {
3884
- /** @example "Mumbai" */
3885
- city?: any;
3886
- /** @example "IND" */
3887
- country?: any;
3888
- /** @example "400018" */
3889
- postalCode?: any;
3890
- /** @example "Maharashtra" */
3891
- stateProvince?: any;
3892
- /** @example ["716 /a, Poonam Chem, Dr.annie Besant Road, Opp.atre Mall, Worli"] */
3893
- streetAddress?: any;
3894
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3895
- /**
3896
- * @tags Transfers Relationships
3897
- * @name BankCodes
3898
- * @summary Bank Codes
3899
- * @request GET:/transfer/bank/bankCodes
3900
- * @secure
3901
- */
3902
- bankCodes(query?: {
3903
- /** @example "IND|MEX" */
3904
- country?: any;
3905
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3906
- /**
3907
- * @tags Transfers Relationships
3908
- * @name BankCodesViaAddress
3909
- * @summary Bank Codes (via address)
3910
- * @request POST:/transfer/bank/bankCodes
3911
- * @secure
3912
- */
3913
- bankCodesViaAddress(data: {
3914
- /** @example "Mumbai" */
3915
- city?: any;
3916
- /** @example "IND" */
3917
- country?: any;
3918
- /** @example "400018" */
3919
- postalCode?: any;
3920
- /** @example "Maharashtra" */
3921
- stateProvince?: any;
3922
- /** @example ["716 /a, Poonam Chem, Dr.annie Besant Road, Opp.atre Mall, Worli"] */
3923
- streetAddress?: any;
3722
+ /**
3723
+ * Threshold of 70% or greater
3724
+ * @example ".7"
3725
+ */
3726
+ threshold?: any;
3924
3727
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3925
3728
  /**
3926
- * @tags Transfers Relationships
3927
- * @name Create
3928
- * @summary Create
3929
- * @request POST:/transfer/relationship/create
3729
+ * @tags Advisory Analytics
3730
+ * @name RealtimeBalanceBreakdown
3731
+ * @summary Realtime balance breakdown
3732
+ * @request GET:/v2/advisory/analytics/breakdown/rtbs/{modelId}
3930
3733
  * @secure
3931
3734
  */
3932
- create(data: {
3933
- /** @example "5VA0XXXX" */
3934
- account?: any;
3935
- /** @example "111111" */
3936
- bankAccount?: any;
3937
- /** @example "John Doe" */
3938
- bankAccountOwnerName?: any;
3939
- /** @example "CHECKING" */
3940
- bankAccountType?: any;
3941
- /** @example "010101010" */
3942
- bankRoutingNumber?: any;
3943
- /** @example "Test" */
3944
- nickname?: any;
3735
+ realtimeBalanceBreakdown(modelId: string, query?: {
3736
+ /**
3737
+ * Bucket size
3738
+ * @example "10000"
3739
+ */
3740
+ bucket?: any;
3945
3741
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3946
3742
  /**
3947
- * @tags Transfers Relationships
3948
- * @name WireInformation
3949
- * @summary Wire information
3950
- * @request POST:/transfer/relationship/wire/create
3743
+ * @tags Advisory Analytics
3744
+ * @name ModelPerformance
3745
+ * @summary Model performance
3746
+ * @request GET:/v2/advisory/analytics/model/performance/{modelId}/{range}
3951
3747
  * @secure
3952
3748
  */
3953
- wireInformation(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3749
+ modelPerformance(modelId: string, range: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3954
3750
  /**
3955
- * @tags Transfers Relationships
3956
- * @name BankingRelationship
3957
- * @summary Banking relationship
3958
- * @request POST:/transfer/relationship/bank/create
3751
+ * @tags Advisory Analytics
3752
+ * @name ModelDriftReport
3753
+ * @summary Model drift report
3754
+ * @request GET:/v2/advisory/analytics/model/drift/{modelId}
3959
3755
  * @secure
3960
3756
  */
3961
- bankingRelationship(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3757
+ modelDriftReport(modelId: string, query?: {
3758
+ /**
3759
+ * `optional` - specifies threshold (10% default)
3760
+ * @example ".1"
3761
+ */
3762
+ threshold?: any;
3763
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3764
+ }
3765
+ export class AdvisoryAllocations<HandleError extends boolean = boolean> {
3766
+ protected readonly apiClient: JwtClient<HandleError>;
3767
+ constructor(apiClient: JwtClient<HandleError>);
3962
3768
  /**
3963
- * @tags Transfers Relationships
3964
- * @name Approve
3965
- * @summary Approve
3966
- * @request POST:/transfer/relationship/approve
3769
+ * @tags Advisory Allocations
3770
+ * @name SearchNa
3771
+ * @summary Search (n/a)
3772
+ * @request GET:/v2/allocations/search
3967
3773
  * @secure
3968
3774
  */
3969
- approve(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3775
+ searchNa(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3970
3776
  /**
3971
- * @tags Transfers Relationships
3972
- * @name Cancel
3973
- * @summary Cancel
3974
- * @request POST:/transfer/relationship/cancel/{entryId}
3777
+ * @tags Advisory Allocations
3778
+ * @name Details
3779
+ * @summary Details
3780
+ * @request GET:/v2/allocations/details/{allocationRef}
3975
3781
  * @secure
3976
3782
  */
3977
- cancel(entryId: string, data: {
3978
- /** @example "2QC05208" */
3979
- account?: any;
3980
- /** @example "USER CANCELED" */
3981
- reason?: any;
3982
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3783
+ details(allocationRef: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3983
3784
  /**
3984
- * @tags Transfers Relationships
3985
- * @name Rename
3986
- * @summary Rename
3987
- * @request POST:/transfer/relationship/rename/{entryId}
3785
+ * @tags Advisory Allocations
3786
+ * @name Cancel
3787
+ * @summary Cancel
3788
+ * @request POST:/v2/allocations/cancel
3988
3789
  * @secure
3989
3790
  */
3990
- rename(entryId: string, data: {
3991
- /** @example "Citi Checking 2" */
3992
- nickname?: any;
3993
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3791
+ cancel(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3994
3792
  /**
3995
- * @tags Transfers Relationships
3996
- * @name AdvisorPolicyUpdate
3997
- * @summary Advisor Policy Update
3998
- * @request POST:/transfer/relationship/policy
3793
+ * @tags Advisory Allocations
3794
+ * @name Validation
3795
+ * @summary Validation
3796
+ * @request POST:/v2/allocations/validate
3999
3797
  * @secure
4000
3798
  */
4001
- advisorPolicyUpdate(data: {
4002
- account?: {
4003
- /** @example 0 */
4004
- accountId?: number;
4005
- /** @example "{optional}" */
4006
- accountNumber?: string;
4007
- };
4008
- /** @example 123 */
4009
- entryId?: any;
4010
- /** @example true */
4011
- esigned?: any;
4012
- /** @example "AllowWithdrawal|Disallow" */
4013
- policy?: any;
4014
- /** @example "" */
4015
- remoteAddr?: any;
4016
- /** @example "" */
4017
- remoteDevice?: any;
4018
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3799
+ validation(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4019
3800
  /**
4020
- * @tags Transfers Relationships
4021
- * @name DocumentUpload
4022
- * @summary Document upload
4023
- * @request POST:/transfer/relationship/wire/upload
3801
+ * @tags Advisory Allocations
3802
+ * @name Scheduling
3803
+ * @summary Scheduling
3804
+ * @request POST:/v2/allocations/preallocate
4024
3805
  * @secure
4025
3806
  */
4026
- documentUpload(data: {
4027
- /**
4028
- * Wire relationship ID
4029
- * @example ""
4030
- */
4031
- entryId?: string;
4032
- /**
4033
- * Document file
4034
- * @format binary
4035
- */
4036
- file?: File;
4037
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3807
+ scheduling(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4038
3808
  /**
4039
- * @tags Transfers Relationships
4040
- * @name MfaReInitiation
4041
- * @summary 2FA re-initiation
4042
- * @request POST:/transfer/relationship/wire/2fa/reinitiate
3809
+ * @tags Advisory Allocations
3810
+ * @name Trigger
3811
+ * @summary Trigger
3812
+ * @request POST:/v2/allocations/trigger
4043
3813
  * @secure
4044
3814
  */
4045
- mfaReInitiation(data: {
4046
- /** @example 123 */
4047
- entryId?: any;
4048
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3815
+ trigger(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3816
+ }
3817
+ export class Device<HandleError extends boolean = boolean> {
3818
+ protected readonly apiClient: JwtClient<HandleError>;
3819
+ constructor(apiClient: JwtClient<HandleError>);
4049
3820
  /**
4050
- * @tags Transfers Relationships
4051
- * @name SupplementWire
4052
- * @summary Supplement wire
4053
- * @request POST:/transfer/relationship/wire/supplement
3821
+ * @tags Device
3822
+ * @name DeviceDeactivate
3823
+ * @summary /device/deactivate
3824
+ * @request POST:/device/deactivate
4054
3825
  * @secure
4055
3826
  */
4056
- supplementWire(data: {
4057
- /** @example 123456 */
4058
- entryId?: any;
4059
- recipientBank?: {
4060
- /** @example "Capital City" */
4061
- city?: string;
4062
- identifier?: {
4063
- /** @example "AAA-123-2587964" */
4064
- id?: string;
4065
- /** @example "BIC" */
4066
- type?: string;
4067
- };
4068
- /** @example "ABC 123" */
4069
- postalCode?: string;
4070
- /** @example "NJ" */
4071
- stateProvince?: string;
4072
- };
4073
- userAccount?: {
4074
- /** @example "AB12345" */
4075
- accountNumber?: string;
4076
- };
3827
+ deviceDeactivate(data: {
3828
+ /**
3829
+ * Token previously registered
3830
+ * @example "123456789"
3831
+ */
3832
+ Token?: string;
4077
3833
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4078
3834
  }
4079
3835
  export class TransfersInstantAccountVerification<HandleError extends boolean = boolean> {
@@ -4155,6 +3911,26 @@ export class TransfersInstantAccountVerification<HandleError extends boolean = b
4155
3911
  remoteDevice?: any;
4156
3912
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4157
3913
  }
3914
+ export class TransfersAch<HandleError extends boolean = boolean> {
3915
+ protected readonly apiClient: JwtClient<HandleError>;
3916
+ constructor(apiClient: JwtClient<HandleError>);
3917
+ /**
3918
+ * @tags Transfers Ach
3919
+ * @name Deposit
3920
+ * @summary Deposit
3921
+ * @request POST:/transfer/ach/deposit
3922
+ * @secure
3923
+ */
3924
+ deposit(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3925
+ /**
3926
+ * @tags Transfers Ach
3927
+ * @name Withdraw
3928
+ * @summary Withdraw
3929
+ * @request POST:/transfer/ach/withdraw
3930
+ * @secure
3931
+ */
3932
+ withdraw(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3933
+ }
4158
3934
  export class TransfersAcats<HandleError extends boolean = boolean> {
4159
3935
  protected readonly apiClient: JwtClient<HandleError>;
4160
3936
  constructor(apiClient: JwtClient<HandleError>);
@@ -4271,42 +4047,22 @@ export class TransfersAcats<HandleError extends boolean = boolean> {
4271
4047
  /** @example "" */
4272
4048
  contraAccountType?: string;
4273
4049
  /** @example "" */
4274
- contraNumber?: string;
4275
- /** @example "" */
4276
- contraTitle?: string;
4277
- /** @example "" */
4278
- participantNumber?: string;
4279
- /** @example "" */
4280
- primaryTaxId?: string;
4281
- /** @example "{optional}" */
4282
- remoteDevice?: string;
4283
- /** @example "{optional}" */
4284
- remoteIp?: string;
4285
- /** @example "" */
4286
- secondaryTaxId?: string;
4287
- /** @example "Full|Partial" */
4288
- type?: string;
4289
- }[], config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4290
- }
4291
- export class TransfersAch<HandleError extends boolean = boolean> {
4292
- protected readonly apiClient: JwtClient<HandleError>;
4293
- constructor(apiClient: JwtClient<HandleError>);
4294
- /**
4295
- * @tags Transfers Ach
4296
- * @name Deposit
4297
- * @summary Deposit
4298
- * @request POST:/transfer/ach/deposit
4299
- * @secure
4300
- */
4301
- deposit(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4302
- /**
4303
- * @tags Transfers Ach
4304
- * @name Withdraw
4305
- * @summary Withdraw
4306
- * @request POST:/transfer/ach/withdraw
4307
- * @secure
4308
- */
4309
- withdraw(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4050
+ contraNumber?: string;
4051
+ /** @example "" */
4052
+ contraTitle?: string;
4053
+ /** @example "" */
4054
+ participantNumber?: string;
4055
+ /** @example "" */
4056
+ primaryTaxId?: string;
4057
+ /** @example "{optional}" */
4058
+ remoteDevice?: string;
4059
+ /** @example "{optional}" */
4060
+ remoteIp?: string;
4061
+ /** @example "" */
4062
+ secondaryTaxId?: string;
4063
+ /** @example "Full|Partial" */
4064
+ type?: string;
4065
+ }[], config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4310
4066
  }
4311
4067
  export class TransfersWires<HandleError extends boolean = boolean> {
4312
4068
  protected readonly apiClient: JwtClient<HandleError>;
@@ -4600,14 +4356,258 @@ export class TransfersInstantCashTransfers<HandleError extends boolean = boolean
4600
4356
  /** @example "RETAIL_BANKING" */
4601
4357
  reportType?: any;
4602
4358
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4603
- /**
4604
- * @tags Transfers Instant Cash Transfers
4605
- * @name ListReports
4606
- * @summary List reports
4607
- * @request GET:/transfer/reports
4608
- * @secure
4609
- */
4610
- listReports(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4359
+ /**
4360
+ * @tags Transfers Instant Cash Transfers
4361
+ * @name ListReports
4362
+ * @summary List reports
4363
+ * @request GET:/transfer/reports
4364
+ * @secure
4365
+ */
4366
+ listReports(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4367
+ }
4368
+ export class TransfersRelationships<HandleError extends boolean = boolean> {
4369
+ protected readonly apiClient: JwtClient<HandleError>;
4370
+ constructor(apiClient: JwtClient<HandleError>);
4371
+ /**
4372
+ * @tags Transfers Relationships
4373
+ * @name List
4374
+ * @summary List
4375
+ * @request GET:/transfer/relationship/list/{account}
4376
+ * @secure
4377
+ */
4378
+ list(account: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4379
+ /**
4380
+ * @tags Transfers Relationships
4381
+ * @name GetInfo
4382
+ * @summary Get Info
4383
+ * @request GET:/transfer/relationship/get
4384
+ * @secure
4385
+ */
4386
+ getInfo(query?: {
4387
+ /**
4388
+ * Account number
4389
+ * @example "ABC123"
4390
+ */
4391
+ account?: any;
4392
+ /**
4393
+ * Desired entry ID
4394
+ * @example "123"
4395
+ */
4396
+ entryId?: any;
4397
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4398
+ /**
4399
+ * @tags Transfers Relationships
4400
+ * @name PaymentMethods
4401
+ * @summary Payment methods
4402
+ * @request GET:/transfer/bank/paymentMethods
4403
+ * @secure
4404
+ */
4405
+ paymentMethods(query?: {
4406
+ /** @example "IND" */
4407
+ country?: any;
4408
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4409
+ /**
4410
+ * @tags Transfers Relationships
4411
+ * @name PaymentMethodsViaAddress
4412
+ * @summary Payment methods (via address)
4413
+ * @request POST:/transfer/bank/paymentMethods
4414
+ * @secure
4415
+ */
4416
+ paymentMethodsViaAddress(data: {
4417
+ /** @example "Mumbai" */
4418
+ city?: any;
4419
+ /** @example "IND" */
4420
+ country?: any;
4421
+ /** @example "400018" */
4422
+ postalCode?: any;
4423
+ /** @example "Maharashtra" */
4424
+ stateProvince?: any;
4425
+ /** @example ["716 /a, Poonam Chem, Dr.annie Besant Road, Opp.atre Mall, Worli"] */
4426
+ streetAddress?: any;
4427
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4428
+ /**
4429
+ * @tags Transfers Relationships
4430
+ * @name BankCodes
4431
+ * @summary Bank Codes
4432
+ * @request GET:/transfer/bank/bankCodes
4433
+ * @secure
4434
+ */
4435
+ bankCodes(query?: {
4436
+ /** @example "IND|MEX" */
4437
+ country?: any;
4438
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4439
+ /**
4440
+ * @tags Transfers Relationships
4441
+ * @name BankCodesViaAddress
4442
+ * @summary Bank Codes (via address)
4443
+ * @request POST:/transfer/bank/bankCodes
4444
+ * @secure
4445
+ */
4446
+ bankCodesViaAddress(data: {
4447
+ /** @example "Mumbai" */
4448
+ city?: any;
4449
+ /** @example "IND" */
4450
+ country?: any;
4451
+ /** @example "400018" */
4452
+ postalCode?: any;
4453
+ /** @example "Maharashtra" */
4454
+ stateProvince?: any;
4455
+ /** @example ["716 /a, Poonam Chem, Dr.annie Besant Road, Opp.atre Mall, Worli"] */
4456
+ streetAddress?: any;
4457
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4458
+ /**
4459
+ * @tags Transfers Relationships
4460
+ * @name Create
4461
+ * @summary Create
4462
+ * @request POST:/transfer/relationship/create
4463
+ * @secure
4464
+ */
4465
+ create(data: {
4466
+ /** @example "5VA0XXXX" */
4467
+ account?: any;
4468
+ /** @example "111111" */
4469
+ bankAccount?: any;
4470
+ /** @example "John Doe" */
4471
+ bankAccountOwnerName?: any;
4472
+ /** @example "CHECKING" */
4473
+ bankAccountType?: any;
4474
+ /** @example "010101010" */
4475
+ bankRoutingNumber?: any;
4476
+ /** @example "Test" */
4477
+ nickname?: any;
4478
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4479
+ /**
4480
+ * @tags Transfers Relationships
4481
+ * @name WireInformation
4482
+ * @summary Wire information
4483
+ * @request POST:/transfer/relationship/wire/create
4484
+ * @secure
4485
+ */
4486
+ wireInformation(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4487
+ /**
4488
+ * @tags Transfers Relationships
4489
+ * @name BankingRelationship
4490
+ * @summary Banking relationship
4491
+ * @request POST:/transfer/relationship/bank/create
4492
+ * @secure
4493
+ */
4494
+ bankingRelationship(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4495
+ /**
4496
+ * @tags Transfers Relationships
4497
+ * @name Approve
4498
+ * @summary Approve
4499
+ * @request POST:/transfer/relationship/approve
4500
+ * @secure
4501
+ */
4502
+ approve(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4503
+ /**
4504
+ * @tags Transfers Relationships
4505
+ * @name Cancel
4506
+ * @summary Cancel
4507
+ * @request POST:/transfer/relationship/cancel/{entryId}
4508
+ * @secure
4509
+ */
4510
+ cancel(entryId: string, data: {
4511
+ /** @example "2QC05208" */
4512
+ account?: any;
4513
+ /** @example "USER CANCELED" */
4514
+ reason?: any;
4515
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4516
+ /**
4517
+ * @tags Transfers Relationships
4518
+ * @name Rename
4519
+ * @summary Rename
4520
+ * @request POST:/transfer/relationship/rename/{entryId}
4521
+ * @secure
4522
+ */
4523
+ rename(entryId: string, data: {
4524
+ /** @example "Citi Checking 2" */
4525
+ nickname?: any;
4526
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4527
+ /**
4528
+ * @tags Transfers Relationships
4529
+ * @name AdvisorPolicyUpdate
4530
+ * @summary Advisor Policy Update
4531
+ * @request POST:/transfer/relationship/policy
4532
+ * @secure
4533
+ */
4534
+ advisorPolicyUpdate(data: {
4535
+ account?: {
4536
+ /** @example 0 */
4537
+ accountId?: number;
4538
+ /** @example "{optional}" */
4539
+ accountNumber?: string;
4540
+ };
4541
+ /** @example 123 */
4542
+ entryId?: any;
4543
+ /** @example true */
4544
+ esigned?: any;
4545
+ /** @example "AllowWithdrawal|Disallow" */
4546
+ policy?: any;
4547
+ /** @example "" */
4548
+ remoteAddr?: any;
4549
+ /** @example "" */
4550
+ remoteDevice?: any;
4551
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4552
+ /**
4553
+ * @tags Transfers Relationships
4554
+ * @name DocumentUpload
4555
+ * @summary Document upload
4556
+ * @request POST:/transfer/relationship/wire/upload
4557
+ * @secure
4558
+ */
4559
+ documentUpload(data: {
4560
+ /**
4561
+ * Wire relationship ID
4562
+ * @example ""
4563
+ */
4564
+ entryId?: string;
4565
+ /**
4566
+ * Document file
4567
+ * @format binary
4568
+ */
4569
+ file?: File;
4570
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4571
+ /**
4572
+ * @tags Transfers Relationships
4573
+ * @name MfaReInitiation
4574
+ * @summary 2FA re-initiation
4575
+ * @request POST:/transfer/relationship/wire/2fa/reinitiate
4576
+ * @secure
4577
+ */
4578
+ mfaReInitiation(data: {
4579
+ /** @example 123 */
4580
+ entryId?: any;
4581
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4582
+ /**
4583
+ * @tags Transfers Relationships
4584
+ * @name SupplementWire
4585
+ * @summary Supplement wire
4586
+ * @request POST:/transfer/relationship/wire/supplement
4587
+ * @secure
4588
+ */
4589
+ supplementWire(data: {
4590
+ /** @example 123456 */
4591
+ entryId?: any;
4592
+ recipientBank?: {
4593
+ /** @example "Capital City" */
4594
+ city?: string;
4595
+ identifier?: {
4596
+ /** @example "AAA-123-2587964" */
4597
+ id?: string;
4598
+ /** @example "BIC" */
4599
+ type?: string;
4600
+ };
4601
+ /** @example "ABC 123" */
4602
+ postalCode?: string;
4603
+ /** @example "NJ" */
4604
+ stateProvince?: string;
4605
+ };
4606
+ userAccount?: {
4607
+ /** @example "AB12345" */
4608
+ accountNumber?: string;
4609
+ };
4610
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4611
4611
  }
4612
4612
  export class TransfersCheques<HandleError extends boolean = boolean> {
4613
4613
  protected readonly apiClient: JwtClient<HandleError>;
@@ -5385,6 +5385,111 @@ export class LegalDocuments<HandleError extends boolean = boolean> {
5385
5385
  remoteDevice?: any;
5386
5386
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5387
5387
  }
5388
+ export class BlacklistAdminBusinesses<HandleError extends boolean = boolean> {
5389
+ protected readonly apiClient: JwtClient<HandleError>;
5390
+ constructor(apiClient: JwtClient<HandleError>);
5391
+ /**
5392
+ * @tags Blacklist Admin Businesses
5393
+ * @name GetBusinessesList
5394
+ * @summary Get Businesses list
5395
+ * @request GET:/v1/admin/businesses
5396
+ * @secure
5397
+ */
5398
+ getBusinessesList(query?: {
5399
+ /**
5400
+ * (Required) page number
5401
+ * @example "5567183"
5402
+ */
5403
+ page?: any;
5404
+ /**
5405
+ * (Required) page size in records displayed
5406
+ * @example "5567183"
5407
+ */
5408
+ page_size?: any;
5409
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5410
+ /**
5411
+ * @tags Blacklist Admin Businesses
5412
+ * @name CreateBusiness
5413
+ * @summary Create Business
5414
+ * @request POST:/v1/admin/businesses
5415
+ * @secure
5416
+ */
5417
+ createBusiness(data: {
5418
+ /** @example "Gracia Marina" */
5419
+ business_name?: any;
5420
+ /** @example "Los Angeles" */
5421
+ city?: any;
5422
+ /** @example "US" */
5423
+ country?: any;
5424
+ /** @example "La Granja Del Camaron" */
5425
+ dba_name?: any;
5426
+ /** @example "" */
5427
+ incorporated?: any;
5428
+ /** @example "812748955" */
5429
+ number?: any;
5430
+ /** @example "EIN" */
5431
+ number_type?: any;
5432
+ /** @example "" */
5433
+ phone?: any;
5434
+ /** @example "CA" */
5435
+ state?: any;
5436
+ /** @example "1119 E 8th St Ste C" */
5437
+ street?: any;
5438
+ /** @example "304902" */
5439
+ tracking_number?: any;
5440
+ /** @example "90021" */
5441
+ zip?: any;
5442
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5443
+ /**
5444
+ * @tags Blacklist Admin Businesses
5445
+ * @name GetBusinessById
5446
+ * @summary Get Business by ID
5447
+ * @request GET:/v1/admin/businesses/{id}
5448
+ * @secure
5449
+ */
5450
+ getBusinessById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5451
+ /**
5452
+ * @tags Blacklist Admin Businesses
5453
+ * @name UpdateBusiness
5454
+ * @summary Update Business
5455
+ * @request PUT:/v1/admin/businesses/{id}
5456
+ * @secure
5457
+ */
5458
+ updateBusiness(id: string, data: {
5459
+ /** @example "Gracia Marina" */
5460
+ business_name?: any;
5461
+ /** @example "Los Angeles" */
5462
+ city?: any;
5463
+ /** @example "US" */
5464
+ country?: any;
5465
+ /** @example "La Granja Del Camaron" */
5466
+ dba_name?: any;
5467
+ /** @example "" */
5468
+ incorporated?: any;
5469
+ /** @example "812748955" */
5470
+ number?: any;
5471
+ /** @example "EIN" */
5472
+ number_type?: any;
5473
+ /** @example "" */
5474
+ phone?: any;
5475
+ /** @example "CA" */
5476
+ state?: any;
5477
+ /** @example "1119 E 8th St Ste C" */
5478
+ street?: any;
5479
+ /** @example "304902" */
5480
+ tracking_number?: any;
5481
+ /** @example "90021" */
5482
+ zip?: any;
5483
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5484
+ /**
5485
+ * @tags Blacklist Admin Businesses
5486
+ * @name DeleteBusiness
5487
+ * @summary Delete Business
5488
+ * @request DELETE:/v1/admin/businesses/{id}
5489
+ * @secure
5490
+ */
5491
+ deleteBusiness(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5492
+ }
5388
5493
  export class BlacklistAdminIndividuals<HandleError extends boolean = boolean> {
5389
5494
  protected readonly apiClient: JwtClient<HandleError>;
5390
5495
  constructor(apiClient: JwtClient<HandleError>);
@@ -5556,6 +5661,35 @@ export class BlacklistSearch<HandleError extends boolean = boolean> {
5556
5661
  };
5557
5662
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5558
5663
  }
5664
+ export class Blacklist<HandleError extends boolean = boolean> {
5665
+ protected readonly apiClient: JwtClient<HandleError>;
5666
+ adminBusinesses: BlacklistAdminBusinesses<HandleError>;
5667
+ adminIndividuals: BlacklistAdminIndividuals<HandleError>;
5668
+ search: BlacklistSearch<HandleError>;
5669
+ constructor(apiClient: JwtClient<HandleError>);
5670
+ /**
5671
+ * @tags Blacklist
5672
+ * @name UploadBlacklistCsv
5673
+ * @summary Upload Blacklist CSV
5674
+ * @request POST:/v1/csv/upload
5675
+ * @secure
5676
+ */
5677
+ uploadBlacklistCsv(data: {
5678
+ /**
5679
+ * (Required) file with info to upload
5680
+ * @format binary
5681
+ */
5682
+ file_field?: File;
5683
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5684
+ /**
5685
+ * @tags Blacklist
5686
+ * @name GetHealth
5687
+ * @summary Get Health
5688
+ * @request GET:/v1/healthz
5689
+ * @secure
5690
+ */
5691
+ getHealth(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5692
+ }
5559
5693
  export class Broker<HandleError extends boolean = boolean> {
5560
5694
  protected readonly apiClient: JwtClient<HandleError>;
5561
5695
  constructor(apiClient: JwtClient<HandleError>);
@@ -5599,139 +5733,144 @@ export class Broker<HandleError extends boolean = boolean> {
5599
5733
  pageSize?: any;
5600
5734
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5601
5735
  }
5602
- export class BlacklistAdminBusinesses<HandleError extends boolean = boolean> {
5736
+ export class WatchmenFfiUserAccountManagement<HandleError extends boolean = boolean> {
5603
5737
  protected readonly apiClient: JwtClient<HandleError>;
5604
5738
  constructor(apiClient: JwtClient<HandleError>);
5605
5739
  /**
5606
- * @tags Blacklist Admin Businesses
5607
- * @name GetBusinessesList
5608
- * @summary Get Businesses list
5609
- * @request GET:/v1/admin/businesses
5740
+ * @tags Watchmen Ffi User Account Management
5741
+ * @name CreateUser
5742
+ * @summary Create User
5743
+ * @request POST:/rest/v1/uam/user/create
5610
5744
  * @secure
5611
5745
  */
5612
- getBusinessesList(query?: {
5613
- /**
5614
- * (Required) page number
5615
- * @example "5567183"
5616
- */
5617
- page?: any;
5618
- /**
5619
- * (Required) page size in records displayed
5620
- * @example "5567183"
5621
- */
5622
- page_size?: any;
5746
+ createUser(data: {
5747
+ /** @example "{optional} enable|disable - whether or not enable user for TipRanks" */
5748
+ Tipranks?: any;
5749
+ /** @example "{optional} true|false - defaults to false" */
5750
+ algos?: any;
5751
+ /** @example "{optional} true|false - defaults to false" */
5752
+ allSession?: any;
5753
+ /** @example "{optional} Full Name" */
5754
+ associatedName?: any;
5755
+ /** @example "{optional} true|false - defaults to false" */
5756
+ buyWrite?: any;
5757
+ /** @example "{optional} e-mail address" */
5758
+ email?: any;
5759
+ /** @example "{optional} true|false - defaults to true" */
5760
+ isTradingEnabled?: any;
5761
+ /** @example "{optional} Limit On Close - true|false - defaults to false" */
5762
+ loc?: any;
5763
+ /** @example "{optional} true|false - whether user is locked" */
5764
+ locked?: any;
5765
+ /** @example "{optional} Limit On Open - true|false - defaults to false" */
5766
+ loo?: any;
5767
+ /** @example "{optional} Market On Open - true|false - defaults to false" */
5768
+ moc?: any;
5769
+ /** @example "{optional} Market On Close - true|false - defaults to false" */
5770
+ moo?: any;
5771
+ /** @example "{optional} One Cancels Other - true|false - defaults to false" */
5772
+ oco?: any;
5773
+ /** @example "{optional} true|false - defaults to false" */
5774
+ optionRoll?: any;
5775
+ /** @example "{optional} true|false - defaults to false" */
5776
+ options?: any;
5777
+ /** @example "{optional}" */
5778
+ password?: any;
5779
+ /** @example "{optional} true|false - defaults to false" */
5780
+ prePostTrading?: any;
5781
+ /** @example "{optional} 1 - delayed, 0 - realtime, 4 - CBOE1, 3 - BATS" */
5782
+ quoteType?: any;
5783
+ /** @example "{optional} true|false - defaults to false" */
5784
+ spreads?: any;
5785
+ /** @example "A - active, S - suspended == initial user status" */
5786
+ status?: any;
5787
+ /** @example "{optional} true|false - defaults to false" */
5788
+ trailingStops?: any;
5789
+ /** @example "UNIQUE_USERNAME" */
5790
+ username?: any;
5623
5791
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5624
5792
  /**
5625
- * @tags Blacklist Admin Businesses
5626
- * @name CreateBusiness
5627
- * @summary Create Business
5628
- * @request POST:/v1/admin/businesses
5793
+ * @tags Watchmen Ffi User Account Management
5794
+ * @name CreateAccount
5795
+ * @summary Create Account
5796
+ * @request POST:/rest/v1/uam/account/create
5629
5797
  * @secure
5630
5798
  */
5631
- createBusiness(data: {
5632
- /** @example "Gracia Marina" */
5633
- business_name?: any;
5634
- /** @example "Los Angeles" */
5635
- city?: any;
5636
- /** @example "US" */
5637
- country?: any;
5638
- /** @example "La Granja Del Camaron" */
5639
- dba_name?: any;
5640
- /** @example "" */
5641
- incorporated?: any;
5642
- /** @example "812748955" */
5643
- number?: any;
5644
- /** @example "EIN" */
5645
- number_type?: any;
5646
- /** @example "" */
5647
- phone?: any;
5648
- /** @example "CA" */
5649
- state?: any;
5650
- /** @example "1119 E 8th St Ste C" */
5651
- street?: any;
5652
- /** @example "304902" */
5653
- tracking_number?: any;
5654
- /** @example "90021" */
5655
- zip?: any;
5799
+ createAccount(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5800
+ /**
5801
+ * @tags Watchmen Ffi User Account Management
5802
+ * @name AccountInformation
5803
+ * @summary Account Information
5804
+ * @request GET:/rest/v1/uam/account/data
5805
+ * @secure
5806
+ */
5807
+ accountInformation(query?: {
5808
+ /** @example "AC123456" */
5809
+ accountNumber?: any;
5656
5810
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5657
5811
  /**
5658
- * @tags Blacklist Admin Businesses
5659
- * @name GetBusinessById
5660
- * @summary Get Business by ID
5661
- * @request GET:/v1/admin/businesses/{id}
5812
+ * @tags Watchmen Ffi User Account Management
5813
+ * @name UserInformation
5814
+ * @summary User Information
5815
+ * @request GET:/rest/v1/uam/user/data
5662
5816
  * @secure
5663
5817
  */
5664
- getBusinessById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5818
+ userInformation(query?: {
5819
+ /** @example "USERNAME" */
5820
+ username?: any;
5821
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5665
5822
  /**
5666
- * @tags Blacklist Admin Businesses
5667
- * @name UpdateBusiness
5668
- * @summary Update Business
5669
- * @request PUT:/v1/admin/businesses/{id}
5823
+ * @tags Watchmen Ffi User Account Management
5824
+ * @name ListLinkedAccounts
5825
+ * @summary List Linked Accounts
5826
+ * @request GET:/rest/v1/linkedaccounts/listAccounts
5670
5827
  * @secure
5671
5828
  */
5672
- updateBusiness(id: string, data: {
5673
- /** @example "Gracia Marina" */
5674
- business_name?: any;
5675
- /** @example "Los Angeles" */
5676
- city?: any;
5677
- /** @example "US" */
5678
- country?: any;
5679
- /** @example "La Granja Del Camaron" */
5680
- dba_name?: any;
5681
- /** @example "" */
5682
- incorporated?: any;
5683
- /** @example "812748955" */
5684
- number?: any;
5685
- /** @example "EIN" */
5686
- number_type?: any;
5687
- /** @example "" */
5688
- phone?: any;
5689
- /** @example "CA" */
5690
- state?: any;
5691
- /** @example "1119 E 8th St Ste C" */
5692
- street?: any;
5693
- /** @example "304902" */
5694
- tracking_number?: any;
5695
- /** @example "90021" */
5696
- zip?: any;
5829
+ listLinkedAccounts(query?: {
5830
+ /** @example "TEST.USER" */
5831
+ username?: any;
5697
5832
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5698
5833
  /**
5699
- * @tags Blacklist Admin Businesses
5700
- * @name DeleteBusiness
5701
- * @summary Delete Business
5702
- * @request DELETE:/v1/admin/businesses/{id}
5834
+ * @tags Watchmen Ffi User Account Management
5835
+ * @name LinkUnlinkAccount
5836
+ * @summary Link/Unlink Account
5837
+ * @request POST:/rest/v1/linkedaccounts/linkUnlinkAccount
5703
5838
  * @secure
5704
5839
  */
5705
- deleteBusiness(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5706
- }
5707
- export class Blacklist<HandleError extends boolean = boolean> {
5708
- protected readonly apiClient: JwtClient<HandleError>;
5709
- adminBusinesses: BlacklistAdminBusinesses<HandleError>;
5710
- adminIndividuals: BlacklistAdminIndividuals<HandleError>;
5711
- search: BlacklistSearch<HandleError>;
5712
- constructor(apiClient: JwtClient<HandleError>);
5840
+ linkUnlinkAccount(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5713
5841
  /**
5714
- * @tags Blacklist
5715
- * @name UploadBlacklistCsv
5716
- * @summary Upload Blacklist CSV
5717
- * @request POST:/v1/csv/upload
5842
+ * @tags Watchmen Ffi User Account Management
5843
+ * @name Visibility
5844
+ * @summary Visibility
5845
+ * @request POST:/rest/v1/linkedaccounts/visibility
5718
5846
  * @secure
5719
5847
  */
5720
- uploadBlacklistCsv(data: {
5721
- /**
5722
- * (Required) file with info to upload
5723
- * @format binary
5724
- */
5725
- file_field?: File;
5726
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5848
+ visibility(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5727
5849
  /**
5728
- * @tags Blacklist
5729
- * @name GetHealth
5730
- * @summary Get Health
5731
- * @request GET:/v1/healthz
5850
+ * @tags Watchmen Ffi User Account Management
5851
+ * @name UserAccountSearch
5852
+ * @summary User/Account Search
5853
+ * @request POST:/rest/v1/uam/user-account-search
5732
5854
  * @secure
5733
5855
  */
5734
- getHealth(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5856
+ userAccountSearch(data: {
5857
+ /** @example "desired account number" */
5858
+ accountNumber?: any;
5859
+ /** @example 100 */
5860
+ limit?: any;
5861
+ /** @example 0 */
5862
+ lockedBit?: any;
5863
+ /** @example "desired username" */
5864
+ login?: any;
5865
+ /** @example false */
5866
+ noBrokers?: any;
5867
+ /** @example "" */
5868
+ omnibus?: any;
5869
+ /** @example false */
5870
+ onlyActiveAccount?: any;
5871
+ /** @example false */
5872
+ onlyActiveUser?: any;
5873
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5735
5874
  }
5736
5875
  export class WatchmenFfiFirmBranch<HandleError extends boolean = boolean> {
5737
5876
  protected readonly apiClient: JwtClient<HandleError>;
@@ -5908,145 +6047,6 @@ export class WatchmenFfiFirmBranch<HandleError extends boolean = boolean> {
5908
6047
  id?: any;
5909
6048
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5910
6049
  }
5911
- export class WatchmenFfiUserAccountManagement<HandleError extends boolean = boolean> {
5912
- protected readonly apiClient: JwtClient<HandleError>;
5913
- constructor(apiClient: JwtClient<HandleError>);
5914
- /**
5915
- * @tags Watchmen Ffi User Account Management
5916
- * @name CreateUser
5917
- * @summary Create User
5918
- * @request POST:/rest/v1/uam/user/create
5919
- * @secure
5920
- */
5921
- createUser(data: {
5922
- /** @example "{optional} enable|disable - whether or not enable user for TipRanks" */
5923
- Tipranks?: any;
5924
- /** @example "{optional} true|false - defaults to false" */
5925
- algos?: any;
5926
- /** @example "{optional} true|false - defaults to false" */
5927
- allSession?: any;
5928
- /** @example "{optional} Full Name" */
5929
- associatedName?: any;
5930
- /** @example "{optional} true|false - defaults to false" */
5931
- buyWrite?: any;
5932
- /** @example "{optional} e-mail address" */
5933
- email?: any;
5934
- /** @example "{optional} true|false - defaults to true" */
5935
- isTradingEnabled?: any;
5936
- /** @example "{optional} Limit On Close - true|false - defaults to false" */
5937
- loc?: any;
5938
- /** @example "{optional} true|false - whether user is locked" */
5939
- locked?: any;
5940
- /** @example "{optional} Limit On Open - true|false - defaults to false" */
5941
- loo?: any;
5942
- /** @example "{optional} Market On Open - true|false - defaults to false" */
5943
- moc?: any;
5944
- /** @example "{optional} Market On Close - true|false - defaults to false" */
5945
- moo?: any;
5946
- /** @example "{optional} One Cancels Other - true|false - defaults to false" */
5947
- oco?: any;
5948
- /** @example "{optional} true|false - defaults to false" */
5949
- optionRoll?: any;
5950
- /** @example "{optional} true|false - defaults to false" */
5951
- options?: any;
5952
- /** @example "{optional}" */
5953
- password?: any;
5954
- /** @example "{optional} true|false - defaults to false" */
5955
- prePostTrading?: any;
5956
- /** @example "{optional} 1 - delayed, 0 - realtime, 4 - CBOE1, 3 - BATS" */
5957
- quoteType?: any;
5958
- /** @example "{optional} true|false - defaults to false" */
5959
- spreads?: any;
5960
- /** @example "A - active, S - suspended == initial user status" */
5961
- status?: any;
5962
- /** @example "{optional} true|false - defaults to false" */
5963
- trailingStops?: any;
5964
- /** @example "UNIQUE_USERNAME" */
5965
- username?: any;
5966
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5967
- /**
5968
- * @tags Watchmen Ffi User Account Management
5969
- * @name CreateAccount
5970
- * @summary Create Account
5971
- * @request POST:/rest/v1/uam/account/create
5972
- * @secure
5973
- */
5974
- createAccount(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5975
- /**
5976
- * @tags Watchmen Ffi User Account Management
5977
- * @name AccountInformation
5978
- * @summary Account Information
5979
- * @request GET:/rest/v1/uam/account/data
5980
- * @secure
5981
- */
5982
- accountInformation(query?: {
5983
- /** @example "AC123456" */
5984
- accountNumber?: any;
5985
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5986
- /**
5987
- * @tags Watchmen Ffi User Account Management
5988
- * @name UserInformation
5989
- * @summary User Information
5990
- * @request GET:/rest/v1/uam/user/data
5991
- * @secure
5992
- */
5993
- userInformation(query?: {
5994
- /** @example "USERNAME" */
5995
- username?: any;
5996
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5997
- /**
5998
- * @tags Watchmen Ffi User Account Management
5999
- * @name ListLinkedAccounts
6000
- * @summary List Linked Accounts
6001
- * @request GET:/rest/v1/linkedaccounts/listAccounts
6002
- * @secure
6003
- */
6004
- listLinkedAccounts(query?: {
6005
- /** @example "TEST.USER" */
6006
- username?: any;
6007
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
6008
- /**
6009
- * @tags Watchmen Ffi User Account Management
6010
- * @name LinkUnlinkAccount
6011
- * @summary Link/Unlink Account
6012
- * @request POST:/rest/v1/linkedaccounts/linkUnlinkAccount
6013
- * @secure
6014
- */
6015
- linkUnlinkAccount(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
6016
- /**
6017
- * @tags Watchmen Ffi User Account Management
6018
- * @name Visibility
6019
- * @summary Visibility
6020
- * @request POST:/rest/v1/linkedaccounts/visibility
6021
- * @secure
6022
- */
6023
- visibility(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
6024
- /**
6025
- * @tags Watchmen Ffi User Account Management
6026
- * @name UserAccountSearch
6027
- * @summary User/Account Search
6028
- * @request POST:/rest/v1/uam/user-account-search
6029
- * @secure
6030
- */
6031
- userAccountSearch(data: {
6032
- /** @example "desired account number" */
6033
- accountNumber?: any;
6034
- /** @example 100 */
6035
- limit?: any;
6036
- /** @example 0 */
6037
- lockedBit?: any;
6038
- /** @example "desired username" */
6039
- login?: any;
6040
- /** @example false */
6041
- noBrokers?: any;
6042
- /** @example "" */
6043
- omnibus?: any;
6044
- /** @example false */
6045
- onlyActiveAccount?: any;
6046
- /** @example false */
6047
- onlyActiveUser?: any;
6048
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
6049
- }
6050
6050
  export class Advisory<HandleError extends boolean = boolean> {
6051
6051
  protected readonly apiClient: JwtClient<HandleError>;
6052
6052
  charges: AdvisoryCharges<HandleError>;