@orbis-systems/orbis-api-clients 0.7.9 → 0.7.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/aesmidas/index.d.ts +38 -29
- package/dist/aesmidas/index.d.ts.map +1 -1
- package/dist/aesmidas/index.esm.js +1 -1
- package/dist/aesmidas/index.esm.js.map +1 -1
- package/dist/aesmidas/index.js +1 -1
- package/dist/aesmidas/index.js.map +1 -1
- package/dist/bridgewise/index.d.ts +521 -521
- package/dist/bridgewise/index.d.ts.map +1 -1
- package/dist/bridgewise/index.esm.js +1 -1
- package/dist/bridgewise/index.esm.js.map +1 -1
- package/dist/bridgewise/index.js +1 -1
- package/dist/bridgewise/index.js.map +1 -1
- package/dist/insight/index.d.ts +392 -385
- package/dist/insight/index.d.ts.map +1 -1
- package/dist/insight/index.esm.js +1 -1
- package/dist/insight/index.esm.js.map +1 -1
- package/dist/insight/index.js +1 -1
- package/dist/insight/index.js.map +1 -1
- package/dist/middleware/index.d.ts +34 -34
- package/dist/middleware/index.d.ts.map +1 -1
- package/dist/middleware/index.esm.js +1 -1
- package/dist/middleware/index.esm.js.map +1 -1
- package/dist/middleware/index.js +1 -1
- package/dist/middleware/index.js.map +1 -1
- package/dist/orbis/index.d.ts +994 -994
- package/dist/orbis/index.d.ts.map +1 -1
- package/dist/orbis/index.esm.js +1 -1
- package/dist/orbis/index.esm.js.map +1 -1
- package/dist/orbis/index.js +1 -1
- package/dist/orbis/index.js.map +1 -1
- package/dist/uma/index.d.ts +274 -274
- package/dist/uma/index.d.ts.map +1 -1
- package/dist/uma/index.esm.js +1 -1
- package/dist/uma/index.esm.js.map +1 -1
- package/dist/uma/index.js +1 -1
- package/dist/uma/index.js.map +1 -1
- package/dist/zerohash/index.d.ts +150 -150
- package/dist/zerohash/index.d.ts.map +1 -1
- package/dist/zerohash/index.esm.js +1 -1
- package/dist/zerohash/index.esm.js.map +1 -1
- package/dist/zerohash/index.js +1 -1
- package/dist/zerohash/index.js.map +1 -1
- package/package.json +1 -1
package/dist/orbis/index.d.ts
CHANGED
|
@@ -305,6 +305,84 @@ 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
|
+
}
|
|
308
386
|
export class OrdersV2Options<HandleError extends boolean = boolean> {
|
|
309
387
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
310
388
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -510,83 +588,49 @@ export class OrdersV2Options<HandleError extends boolean = boolean> {
|
|
|
510
588
|
};
|
|
511
589
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
512
590
|
}
|
|
513
|
-
export class
|
|
591
|
+
export class OrdersV2MutualFunds<HandleError extends boolean = boolean> {
|
|
514
592
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
515
593
|
constructor(apiClient: JwtClient<HandleError>);
|
|
516
594
|
/**
|
|
517
|
-
* @tags Orders V2
|
|
518
|
-
* @name
|
|
519
|
-
* @summary
|
|
520
|
-
* @request
|
|
595
|
+
* @tags Orders V2 Mutual Funds
|
|
596
|
+
* @name ListMutualFunds
|
|
597
|
+
* @summary List Mutual Funds
|
|
598
|
+
* @request GET:/quotes/mf/allowed
|
|
521
599
|
* @secure
|
|
522
600
|
*/
|
|
523
|
-
|
|
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>>;
|
|
601
|
+
listMutualFunds(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
553
602
|
/**
|
|
554
|
-
* @tags Orders V2
|
|
555
|
-
* @name
|
|
556
|
-
* @summary
|
|
557
|
-
* @request
|
|
603
|
+
* @tags Orders V2 Mutual Funds
|
|
604
|
+
* @name MutualFundDetails
|
|
605
|
+
* @summary Mutual Fund Details
|
|
606
|
+
* @request GET:/quotes/mf/allowed/details/{symbol}
|
|
558
607
|
* @secure
|
|
559
608
|
*/
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
|
|
569
|
-
|
|
570
|
-
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
|
|
585
|
-
};
|
|
586
|
-
/** @example "BUY|SELL" */
|
|
587
|
-
transaction?: string;
|
|
588
|
-
};
|
|
589
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
609
|
+
mutualFundDetails(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
610
|
+
/**
|
|
611
|
+
* @tags Orders V2 Mutual Funds
|
|
612
|
+
* @name CheckMutualFund
|
|
613
|
+
* @summary Check Mutual Fund
|
|
614
|
+
* @request GET:/quotes/mf/check/{symbol}
|
|
615
|
+
* @secure
|
|
616
|
+
*/
|
|
617
|
+
checkMutualFund(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
618
|
+
/**
|
|
619
|
+
* @tags Orders V2 Mutual Funds
|
|
620
|
+
* @name MutualFundPlacement
|
|
621
|
+
* @summary Mutual fund placement
|
|
622
|
+
* @request POST:/orders/v2/mf/place
|
|
623
|
+
* @secure
|
|
624
|
+
*/
|
|
625
|
+
mutualFundPlacement(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
626
|
+
/**
|
|
627
|
+
* @tags Orders V2 Mutual Funds
|
|
628
|
+
* @name MutualFundPreview
|
|
629
|
+
* @summary Mutual fund preview
|
|
630
|
+
* @request POST:/orders/v2/mf/preview
|
|
631
|
+
* @secure
|
|
632
|
+
*/
|
|
633
|
+
mutualFundPreview(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
590
634
|
}
|
|
591
635
|
export class OrdersV2Crypto<HandleError extends boolean = boolean> {
|
|
592
636
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -662,50 +706,6 @@ export class OrdersV2Crypto<HandleError extends boolean = boolean> {
|
|
|
662
706
|
};
|
|
663
707
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
664
708
|
}
|
|
665
|
-
export class OrdersV2MutualFunds<HandleError extends boolean = boolean> {
|
|
666
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
667
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
668
|
-
/**
|
|
669
|
-
* @tags Orders V2 Mutual Funds
|
|
670
|
-
* @name ListMutualFunds
|
|
671
|
-
* @summary List Mutual Funds
|
|
672
|
-
* @request GET:/quotes/mf/allowed
|
|
673
|
-
* @secure
|
|
674
|
-
*/
|
|
675
|
-
listMutualFunds(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
676
|
-
/**
|
|
677
|
-
* @tags Orders V2 Mutual Funds
|
|
678
|
-
* @name MutualFundDetails
|
|
679
|
-
* @summary Mutual Fund Details
|
|
680
|
-
* @request GET:/quotes/mf/allowed/details/{symbol}
|
|
681
|
-
* @secure
|
|
682
|
-
*/
|
|
683
|
-
mutualFundDetails(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
684
|
-
/**
|
|
685
|
-
* @tags Orders V2 Mutual Funds
|
|
686
|
-
* @name CheckMutualFund
|
|
687
|
-
* @summary Check Mutual Fund
|
|
688
|
-
* @request GET:/quotes/mf/check/{symbol}
|
|
689
|
-
* @secure
|
|
690
|
-
*/
|
|
691
|
-
checkMutualFund(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
692
|
-
/**
|
|
693
|
-
* @tags Orders V2 Mutual Funds
|
|
694
|
-
* @name MutualFundPlacement
|
|
695
|
-
* @summary Mutual fund placement
|
|
696
|
-
* @request POST:/orders/v2/mf/place
|
|
697
|
-
* @secure
|
|
698
|
-
*/
|
|
699
|
-
mutualFundPlacement(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
700
|
-
/**
|
|
701
|
-
* @tags Orders V2 Mutual Funds
|
|
702
|
-
* @name MutualFundPreview
|
|
703
|
-
* @summary Mutual fund preview
|
|
704
|
-
* @request POST:/orders/v2/mf/preview
|
|
705
|
-
* @secure
|
|
706
|
-
*/
|
|
707
|
-
mutualFundPreview(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
708
|
-
}
|
|
709
709
|
export class OrdersV2Offerings<HandleError extends boolean = boolean> {
|
|
710
710
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
711
711
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -1866,85 +1866,20 @@ 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
|
|
1869
|
+
export class ResearchAlphaTools<HandleError extends boolean = boolean> {
|
|
1870
1870
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
1871
1871
|
constructor(apiClient: JwtClient<HandleError>);
|
|
1872
1872
|
/**
|
|
1873
|
-
* @tags Research
|
|
1874
|
-
* @name
|
|
1875
|
-
* @summary
|
|
1876
|
-
* @request GET:/
|
|
1873
|
+
* @tags Research Alpha Tools
|
|
1874
|
+
* @name AlphaTracker
|
|
1875
|
+
* @summary Alpha Tracker
|
|
1876
|
+
* @request GET:/quotes/rst
|
|
1877
1877
|
* @secure
|
|
1878
1878
|
*/
|
|
1879
|
-
|
|
1880
|
-
/** @example "0" */
|
|
1881
|
-
start?: any;
|
|
1879
|
+
alphaTracker(query?: {
|
|
1882
1880
|
/**
|
|
1883
|
-
*
|
|
1884
|
-
* @example "
|
|
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
|
-
}
|
|
1934
|
-
export class ResearchAlphaTools<HandleError extends boolean = boolean> {
|
|
1935
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
1936
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
1937
|
-
/**
|
|
1938
|
-
* @tags Research Alpha Tools
|
|
1939
|
-
* @name AlphaTracker
|
|
1940
|
-
* @summary Alpha Tracker
|
|
1941
|
-
* @request GET:/quotes/rst
|
|
1942
|
-
* @secure
|
|
1943
|
-
*/
|
|
1944
|
-
alphaTracker(query?: {
|
|
1945
|
-
/**
|
|
1946
|
-
* Takes one symbol for the benchmark
|
|
1947
|
-
* @example "SPY"
|
|
1881
|
+
* Takes one symbol for the benchmark
|
|
1882
|
+
* @example "SPY"
|
|
1948
1883
|
*/
|
|
1949
1884
|
benchmark?: any;
|
|
1950
1885
|
/**
|
|
@@ -2017,330 +1952,236 @@ export class ResearchAlphaTools<HandleError extends boolean = boolean> {
|
|
|
2017
1952
|
years?: any;
|
|
2018
1953
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2019
1954
|
}
|
|
2020
|
-
export class
|
|
1955
|
+
export class ResearchNews<HandleError extends boolean = boolean> {
|
|
2021
1956
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2022
1957
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2023
1958
|
/**
|
|
2024
|
-
* @tags Research
|
|
2025
|
-
* @name
|
|
2026
|
-
* @summary
|
|
2027
|
-
* @request GET:/research/
|
|
1959
|
+
* @tags Research News
|
|
1960
|
+
* @name List
|
|
1961
|
+
* @summary List
|
|
1962
|
+
* @request GET:/research/news
|
|
2028
1963
|
* @secure
|
|
2029
1964
|
*/
|
|
2030
|
-
|
|
1965
|
+
list(query?: {
|
|
1966
|
+
/** @example "0" */
|
|
1967
|
+
start?: any;
|
|
2031
1968
|
/**
|
|
2032
|
-
*
|
|
2033
|
-
* @example ""
|
|
1969
|
+
* Defaults to 20
|
|
1970
|
+
* @example "100"
|
|
2034
1971
|
*/
|
|
2035
|
-
|
|
2036
|
-
/**
|
|
2037
|
-
|
|
2038
|
-
/** symbol, ipoDate, offerPx, shares, day1Ret, ipoRet, last, change, offerSz */
|
|
2039
|
-
sort?: any;
|
|
1972
|
+
count?: any;
|
|
1973
|
+
/** @example "[[-](provider|aggregator):value1,valueN];" */
|
|
1974
|
+
filter?: any;
|
|
2040
1975
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2041
1976
|
/**
|
|
2042
|
-
* @tags Research
|
|
2043
|
-
* @name
|
|
2044
|
-
* @summary
|
|
2045
|
-
* @request GET:/research/
|
|
2046
|
-
* @secure
|
|
2047
|
-
*/
|
|
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
|
|
1977
|
+
* @tags Research News
|
|
1978
|
+
* @name NewsBySymbol
|
|
1979
|
+
* @summary News by Symbol
|
|
1980
|
+
* @request GET:/research/news/ticker/{symbol}
|
|
2054
1981
|
* @secure
|
|
2055
1982
|
*/
|
|
2056
|
-
|
|
2057
|
-
/**
|
|
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;
|
|
1983
|
+
newsBySymbol(symbol: string, query?: {
|
|
2067
1984
|
/**
|
|
2068
|
-
*
|
|
2069
|
-
* @example "
|
|
1985
|
+
* Starting page (optional)
|
|
1986
|
+
* @example ""
|
|
2070
1987
|
*/
|
|
2071
|
-
|
|
1988
|
+
start?: any;
|
|
1989
|
+
/** Defaults to 20 (optional) */
|
|
1990
|
+
count?: any;
|
|
2072
1991
|
}, 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
1992
|
/**
|
|
2085
|
-
* @tags Research
|
|
2086
|
-
* @name
|
|
2087
|
-
* @summary
|
|
2088
|
-
* @request GET:/
|
|
1993
|
+
* @tags Research News
|
|
1994
|
+
* @name Sec
|
|
1995
|
+
* @summary SEC
|
|
1996
|
+
* @request GET:/research/news/sec/{symbol}
|
|
2089
1997
|
* @secure
|
|
2090
1998
|
*/
|
|
2091
|
-
|
|
2092
|
-
/**
|
|
2093
|
-
* See table above
|
|
2094
|
-
* @example "BIG3"
|
|
2095
|
-
*/
|
|
2096
|
-
market?: any;
|
|
1999
|
+
sec(symbol: string, query?: {
|
|
2097
2000
|
/**
|
|
2098
|
-
*
|
|
2099
|
-
* @example "
|
|
2001
|
+
* Starting point(optional)
|
|
2002
|
+
* @example "0"
|
|
2100
2003
|
*/
|
|
2101
|
-
|
|
2004
|
+
start?: any;
|
|
2102
2005
|
/**
|
|
2103
|
-
*
|
|
2104
|
-
* @example "
|
|
2006
|
+
* Defaults to 20 (optional)
|
|
2007
|
+
* @example "2"
|
|
2105
2008
|
*/
|
|
2106
2009
|
count?: any;
|
|
2107
2010
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2108
2011
|
/**
|
|
2109
|
-
* @tags Research
|
|
2110
|
-
* @name
|
|
2111
|
-
* @summary
|
|
2112
|
-
* @request GET:/research/{
|
|
2012
|
+
* @tags Research News
|
|
2013
|
+
* @name Lookup
|
|
2014
|
+
* @summary Lookup
|
|
2015
|
+
* @request GET:/research/news/{newsId}
|
|
2113
2016
|
* @secure
|
|
2114
2017
|
*/
|
|
2115
|
-
|
|
2018
|
+
lookup(newsId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2019
|
+
}
|
|
2020
|
+
export class UserDevice<HandleError extends boolean = boolean> {
|
|
2021
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2022
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2116
2023
|
/**
|
|
2117
|
-
* @tags
|
|
2118
|
-
* @name
|
|
2119
|
-
* @summary
|
|
2120
|
-
* @request GET:/
|
|
2024
|
+
* @tags User Device
|
|
2025
|
+
* @name Register
|
|
2026
|
+
* @summary Register
|
|
2027
|
+
* @request GET:/user/device/register
|
|
2121
2028
|
* @secure
|
|
2122
2029
|
*/
|
|
2123
|
-
|
|
2124
|
-
/**
|
|
2125
|
-
* Comma separated list of symbols.
|
|
2126
|
-
* @example "AAPL,BABA"
|
|
2127
|
-
*/
|
|
2128
|
-
symbols?: any;
|
|
2129
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2030
|
+
register(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2130
2031
|
/**
|
|
2131
|
-
* @tags
|
|
2132
|
-
* @name
|
|
2133
|
-
* @summary
|
|
2134
|
-
* @request GET:/
|
|
2032
|
+
* @tags User Device
|
|
2033
|
+
* @name Deregister
|
|
2034
|
+
* @summary Deregister
|
|
2035
|
+
* @request GET:/user/device/deregister
|
|
2135
2036
|
* @secure
|
|
2136
2037
|
*/
|
|
2137
|
-
|
|
2138
|
-
|
|
2139
|
-
* See table above. Leaving blank returns an overview of all of them.
|
|
2140
|
-
* @example ""
|
|
2141
|
-
*/
|
|
2142
|
-
filter?: any;
|
|
2038
|
+
deregister(query?: {
|
|
2039
|
+
token?: any;
|
|
2143
2040
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2144
2041
|
/**
|
|
2145
|
-
* @tags
|
|
2146
|
-
* @name
|
|
2147
|
-
* @summary
|
|
2148
|
-
* @request
|
|
2042
|
+
* @tags User Device
|
|
2043
|
+
* @name FirebaseRegistration
|
|
2044
|
+
* @summary Firebase - registration
|
|
2045
|
+
* @request POST:/user/device/firebase/register
|
|
2149
2046
|
* @secure
|
|
2150
2047
|
*/
|
|
2151
|
-
|
|
2152
|
-
/**
|
|
2153
|
-
|
|
2154
|
-
|
|
2155
|
-
|
|
2156
|
-
loadQuotes?: any;
|
|
2048
|
+
firebaseRegistration(data: {
|
|
2049
|
+
/** @example "{predfined scope name}" */
|
|
2050
|
+
scope?: any;
|
|
2051
|
+
/** @example "a1s2d3f4g5h6" */
|
|
2052
|
+
token?: any;
|
|
2157
2053
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2158
2054
|
/**
|
|
2159
|
-
* @tags
|
|
2160
|
-
* @name
|
|
2161
|
-
* @summary
|
|
2162
|
-
* @request
|
|
2055
|
+
* @tags User Device
|
|
2056
|
+
* @name FirebaseRemoval
|
|
2057
|
+
* @summary Firebase - removal
|
|
2058
|
+
* @request POST:/user/device/firebase/deregister
|
|
2163
2059
|
* @secure
|
|
2164
2060
|
*/
|
|
2165
|
-
|
|
2166
|
-
/**
|
|
2167
|
-
|
|
2168
|
-
* @example "AAPL"
|
|
2169
|
-
*/
|
|
2170
|
-
symbols?: any;
|
|
2061
|
+
firebaseRemoval(data: {
|
|
2062
|
+
/** @example "a1s2d3f4g5h6" */
|
|
2063
|
+
token?: any;
|
|
2171
2064
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2065
|
+
}
|
|
2066
|
+
export class UserTradingLimitManagement<HandleError extends boolean = boolean> {
|
|
2067
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2068
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2172
2069
|
/**
|
|
2173
|
-
* @tags
|
|
2174
|
-
* @name
|
|
2175
|
-
* @summary
|
|
2176
|
-
* @request
|
|
2070
|
+
* @tags User Trading Limit Management
|
|
2071
|
+
* @name Update
|
|
2072
|
+
* @summary Update
|
|
2073
|
+
* @request POST:/user/balance/adjust
|
|
2177
2074
|
* @secure
|
|
2178
2075
|
*/
|
|
2179
|
-
|
|
2180
|
-
|
|
2181
|
-
|
|
2182
|
-
|
|
2183
|
-
|
|
2184
|
-
|
|
2185
|
-
|
|
2186
|
-
|
|
2187
|
-
|
|
2188
|
-
|
|
2189
|
-
|
|
2190
|
-
/**
|
|
2191
|
-
|
|
2192
|
-
|
|
2193
|
-
|
|
2194
|
-
|
|
2195
|
-
|
|
2196
|
-
* Number of items per page
|
|
2197
|
-
* @example "20"
|
|
2198
|
-
*/
|
|
2199
|
-
count?: any;
|
|
2200
|
-
/**
|
|
2201
|
-
* Page num (first page is zero)
|
|
2202
|
-
* @example "0"
|
|
2203
|
-
*/
|
|
2204
|
-
page?: any;
|
|
2076
|
+
update(data: {
|
|
2077
|
+
account?: {
|
|
2078
|
+
/** @example "AB123456" */
|
|
2079
|
+
accountNumber?: string;
|
|
2080
|
+
};
|
|
2081
|
+
/** @example 100 */
|
|
2082
|
+
adjustment?: any;
|
|
2083
|
+
/** @example "USD" */
|
|
2084
|
+
currency?: any;
|
|
2085
|
+
/** @example "something nice" */
|
|
2086
|
+
note?: any;
|
|
2087
|
+
/** @example "tbd" */
|
|
2088
|
+
reason?: any;
|
|
2089
|
+
/** @example "" */
|
|
2090
|
+
referenceNo?: any;
|
|
2091
|
+
/** @example "Delta|Absolute" */
|
|
2092
|
+
type?: any;
|
|
2205
2093
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2094
|
+
}
|
|
2095
|
+
export class UserAgreements<HandleError extends boolean = boolean> {
|
|
2096
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2097
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2206
2098
|
/**
|
|
2207
|
-
* @tags
|
|
2208
|
-
* @name
|
|
2209
|
-
* @summary
|
|
2210
|
-
* @request GET:/
|
|
2099
|
+
* @tags User Agreements
|
|
2100
|
+
* @name Available
|
|
2101
|
+
* @summary Available
|
|
2102
|
+
* @request GET:/user/agreements/all/active
|
|
2211
2103
|
* @secure
|
|
2212
2104
|
*/
|
|
2213
|
-
|
|
2214
|
-
/**
|
|
2215
|
-
* Comma separated list of owner IDs
|
|
2216
|
-
* @example "PS000000YH,PS000004TI"
|
|
2217
|
-
*/
|
|
2218
|
-
ids?: any;
|
|
2219
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2105
|
+
available(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2220
2106
|
/**
|
|
2221
|
-
* @tags
|
|
2222
|
-
* @name
|
|
2223
|
-
* @summary
|
|
2224
|
-
* @request GET:/
|
|
2107
|
+
* @tags User Agreements
|
|
2108
|
+
* @name Agreement
|
|
2109
|
+
* @summary Agreement
|
|
2110
|
+
* @request GET:/user/agreements/contents/{version}/{code}/body.html
|
|
2225
2111
|
* @secure
|
|
2226
2112
|
*/
|
|
2227
|
-
|
|
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>>;
|
|
2113
|
+
agreement(version: string, code: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2249
2114
|
/**
|
|
2250
|
-
* @tags
|
|
2251
|
-
* @name
|
|
2252
|
-
* @summary
|
|
2253
|
-
* @request GET:/
|
|
2115
|
+
* @tags User Agreements
|
|
2116
|
+
* @name Unsigned
|
|
2117
|
+
* @summary Unsigned
|
|
2118
|
+
* @request GET:/user/agreements/unsigned
|
|
2254
2119
|
* @secure
|
|
2255
2120
|
*/
|
|
2256
|
-
|
|
2121
|
+
unsigned(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2257
2122
|
/**
|
|
2258
|
-
* @tags
|
|
2259
|
-
* @name
|
|
2260
|
-
* @summary
|
|
2261
|
-
* @request
|
|
2123
|
+
* @tags User Agreements
|
|
2124
|
+
* @name AttestStatus
|
|
2125
|
+
* @summary Attest status
|
|
2126
|
+
* @request POST:/user/professional/attest
|
|
2262
2127
|
* @secure
|
|
2263
2128
|
*/
|
|
2264
|
-
|
|
2129
|
+
attestStatus(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2265
2130
|
/**
|
|
2266
|
-
* @tags
|
|
2267
|
-
* @name
|
|
2268
|
-
* @summary
|
|
2269
|
-
* @request POST:/
|
|
2131
|
+
* @tags User Agreements
|
|
2132
|
+
* @name Sign
|
|
2133
|
+
* @summary Sign
|
|
2134
|
+
* @request POST:/user/agreements/sign
|
|
2270
2135
|
* @secure
|
|
2271
2136
|
*/
|
|
2272
|
-
|
|
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 */
|
|
2278
|
-
start?: any;
|
|
2279
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2137
|
+
sign(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2280
2138
|
/**
|
|
2281
|
-
* @tags
|
|
2282
|
-
* @name
|
|
2283
|
-
* @summary
|
|
2284
|
-
* @request GET:/
|
|
2139
|
+
* @tags User Agreements
|
|
2140
|
+
* @name CryptoAgreement
|
|
2141
|
+
* @summary Crypto Agreement
|
|
2142
|
+
* @request GET:/user/agreements/crypto/Agreement
|
|
2285
2143
|
* @secure
|
|
2286
2144
|
*/
|
|
2287
|
-
|
|
2288
|
-
/**
|
|
2289
|
-
* Can be one of the following:
|
|
2290
|
-
* Sector| Group | Industry | SubIndustry
|
|
2291
|
-
* @example "group"
|
|
2292
|
-
*/
|
|
2293
|
-
industryType?: any;
|
|
2294
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2145
|
+
cryptoAgreement(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2295
2146
|
/**
|
|
2296
|
-
* @tags
|
|
2297
|
-
* @name
|
|
2298
|
-
* @summary
|
|
2299
|
-
* @request
|
|
2147
|
+
* @tags User Agreements
|
|
2148
|
+
* @name CryptoSign
|
|
2149
|
+
* @summary Crypto Sign
|
|
2150
|
+
* @request POST:/user/agreements/crypto/sign
|
|
2300
2151
|
* @secure
|
|
2301
2152
|
*/
|
|
2302
|
-
|
|
2153
|
+
cryptoSign(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2154
|
+
}
|
|
2155
|
+
export class UserAttachedBanks<HandleError extends boolean = boolean> {
|
|
2156
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2157
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2303
2158
|
/**
|
|
2304
|
-
* @tags
|
|
2305
|
-
* @name
|
|
2306
|
-
* @summary
|
|
2307
|
-
* @request GET:/
|
|
2159
|
+
* @tags User Attached Banks
|
|
2160
|
+
* @name Accounts
|
|
2161
|
+
* @summary Accounts
|
|
2162
|
+
* @request GET:/user/bank/accounts
|
|
2308
2163
|
* @secure
|
|
2309
2164
|
*/
|
|
2310
|
-
|
|
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;
|
|
2165
|
+
accounts(query?: {
|
|
2319
2166
|
/**
|
|
2320
|
-
*
|
|
2321
|
-
*
|
|
2167
|
+
* Brokerage account number
|
|
2168
|
+
* @example "AC123456"
|
|
2322
2169
|
*/
|
|
2323
|
-
|
|
2170
|
+
account?: any;
|
|
2324
2171
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2325
2172
|
/**
|
|
2326
|
-
* @tags
|
|
2327
|
-
* @name
|
|
2328
|
-
* @summary
|
|
2329
|
-
* @request GET:/
|
|
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
|
|
2173
|
+
* @tags User Attached Banks
|
|
2174
|
+
* @name Balances
|
|
2175
|
+
* @summary Balances
|
|
2176
|
+
* @request GET:/user/bank/balances
|
|
2338
2177
|
* @secure
|
|
2339
2178
|
*/
|
|
2340
|
-
|
|
2341
|
-
|
|
2342
|
-
|
|
2343
|
-
|
|
2179
|
+
balances(query?: {
|
|
2180
|
+
/**
|
|
2181
|
+
* Brokerage account number
|
|
2182
|
+
* @example "AC123456"
|
|
2183
|
+
*/
|
|
2184
|
+
account?: any;
|
|
2344
2185
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2345
2186
|
}
|
|
2346
2187
|
export class UserWatchlists<HandleError extends boolean = boolean> {
|
|
@@ -2387,212 +2228,45 @@ export class UserWatchlists<HandleError extends boolean = boolean> {
|
|
|
2387
2228
|
*/
|
|
2388
2229
|
removeFromWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2389
2230
|
}
|
|
2390
|
-
export class
|
|
2231
|
+
export class UserProfitLoss<HandleError extends boolean = boolean> {
|
|
2391
2232
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2392
2233
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2393
2234
|
/**
|
|
2394
|
-
* @tags User
|
|
2395
|
-
* @name
|
|
2396
|
-
* @summary
|
|
2397
|
-
* @request
|
|
2398
|
-
* @secure
|
|
2399
|
-
*/
|
|
2400
|
-
register(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2401
|
-
/**
|
|
2402
|
-
* @tags User Device
|
|
2403
|
-
* @name Deregister
|
|
2404
|
-
* @summary Deregister
|
|
2405
|
-
* @request GET:/user/device/deregister
|
|
2235
|
+
* @tags User Profit Loss
|
|
2236
|
+
* @name ReportRequest
|
|
2237
|
+
* @summary Report Request
|
|
2238
|
+
* @request POST:/user/pal/submit
|
|
2406
2239
|
* @secure
|
|
2407
2240
|
*/
|
|
2408
|
-
|
|
2409
|
-
|
|
2241
|
+
reportRequest(data: {
|
|
2242
|
+
/** @example "{account number}" */
|
|
2243
|
+
account?: any;
|
|
2244
|
+
/** @example "{timestamp}" */
|
|
2245
|
+
from?: any;
|
|
2246
|
+
/** @example "{timestamp}" */
|
|
2247
|
+
until?: any;
|
|
2410
2248
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2411
2249
|
/**
|
|
2412
|
-
* @tags User
|
|
2413
|
-
* @name
|
|
2414
|
-
* @summary
|
|
2415
|
-
* @request
|
|
2250
|
+
* @tags User Profit Loss
|
|
2251
|
+
* @name StatusCheck
|
|
2252
|
+
* @summary Status check
|
|
2253
|
+
* @request GET:/user/pal/status
|
|
2416
2254
|
* @secure
|
|
2417
2255
|
*/
|
|
2418
|
-
|
|
2419
|
-
/** @example "
|
|
2420
|
-
|
|
2421
|
-
/** @example "a1s2d3f4g5h6" */
|
|
2422
|
-
token?: any;
|
|
2256
|
+
statusCheck(query?: {
|
|
2257
|
+
/** @example "643eaa24e00691406cbaa72f" */
|
|
2258
|
+
requestId?: any;
|
|
2423
2259
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2424
2260
|
/**
|
|
2425
|
-
* @tags User
|
|
2426
|
-
* @name
|
|
2427
|
-
* @summary
|
|
2428
|
-
* @request
|
|
2261
|
+
* @tags User Profit Loss
|
|
2262
|
+
* @name Report
|
|
2263
|
+
* @summary Report
|
|
2264
|
+
* @request GET:/user/pal/report
|
|
2429
2265
|
* @secure
|
|
2430
2266
|
*/
|
|
2431
|
-
|
|
2432
|
-
/** @example "
|
|
2433
|
-
|
|
2434
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2435
|
-
}
|
|
2436
|
-
export class UserAgreements<HandleError extends boolean = boolean> {
|
|
2437
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
2438
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
2439
|
-
/**
|
|
2440
|
-
* @tags User Agreements
|
|
2441
|
-
* @name Available
|
|
2442
|
-
* @summary Available
|
|
2443
|
-
* @request GET:/user/agreements/all/active
|
|
2444
|
-
* @secure
|
|
2445
|
-
*/
|
|
2446
|
-
available(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2447
|
-
/**
|
|
2448
|
-
* @tags User Agreements
|
|
2449
|
-
* @name Agreement
|
|
2450
|
-
* @summary Agreement
|
|
2451
|
-
* @request GET:/user/agreements/contents/{version}/{code}/body.html
|
|
2452
|
-
* @secure
|
|
2453
|
-
*/
|
|
2454
|
-
agreement(version: string, code: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2455
|
-
/**
|
|
2456
|
-
* @tags User Agreements
|
|
2457
|
-
* @name Unsigned
|
|
2458
|
-
* @summary Unsigned
|
|
2459
|
-
* @request GET:/user/agreements/unsigned
|
|
2460
|
-
* @secure
|
|
2461
|
-
*/
|
|
2462
|
-
unsigned(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2463
|
-
/**
|
|
2464
|
-
* @tags User Agreements
|
|
2465
|
-
* @name AttestStatus
|
|
2466
|
-
* @summary Attest status
|
|
2467
|
-
* @request POST:/user/professional/attest
|
|
2468
|
-
* @secure
|
|
2469
|
-
*/
|
|
2470
|
-
attestStatus(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2471
|
-
/**
|
|
2472
|
-
* @tags User Agreements
|
|
2473
|
-
* @name Sign
|
|
2474
|
-
* @summary Sign
|
|
2475
|
-
* @request POST:/user/agreements/sign
|
|
2476
|
-
* @secure
|
|
2477
|
-
*/
|
|
2478
|
-
sign(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2479
|
-
/**
|
|
2480
|
-
* @tags User Agreements
|
|
2481
|
-
* @name CryptoAgreement
|
|
2482
|
-
* @summary Crypto Agreement
|
|
2483
|
-
* @request GET:/user/agreements/crypto/Agreement
|
|
2484
|
-
* @secure
|
|
2485
|
-
*/
|
|
2486
|
-
cryptoAgreement(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2487
|
-
/**
|
|
2488
|
-
* @tags User Agreements
|
|
2489
|
-
* @name CryptoSign
|
|
2490
|
-
* @summary Crypto Sign
|
|
2491
|
-
* @request POST:/user/agreements/crypto/sign
|
|
2492
|
-
* @secure
|
|
2493
|
-
*/
|
|
2494
|
-
cryptoSign(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2495
|
-
}
|
|
2496
|
-
export class UserTradingLimitManagement<HandleError extends boolean = boolean> {
|
|
2497
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
2498
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
2499
|
-
/**
|
|
2500
|
-
* @tags User Trading Limit Management
|
|
2501
|
-
* @name Update
|
|
2502
|
-
* @summary Update
|
|
2503
|
-
* @request POST:/user/balance/adjust
|
|
2504
|
-
* @secure
|
|
2505
|
-
*/
|
|
2506
|
-
update(data: {
|
|
2507
|
-
account?: {
|
|
2508
|
-
/** @example "AB123456" */
|
|
2509
|
-
accountNumber?: string;
|
|
2510
|
-
};
|
|
2511
|
-
/** @example 100 */
|
|
2512
|
-
adjustment?: any;
|
|
2513
|
-
/** @example "USD" */
|
|
2514
|
-
currency?: any;
|
|
2515
|
-
/** @example "something nice" */
|
|
2516
|
-
note?: any;
|
|
2517
|
-
/** @example "tbd" */
|
|
2518
|
-
reason?: any;
|
|
2519
|
-
/** @example "" */
|
|
2520
|
-
referenceNo?: any;
|
|
2521
|
-
/** @example "Delta|Absolute" */
|
|
2522
|
-
type?: any;
|
|
2523
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2524
|
-
}
|
|
2525
|
-
export class UserAttachedBanks<HandleError extends boolean = boolean> {
|
|
2526
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
2527
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
2528
|
-
/**
|
|
2529
|
-
* @tags User Attached Banks
|
|
2530
|
-
* @name Accounts
|
|
2531
|
-
* @summary Accounts
|
|
2532
|
-
* @request GET:/user/bank/accounts
|
|
2533
|
-
* @secure
|
|
2534
|
-
*/
|
|
2535
|
-
accounts(query?: {
|
|
2536
|
-
/**
|
|
2537
|
-
* Brokerage account number
|
|
2538
|
-
* @example "AC123456"
|
|
2539
|
-
*/
|
|
2540
|
-
account?: any;
|
|
2541
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2542
|
-
/**
|
|
2543
|
-
* @tags User Attached Banks
|
|
2544
|
-
* @name Balances
|
|
2545
|
-
* @summary Balances
|
|
2546
|
-
* @request GET:/user/bank/balances
|
|
2547
|
-
* @secure
|
|
2548
|
-
*/
|
|
2549
|
-
balances(query?: {
|
|
2550
|
-
/**
|
|
2551
|
-
* Brokerage account number
|
|
2552
|
-
* @example "AC123456"
|
|
2553
|
-
*/
|
|
2554
|
-
account?: any;
|
|
2555
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2556
|
-
}
|
|
2557
|
-
export class UserProfitLoss<HandleError extends boolean = boolean> {
|
|
2558
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
2559
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
2560
|
-
/**
|
|
2561
|
-
* @tags User Profit Loss
|
|
2562
|
-
* @name ReportRequest
|
|
2563
|
-
* @summary Report Request
|
|
2564
|
-
* @request POST:/user/pal/submit
|
|
2565
|
-
* @secure
|
|
2566
|
-
*/
|
|
2567
|
-
reportRequest(data: {
|
|
2568
|
-
/** @example "{account number}" */
|
|
2569
|
-
account?: any;
|
|
2570
|
-
/** @example "{timestamp}" */
|
|
2571
|
-
from?: any;
|
|
2572
|
-
/** @example "{timestamp}" */
|
|
2573
|
-
until?: any;
|
|
2574
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2575
|
-
/**
|
|
2576
|
-
* @tags User Profit Loss
|
|
2577
|
-
* @name StatusCheck
|
|
2578
|
-
* @summary Status check
|
|
2579
|
-
* @request GET:/user/pal/status
|
|
2580
|
-
* @secure
|
|
2581
|
-
*/
|
|
2582
|
-
statusCheck(query?: {
|
|
2583
|
-
/** @example "643eaa24e00691406cbaa72f" */
|
|
2584
|
-
requestId?: any;
|
|
2585
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2586
|
-
/**
|
|
2587
|
-
* @tags User Profit Loss
|
|
2588
|
-
* @name Report
|
|
2589
|
-
* @summary Report
|
|
2590
|
-
* @request GET:/user/pal/report
|
|
2591
|
-
* @secure
|
|
2592
|
-
*/
|
|
2593
|
-
report(query?: {
|
|
2594
|
-
/** @example "643eaa24e00691406cbaa72f" */
|
|
2595
|
-
requestId?: any;
|
|
2267
|
+
report(query?: {
|
|
2268
|
+
/** @example "643eaa24e00691406cbaa72f" */
|
|
2269
|
+
requestId?: any;
|
|
2596
2270
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2597
2271
|
}
|
|
2598
2272
|
export class User<HandleError extends boolean = boolean> {
|
|
@@ -3435,130 +3109,456 @@ export class AdvisoryModels<HandleError extends boolean = boolean> {
|
|
|
3435
3109
|
*/
|
|
3436
3110
|
portfolio(modelId: string, query?: {
|
|
3437
3111
|
/**
|
|
3438
|
-
* Should load quotes or not.
|
|
3439
|
-
* @example "false"
|
|
3112
|
+
* Should load quotes or not.
|
|
3113
|
+
* @example "false"
|
|
3114
|
+
*/
|
|
3115
|
+
loadQuotes?: any;
|
|
3116
|
+
/**
|
|
3117
|
+
* Whether to return combined portfolio (no accounts, with approximate prices)
|
|
3118
|
+
* @example "false"
|
|
3119
|
+
*/
|
|
3120
|
+
combined?: any;
|
|
3121
|
+
/** @example "false" */
|
|
3122
|
+
loadIndustries?: any;
|
|
3123
|
+
/** @example "false" */
|
|
3124
|
+
loadUpgrades?: any;
|
|
3125
|
+
/** @example "false" */
|
|
3126
|
+
loadEarnings?: any;
|
|
3127
|
+
/**
|
|
3128
|
+
* Whether or not to include orders comprising each position's cost
|
|
3129
|
+
* @example "false"
|
|
3130
|
+
*/
|
|
3131
|
+
loadCost?: any;
|
|
3132
|
+
/**
|
|
3133
|
+
* Analyze market caps and get `marketCapWeights`. To be used in conjuction with `loadQuotes`
|
|
3134
|
+
* @example "false"
|
|
3135
|
+
*/
|
|
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?: {
|
|
3146
|
+
/**
|
|
3147
|
+
* [optional] when omitted defaults to system's setting.
|
|
3148
|
+
* @example "USD"
|
|
3149
|
+
*/
|
|
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;
|
|
3161
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3162
|
+
/**
|
|
3163
|
+
* @tags Advisory Models
|
|
3164
|
+
* @name PositionLookupOptions
|
|
3165
|
+
* @summary Position lookup (options)
|
|
3166
|
+
* @request GET:/v2/advisory/model/position/option/{modelId}
|
|
3167
|
+
* @secure
|
|
3168
|
+
*/
|
|
3169
|
+
positionLookupOptions(modelId: string, query?: {
|
|
3170
|
+
symbol?: any;
|
|
3171
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3172
|
+
/**
|
|
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
|
|
3185
|
+
* @secure
|
|
3186
|
+
*/
|
|
3187
|
+
creation(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3188
|
+
/**
|
|
3189
|
+
* @tags Advisory Models
|
|
3190
|
+
* @name Update
|
|
3191
|
+
* @summary Update
|
|
3192
|
+
* @request POST:/v2/advisory/model/update
|
|
3193
|
+
* @secure
|
|
3194
|
+
*/
|
|
3195
|
+
update(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3196
|
+
/**
|
|
3197
|
+
* @tags Advisory Models
|
|
3198
|
+
* @name Deletion
|
|
3199
|
+
* @summary Deletion
|
|
3200
|
+
* @request POST:/v2/advisory/model/delete
|
|
3201
|
+
* @secure
|
|
3202
|
+
*/
|
|
3203
|
+
deletion(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3204
|
+
/**
|
|
3205
|
+
* @tags Advisory Models
|
|
3206
|
+
* @name ComponentUpdate
|
|
3207
|
+
* @summary Component update
|
|
3208
|
+
* @request POST:/v2/advisory/model/component/update
|
|
3209
|
+
* @secure
|
|
3210
|
+
*/
|
|
3211
|
+
componentUpdate(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3212
|
+
/**
|
|
3213
|
+
* @tags Advisory Models
|
|
3214
|
+
* @name LinkOfMemberAccounts
|
|
3215
|
+
* @summary Link of member accounts
|
|
3216
|
+
* @request POST:/v2/advisory/model/account/link
|
|
3217
|
+
* @secure
|
|
3218
|
+
*/
|
|
3219
|
+
linkOfMemberAccounts(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3220
|
+
/**
|
|
3221
|
+
* @tags Advisory Models
|
|
3222
|
+
* @name UnlinkMemberAccount
|
|
3223
|
+
* @summary Unlink member account
|
|
3224
|
+
* @request POST:/v2/advisory/model/account/unlink
|
|
3225
|
+
* @secure
|
|
3226
|
+
*/
|
|
3227
|
+
unlinkMemberAccount(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3228
|
+
/**
|
|
3229
|
+
* @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}
|
|
3306
|
+
* @secure
|
|
3307
|
+
*/
|
|
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;
|
|
3319
|
+
/**
|
|
3320
|
+
* Optional. Defaults to 10
|
|
3321
|
+
* @example "10"
|
|
3322
|
+
*/
|
|
3323
|
+
count?: any;
|
|
3324
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3325
|
+
/**
|
|
3326
|
+
* @tags Research
|
|
3327
|
+
* @name CompanyResearch
|
|
3328
|
+
* @summary Company Research
|
|
3329
|
+
* @request GET:/research/{symbol}
|
|
3330
|
+
* @secure
|
|
3331
|
+
*/
|
|
3332
|
+
companyResearch(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3333
|
+
/**
|
|
3334
|
+
* @tags Research
|
|
3335
|
+
* @name OptionRatios
|
|
3336
|
+
* @summary Option Ratios
|
|
3337
|
+
* @request GET:/research/option/ratios
|
|
3338
|
+
* @secure
|
|
3339
|
+
*/
|
|
3340
|
+
optionRatios(query?: {
|
|
3341
|
+
/**
|
|
3342
|
+
* Comma separated list of symbols.
|
|
3343
|
+
* @example "AAPL,BABA"
|
|
3344
|
+
*/
|
|
3345
|
+
symbols?: any;
|
|
3346
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3347
|
+
/**
|
|
3348
|
+
* @tags Research
|
|
3349
|
+
* @name OptionRadar
|
|
3350
|
+
* @summary Option Radar
|
|
3351
|
+
* @request GET:/research/option/radar
|
|
3352
|
+
* @secure
|
|
3353
|
+
*/
|
|
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>>;
|
|
3361
|
+
/**
|
|
3362
|
+
* @tags Research
|
|
3363
|
+
* @name IndexComponents
|
|
3364
|
+
* @summary Index Components
|
|
3365
|
+
* @request GET:/research/index/components/{index}
|
|
3366
|
+
* @secure
|
|
3367
|
+
*/
|
|
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>>;
|
|
3375
|
+
/**
|
|
3376
|
+
* @tags Research
|
|
3377
|
+
* @name StockUpgrades
|
|
3378
|
+
* @summary Stock Upgrades
|
|
3379
|
+
* @request GET:/research/upgrades
|
|
3380
|
+
* @secure
|
|
3381
|
+
*/
|
|
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>>;
|
|
3389
|
+
/**
|
|
3390
|
+
* @tags Research
|
|
3391
|
+
* @name OwnershipDetails
|
|
3392
|
+
* @summary Ownership Details
|
|
3393
|
+
* @request GET:/research/ownerships/details
|
|
3394
|
+
* @secure
|
|
3395
|
+
*/
|
|
3396
|
+
ownershipDetails(query?: {
|
|
3397
|
+
/**
|
|
3398
|
+
* Comma separated list of tickers
|
|
3399
|
+
* @example "MSFT,GOOG"
|
|
3400
|
+
*/
|
|
3401
|
+
symbols?: any;
|
|
3402
|
+
/**
|
|
3403
|
+
* One of `ALL`, `INSTITUTIONAL`, `FUND`, `INSIDER`
|
|
3404
|
+
* @example "ALL"
|
|
3440
3405
|
*/
|
|
3441
|
-
|
|
3406
|
+
filter?: any;
|
|
3442
3407
|
/**
|
|
3443
|
-
*
|
|
3444
|
-
* @example "
|
|
3408
|
+
* One of `portfolio`, `ownership`, `market`
|
|
3409
|
+
* @example "portfolio"
|
|
3445
3410
|
*/
|
|
3446
|
-
|
|
3447
|
-
/** @example "false" */
|
|
3448
|
-
loadIndustries?: any;
|
|
3449
|
-
/** @example "false" */
|
|
3450
|
-
loadUpgrades?: any;
|
|
3451
|
-
/** @example "false" */
|
|
3452
|
-
loadEarnings?: any;
|
|
3411
|
+
sort?: any;
|
|
3453
3412
|
/**
|
|
3454
|
-
*
|
|
3455
|
-
* @example "
|
|
3413
|
+
* Number of items per page
|
|
3414
|
+
* @example "20"
|
|
3456
3415
|
*/
|
|
3457
|
-
|
|
3416
|
+
count?: any;
|
|
3458
3417
|
/**
|
|
3459
|
-
*
|
|
3460
|
-
* @example "
|
|
3418
|
+
* Page num (first page is zero)
|
|
3419
|
+
* @example "0"
|
|
3461
3420
|
*/
|
|
3462
|
-
|
|
3421
|
+
page?: any;
|
|
3463
3422
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3464
3423
|
/**
|
|
3465
|
-
* @tags
|
|
3466
|
-
* @name
|
|
3467
|
-
* @summary
|
|
3468
|
-
* @request GET:/
|
|
3424
|
+
* @tags Research
|
|
3425
|
+
* @name OwnerDetails
|
|
3426
|
+
* @summary Owner Details
|
|
3427
|
+
* @request GET:/research/owner/details
|
|
3469
3428
|
* @secure
|
|
3470
3429
|
*/
|
|
3471
|
-
|
|
3430
|
+
ownerDetails(query?: {
|
|
3472
3431
|
/**
|
|
3473
|
-
*
|
|
3474
|
-
* @example "
|
|
3432
|
+
* Comma separated list of owner IDs
|
|
3433
|
+
* @example "PS000000YH,PS000004TI"
|
|
3475
3434
|
*/
|
|
3476
|
-
|
|
3477
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3478
|
-
/**
|
|
3479
|
-
* @tags Advisory Models
|
|
3480
|
-
* @name PositionLookup
|
|
3481
|
-
* @summary Position lookup
|
|
3482
|
-
* @request GET:/v2/advisory/model/position/equity/{modelId}
|
|
3483
|
-
* @secure
|
|
3484
|
-
*/
|
|
3485
|
-
positionLookup(modelId: string, query?: {
|
|
3486
|
-
symbol?: any;
|
|
3435
|
+
ids?: any;
|
|
3487
3436
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3488
3437
|
/**
|
|
3489
|
-
* @tags
|
|
3490
|
-
* @name
|
|
3491
|
-
* @summary
|
|
3492
|
-
* @request GET:/
|
|
3438
|
+
* @tags Research
|
|
3439
|
+
* @name EarningsCalendar
|
|
3440
|
+
* @summary Earnings Calendar
|
|
3441
|
+
* @request GET:/research/earnings
|
|
3493
3442
|
* @secure
|
|
3494
3443
|
*/
|
|
3495
|
-
|
|
3496
|
-
|
|
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;
|
|
3497
3465
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3498
3466
|
/**
|
|
3499
|
-
* @tags
|
|
3500
|
-
* @name
|
|
3501
|
-
* @summary
|
|
3502
|
-
* @request
|
|
3467
|
+
* @tags Research
|
|
3468
|
+
* @name Fundamentals
|
|
3469
|
+
* @summary Fundamentals
|
|
3470
|
+
* @request GET:/research/fundamentals/{type}/{symbol}
|
|
3503
3471
|
* @secure
|
|
3504
3472
|
*/
|
|
3505
|
-
|
|
3473
|
+
fundamentals(type: string, symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3506
3474
|
/**
|
|
3507
|
-
* @tags
|
|
3508
|
-
* @name
|
|
3509
|
-
* @summary
|
|
3510
|
-
* @request
|
|
3475
|
+
* @tags Research
|
|
3476
|
+
* @name FundamentalTypes
|
|
3477
|
+
* @summary Fundamental Types
|
|
3478
|
+
* @request GET:/research/fundamentals/types
|
|
3511
3479
|
* @secure
|
|
3512
3480
|
*/
|
|
3513
|
-
|
|
3481
|
+
fundamentalTypes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3514
3482
|
/**
|
|
3515
|
-
* @tags
|
|
3516
|
-
* @name
|
|
3517
|
-
* @summary
|
|
3518
|
-
* @request POST:/
|
|
3483
|
+
* @tags Research
|
|
3484
|
+
* @name Screener
|
|
3485
|
+
* @summary Screener
|
|
3486
|
+
* @request POST:/research/screener
|
|
3519
3487
|
* @secure
|
|
3520
3488
|
*/
|
|
3521
|
-
|
|
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>>;
|
|
3522
3497
|
/**
|
|
3523
|
-
* @tags
|
|
3524
|
-
* @name
|
|
3525
|
-
* @summary
|
|
3526
|
-
* @request
|
|
3498
|
+
* @tags Research
|
|
3499
|
+
* @name IndustryHeatMap
|
|
3500
|
+
* @summary Industry Heat Map
|
|
3501
|
+
* @request GET:/research/heatMap/industryRanking
|
|
3527
3502
|
* @secure
|
|
3528
3503
|
*/
|
|
3529
|
-
|
|
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>>;
|
|
3530
3512
|
/**
|
|
3531
|
-
* @tags
|
|
3532
|
-
* @name
|
|
3533
|
-
* @summary
|
|
3534
|
-
* @request
|
|
3513
|
+
* @tags Research
|
|
3514
|
+
* @name IndustryList
|
|
3515
|
+
* @summary Industry List
|
|
3516
|
+
* @request GET:/
|
|
3535
3517
|
* @secure
|
|
3536
3518
|
*/
|
|
3537
|
-
|
|
3519
|
+
industryList(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3538
3520
|
/**
|
|
3539
|
-
* @tags
|
|
3540
|
-
* @name
|
|
3541
|
-
* @summary
|
|
3542
|
-
* @request
|
|
3521
|
+
* @tags Research
|
|
3522
|
+
* @name SymbolHeatMap
|
|
3523
|
+
* @summary Symbol Heat Map
|
|
3524
|
+
* @request GET:/research/heatMap/symbols
|
|
3543
3525
|
* @secure
|
|
3544
3526
|
*/
|
|
3545
|
-
|
|
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>>;
|
|
3546
3542
|
/**
|
|
3547
|
-
* @tags
|
|
3548
|
-
* @name
|
|
3549
|
-
* @summary
|
|
3550
|
-
* @request
|
|
3543
|
+
* @tags Research
|
|
3544
|
+
* @name IndexOverview
|
|
3545
|
+
* @summary Index Overview
|
|
3546
|
+
* @request GET:/research/marketOverview
|
|
3551
3547
|
* @secure
|
|
3552
3548
|
*/
|
|
3553
|
-
|
|
3549
|
+
indexOverview(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3554
3550
|
/**
|
|
3555
|
-
* @tags
|
|
3556
|
-
* @name
|
|
3557
|
-
* @summary
|
|
3558
|
-
* @request
|
|
3551
|
+
* @tags Research
|
|
3552
|
+
* @name HistoricalData
|
|
3553
|
+
* @summary Historical Data
|
|
3554
|
+
* @request GET:/research/historicalPrices
|
|
3559
3555
|
* @secure
|
|
3560
3556
|
*/
|
|
3561
|
-
|
|
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>>;
|
|
3562
3562
|
}
|
|
3563
3563
|
export class AdvisoryUserAccountManagement<HandleError extends boolean = boolean> {
|
|
3564
3564
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -3762,6 +3762,24 @@ export class AdvisoryAnalytics<HandleError extends boolean = boolean> {
|
|
|
3762
3762
|
threshold?: any;
|
|
3763
3763
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3764
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
|
+
}
|
|
3765
3783
|
export class AdvisoryAllocations<HandleError extends boolean = boolean> {
|
|
3766
3784
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3767
3785
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -3814,24 +3832,6 @@ export class AdvisoryAllocations<HandleError extends boolean = boolean> {
|
|
|
3814
3832
|
*/
|
|
3815
3833
|
trigger(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3816
3834
|
}
|
|
3817
|
-
export class Device<HandleError extends boolean = boolean> {
|
|
3818
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
3819
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
3820
|
-
/**
|
|
3821
|
-
* @tags Device
|
|
3822
|
-
* @name DeviceDeactivate
|
|
3823
|
-
* @summary /device/deactivate
|
|
3824
|
-
* @request POST:/device/deactivate
|
|
3825
|
-
* @secure
|
|
3826
|
-
*/
|
|
3827
|
-
deviceDeactivate(data: {
|
|
3828
|
-
/**
|
|
3829
|
-
* Token previously registered
|
|
3830
|
-
* @example "123456789"
|
|
3831
|
-
*/
|
|
3832
|
-
Token?: string;
|
|
3833
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3834
|
-
}
|
|
3835
3835
|
export class TransfersRelationships<HandleError extends boolean = boolean> {
|
|
3836
3836
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3837
3837
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4155,26 +4155,6 @@ export class TransfersInstantAccountVerification<HandleError extends boolean = b
|
|
|
4155
4155
|
remoteDevice?: any;
|
|
4156
4156
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4157
4157
|
}
|
|
4158
|
-
export class TransfersAch<HandleError extends boolean = boolean> {
|
|
4159
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4160
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4161
|
-
/**
|
|
4162
|
-
* @tags Transfers Ach
|
|
4163
|
-
* @name Deposit
|
|
4164
|
-
* @summary Deposit
|
|
4165
|
-
* @request POST:/transfer/ach/deposit
|
|
4166
|
-
* @secure
|
|
4167
|
-
*/
|
|
4168
|
-
deposit(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4169
|
-
/**
|
|
4170
|
-
* @tags Transfers Ach
|
|
4171
|
-
* @name Withdraw
|
|
4172
|
-
* @summary Withdraw
|
|
4173
|
-
* @request POST:/transfer/ach/withdraw
|
|
4174
|
-
* @secure
|
|
4175
|
-
*/
|
|
4176
|
-
withdraw(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4177
|
-
}
|
|
4178
4158
|
export class TransfersAcats<HandleError extends boolean = boolean> {
|
|
4179
4159
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4180
4160
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4308,6 +4288,26 @@ export class TransfersAcats<HandleError extends boolean = boolean> {
|
|
|
4308
4288
|
type?: string;
|
|
4309
4289
|
}[], config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4310
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>>;
|
|
4310
|
+
}
|
|
4311
4311
|
export class TransfersWires<HandleError extends boolean = boolean> {
|
|
4312
4312
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4313
4313
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5385,111 +5385,6 @@ 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
|
-
}
|
|
5493
5388
|
export class BlacklistAdminIndividuals<HandleError extends boolean = boolean> {
|
|
5494
5389
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5495
5390
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5661,35 +5556,6 @@ export class BlacklistSearch<HandleError extends boolean = boolean> {
|
|
|
5661
5556
|
};
|
|
5662
5557
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5663
5558
|
}
|
|
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
|
-
}
|
|
5693
5559
|
export class Broker<HandleError extends boolean = boolean> {
|
|
5694
5560
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5695
5561
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5733,144 +5599,139 @@ export class Broker<HandleError extends boolean = boolean> {
|
|
|
5733
5599
|
pageSize?: any;
|
|
5734
5600
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5735
5601
|
}
|
|
5736
|
-
export class
|
|
5602
|
+
export class BlacklistAdminBusinesses<HandleError extends boolean = boolean> {
|
|
5737
5603
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5738
5604
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5739
5605
|
/**
|
|
5740
|
-
* @tags
|
|
5741
|
-
* @name
|
|
5742
|
-
* @summary
|
|
5743
|
-
* @request
|
|
5606
|
+
* @tags Blacklist Admin Businesses
|
|
5607
|
+
* @name GetBusinessesList
|
|
5608
|
+
* @summary Get Businesses list
|
|
5609
|
+
* @request GET:/v1/admin/businesses
|
|
5744
5610
|
* @secure
|
|
5745
5611
|
*/
|
|
5746
|
-
|
|
5747
|
-
/**
|
|
5748
|
-
|
|
5749
|
-
|
|
5750
|
-
|
|
5751
|
-
|
|
5752
|
-
|
|
5753
|
-
|
|
5754
|
-
|
|
5755
|
-
|
|
5756
|
-
|
|
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;
|
|
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;
|
|
5791
5623
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5792
5624
|
/**
|
|
5793
|
-
* @tags
|
|
5794
|
-
* @name
|
|
5795
|
-
* @summary Create
|
|
5796
|
-
* @request POST:/
|
|
5797
|
-
* @secure
|
|
5798
|
-
*/
|
|
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
|
|
5625
|
+
* @tags Blacklist Admin Businesses
|
|
5626
|
+
* @name CreateBusiness
|
|
5627
|
+
* @summary Create Business
|
|
5628
|
+
* @request POST:/v1/admin/businesses
|
|
5805
5629
|
* @secure
|
|
5806
5630
|
*/
|
|
5807
|
-
|
|
5808
|
-
/** @example "
|
|
5809
|
-
|
|
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;
|
|
5810
5656
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5811
5657
|
/**
|
|
5812
|
-
* @tags
|
|
5813
|
-
* @name
|
|
5814
|
-
* @summary
|
|
5815
|
-
* @request GET:/
|
|
5658
|
+
* @tags Blacklist Admin Businesses
|
|
5659
|
+
* @name GetBusinessById
|
|
5660
|
+
* @summary Get Business by ID
|
|
5661
|
+
* @request GET:/v1/admin/businesses/{id}
|
|
5816
5662
|
* @secure
|
|
5817
5663
|
*/
|
|
5818
|
-
|
|
5819
|
-
/** @example "USERNAME" */
|
|
5820
|
-
username?: any;
|
|
5821
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5664
|
+
getBusinessById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5822
5665
|
/**
|
|
5823
|
-
* @tags
|
|
5824
|
-
* @name
|
|
5825
|
-
* @summary
|
|
5826
|
-
* @request
|
|
5666
|
+
* @tags Blacklist Admin Businesses
|
|
5667
|
+
* @name UpdateBusiness
|
|
5668
|
+
* @summary Update Business
|
|
5669
|
+
* @request PUT:/v1/admin/businesses/{id}
|
|
5827
5670
|
* @secure
|
|
5828
5671
|
*/
|
|
5829
|
-
|
|
5830
|
-
/** @example "
|
|
5831
|
-
|
|
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;
|
|
5832
5697
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5833
5698
|
/**
|
|
5834
|
-
* @tags
|
|
5835
|
-
* @name
|
|
5836
|
-
* @summary
|
|
5837
|
-
* @request
|
|
5699
|
+
* @tags Blacklist Admin Businesses
|
|
5700
|
+
* @name DeleteBusiness
|
|
5701
|
+
* @summary Delete Business
|
|
5702
|
+
* @request DELETE:/v1/admin/businesses/{id}
|
|
5838
5703
|
* @secure
|
|
5839
5704
|
*/
|
|
5840
|
-
|
|
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>);
|
|
5841
5713
|
/**
|
|
5842
|
-
* @tags
|
|
5843
|
-
* @name
|
|
5844
|
-
* @summary
|
|
5845
|
-
* @request POST:/
|
|
5714
|
+
* @tags Blacklist
|
|
5715
|
+
* @name UploadBlacklistCsv
|
|
5716
|
+
* @summary Upload Blacklist CSV
|
|
5717
|
+
* @request POST:/v1/csv/upload
|
|
5846
5718
|
* @secure
|
|
5847
5719
|
*/
|
|
5848
|
-
|
|
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>>;
|
|
5849
5727
|
/**
|
|
5850
|
-
* @tags
|
|
5851
|
-
* @name
|
|
5852
|
-
* @summary
|
|
5853
|
-
* @request
|
|
5728
|
+
* @tags Blacklist
|
|
5729
|
+
* @name GetHealth
|
|
5730
|
+
* @summary Get Health
|
|
5731
|
+
* @request GET:/v1/healthz
|
|
5854
5732
|
* @secure
|
|
5855
5733
|
*/
|
|
5856
|
-
|
|
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>>;
|
|
5734
|
+
getHealth(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5874
5735
|
}
|
|
5875
5736
|
export class WatchmenFfiFirmBranch<HandleError extends boolean = boolean> {
|
|
5876
5737
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -6047,6 +5908,145 @@ export class WatchmenFfiFirmBranch<HandleError extends boolean = boolean> {
|
|
|
6047
5908
|
id?: any;
|
|
6048
5909
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
6049
5910
|
}
|
|
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>;
|