@orbis-systems/orbis-api-clients 0.7.10 → 0.7.11
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 +114 -114
- 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 +500 -491
- 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 +622 -544
- 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/orbis/index.d.ts +1469 -1469
- 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 +319 -319
- 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 +130 -130
- 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,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,49 +510,83 @@ export class OrdersV2Options<HandleError extends boolean = boolean> {
|
|
|
588
510
|
};
|
|
589
511
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
590
512
|
}
|
|
591
|
-
export class
|
|
513
|
+
export class OrdersV2FixedIncome<HandleError extends boolean = boolean> {
|
|
592
514
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
593
515
|
constructor(apiClient: JwtClient<HandleError>);
|
|
594
516
|
/**
|
|
595
|
-
* @tags Orders V2
|
|
596
|
-
* @name
|
|
597
|
-
* @summary
|
|
598
|
-
* @request
|
|
599
|
-
* @secure
|
|
600
|
-
*/
|
|
601
|
-
listMutualFunds(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
602
|
-
/**
|
|
603
|
-
* @tags Orders V2 Mutual Funds
|
|
604
|
-
* @name MutualFundDetails
|
|
605
|
-
* @summary Mutual Fund Details
|
|
606
|
-
* @request GET:/quotes/mf/allowed/details/{symbol}
|
|
607
|
-
* @secure
|
|
608
|
-
*/
|
|
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
|
|
517
|
+
* @tags Orders V2 Fixed Income
|
|
518
|
+
* @name BondPlacement
|
|
519
|
+
* @summary Bond placement
|
|
520
|
+
* @request POST:/orders/v2/bonds/place
|
|
623
521
|
* @secure
|
|
624
522
|
*/
|
|
625
|
-
|
|
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>>;
|
|
626
553
|
/**
|
|
627
|
-
* @tags Orders V2
|
|
628
|
-
* @name
|
|
629
|
-
* @summary
|
|
630
|
-
* @request POST:/orders/v2/
|
|
554
|
+
* @tags Orders V2 Fixed Income
|
|
555
|
+
* @name BondOrderPreview
|
|
556
|
+
* @summary Bond order preview
|
|
557
|
+
* @request POST:/orders/v2/bonds/preview
|
|
631
558
|
* @secure
|
|
632
559
|
*/
|
|
633
|
-
|
|
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>>;
|
|
634
590
|
}
|
|
635
591
|
export class OrdersV2Crypto<HandleError extends boolean = boolean> {
|
|
636
592
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -706,6 +662,50 @@ export class OrdersV2Crypto<HandleError extends boolean = boolean> {
|
|
|
706
662
|
};
|
|
707
663
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
708
664
|
}
|
|
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,33 +1866,98 @@ 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 ResearchNews<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 News
|
|
1874
|
+
* @name List
|
|
1875
|
+
* @summary List
|
|
1876
|
+
* @request GET:/research/news
|
|
1877
1877
|
* @secure
|
|
1878
1878
|
*/
|
|
1879
|
-
|
|
1880
|
-
/**
|
|
1881
|
-
|
|
1882
|
-
* @example "SPY"
|
|
1883
|
-
*/
|
|
1884
|
-
benchmark?: any;
|
|
1885
|
-
/**
|
|
1886
|
-
* Comma seperated list of symbols
|
|
1887
|
-
* @example "AAPL,GOOG"
|
|
1888
|
-
*/
|
|
1889
|
-
symbols?: any;
|
|
1879
|
+
list(query?: {
|
|
1880
|
+
/** @example "0" */
|
|
1881
|
+
start?: any;
|
|
1890
1882
|
/**
|
|
1891
|
-
*
|
|
1892
|
-
* @example "
|
|
1883
|
+
* Defaults to 20
|
|
1884
|
+
* @example "100"
|
|
1893
1885
|
*/
|
|
1894
|
-
|
|
1895
|
-
/**
|
|
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"
|
|
1948
|
+
*/
|
|
1949
|
+
benchmark?: any;
|
|
1950
|
+
/**
|
|
1951
|
+
* Comma seperated list of symbols
|
|
1952
|
+
* @example "AAPL,GOOG"
|
|
1953
|
+
*/
|
|
1954
|
+
symbols?: any;
|
|
1955
|
+
/**
|
|
1956
|
+
* Format: [num][y/m] (y – year, m – months). `num` specifies number of (y/m) back from current date. If range is not provided it defaults to 1 year.
|
|
1957
|
+
* @example "2y"
|
|
1958
|
+
*/
|
|
1959
|
+
range?: any;
|
|
1960
|
+
/**
|
|
1896
1961
|
* A number between 4-10 can be selected for the period. Defaults to 4
|
|
1897
1962
|
* @example "180"
|
|
1898
1963
|
*/
|
|
@@ -1952,117 +2017,378 @@ 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
|
|
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
|
|
1960
|
-
* @name
|
|
1961
|
-
* @summary
|
|
1962
|
-
* @request GET:/research/
|
|
2024
|
+
* @tags Research Ipos
|
|
2025
|
+
* @name Recent
|
|
2026
|
+
* @summary Recent
|
|
2027
|
+
* @request GET:/research/ipo/recent
|
|
1963
2028
|
* @secure
|
|
1964
2029
|
*/
|
|
1965
|
-
|
|
1966
|
-
/** @example "0" */
|
|
1967
|
-
start?: any;
|
|
2030
|
+
recent(query?: {
|
|
1968
2031
|
/**
|
|
1969
|
-
*
|
|
1970
|
-
* @example "
|
|
2032
|
+
* `true` or `false` to load quotes
|
|
2033
|
+
* @example ""
|
|
1971
2034
|
*/
|
|
1972
|
-
|
|
1973
|
-
/**
|
|
1974
|
-
|
|
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
|
|
1978
|
-
* @name
|
|
1979
|
-
* @summary
|
|
1980
|
-
* @request GET:/research/
|
|
2042
|
+
* @tags Research Ipos
|
|
2043
|
+
* @name Upcoming
|
|
2044
|
+
* @summary Upcoming
|
|
2045
|
+
* @request GET:/research/ipo/upcoming
|
|
1981
2046
|
* @secure
|
|
1982
2047
|
*/
|
|
1983
|
-
|
|
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
|
-
*
|
|
1986
|
-
* @example ""
|
|
2058
|
+
* `true` or `false` to load quotes
|
|
2059
|
+
* @example "false"
|
|
1987
2060
|
*/
|
|
1988
|
-
|
|
1989
|
-
/**
|
|
1990
|
-
|
|
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;
|
|
1991
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>);
|
|
1992
2084
|
/**
|
|
1993
|
-
* @tags Research
|
|
1994
|
-
* @name
|
|
1995
|
-
* @summary
|
|
1996
|
-
* @request GET:/
|
|
2085
|
+
* @tags Research
|
|
2086
|
+
* @name TopStocks
|
|
2087
|
+
* @summary Top Stocks
|
|
2088
|
+
* @request GET:/quotes/top10/{category}
|
|
1997
2089
|
* @secure
|
|
1998
2090
|
*/
|
|
1999
|
-
|
|
2091
|
+
topStocks(category: string, query?: {
|
|
2000
2092
|
/**
|
|
2001
|
-
*
|
|
2002
|
-
* @example "
|
|
2093
|
+
* See table above
|
|
2094
|
+
* @example "BIG3"
|
|
2003
2095
|
*/
|
|
2004
|
-
|
|
2096
|
+
market?: any;
|
|
2005
2097
|
/**
|
|
2006
|
-
*
|
|
2007
|
-
* @example "
|
|
2098
|
+
* See table above
|
|
2099
|
+
* @example "H"
|
|
2100
|
+
*/
|
|
2101
|
+
order?: any;
|
|
2102
|
+
/**
|
|
2103
|
+
* Optional. Defaults to 10
|
|
2104
|
+
* @example "10"
|
|
2008
2105
|
*/
|
|
2009
2106
|
count?: any;
|
|
2010
2107
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2011
2108
|
/**
|
|
2012
|
-
* @tags Research
|
|
2013
|
-
* @name
|
|
2014
|
-
* @summary
|
|
2015
|
-
* @request GET:/research/
|
|
2109
|
+
* @tags Research
|
|
2110
|
+
* @name CompanyResearch
|
|
2111
|
+
* @summary Company Research
|
|
2112
|
+
* @request GET:/research/{symbol}
|
|
2016
2113
|
* @secure
|
|
2017
2114
|
*/
|
|
2018
|
-
|
|
2019
|
-
}
|
|
2020
|
-
export class UserDevice<HandleError extends boolean = boolean> {
|
|
2021
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
2022
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
2115
|
+
companyResearch(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2023
2116
|
/**
|
|
2024
|
-
* @tags
|
|
2025
|
-
* @name
|
|
2026
|
-
* @summary
|
|
2027
|
-
* @request GET:/
|
|
2117
|
+
* @tags Research
|
|
2118
|
+
* @name OptionRatios
|
|
2119
|
+
* @summary Option Ratios
|
|
2120
|
+
* @request GET:/research/option/ratios
|
|
2028
2121
|
* @secure
|
|
2029
2122
|
*/
|
|
2030
|
-
|
|
2123
|
+
optionRatios(query?: {
|
|
2124
|
+
/**
|
|
2125
|
+
* Comma separated list of symbols.
|
|
2126
|
+
* @example "AAPL,BABA"
|
|
2127
|
+
*/
|
|
2128
|
+
symbols?: any;
|
|
2129
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2031
2130
|
/**
|
|
2032
|
-
* @tags
|
|
2033
|
-
* @name
|
|
2034
|
-
* @summary
|
|
2035
|
-
* @request GET:/
|
|
2131
|
+
* @tags Research
|
|
2132
|
+
* @name OptionRadar
|
|
2133
|
+
* @summary Option Radar
|
|
2134
|
+
* @request GET:/research/option/radar
|
|
2036
2135
|
* @secure
|
|
2037
2136
|
*/
|
|
2038
|
-
|
|
2039
|
-
|
|
2137
|
+
optionRadar(query?: {
|
|
2138
|
+
/**
|
|
2139
|
+
* See table above. Leaving blank returns an overview of all of them.
|
|
2140
|
+
* @example ""
|
|
2141
|
+
*/
|
|
2142
|
+
filter?: any;
|
|
2040
2143
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2041
2144
|
/**
|
|
2042
|
-
* @tags
|
|
2043
|
-
* @name
|
|
2044
|
-
* @summary
|
|
2045
|
-
* @request
|
|
2145
|
+
* @tags Research
|
|
2146
|
+
* @name IndexComponents
|
|
2147
|
+
* @summary Index Components
|
|
2148
|
+
* @request GET:/research/index/components/{index}
|
|
2046
2149
|
* @secure
|
|
2047
2150
|
*/
|
|
2048
|
-
|
|
2049
|
-
/**
|
|
2050
|
-
|
|
2051
|
-
|
|
2052
|
-
|
|
2151
|
+
indexComponents(index: string, query?: {
|
|
2152
|
+
/**
|
|
2153
|
+
* `true` or `false` to load quotes
|
|
2154
|
+
* @example "true"
|
|
2155
|
+
*/
|
|
2156
|
+
loadQuotes?: any;
|
|
2053
2157
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2054
2158
|
/**
|
|
2055
|
-
* @tags
|
|
2056
|
-
* @name
|
|
2057
|
-
* @summary
|
|
2058
|
-
* @request
|
|
2159
|
+
* @tags Research
|
|
2160
|
+
* @name StockUpgrades
|
|
2161
|
+
* @summary Stock Upgrades
|
|
2162
|
+
* @request GET:/research/upgrades
|
|
2059
2163
|
* @secure
|
|
2060
2164
|
*/
|
|
2061
|
-
|
|
2062
|
-
/**
|
|
2063
|
-
|
|
2165
|
+
stockUpgrades(query?: {
|
|
2166
|
+
/**
|
|
2167
|
+
* Comma separated list of symbols
|
|
2168
|
+
* @example "AAPL"
|
|
2169
|
+
*/
|
|
2170
|
+
symbols?: any;
|
|
2064
2171
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2065
|
-
|
|
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)
|
|
2202
|
+
* @example "0"
|
|
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 */
|
|
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?: {
|
|
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>>;
|
|
2295
|
+
/**
|
|
2296
|
+
* @tags Research
|
|
2297
|
+
* @name IndustryList
|
|
2298
|
+
* @summary Industry List
|
|
2299
|
+
* @request GET:/
|
|
2300
|
+
* @secure
|
|
2301
|
+
*/
|
|
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>>;
|
|
2345
|
+
}
|
|
2346
|
+
export class UserDevice<HandleError extends boolean = boolean> {
|
|
2347
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2348
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2349
|
+
/**
|
|
2350
|
+
* @tags User Device
|
|
2351
|
+
* @name Register
|
|
2352
|
+
* @summary Register
|
|
2353
|
+
* @request GET:/user/device/register
|
|
2354
|
+
* @secure
|
|
2355
|
+
*/
|
|
2356
|
+
register(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2357
|
+
/**
|
|
2358
|
+
* @tags User Device
|
|
2359
|
+
* @name Deregister
|
|
2360
|
+
* @summary Deregister
|
|
2361
|
+
* @request GET:/user/device/deregister
|
|
2362
|
+
* @secure
|
|
2363
|
+
*/
|
|
2364
|
+
deregister(query?: {
|
|
2365
|
+
token?: any;
|
|
2366
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2367
|
+
/**
|
|
2368
|
+
* @tags User Device
|
|
2369
|
+
* @name FirebaseRegistration
|
|
2370
|
+
* @summary Firebase - registration
|
|
2371
|
+
* @request POST:/user/device/firebase/register
|
|
2372
|
+
* @secure
|
|
2373
|
+
*/
|
|
2374
|
+
firebaseRegistration(data: {
|
|
2375
|
+
/** @example "{predfined scope name}" */
|
|
2376
|
+
scope?: any;
|
|
2377
|
+
/** @example "a1s2d3f4g5h6" */
|
|
2378
|
+
token?: any;
|
|
2379
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2380
|
+
/**
|
|
2381
|
+
* @tags User Device
|
|
2382
|
+
* @name FirebaseRemoval
|
|
2383
|
+
* @summary Firebase - removal
|
|
2384
|
+
* @request POST:/user/device/firebase/deregister
|
|
2385
|
+
* @secure
|
|
2386
|
+
*/
|
|
2387
|
+
firebaseRemoval(data: {
|
|
2388
|
+
/** @example "a1s2d3f4g5h6" */
|
|
2389
|
+
token?: any;
|
|
2390
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2391
|
+
}
|
|
2066
2392
|
export class UserTradingLimitManagement<HandleError extends boolean = boolean> {
|
|
2067
2393
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2068
2394
|
constructor(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>);
|
|
@@ -2228,46 +2535,65 @@ export class UserWatchlists<HandleError extends boolean = boolean> {
|
|
|
2228
2535
|
*/
|
|
2229
2536
|
removeFromWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2230
2537
|
}
|
|
2231
|
-
export class
|
|
2538
|
+
export class UserAgreements<HandleError extends boolean = boolean> {
|
|
2232
2539
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2233
2540
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2234
2541
|
/**
|
|
2235
|
-
* @tags User
|
|
2236
|
-
* @name
|
|
2237
|
-
* @summary
|
|
2238
|
-
* @request
|
|
2542
|
+
* @tags User Agreements
|
|
2543
|
+
* @name Available
|
|
2544
|
+
* @summary Available
|
|
2545
|
+
* @request GET:/user/agreements/all/active
|
|
2239
2546
|
* @secure
|
|
2240
2547
|
*/
|
|
2241
|
-
|
|
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>>;
|
|
2548
|
+
available(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2249
2549
|
/**
|
|
2250
|
-
* @tags User
|
|
2251
|
-
* @name
|
|
2252
|
-
* @summary
|
|
2253
|
-
* @request GET:/user/
|
|
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>>;
|
|
2573
|
+
/**
|
|
2574
|
+
* @tags User Agreements
|
|
2575
|
+
* @name Sign
|
|
2576
|
+
* @summary Sign
|
|
2577
|
+
* @request POST:/user/agreements/sign
|
|
2578
|
+
* @secure
|
|
2579
|
+
*/
|
|
2580
|
+
sign(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2581
|
+
/**
|
|
2582
|
+
* @tags User Agreements
|
|
2583
|
+
* @name CryptoAgreement
|
|
2584
|
+
* @summary Crypto Agreement
|
|
2585
|
+
* @request GET:/user/agreements/crypto/Agreement
|
|
2254
2586
|
* @secure
|
|
2255
2587
|
*/
|
|
2256
|
-
|
|
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
|
|
2262
|
-
* @name
|
|
2263
|
-
* @summary
|
|
2264
|
-
* @request
|
|
2590
|
+
* @tags User Agreements
|
|
2591
|
+
* @name CryptoSign
|
|
2592
|
+
* @summary Crypto Sign
|
|
2593
|
+
* @request POST:/user/agreements/crypto/sign
|
|
2265
2594
|
* @secure
|
|
2266
2595
|
*/
|
|
2267
|
-
|
|
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>;
|
|
@@ -2954,611 +3280,285 @@ export class AdvisoryCharges<HandleError extends boolean = boolean> {
|
|
|
2954
3280
|
* @tags Advisory Charges
|
|
2955
3281
|
* @name Cancel
|
|
2956
3282
|
* @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}
|
|
3108
|
-
* @secure
|
|
3109
|
-
*/
|
|
3110
|
-
portfolio(modelId: string, query?: {
|
|
3111
|
-
/**
|
|
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
|
|
3283
|
+
* @request POST:/v2/charges/cancel
|
|
3193
3284
|
* @secure
|
|
3194
3285
|
*/
|
|
3195
|
-
|
|
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>);
|
|
3196
3291
|
/**
|
|
3197
3292
|
* @tags Advisory Models
|
|
3198
|
-
* @name
|
|
3199
|
-
* @summary
|
|
3200
|
-
* @request
|
|
3293
|
+
* @name Listing
|
|
3294
|
+
* @summary Listing
|
|
3295
|
+
* @request GET:/v2/advisory/models
|
|
3201
3296
|
* @secure
|
|
3202
3297
|
*/
|
|
3203
|
-
|
|
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>>;
|
|
3204
3310
|
/**
|
|
3205
3311
|
* @tags Advisory Models
|
|
3206
|
-
* @name
|
|
3207
|
-
* @summary
|
|
3208
|
-
* @request
|
|
3312
|
+
* @name ModelsByAccount
|
|
3313
|
+
* @summary Models by account
|
|
3314
|
+
* @request GET:/v2/advisory/modelsOfAccount
|
|
3209
3315
|
* @secure
|
|
3210
3316
|
*/
|
|
3211
|
-
|
|
3317
|
+
modelsByAccount(query?: {
|
|
3318
|
+
/** @example "" */
|
|
3319
|
+
accountId?: any;
|
|
3320
|
+
/** @example "" */
|
|
3321
|
+
account?: any;
|
|
3322
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3212
3323
|
/**
|
|
3213
3324
|
* @tags Advisory Models
|
|
3214
|
-
* @name
|
|
3215
|
-
* @summary
|
|
3216
|
-
* @request
|
|
3325
|
+
* @name ComponentTags
|
|
3326
|
+
* @summary Component tags
|
|
3327
|
+
* @request GET:/v2/advisory/models/components/tags
|
|
3217
3328
|
* @secure
|
|
3218
3329
|
*/
|
|
3219
|
-
|
|
3330
|
+
componentTags(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3220
3331
|
/**
|
|
3221
3332
|
* @tags Advisory Models
|
|
3222
|
-
* @name
|
|
3223
|
-
* @summary
|
|
3224
|
-
* @request
|
|
3333
|
+
* @name BuyingPower
|
|
3334
|
+
* @summary Buying power
|
|
3335
|
+
* @request GET:/v2/advisory/model/balance/{currency}/{modelId}
|
|
3225
3336
|
* @secure
|
|
3226
3337
|
*/
|
|
3227
|
-
|
|
3338
|
+
buyingPower(currency: string, modelId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3228
3339
|
/**
|
|
3229
3340
|
* @tags Advisory Models
|
|
3230
|
-
* @name
|
|
3231
|
-
* @summary
|
|
3232
|
-
* @request
|
|
3341
|
+
* @name RealtimeBalance
|
|
3342
|
+
* @summary Realtime balance
|
|
3343
|
+
* @request GET:/v2/advisory/model/rtb/{modelId}
|
|
3233
3344
|
* @secure
|
|
3234
3345
|
*/
|
|
3235
|
-
|
|
3236
|
-
}
|
|
3237
|
-
export class ResearchIpos<HandleError extends boolean = boolean> {
|
|
3238
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
3239
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
3346
|
+
realtimeBalance(modelId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3240
3347
|
/**
|
|
3241
|
-
* @tags
|
|
3242
|
-
* @name
|
|
3243
|
-
* @summary
|
|
3244
|
-
* @request GET:/
|
|
3348
|
+
* @tags Advisory Models
|
|
3349
|
+
* @name RealtimeBalanceHistory
|
|
3350
|
+
* @summary Realtime balance history
|
|
3351
|
+
* @request GET:/v2/advisory/model/rtb/history/{modelId}
|
|
3245
3352
|
* @secure
|
|
3246
3353
|
*/
|
|
3247
|
-
|
|
3248
|
-
/**
|
|
3249
|
-
|
|
3250
|
-
|
|
3251
|
-
|
|
3252
|
-
|
|
3253
|
-
|
|
3254
|
-
time?: any;
|
|
3255
|
-
/** symbol, ipoDate, offerPx, shares, day1Ret, ipoRet, last, change, offerSz */
|
|
3256
|
-
sort?: 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;
|
|
3257
3361
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3258
3362
|
/**
|
|
3259
|
-
* @tags
|
|
3260
|
-
* @name
|
|
3261
|
-
* @summary
|
|
3262
|
-
* @request GET:/
|
|
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
|
|
3363
|
+
* @tags Advisory Models
|
|
3364
|
+
* @name Adjustments
|
|
3365
|
+
* @summary Adjustments
|
|
3366
|
+
* @request GET:/v2/advisory/model/adjustments/{modelId}
|
|
3271
3367
|
* @secure
|
|
3272
3368
|
*/
|
|
3273
|
-
|
|
3369
|
+
adjustments(modelId: string, query?: {
|
|
3274
3370
|
/**
|
|
3275
|
-
*
|
|
3371
|
+
* true|false
|
|
3276
3372
|
* @example "false"
|
|
3277
3373
|
*/
|
|
3278
3374
|
loadQuotes?: any;
|
|
3279
|
-
/**
|
|
3280
|
-
|
|
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;
|
|
3375
|
+
/** Pending, Active, Complete, Rejected, Cancelled */
|
|
3376
|
+
status?: any;
|
|
3324
3377
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3325
3378
|
/**
|
|
3326
|
-
* @tags
|
|
3327
|
-
* @name
|
|
3328
|
-
* @summary
|
|
3329
|
-
* @request GET:/
|
|
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
|
-
|
|
3385
|
+
adjustmentPreview(adjustmentId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3333
3386
|
/**
|
|
3334
|
-
* @tags
|
|
3335
|
-
* @name
|
|
3336
|
-
* @summary
|
|
3337
|
-
* @request GET:/
|
|
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
|
-
|
|
3393
|
+
memberAccounts(modelId: string, query?: {
|
|
3341
3394
|
/**
|
|
3342
|
-
*
|
|
3343
|
-
* @example "
|
|
3395
|
+
* `true`|`false` - whether or not to load account's realtime balance
|
|
3396
|
+
* @example "false"
|
|
3344
3397
|
*/
|
|
3345
|
-
|
|
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
|
|
3349
|
-
* @name
|
|
3350
|
-
* @summary
|
|
3351
|
-
* @request GET:/
|
|
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
|
-
|
|
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
|
|
3363
|
-
* @name
|
|
3364
|
-
* @summary
|
|
3365
|
-
* @request GET:/
|
|
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
|
-
|
|
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
|
|
3377
|
-
* @name
|
|
3378
|
-
* @summary
|
|
3379
|
-
* @request GET:/
|
|
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
|
-
|
|
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
|
|
3391
|
-
* @name
|
|
3392
|
-
* @summary
|
|
3393
|
-
* @request GET:/
|
|
3430
|
+
* @tags Advisory Models
|
|
3431
|
+
* @name Portfolio
|
|
3432
|
+
* @summary Portfolio
|
|
3433
|
+
* @request GET:/v2/advisory/model/portfolios/{modelId}
|
|
3394
3434
|
* @secure
|
|
3395
3435
|
*/
|
|
3396
|
-
|
|
3397
|
-
/**
|
|
3398
|
-
* Comma separated list of tickers
|
|
3399
|
-
* @example "MSFT,GOOG"
|
|
3400
|
-
*/
|
|
3401
|
-
symbols?: any;
|
|
3436
|
+
portfolio(modelId: string, query?: {
|
|
3402
3437
|
/**
|
|
3403
|
-
*
|
|
3404
|
-
* @example "
|
|
3438
|
+
* Should load quotes or not.
|
|
3439
|
+
* @example "false"
|
|
3405
3440
|
*/
|
|
3406
|
-
|
|
3441
|
+
loadQuotes?: any;
|
|
3407
3442
|
/**
|
|
3408
|
-
*
|
|
3409
|
-
* @example "
|
|
3443
|
+
* Whether to return combined portfolio (no accounts, with approximate prices)
|
|
3444
|
+
* @example "false"
|
|
3410
3445
|
*/
|
|
3411
|
-
|
|
3446
|
+
combined?: any;
|
|
3447
|
+
/** @example "false" */
|
|
3448
|
+
loadIndustries?: any;
|
|
3449
|
+
/** @example "false" */
|
|
3450
|
+
loadUpgrades?: any;
|
|
3451
|
+
/** @example "false" */
|
|
3452
|
+
loadEarnings?: any;
|
|
3412
3453
|
/**
|
|
3413
|
-
*
|
|
3414
|
-
* @example "
|
|
3454
|
+
* Whether or not to include orders comprising each position's cost
|
|
3455
|
+
* @example "false"
|
|
3415
3456
|
*/
|
|
3416
|
-
|
|
3457
|
+
loadCost?: any;
|
|
3417
3458
|
/**
|
|
3418
|
-
*
|
|
3419
|
-
* @example "
|
|
3459
|
+
* Analyze market caps and get `marketCapWeights`. To be used in conjuction with `loadQuotes`
|
|
3460
|
+
* @example "false"
|
|
3420
3461
|
*/
|
|
3421
|
-
|
|
3462
|
+
marketCapWeights?: any;
|
|
3422
3463
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3423
3464
|
/**
|
|
3424
|
-
* @tags
|
|
3425
|
-
* @name
|
|
3426
|
-
* @summary
|
|
3427
|
-
* @request GET:/
|
|
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
|
-
|
|
3471
|
+
allModelBuyingPower(currency: string, query?: {
|
|
3431
3472
|
/**
|
|
3432
|
-
*
|
|
3433
|
-
* @example "
|
|
3473
|
+
* [optional] when omitted defaults to system's setting.
|
|
3474
|
+
* @example "USD"
|
|
3434
3475
|
*/
|
|
3435
|
-
|
|
3476
|
+
currency?: any;
|
|
3436
3477
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3437
3478
|
/**
|
|
3438
|
-
* @tags
|
|
3439
|
-
* @name
|
|
3440
|
-
* @summary
|
|
3441
|
-
* @request GET:/
|
|
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
|
-
|
|
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
|
|
3468
|
-
* @name
|
|
3469
|
-
* @summary
|
|
3470
|
-
* @request GET:/
|
|
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
|
-
|
|
3495
|
+
positionLookupOptions(modelId: string, query?: {
|
|
3496
|
+
symbol?: any;
|
|
3497
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3474
3498
|
/**
|
|
3475
|
-
* @tags
|
|
3476
|
-
* @name
|
|
3477
|
-
* @summary
|
|
3478
|
-
* @request
|
|
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
|
-
|
|
3505
|
+
adjustmentUpdates(action: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3482
3506
|
/**
|
|
3483
|
-
* @tags
|
|
3484
|
-
* @name
|
|
3485
|
-
* @summary
|
|
3486
|
-
* @request POST:/
|
|
3507
|
+
* @tags Advisory Models
|
|
3508
|
+
* @name Creation
|
|
3509
|
+
* @summary Creation
|
|
3510
|
+
* @request POST:/v2/advisory/model/create
|
|
3487
3511
|
* @secure
|
|
3488
3512
|
*/
|
|
3489
|
-
|
|
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
|
|
3499
|
-
* @name
|
|
3500
|
-
* @summary
|
|
3501
|
-
* @request
|
|
3515
|
+
* @tags Advisory Models
|
|
3516
|
+
* @name Update
|
|
3517
|
+
* @summary Update
|
|
3518
|
+
* @request POST:/v2/advisory/model/update
|
|
3502
3519
|
* @secure
|
|
3503
3520
|
*/
|
|
3504
|
-
|
|
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
|
|
3514
|
-
* @name
|
|
3515
|
-
* @summary
|
|
3516
|
-
* @request
|
|
3523
|
+
* @tags Advisory Models
|
|
3524
|
+
* @name Deletion
|
|
3525
|
+
* @summary Deletion
|
|
3526
|
+
* @request POST:/v2/advisory/model/delete
|
|
3517
3527
|
* @secure
|
|
3518
3528
|
*/
|
|
3519
|
-
|
|
3529
|
+
deletion(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3520
3530
|
/**
|
|
3521
|
-
* @tags
|
|
3522
|
-
* @name
|
|
3523
|
-
* @summary
|
|
3524
|
-
* @request
|
|
3531
|
+
* @tags Advisory Models
|
|
3532
|
+
* @name ComponentUpdate
|
|
3533
|
+
* @summary Component update
|
|
3534
|
+
* @request POST:/v2/advisory/model/component/update
|
|
3525
3535
|
* @secure
|
|
3526
3536
|
*/
|
|
3527
|
-
|
|
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>>;
|
|
3537
|
+
componentUpdate(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3542
3538
|
/**
|
|
3543
|
-
* @tags
|
|
3544
|
-
* @name
|
|
3545
|
-
* @summary
|
|
3546
|
-
* @request
|
|
3539
|
+
* @tags Advisory Models
|
|
3540
|
+
* @name LinkOfMemberAccounts
|
|
3541
|
+
* @summary Link of member accounts
|
|
3542
|
+
* @request POST:/v2/advisory/model/account/link
|
|
3547
3543
|
* @secure
|
|
3548
3544
|
*/
|
|
3549
|
-
|
|
3545
|
+
linkOfMemberAccounts(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3550
3546
|
/**
|
|
3551
|
-
* @tags
|
|
3552
|
-
* @name
|
|
3553
|
-
* @summary
|
|
3554
|
-
* @request
|
|
3547
|
+
* @tags Advisory Models
|
|
3548
|
+
* @name UnlinkMemberAccount
|
|
3549
|
+
* @summary Unlink member account
|
|
3550
|
+
* @request POST:/v2/advisory/model/account/unlink
|
|
3555
3551
|
* @secure
|
|
3556
3552
|
*/
|
|
3557
|
-
|
|
3558
|
-
|
|
3559
|
-
|
|
3560
|
-
|
|
3561
|
-
|
|
3553
|
+
unlinkMemberAccount(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3554
|
+
/**
|
|
3555
|
+
* @tags Advisory Models
|
|
3556
|
+
* @name Allocations
|
|
3557
|
+
* @summary Allocations
|
|
3558
|
+
* @request POST:/v2/advisory/model/orders/allocate
|
|
3559
|
+
* @secure
|
|
3560
|
+
*/
|
|
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>;
|
|
@@ -3594,119 +3594,42 @@ export class AdvisoryUserAccountManagement<HandleError extends boolean = boolean
|
|
|
3594
3594
|
* @request GET:/v2/advisory/users/accounts/stats
|
|
3595
3595
|
* @secure
|
|
3596
3596
|
*/
|
|
3597
|
-
accountsStats(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3598
|
-
/**
|
|
3599
|
-
* @tags Advisory User Account Management
|
|
3600
|
-
* @name AccountNotes
|
|
3601
|
-
* @summary /account/notes
|
|
3602
|
-
* @request GET:/v2/advisory/users/account/notes
|
|
3603
|
-
* @secure
|
|
3604
|
-
*/
|
|
3605
|
-
accountNotes(query?: {
|
|
3606
|
-
/**
|
|
3607
|
-
* Account's ID
|
|
3608
|
-
* @example "1234"
|
|
3609
|
-
*/
|
|
3610
|
-
aid?: any;
|
|
3611
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3612
|
-
/**
|
|
3613
|
-
* @tags Advisory User Account Management
|
|
3614
|
-
* @name Notes
|
|
3615
|
-
* @summary /notes
|
|
3616
|
-
* @request GET:/v2/advisory/users/notes
|
|
3617
|
-
* @secure
|
|
3618
|
-
*/
|
|
3619
|
-
notes(query?: {
|
|
3620
|
-
/**
|
|
3621
|
-
* User's ID
|
|
3622
|
-
* @example "1234"
|
|
3623
|
-
*/
|
|
3624
|
-
uid?: any;
|
|
3625
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3626
|
-
/**
|
|
3627
|
-
* @tags Advisory User Account Management
|
|
3628
|
-
* @name NotesPost
|
|
3629
|
-
* @request POST:/v2/advisory/users/notes/{action}
|
|
3630
|
-
* @secure
|
|
3631
|
-
*/
|
|
3632
|
-
notesPost(action: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3633
|
-
}
|
|
3634
|
-
export class AdvisoryGroups<HandleError extends boolean = boolean> {
|
|
3635
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
3636
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
3637
|
-
/**
|
|
3638
|
-
* @tags Advisory Groups
|
|
3639
|
-
* @name GroupsManage
|
|
3640
|
-
* @request POST:/v1/groups/manage/{action}
|
|
3641
|
-
* @secure
|
|
3642
|
-
*/
|
|
3643
|
-
groupsManage(action: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3644
|
-
/**
|
|
3645
|
-
* @tags Advisory Groups
|
|
3646
|
-
* @name GroupsList
|
|
3647
|
-
* @request GET:/v1/groups/list
|
|
3648
|
-
* @secure
|
|
3649
|
-
*/
|
|
3650
|
-
groupsList(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3651
|
-
/**
|
|
3652
|
-
* @tags Advisory Groups
|
|
3653
|
-
* @name GroupAccountsStats
|
|
3654
|
-
* @request GET:/v2/advisory/group/accounts/stats/{groupsId}
|
|
3655
|
-
* @secure
|
|
3656
|
-
*/
|
|
3657
|
-
groupAccountsStats(groupsId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3597
|
+
accountsStats(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3658
3598
|
/**
|
|
3659
|
-
* @tags Advisory
|
|
3660
|
-
* @name
|
|
3661
|
-
* @
|
|
3599
|
+
* @tags Advisory User Account Management
|
|
3600
|
+
* @name AccountNotes
|
|
3601
|
+
* @summary /account/notes
|
|
3602
|
+
* @request GET:/v2/advisory/users/account/notes
|
|
3662
3603
|
* @secure
|
|
3663
3604
|
*/
|
|
3664
|
-
|
|
3665
|
-
/**
|
|
3666
|
-
* Should load quotes or not.
|
|
3667
|
-
* @example "false"
|
|
3668
|
-
*/
|
|
3669
|
-
loadQuotes?: any;
|
|
3670
|
-
/**
|
|
3671
|
-
* Whether to return combined portfolio (no accounts, with approximate prices)
|
|
3672
|
-
* @example "false"
|
|
3673
|
-
*/
|
|
3674
|
-
combined?: any;
|
|
3675
|
-
/** @example "false" */
|
|
3676
|
-
loadIndustries?: any;
|
|
3677
|
-
/** @example "false" */
|
|
3678
|
-
loadUpgrades?: any;
|
|
3679
|
-
/** @example "false" */
|
|
3680
|
-
loadEarnings?: any;
|
|
3681
|
-
/**
|
|
3682
|
-
* Whether or not to include orders comprising each position's cost
|
|
3683
|
-
* @example "false"
|
|
3684
|
-
*/
|
|
3685
|
-
loadCost?: any;
|
|
3605
|
+
accountNotes(query?: {
|
|
3686
3606
|
/**
|
|
3687
|
-
*
|
|
3688
|
-
* @example "
|
|
3607
|
+
* Account's ID
|
|
3608
|
+
* @example "1234"
|
|
3689
3609
|
*/
|
|
3690
|
-
|
|
3691
|
-
/** @example "1" */
|
|
3692
|
-
pageNum?: any;
|
|
3693
|
-
/** @example "100" */
|
|
3694
|
-
pageSize?: any;
|
|
3610
|
+
aid?: any;
|
|
3695
3611
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3696
3612
|
/**
|
|
3697
|
-
* @tags Advisory
|
|
3698
|
-
* @name
|
|
3699
|
-
* @
|
|
3613
|
+
* @tags Advisory User Account Management
|
|
3614
|
+
* @name Notes
|
|
3615
|
+
* @summary /notes
|
|
3616
|
+
* @request GET:/v2/advisory/users/notes
|
|
3700
3617
|
* @secure
|
|
3701
3618
|
*/
|
|
3702
|
-
|
|
3619
|
+
notes(query?: {
|
|
3620
|
+
/**
|
|
3621
|
+
* User's ID
|
|
3622
|
+
* @example "1234"
|
|
3623
|
+
*/
|
|
3624
|
+
uid?: any;
|
|
3625
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3703
3626
|
/**
|
|
3704
|
-
* @tags Advisory
|
|
3705
|
-
* @name
|
|
3706
|
-
* @request
|
|
3627
|
+
* @tags Advisory User Account Management
|
|
3628
|
+
* @name NotesPost
|
|
3629
|
+
* @request POST:/v2/advisory/users/notes/{action}
|
|
3707
3630
|
* @secure
|
|
3708
3631
|
*/
|
|
3709
|
-
|
|
3632
|
+
notesPost(action: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3710
3633
|
}
|
|
3711
3634
|
export class AdvisoryAnalytics<HandleError extends boolean = boolean> {
|
|
3712
3635
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -3762,24 +3685,6 @@ export class AdvisoryAnalytics<HandleError extends boolean = boolean> {
|
|
|
3762
3685
|
threshold?: any;
|
|
3763
3686
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3764
3687
|
}
|
|
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
3688
|
export class AdvisoryAllocations<HandleError extends boolean = boolean> {
|
|
3784
3689
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3785
3690
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4076,6 +3981,83 @@ export class TransfersRelationships<HandleError extends boolean = boolean> {
|
|
|
4076
3981
|
};
|
|
4077
3982
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4078
3983
|
}
|
|
3984
|
+
export class AdvisoryGroups<HandleError extends boolean = boolean> {
|
|
3985
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3986
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3987
|
+
/**
|
|
3988
|
+
* @tags Advisory Groups
|
|
3989
|
+
* @name GroupsManage
|
|
3990
|
+
* @request POST:/v1/groups/manage/{action}
|
|
3991
|
+
* @secure
|
|
3992
|
+
*/
|
|
3993
|
+
groupsManage(action: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3994
|
+
/**
|
|
3995
|
+
* @tags Advisory Groups
|
|
3996
|
+
* @name GroupsList
|
|
3997
|
+
* @request GET:/v1/groups/list
|
|
3998
|
+
* @secure
|
|
3999
|
+
*/
|
|
4000
|
+
groupsList(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4001
|
+
/**
|
|
4002
|
+
* @tags Advisory Groups
|
|
4003
|
+
* @name GroupAccountsStats
|
|
4004
|
+
* @request GET:/v2/advisory/group/accounts/stats/{groupsId}
|
|
4005
|
+
* @secure
|
|
4006
|
+
*/
|
|
4007
|
+
groupAccountsStats(groupsId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4008
|
+
/**
|
|
4009
|
+
* @tags Advisory Groups
|
|
4010
|
+
* @name GroupPortfolios
|
|
4011
|
+
* @request GET:/v2/advisory/group/portfolios/{groupId}
|
|
4012
|
+
* @secure
|
|
4013
|
+
*/
|
|
4014
|
+
groupPortfolios(groupId: string, query?: {
|
|
4015
|
+
/**
|
|
4016
|
+
* Should load quotes or not.
|
|
4017
|
+
* @example "false"
|
|
4018
|
+
*/
|
|
4019
|
+
loadQuotes?: any;
|
|
4020
|
+
/**
|
|
4021
|
+
* Whether to return combined portfolio (no accounts, with approximate prices)
|
|
4022
|
+
* @example "false"
|
|
4023
|
+
*/
|
|
4024
|
+
combined?: any;
|
|
4025
|
+
/** @example "false" */
|
|
4026
|
+
loadIndustries?: any;
|
|
4027
|
+
/** @example "false" */
|
|
4028
|
+
loadUpgrades?: any;
|
|
4029
|
+
/** @example "false" */
|
|
4030
|
+
loadEarnings?: any;
|
|
4031
|
+
/**
|
|
4032
|
+
* Whether or not to include orders comprising each position's cost
|
|
4033
|
+
* @example "false"
|
|
4034
|
+
*/
|
|
4035
|
+
loadCost?: any;
|
|
4036
|
+
/**
|
|
4037
|
+
* Analyze market caps and get `marketCapWeights`. To be used in conjuction with `loadQuotes`
|
|
4038
|
+
* @example "false"
|
|
4039
|
+
*/
|
|
4040
|
+
marketCapWeights?: any;
|
|
4041
|
+
/** @example "1" */
|
|
4042
|
+
pageNum?: any;
|
|
4043
|
+
/** @example "100" */
|
|
4044
|
+
pageSize?: any;
|
|
4045
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4046
|
+
/**
|
|
4047
|
+
* @tags Advisory Groups
|
|
4048
|
+
* @name GroupRtb
|
|
4049
|
+
* @request GET:/v2/advisory/group/rtb/{groupId}
|
|
4050
|
+
* @secure
|
|
4051
|
+
*/
|
|
4052
|
+
groupRtb(groupId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4053
|
+
/**
|
|
4054
|
+
* @tags Advisory Groups
|
|
4055
|
+
* @name GroupRtbs
|
|
4056
|
+
* @request GET:/v2/advisory/group/rtbs/{groupId}
|
|
4057
|
+
* @secure
|
|
4058
|
+
*/
|
|
4059
|
+
groupRtbs(groupId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4060
|
+
}
|
|
4079
4061
|
export class TransfersInstantAccountVerification<HandleError extends boolean = boolean> {
|
|
4080
4062
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4081
4063
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4155,6 +4137,44 @@ export class TransfersInstantAccountVerification<HandleError extends boolean = b
|
|
|
4155
4137
|
remoteDevice?: any;
|
|
4156
4138
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4157
4139
|
}
|
|
4140
|
+
export class TransfersAch<HandleError extends boolean = boolean> {
|
|
4141
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4142
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4143
|
+
/**
|
|
4144
|
+
* @tags Transfers Ach
|
|
4145
|
+
* @name Deposit
|
|
4146
|
+
* @summary Deposit
|
|
4147
|
+
* @request POST:/transfer/ach/deposit
|
|
4148
|
+
* @secure
|
|
4149
|
+
*/
|
|
4150
|
+
deposit(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4151
|
+
/**
|
|
4152
|
+
* @tags Transfers Ach
|
|
4153
|
+
* @name Withdraw
|
|
4154
|
+
* @summary Withdraw
|
|
4155
|
+
* @request POST:/transfer/ach/withdraw
|
|
4156
|
+
* @secure
|
|
4157
|
+
*/
|
|
4158
|
+
withdraw(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4159
|
+
}
|
|
4160
|
+
export class Device<HandleError extends boolean = boolean> {
|
|
4161
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4162
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4163
|
+
/**
|
|
4164
|
+
* @tags Device
|
|
4165
|
+
* @name DeviceDeactivate
|
|
4166
|
+
* @summary /device/deactivate
|
|
4167
|
+
* @request POST:/device/deactivate
|
|
4168
|
+
* @secure
|
|
4169
|
+
*/
|
|
4170
|
+
deviceDeactivate(data: {
|
|
4171
|
+
/**
|
|
4172
|
+
* Token previously registered
|
|
4173
|
+
* @example "123456789"
|
|
4174
|
+
*/
|
|
4175
|
+
Token?: string;
|
|
4176
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4177
|
+
}
|
|
4158
4178
|
export class TransfersAcats<HandleError extends boolean = boolean> {
|
|
4159
4179
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4160
4180
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4288,26 +4308,6 @@ export class TransfersAcats<HandleError extends boolean = boolean> {
|
|
|
4288
4308
|
type?: string;
|
|
4289
4309
|
}[], config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4290
4310
|
}
|
|
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>);
|
|
@@ -4383,6 +4383,57 @@ export class TransfersWires<HandleError extends boolean = boolean> {
|
|
|
4383
4383
|
remoteDevice?: any;
|
|
4384
4384
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4385
4385
|
}
|
|
4386
|
+
export class TransfersPositions<HandleError extends boolean = boolean> {
|
|
4387
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4388
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4389
|
+
/**
|
|
4390
|
+
* @tags Transfers Positions
|
|
4391
|
+
* @name TransferRequest
|
|
4392
|
+
* @summary Transfer request
|
|
4393
|
+
* @request POST:/transfer/position/request
|
|
4394
|
+
* @secure
|
|
4395
|
+
*/
|
|
4396
|
+
transferRequest(data: {
|
|
4397
|
+
deliverFrom?: {
|
|
4398
|
+
/** @example 124 */
|
|
4399
|
+
accountId?: number;
|
|
4400
|
+
/** @example "ABC123456" */
|
|
4401
|
+
accountNumber?: string;
|
|
4402
|
+
};
|
|
4403
|
+
deliverTo?: {
|
|
4404
|
+
/** @example 456 */
|
|
4405
|
+
accountId?: number;
|
|
4406
|
+
/** @example "DEF123456" */
|
|
4407
|
+
accountNumber?: string;
|
|
4408
|
+
};
|
|
4409
|
+
/** @example "NoPurpose|Gift" */
|
|
4410
|
+
purpose?: any;
|
|
4411
|
+
/** @example 1000 */
|
|
4412
|
+
quantity?: any;
|
|
4413
|
+
quote?: {
|
|
4414
|
+
/** @example "IBM" */
|
|
4415
|
+
symbol?: string;
|
|
4416
|
+
};
|
|
4417
|
+
/** @example "" */
|
|
4418
|
+
reason?: any;
|
|
4419
|
+
/** @example "0.0.0.0" */
|
|
4420
|
+
remoteAddr?: any;
|
|
4421
|
+
/** @example "Ultra fast proxy" */
|
|
4422
|
+
remoteDevice?: any;
|
|
4423
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4424
|
+
}
|
|
4425
|
+
export class TransfersBank<HandleError extends boolean = boolean> {
|
|
4426
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4427
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4428
|
+
/**
|
|
4429
|
+
* @tags Transfers Bank
|
|
4430
|
+
* @name FundTransfer
|
|
4431
|
+
* @summary Fund transfer
|
|
4432
|
+
* @request POST:/transfer/bank/{direction}
|
|
4433
|
+
* @secure
|
|
4434
|
+
*/
|
|
4435
|
+
fundTransfer(direction: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4436
|
+
}
|
|
4386
4437
|
export class TransfersJournals<HandleError extends boolean = boolean> {
|
|
4387
4438
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4388
4439
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4453,57 +4504,6 @@ export class TransfersJournals<HandleError extends boolean = boolean> {
|
|
|
4453
4504
|
transferId?: any;
|
|
4454
4505
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4455
4506
|
}
|
|
4456
|
-
export class TransfersPositions<HandleError extends boolean = boolean> {
|
|
4457
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4458
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4459
|
-
/**
|
|
4460
|
-
* @tags Transfers Positions
|
|
4461
|
-
* @name TransferRequest
|
|
4462
|
-
* @summary Transfer request
|
|
4463
|
-
* @request POST:/transfer/position/request
|
|
4464
|
-
* @secure
|
|
4465
|
-
*/
|
|
4466
|
-
transferRequest(data: {
|
|
4467
|
-
deliverFrom?: {
|
|
4468
|
-
/** @example 124 */
|
|
4469
|
-
accountId?: number;
|
|
4470
|
-
/** @example "ABC123456" */
|
|
4471
|
-
accountNumber?: string;
|
|
4472
|
-
};
|
|
4473
|
-
deliverTo?: {
|
|
4474
|
-
/** @example 456 */
|
|
4475
|
-
accountId?: number;
|
|
4476
|
-
/** @example "DEF123456" */
|
|
4477
|
-
accountNumber?: string;
|
|
4478
|
-
};
|
|
4479
|
-
/** @example "NoPurpose|Gift" */
|
|
4480
|
-
purpose?: any;
|
|
4481
|
-
/** @example 1000 */
|
|
4482
|
-
quantity?: any;
|
|
4483
|
-
quote?: {
|
|
4484
|
-
/** @example "IBM" */
|
|
4485
|
-
symbol?: string;
|
|
4486
|
-
};
|
|
4487
|
-
/** @example "" */
|
|
4488
|
-
reason?: any;
|
|
4489
|
-
/** @example "0.0.0.0" */
|
|
4490
|
-
remoteAddr?: any;
|
|
4491
|
-
/** @example "Ultra fast proxy" */
|
|
4492
|
-
remoteDevice?: any;
|
|
4493
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4494
|
-
}
|
|
4495
|
-
export class TransfersBank<HandleError extends boolean = boolean> {
|
|
4496
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4497
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4498
|
-
/**
|
|
4499
|
-
* @tags Transfers Bank
|
|
4500
|
-
* @name FundTransfer
|
|
4501
|
-
* @summary Fund transfer
|
|
4502
|
-
* @request POST:/transfer/bank/{direction}
|
|
4503
|
-
* @secure
|
|
4504
|
-
*/
|
|
4505
|
-
fundTransfer(direction: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4506
|
-
}
|
|
4507
4507
|
export class TransfersInstantCashTransfers<HandleError extends boolean = boolean> {
|
|
4508
4508
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4509
4509
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4767,242 +4767,93 @@ export class Transfers<HandleError extends boolean = boolean> {
|
|
|
4767
4767
|
/** @example "ultra fast browser 1.1" */
|
|
4768
4768
|
remoteDevice?: any;
|
|
4769
4769
|
/** @example "BTC/USD" */
|
|
4770
|
-
symbol?: any;
|
|
4771
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4772
|
-
/**
|
|
4773
|
-
* @tags Transfers
|
|
4774
|
-
* @name ListFees
|
|
4775
|
-
* @summary List fees
|
|
4776
|
-
* @request GET:/transfer/fees/classifications/fees
|
|
4777
|
-
* @secure
|
|
4778
|
-
*/
|
|
4779
|
-
listFees(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4780
|
-
/**
|
|
4781
|
-
* @tags Transfers
|
|
4782
|
-
* @name ListCredits
|
|
4783
|
-
* @summary List credits
|
|
4784
|
-
* @request GET:/transfer/fees/classifications/credits
|
|
4785
|
-
* @secure
|
|
4786
|
-
*/
|
|
4787
|
-
listCredits(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4788
|
-
/**
|
|
4789
|
-
* @tags Transfers
|
|
4790
|
-
* @name CryptoDepositAddress
|
|
4791
|
-
* @summary Crypto Deposit Address
|
|
4792
|
-
* @request GET:/transfer/crypto/deposit/wallet/address
|
|
4793
|
-
* @secure
|
|
4794
|
-
*/
|
|
4795
|
-
cryptoDepositAddress(data: {
|
|
4796
|
-
/** @example "AB123456" */
|
|
4797
|
-
account?: any;
|
|
4798
|
-
/** @example "BTC" */
|
|
4799
|
-
currency?: any;
|
|
4800
|
-
/** @example "{optional}" */
|
|
4801
|
-
network?: any;
|
|
4802
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4803
|
-
/**
|
|
4804
|
-
* @tags Transfers
|
|
4805
|
-
* @name CryptoWithdrawalEstimate
|
|
4806
|
-
* @summary Crypto Withdrawal Estimate
|
|
4807
|
-
* @request POST:/transfer/crypto/withdrawal/estimate
|
|
4808
|
-
* @secure
|
|
4809
|
-
*/
|
|
4810
|
-
cryptoWithdrawalEstimate(data: {
|
|
4811
|
-
/** @example "BTC" */
|
|
4812
|
-
currency?: any;
|
|
4813
|
-
/** @example "{optional}" */
|
|
4814
|
-
network?: any;
|
|
4815
|
-
/** @example "0.1" */
|
|
4816
|
-
quantity?: any;
|
|
4817
|
-
/** @example "{optional}" */
|
|
4818
|
-
wallet?: any;
|
|
4819
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4820
|
-
/**
|
|
4821
|
-
* @tags Transfers
|
|
4822
|
-
* @name CryptoWithdrawal
|
|
4823
|
-
* @summary Crypto Withdrawal
|
|
4824
|
-
* @request POST:/transfer/crypto/withdraw
|
|
4825
|
-
* @secure
|
|
4826
|
-
*/
|
|
4827
|
-
cryptoWithdrawal(data: {
|
|
4828
|
-
/** @example "AB123456" */
|
|
4829
|
-
account?: any;
|
|
4830
|
-
/** @example "BTC" */
|
|
4831
|
-
currency?: any;
|
|
4832
|
-
/** @example "{optional}" */
|
|
4833
|
-
estimateExtension?: any;
|
|
4834
|
-
/** @example "abc123" */
|
|
4835
|
-
estimateId?: any;
|
|
4836
|
-
/** @example "{optional}" */
|
|
4837
|
-
network?: any;
|
|
4838
|
-
/** @example 0.1 */
|
|
4839
|
-
quantity?: any;
|
|
4840
|
-
/** @example "{conditional}" */
|
|
4841
|
-
recipientFirstName?: any;
|
|
4842
|
-
/** @example "{conditional}" */
|
|
4843
|
-
recipientLastName?: any;
|
|
4844
|
-
/** @example "{optional} 1.1.1.1" */
|
|
4845
|
-
remoteAddr?: any;
|
|
4846
|
-
/** @example "{optional} Some phone" */
|
|
4847
|
-
remoteDevice?: any;
|
|
4848
|
-
/** @example "{optional} true|false" */
|
|
4849
|
-
selfHosted?: any;
|
|
4850
|
-
/** @example "{optional}" */
|
|
4851
|
-
tag?: any;
|
|
4852
|
-
/** @example "{conditional}" */
|
|
4853
|
-
vaspName?: any;
|
|
4854
|
-
/** @example "wallet address" */
|
|
4855
|
-
wallet?: any;
|
|
4856
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4857
|
-
}
|
|
4858
|
-
export class Documents<HandleError extends boolean = boolean> {
|
|
4859
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4860
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4861
|
-
/**
|
|
4862
|
-
* @tags Documents
|
|
4863
|
-
* @name Confirm
|
|
4864
|
-
* @summary Confirm
|
|
4865
|
-
* @request GET:/documents/confirm
|
|
4866
|
-
* @secure
|
|
4867
|
-
*/
|
|
4868
|
-
confirm(query?: {
|
|
4869
|
-
/**
|
|
4870
|
-
* *_accountNumber_ is accepted as well*
|
|
4871
|
-
* @example "5VA0XXXX"
|
|
4872
|
-
*/
|
|
4873
|
-
account?: any;
|
|
4874
|
-
/**
|
|
4875
|
-
* Date for the confirm. The required date format is: mm/dd/yyyy.
|
|
4876
|
-
* @example "03/03/2018"
|
|
4877
|
-
*/
|
|
4878
|
-
date?: any;
|
|
4879
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4880
|
-
/**
|
|
4881
|
-
* @tags Documents
|
|
4882
|
-
* @name ListOfConfirms
|
|
4883
|
-
* @summary List of Confirms
|
|
4884
|
-
* @request GET:/documents/confirm/list
|
|
4885
|
-
* @secure
|
|
4886
|
-
*/
|
|
4887
|
-
listOfConfirms(query?: {
|
|
4888
|
-
/**
|
|
4889
|
-
* *_accountNumber_ is accepted as well*
|
|
4890
|
-
* @example "5VA0XXXX"
|
|
4891
|
-
*/
|
|
4892
|
-
account?: any;
|
|
4893
|
-
/**
|
|
4894
|
-
* Start date for the list of confirms. The required date format is: `mm/dd/yyyy`.
|
|
4895
|
-
* @example "01/01/2017"
|
|
4896
|
-
*/
|
|
4897
|
-
beginDate?: any;
|
|
4898
|
-
/**
|
|
4899
|
-
* End date for the list of confirms. The required date format is: `mm/dd/yyyy`.
|
|
4900
|
-
* @example "03/01/2018"
|
|
4901
|
-
*/
|
|
4902
|
-
endDate?: any;
|
|
4903
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4904
|
-
/**
|
|
4905
|
-
* @tags Documents
|
|
4906
|
-
* @name ServiceDocs
|
|
4907
|
-
* @summary Service Docs
|
|
4908
|
-
* @request GET:/documents/service
|
|
4909
|
-
* @secure
|
|
4910
|
-
*/
|
|
4911
|
-
serviceDocs(query?: {
|
|
4912
|
-
/** @example "5VA0XXXX" */
|
|
4913
|
-
accountNumber?: any;
|
|
4914
|
-
/** See table for details. Leave blank for all document types. */
|
|
4915
|
-
docType?: any;
|
|
4916
|
-
/**
|
|
4917
|
-
* The beginning 2-digit month (MM) to be used as search criteria.
|
|
4918
|
-
* @example "01"
|
|
4919
|
-
*/
|
|
4920
|
-
beginMonth?: any;
|
|
4921
|
-
/**
|
|
4922
|
-
* The beginning 4-digit year (YYYY) to be used as search criteria.
|
|
4923
|
-
* @example "2012"
|
|
4924
|
-
*/
|
|
4925
|
-
beginYear?: any;
|
|
4926
|
-
/**
|
|
4927
|
-
* The ending 2-digit month (MM) to be used as search criteria.
|
|
4928
|
-
* @example "12"
|
|
4929
|
-
*/
|
|
4930
|
-
endMonth?: any;
|
|
4931
|
-
/**
|
|
4932
|
-
* The ending 4-digit year (YYYY) to be used as search criteria.
|
|
4933
|
-
* @example "2017"
|
|
4934
|
-
*/
|
|
4935
|
-
endYear?: any;
|
|
4936
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4937
|
-
/**
|
|
4938
|
-
* @tags Documents
|
|
4939
|
-
* @name DocumentList
|
|
4940
|
-
* @summary Document list
|
|
4941
|
-
* @request GET:/documents/list
|
|
4942
|
-
* @secure
|
|
4943
|
-
*/
|
|
4944
|
-
documentList(query?: {
|
|
4945
|
-
/** @example "5VA0XXXX" */
|
|
4946
|
-
account?: any;
|
|
4947
|
-
/**
|
|
4948
|
-
* Omit for all document types.
|
|
4949
|
-
* @example "All"
|
|
4950
|
-
*/
|
|
4951
|
-
documentType?: any;
|
|
4952
|
-
/**
|
|
4953
|
-
* Indicates start month & year (day of month is not used)
|
|
4954
|
-
* @example "1/1/2021"
|
|
4955
|
-
*/
|
|
4956
|
-
fromMonth?: any;
|
|
4957
|
-
/**
|
|
4958
|
-
* Indicates end month & year (day of month is not used)
|
|
4959
|
-
* @example "12/1/2021"
|
|
4960
|
-
*/
|
|
4961
|
-
toMonth?: any;
|
|
4770
|
+
symbol?: any;
|
|
4962
4771
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4963
4772
|
/**
|
|
4964
|
-
* @tags
|
|
4965
|
-
* @name
|
|
4966
|
-
* @summary
|
|
4967
|
-
* @request GET:/
|
|
4773
|
+
* @tags Transfers
|
|
4774
|
+
* @name ListFees
|
|
4775
|
+
* @summary List fees
|
|
4776
|
+
* @request GET:/transfer/fees/classifications/fees
|
|
4968
4777
|
* @secure
|
|
4969
4778
|
*/
|
|
4970
|
-
|
|
4779
|
+
listFees(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4971
4780
|
/**
|
|
4972
|
-
* @tags
|
|
4973
|
-
* @name
|
|
4974
|
-
* @summary
|
|
4975
|
-
* @request GET:/
|
|
4781
|
+
* @tags Transfers
|
|
4782
|
+
* @name ListCredits
|
|
4783
|
+
* @summary List credits
|
|
4784
|
+
* @request GET:/transfer/fees/classifications/credits
|
|
4976
4785
|
* @secure
|
|
4977
4786
|
*/
|
|
4978
|
-
|
|
4787
|
+
listCredits(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4979
4788
|
/**
|
|
4980
|
-
* @tags
|
|
4981
|
-
* @name
|
|
4982
|
-
* @summary
|
|
4983
|
-
* @request GET:/
|
|
4789
|
+
* @tags Transfers
|
|
4790
|
+
* @name CryptoDepositAddress
|
|
4791
|
+
* @summary Crypto Deposit Address
|
|
4792
|
+
* @request GET:/transfer/crypto/deposit/wallet/address
|
|
4984
4793
|
* @secure
|
|
4985
4794
|
*/
|
|
4986
|
-
|
|
4987
|
-
/**
|
|
4988
|
-
* Account Number
|
|
4989
|
-
* @example "{accountNumber}"
|
|
4990
|
-
*/
|
|
4795
|
+
cryptoDepositAddress(data: {
|
|
4796
|
+
/** @example "AB123456" */
|
|
4991
4797
|
account?: any;
|
|
4992
|
-
/**
|
|
4993
|
-
|
|
4994
|
-
|
|
4995
|
-
|
|
4996
|
-
key?: any;
|
|
4798
|
+
/** @example "BTC" */
|
|
4799
|
+
currency?: any;
|
|
4800
|
+
/** @example "{optional}" */
|
|
4801
|
+
network?: any;
|
|
4997
4802
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4998
4803
|
/**
|
|
4999
|
-
* @tags
|
|
5000
|
-
* @name
|
|
5001
|
-
* @summary
|
|
5002
|
-
* @request
|
|
4804
|
+
* @tags Transfers
|
|
4805
|
+
* @name CryptoWithdrawalEstimate
|
|
4806
|
+
* @summary Crypto Withdrawal Estimate
|
|
4807
|
+
* @request POST:/transfer/crypto/withdrawal/estimate
|
|
5003
4808
|
* @secure
|
|
5004
4809
|
*/
|
|
5005
|
-
|
|
4810
|
+
cryptoWithdrawalEstimate(data: {
|
|
4811
|
+
/** @example "BTC" */
|
|
4812
|
+
currency?: any;
|
|
4813
|
+
/** @example "{optional}" */
|
|
4814
|
+
network?: any;
|
|
4815
|
+
/** @example "0.1" */
|
|
4816
|
+
quantity?: any;
|
|
4817
|
+
/** @example "{optional}" */
|
|
4818
|
+
wallet?: any;
|
|
4819
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4820
|
+
/**
|
|
4821
|
+
* @tags Transfers
|
|
4822
|
+
* @name CryptoWithdrawal
|
|
4823
|
+
* @summary Crypto Withdrawal
|
|
4824
|
+
* @request POST:/transfer/crypto/withdraw
|
|
4825
|
+
* @secure
|
|
4826
|
+
*/
|
|
4827
|
+
cryptoWithdrawal(data: {
|
|
4828
|
+
/** @example "AB123456" */
|
|
4829
|
+
account?: any;
|
|
4830
|
+
/** @example "BTC" */
|
|
4831
|
+
currency?: any;
|
|
4832
|
+
/** @example "{optional}" */
|
|
4833
|
+
estimateExtension?: any;
|
|
4834
|
+
/** @example "abc123" */
|
|
4835
|
+
estimateId?: any;
|
|
4836
|
+
/** @example "{optional}" */
|
|
4837
|
+
network?: any;
|
|
4838
|
+
/** @example 0.1 */
|
|
4839
|
+
quantity?: any;
|
|
4840
|
+
/** @example "{conditional}" */
|
|
4841
|
+
recipientFirstName?: any;
|
|
4842
|
+
/** @example "{conditional}" */
|
|
4843
|
+
recipientLastName?: any;
|
|
4844
|
+
/** @example "{optional} 1.1.1.1" */
|
|
4845
|
+
remoteAddr?: any;
|
|
4846
|
+
/** @example "{optional} Some phone" */
|
|
4847
|
+
remoteDevice?: any;
|
|
4848
|
+
/** @example "{optional} true|false" */
|
|
4849
|
+
selfHosted?: any;
|
|
4850
|
+
/** @example "{optional}" */
|
|
4851
|
+
tag?: any;
|
|
4852
|
+
/** @example "{conditional}" */
|
|
4853
|
+
vaspName?: any;
|
|
4854
|
+
/** @example "wallet address" */
|
|
4855
|
+
wallet?: any;
|
|
4856
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5006
4857
|
}
|
|
5007
4858
|
export class Miscellaneous<HandleError extends boolean = boolean> {
|
|
5008
4859
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -5120,71 +4971,220 @@ export class Miscellaneous<HandleError extends boolean = boolean> {
|
|
|
5120
4971
|
*/
|
|
5121
4972
|
filesList(query?: {
|
|
5122
4973
|
/**
|
|
5123
|
-
* Optional. Allows filtering for tags
|
|
5124
|
-
* @example "document*"
|
|
4974
|
+
* Optional. Allows filtering for tags
|
|
4975
|
+
* @example "document*"
|
|
4976
|
+
*/
|
|
4977
|
+
tag?: any;
|
|
4978
|
+
/**
|
|
4979
|
+
* Optional. Allows filtering for filenames
|
|
4980
|
+
* @example "application*"
|
|
4981
|
+
*/
|
|
4982
|
+
filename?: any;
|
|
4983
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4984
|
+
/**
|
|
4985
|
+
* @tags Miscellaneous
|
|
4986
|
+
* @name FilesAllowedExts
|
|
4987
|
+
* @request GET:/v1/files/allowed/exts
|
|
4988
|
+
* @secure
|
|
4989
|
+
*/
|
|
4990
|
+
filesAllowedExts(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4991
|
+
/**
|
|
4992
|
+
* @tags Miscellaneous
|
|
4993
|
+
* @name ErrorCodeListing
|
|
4994
|
+
* @summary Error code listing
|
|
4995
|
+
* @request GET:/general/errors
|
|
4996
|
+
* @secure
|
|
4997
|
+
*/
|
|
4998
|
+
errorCodeListing(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4999
|
+
/**
|
|
5000
|
+
* @tags Miscellaneous
|
|
5001
|
+
* @name Ping
|
|
5002
|
+
* @summary Ping
|
|
5003
|
+
* @request GET:/general/ping
|
|
5004
|
+
* @secure
|
|
5005
|
+
*/
|
|
5006
|
+
ping(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5007
|
+
/**
|
|
5008
|
+
* @tags Miscellaneous
|
|
5009
|
+
* @name CurrencyList
|
|
5010
|
+
* @summary Currency list
|
|
5011
|
+
* @request GET:/general/available-currencies
|
|
5012
|
+
* @secure
|
|
5013
|
+
*/
|
|
5014
|
+
currencyList(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5015
|
+
/**
|
|
5016
|
+
* @tags Miscellaneous
|
|
5017
|
+
* @name TradableCurrencyList
|
|
5018
|
+
* @summary Tradable currency list
|
|
5019
|
+
* @request GET:/general/tradable-currencies
|
|
5020
|
+
* @secure
|
|
5021
|
+
*/
|
|
5022
|
+
tradableCurrencyList(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5023
|
+
/**
|
|
5024
|
+
* @tags Miscellaneous
|
|
5025
|
+
* @name OptionStrategyTypes
|
|
5026
|
+
* @summary Option Strategy Types
|
|
5027
|
+
* @request GET:/general/options/strategyTypes
|
|
5028
|
+
* @secure
|
|
5029
|
+
*/
|
|
5030
|
+
optionStrategyTypes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5031
|
+
/**
|
|
5032
|
+
* @tags Miscellaneous
|
|
5033
|
+
* @name OptionStrategyClassifications
|
|
5034
|
+
* @summary Option Strategy Classifications
|
|
5035
|
+
* @request GET:/general/options/strategyClassifications
|
|
5036
|
+
* @secure
|
|
5037
|
+
*/
|
|
5038
|
+
optionStrategyClassifications(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5039
|
+
}
|
|
5040
|
+
export class Documents<HandleError extends boolean = boolean> {
|
|
5041
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5042
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5043
|
+
/**
|
|
5044
|
+
* @tags Documents
|
|
5045
|
+
* @name Confirm
|
|
5046
|
+
* @summary Confirm
|
|
5047
|
+
* @request GET:/documents/confirm
|
|
5048
|
+
* @secure
|
|
5049
|
+
*/
|
|
5050
|
+
confirm(query?: {
|
|
5051
|
+
/**
|
|
5052
|
+
* *_accountNumber_ is accepted as well*
|
|
5053
|
+
* @example "5VA0XXXX"
|
|
5054
|
+
*/
|
|
5055
|
+
account?: any;
|
|
5056
|
+
/**
|
|
5057
|
+
* Date for the confirm. The required date format is: mm/dd/yyyy.
|
|
5058
|
+
* @example "03/03/2018"
|
|
5059
|
+
*/
|
|
5060
|
+
date?: any;
|
|
5061
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5062
|
+
/**
|
|
5063
|
+
* @tags Documents
|
|
5064
|
+
* @name ListOfConfirms
|
|
5065
|
+
* @summary List of Confirms
|
|
5066
|
+
* @request GET:/documents/confirm/list
|
|
5067
|
+
* @secure
|
|
5068
|
+
*/
|
|
5069
|
+
listOfConfirms(query?: {
|
|
5070
|
+
/**
|
|
5071
|
+
* *_accountNumber_ is accepted as well*
|
|
5072
|
+
* @example "5VA0XXXX"
|
|
5073
|
+
*/
|
|
5074
|
+
account?: any;
|
|
5075
|
+
/**
|
|
5076
|
+
* Start date for the list of confirms. The required date format is: `mm/dd/yyyy`.
|
|
5077
|
+
* @example "01/01/2017"
|
|
5078
|
+
*/
|
|
5079
|
+
beginDate?: any;
|
|
5080
|
+
/**
|
|
5081
|
+
* End date for the list of confirms. The required date format is: `mm/dd/yyyy`.
|
|
5082
|
+
* @example "03/01/2018"
|
|
5083
|
+
*/
|
|
5084
|
+
endDate?: any;
|
|
5085
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5086
|
+
/**
|
|
5087
|
+
* @tags Documents
|
|
5088
|
+
* @name ServiceDocs
|
|
5089
|
+
* @summary Service Docs
|
|
5090
|
+
* @request GET:/documents/service
|
|
5091
|
+
* @secure
|
|
5092
|
+
*/
|
|
5093
|
+
serviceDocs(query?: {
|
|
5094
|
+
/** @example "5VA0XXXX" */
|
|
5095
|
+
accountNumber?: any;
|
|
5096
|
+
/** See table for details. Leave blank for all document types. */
|
|
5097
|
+
docType?: any;
|
|
5098
|
+
/**
|
|
5099
|
+
* The beginning 2-digit month (MM) to be used as search criteria.
|
|
5100
|
+
* @example "01"
|
|
5101
|
+
*/
|
|
5102
|
+
beginMonth?: any;
|
|
5103
|
+
/**
|
|
5104
|
+
* The beginning 4-digit year (YYYY) to be used as search criteria.
|
|
5105
|
+
* @example "2012"
|
|
5106
|
+
*/
|
|
5107
|
+
beginYear?: any;
|
|
5108
|
+
/**
|
|
5109
|
+
* The ending 2-digit month (MM) to be used as search criteria.
|
|
5110
|
+
* @example "12"
|
|
5111
|
+
*/
|
|
5112
|
+
endMonth?: any;
|
|
5113
|
+
/**
|
|
5114
|
+
* The ending 4-digit year (YYYY) to be used as search criteria.
|
|
5115
|
+
* @example "2017"
|
|
5116
|
+
*/
|
|
5117
|
+
endYear?: any;
|
|
5118
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5119
|
+
/**
|
|
5120
|
+
* @tags Documents
|
|
5121
|
+
* @name DocumentList
|
|
5122
|
+
* @summary Document list
|
|
5123
|
+
* @request GET:/documents/list
|
|
5124
|
+
* @secure
|
|
5125
|
+
*/
|
|
5126
|
+
documentList(query?: {
|
|
5127
|
+
/** @example "5VA0XXXX" */
|
|
5128
|
+
account?: any;
|
|
5129
|
+
/**
|
|
5130
|
+
* Omit for all document types.
|
|
5131
|
+
* @example "All"
|
|
5125
5132
|
*/
|
|
5126
|
-
|
|
5133
|
+
documentType?: any;
|
|
5127
5134
|
/**
|
|
5128
|
-
*
|
|
5129
|
-
* @example "
|
|
5135
|
+
* Indicates start month & year (day of month is not used)
|
|
5136
|
+
* @example "1/1/2021"
|
|
5130
5137
|
*/
|
|
5131
|
-
|
|
5138
|
+
fromMonth?: any;
|
|
5139
|
+
/**
|
|
5140
|
+
* Indicates end month & year (day of month is not used)
|
|
5141
|
+
* @example "12/1/2021"
|
|
5142
|
+
*/
|
|
5143
|
+
toMonth?: any;
|
|
5132
5144
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5133
5145
|
/**
|
|
5134
|
-
* @tags
|
|
5135
|
-
* @name
|
|
5136
|
-
* @
|
|
5137
|
-
* @
|
|
5138
|
-
*/
|
|
5139
|
-
filesAllowedExts(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5140
|
-
/**
|
|
5141
|
-
* @tags Miscellaneous
|
|
5142
|
-
* @name ErrorCodeListing
|
|
5143
|
-
* @summary Error code listing
|
|
5144
|
-
* @request GET:/general/errors
|
|
5145
|
-
* @secure
|
|
5146
|
-
*/
|
|
5147
|
-
errorCodeListing(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5148
|
-
/**
|
|
5149
|
-
* @tags Miscellaneous
|
|
5150
|
-
* @name Ping
|
|
5151
|
-
* @summary Ping
|
|
5152
|
-
* @request GET:/general/ping
|
|
5153
|
-
* @secure
|
|
5154
|
-
*/
|
|
5155
|
-
ping(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5156
|
-
/**
|
|
5157
|
-
* @tags Miscellaneous
|
|
5158
|
-
* @name CurrencyList
|
|
5159
|
-
* @summary Currency list
|
|
5160
|
-
* @request GET:/general/available-currencies
|
|
5146
|
+
* @tags Documents
|
|
5147
|
+
* @name AvailableDocumentTypes
|
|
5148
|
+
* @summary Available document types
|
|
5149
|
+
* @request GET:/documents/types
|
|
5161
5150
|
* @secure
|
|
5162
5151
|
*/
|
|
5163
|
-
|
|
5152
|
+
availableDocumentTypes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5164
5153
|
/**
|
|
5165
|
-
* @tags
|
|
5166
|
-
* @name
|
|
5167
|
-
* @summary
|
|
5168
|
-
* @request GET:/
|
|
5154
|
+
* @tags Documents
|
|
5155
|
+
* @name AvailableDocumentTypesAndCodes
|
|
5156
|
+
* @summary Available document types and codes
|
|
5157
|
+
* @request GET:/documents/typesAndCodes
|
|
5169
5158
|
* @secure
|
|
5170
5159
|
*/
|
|
5171
|
-
|
|
5160
|
+
availableDocumentTypesAndCodes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5172
5161
|
/**
|
|
5173
|
-
* @tags
|
|
5174
|
-
* @name
|
|
5175
|
-
* @summary
|
|
5176
|
-
* @request GET:/
|
|
5162
|
+
* @tags Documents
|
|
5163
|
+
* @name Download
|
|
5164
|
+
* @summary Download
|
|
5165
|
+
* @request GET:/documents/download
|
|
5177
5166
|
* @secure
|
|
5178
5167
|
*/
|
|
5179
|
-
|
|
5168
|
+
download(query?: {
|
|
5169
|
+
/**
|
|
5170
|
+
* Account Number
|
|
5171
|
+
* @example "{accountNumber}"
|
|
5172
|
+
*/
|
|
5173
|
+
account?: any;
|
|
5174
|
+
/**
|
|
5175
|
+
* UUID for finding specific document
|
|
5176
|
+
* @example "{key}"
|
|
5177
|
+
*/
|
|
5178
|
+
key?: any;
|
|
5179
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5180
5180
|
/**
|
|
5181
|
-
* @tags
|
|
5182
|
-
* @name
|
|
5183
|
-
* @summary
|
|
5184
|
-
* @request GET:/
|
|
5181
|
+
* @tags Documents
|
|
5182
|
+
* @name GetAllBranchDocuments
|
|
5183
|
+
* @summary Get all Branch Documents
|
|
5184
|
+
* @request GET:/documents/branch/list
|
|
5185
5185
|
* @secure
|
|
5186
5186
|
*/
|
|
5187
|
-
|
|
5187
|
+
getAllBranchDocuments(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5188
5188
|
}
|
|
5189
5189
|
export class Branch<HandleError extends boolean = boolean> {
|
|
5190
5190
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -5277,114 +5277,6 @@ export class Branch<HandleError extends boolean = boolean> {
|
|
|
5277
5277
|
maturity?: any;
|
|
5278
5278
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5279
5279
|
}
|
|
5280
|
-
export class LegalDocuments<HandleError extends boolean = boolean> {
|
|
5281
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5282
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5283
|
-
/**
|
|
5284
|
-
* @tags Legal Documents
|
|
5285
|
-
* @name DocumentClassifications
|
|
5286
|
-
* @summary Document classifications
|
|
5287
|
-
* @request GET:/user/legal/classifications
|
|
5288
|
-
* @secure
|
|
5289
|
-
*/
|
|
5290
|
-
documentClassifications(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5291
|
-
/**
|
|
5292
|
-
* @tags Legal Documents
|
|
5293
|
-
* @name DocumentListing
|
|
5294
|
-
* @summary Document listing
|
|
5295
|
-
* @request GET:/user/legal/documents
|
|
5296
|
-
* @secure
|
|
5297
|
-
*/
|
|
5298
|
-
documentListing(query?: {
|
|
5299
|
-
/**
|
|
5300
|
-
* {optional}
|
|
5301
|
-
* @example "TermsOfUse"
|
|
5302
|
-
*/
|
|
5303
|
-
classification?: any;
|
|
5304
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5305
|
-
/**
|
|
5306
|
-
* @tags Legal Documents
|
|
5307
|
-
* @name PolicyValues
|
|
5308
|
-
* @summary Policy values
|
|
5309
|
-
* @request GET:/user/legal/policies/listing/{type}
|
|
5310
|
-
* @secure
|
|
5311
|
-
*/
|
|
5312
|
-
policyValues(type: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5313
|
-
/**
|
|
5314
|
-
* @tags Legal Documents
|
|
5315
|
-
* @name DocumentContent
|
|
5316
|
-
* @summary Document content
|
|
5317
|
-
* @request GET:/user/legal/document/content
|
|
5318
|
-
* @secure
|
|
5319
|
-
*/
|
|
5320
|
-
documentContent(query?: {
|
|
5321
|
-
/** @example "{as provided}" */
|
|
5322
|
-
id?: any;
|
|
5323
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5324
|
-
/**
|
|
5325
|
-
* @tags Legal Documents
|
|
5326
|
-
* @name DocumentDownload
|
|
5327
|
-
* @summary Document download
|
|
5328
|
-
* @request GET:/user/legal/document/download
|
|
5329
|
-
* @secure
|
|
5330
|
-
*/
|
|
5331
|
-
documentDownload(query?: {
|
|
5332
|
-
/** @example "{as provided}" */
|
|
5333
|
-
id?: any;
|
|
5334
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5335
|
-
/**
|
|
5336
|
-
* @tags Legal Documents
|
|
5337
|
-
* @name SignTheDocument
|
|
5338
|
-
* @summary Sign the document
|
|
5339
|
-
* @request POST:/user/legal/document/sign
|
|
5340
|
-
* @secure
|
|
5341
|
-
*/
|
|
5342
|
-
signTheDocument(data: {
|
|
5343
|
-
account?: {
|
|
5344
|
-
/** @example 1234 */
|
|
5345
|
-
accountId?: number;
|
|
5346
|
-
/** @example "AC123456" */
|
|
5347
|
-
accountNumber?: string;
|
|
5348
|
-
};
|
|
5349
|
-
data?: {
|
|
5350
|
-
/** @example "{conditional}" */
|
|
5351
|
-
bankAccountNumber?: string;
|
|
5352
|
-
};
|
|
5353
|
-
/** @example "{required}" */
|
|
5354
|
-
documentId?: any;
|
|
5355
|
-
/** @example true */
|
|
5356
|
-
esigned?: any;
|
|
5357
|
-
/** @example "" */
|
|
5358
|
-
remoteAddr?: any;
|
|
5359
|
-
/** @example "{required}" */
|
|
5360
|
-
remoteDevice?: any;
|
|
5361
|
-
/** @example "{required}" */
|
|
5362
|
-
signature?: any;
|
|
5363
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5364
|
-
/**
|
|
5365
|
-
* @tags Legal Documents
|
|
5366
|
-
* @name UpdatesPolicyOnTheAccount
|
|
5367
|
-
* @summary Updates policy on the account
|
|
5368
|
-
* @request POST:/user/legal/policy/{type}
|
|
5369
|
-
* @secure
|
|
5370
|
-
*/
|
|
5371
|
-
updatesPolicyOnTheAccount(type: string, data: {
|
|
5372
|
-
account?: {
|
|
5373
|
-
/** @example 0 */
|
|
5374
|
-
accountId?: number;
|
|
5375
|
-
/** @example "{optional}" */
|
|
5376
|
-
accountNumber?: string;
|
|
5377
|
-
};
|
|
5378
|
-
/** @example true */
|
|
5379
|
-
esigned?: any;
|
|
5380
|
-
/** @example "Allow" */
|
|
5381
|
-
policy?: any;
|
|
5382
|
-
/** @example "" */
|
|
5383
|
-
remoteAddr?: any;
|
|
5384
|
-
/** @example "" */
|
|
5385
|
-
remoteDevice?: any;
|
|
5386
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5387
|
-
}
|
|
5388
5280
|
export class BlacklistAdminIndividuals<HandleError extends boolean = boolean> {
|
|
5389
5281
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5390
5282
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5503,101 +5395,16 @@ export class BlacklistAdminIndividuals<HandleError extends boolean = boolean> {
|
|
|
5503
5395
|
/** @example "305178" */
|
|
5504
5396
|
tracking_number?: any;
|
|
5505
5397
|
/** @example "11358" */
|
|
5506
|
-
zip?: any;
|
|
5507
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5508
|
-
/**
|
|
5509
|
-
* @tags Blacklist Admin Individuals
|
|
5510
|
-
* @name DeleteIndividual
|
|
5511
|
-
* @summary Delete Individual
|
|
5512
|
-
* @request DELETE:/v1/admin/individuals/{id}
|
|
5513
|
-
* @secure
|
|
5514
|
-
*/
|
|
5515
|
-
deleteIndividual(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5516
|
-
}
|
|
5517
|
-
export class BlacklistSearch<HandleError extends boolean = boolean> {
|
|
5518
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5519
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5520
|
-
/**
|
|
5521
|
-
* @tags Blacklist Search
|
|
5522
|
-
* @name SearchBusiness
|
|
5523
|
-
* @summary Search Business
|
|
5524
|
-
* @request POST:/v1/businesses/search
|
|
5525
|
-
* @secure
|
|
5526
|
-
*/
|
|
5527
|
-
searchBusiness(data: {
|
|
5528
|
-
/** @example [{"distance":0,"name":"business_name","value":"Gracia Marina"},{"distance":2,"name":"dba_name","value":"La Granja Del Camar"}] */
|
|
5529
|
-
filters?: any;
|
|
5530
|
-
/** @example "AND" */
|
|
5531
|
-
match_type?: any;
|
|
5532
|
-
pagination?: {
|
|
5533
|
-
/** @example 1 */
|
|
5534
|
-
page?: number;
|
|
5535
|
-
/** @example 20 */
|
|
5536
|
-
page_size?: number;
|
|
5537
|
-
};
|
|
5538
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5539
|
-
/**
|
|
5540
|
-
* @tags Blacklist Search
|
|
5541
|
-
* @name SearchIndividual
|
|
5542
|
-
* @summary Search Individual
|
|
5543
|
-
* @request POST:/v1/individuals/search
|
|
5544
|
-
* @secure
|
|
5545
|
-
*/
|
|
5546
|
-
searchIndividual(data: {
|
|
5547
|
-
/** @example [{"distance":2,"name":"first_name","value":"Hyodan"},{"distance":0,"name":"alias_middle_name","value":"Hyodon"}] */
|
|
5548
|
-
filters?: any;
|
|
5549
|
-
/** @example "OR" */
|
|
5550
|
-
match_type?: any;
|
|
5551
|
-
pagination?: {
|
|
5552
|
-
/** @example 1 */
|
|
5553
|
-
page?: number;
|
|
5554
|
-
/** @example 20 */
|
|
5555
|
-
page_size?: number;
|
|
5556
|
-
};
|
|
5557
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5558
|
-
}
|
|
5559
|
-
export class Broker<HandleError extends boolean = boolean> {
|
|
5560
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5561
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5398
|
+
zip?: any;
|
|
5399
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5562
5400
|
/**
|
|
5563
|
-
* @tags
|
|
5564
|
-
* @name
|
|
5565
|
-
* @summary
|
|
5566
|
-
* @request
|
|
5401
|
+
* @tags Blacklist Admin Individuals
|
|
5402
|
+
* @name DeleteIndividual
|
|
5403
|
+
* @summary Delete Individual
|
|
5404
|
+
* @request DELETE:/v1/admin/individuals/{id}
|
|
5567
5405
|
* @secure
|
|
5568
5406
|
*/
|
|
5569
|
-
|
|
5570
|
-
/**
|
|
5571
|
-
* (true or false) Allows for loading of quotes for each portfolio entry. Defaults to false.
|
|
5572
|
-
* @example "false"
|
|
5573
|
-
*/
|
|
5574
|
-
loadQuotes?: any;
|
|
5575
|
-
/** @example "false" */
|
|
5576
|
-
loadIndustries?: any;
|
|
5577
|
-
/** @example "false" */
|
|
5578
|
-
loadUpgrades?: any;
|
|
5579
|
-
/** @example "false" */
|
|
5580
|
-
loadEarnings?: any;
|
|
5581
|
-
/**
|
|
5582
|
-
* Load balances for weight
|
|
5583
|
-
* @example "false"
|
|
5584
|
-
*/
|
|
5585
|
-
loadRtb?: any;
|
|
5586
|
-
/**
|
|
5587
|
-
* Analyze market caps and get `marketCapWeights`. To be used in conjuction with `loadQuotes`
|
|
5588
|
-
* @example "false"
|
|
5589
|
-
*/
|
|
5590
|
-
marketCapBreakdown?: any;
|
|
5591
|
-
/**
|
|
5592
|
-
* Combined portfolio for the branch
|
|
5593
|
-
* @example "false"
|
|
5594
|
-
*/
|
|
5595
|
-
combined?: any;
|
|
5596
|
-
/** @example "1" */
|
|
5597
|
-
pageNum?: any;
|
|
5598
|
-
/** @example "100" */
|
|
5599
|
-
pageSize?: any;
|
|
5600
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5407
|
+
deleteIndividual(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5601
5408
|
}
|
|
5602
5409
|
export class BlacklistAdminBusinesses<HandleError extends boolean = boolean> {
|
|
5603
5410
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -5704,6 +5511,156 @@ export class BlacklistAdminBusinesses<HandleError extends boolean = boolean> {
|
|
|
5704
5511
|
*/
|
|
5705
5512
|
deleteBusiness(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5706
5513
|
}
|
|
5514
|
+
export class BlacklistSearch<HandleError extends boolean = boolean> {
|
|
5515
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5516
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5517
|
+
/**
|
|
5518
|
+
* @tags Blacklist Search
|
|
5519
|
+
* @name SearchBusiness
|
|
5520
|
+
* @summary Search Business
|
|
5521
|
+
* @request POST:/v1/businesses/search
|
|
5522
|
+
* @secure
|
|
5523
|
+
*/
|
|
5524
|
+
searchBusiness(data: {
|
|
5525
|
+
/** @example [{"distance":0,"name":"business_name","value":"Gracia Marina"},{"distance":2,"name":"dba_name","value":"La Granja Del Camar"}] */
|
|
5526
|
+
filters?: any;
|
|
5527
|
+
/** @example "AND" */
|
|
5528
|
+
match_type?: any;
|
|
5529
|
+
pagination?: {
|
|
5530
|
+
/** @example 1 */
|
|
5531
|
+
page?: number;
|
|
5532
|
+
/** @example 20 */
|
|
5533
|
+
page_size?: number;
|
|
5534
|
+
};
|
|
5535
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5536
|
+
/**
|
|
5537
|
+
* @tags Blacklist Search
|
|
5538
|
+
* @name SearchIndividual
|
|
5539
|
+
* @summary Search Individual
|
|
5540
|
+
* @request POST:/v1/individuals/search
|
|
5541
|
+
* @secure
|
|
5542
|
+
*/
|
|
5543
|
+
searchIndividual(data: {
|
|
5544
|
+
/** @example [{"distance":2,"name":"first_name","value":"Hyodan"},{"distance":0,"name":"alias_middle_name","value":"Hyodon"}] */
|
|
5545
|
+
filters?: any;
|
|
5546
|
+
/** @example "OR" */
|
|
5547
|
+
match_type?: any;
|
|
5548
|
+
pagination?: {
|
|
5549
|
+
/** @example 1 */
|
|
5550
|
+
page?: number;
|
|
5551
|
+
/** @example 20 */
|
|
5552
|
+
page_size?: number;
|
|
5553
|
+
};
|
|
5554
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5555
|
+
}
|
|
5556
|
+
export class LegalDocuments<HandleError extends boolean = boolean> {
|
|
5557
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5558
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5559
|
+
/**
|
|
5560
|
+
* @tags Legal Documents
|
|
5561
|
+
* @name DocumentClassifications
|
|
5562
|
+
* @summary Document classifications
|
|
5563
|
+
* @request GET:/user/legal/classifications
|
|
5564
|
+
* @secure
|
|
5565
|
+
*/
|
|
5566
|
+
documentClassifications(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5567
|
+
/**
|
|
5568
|
+
* @tags Legal Documents
|
|
5569
|
+
* @name DocumentListing
|
|
5570
|
+
* @summary Document listing
|
|
5571
|
+
* @request GET:/user/legal/documents
|
|
5572
|
+
* @secure
|
|
5573
|
+
*/
|
|
5574
|
+
documentListing(query?: {
|
|
5575
|
+
/**
|
|
5576
|
+
* {optional}
|
|
5577
|
+
* @example "TermsOfUse"
|
|
5578
|
+
*/
|
|
5579
|
+
classification?: any;
|
|
5580
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5581
|
+
/**
|
|
5582
|
+
* @tags Legal Documents
|
|
5583
|
+
* @name PolicyValues
|
|
5584
|
+
* @summary Policy values
|
|
5585
|
+
* @request GET:/user/legal/policies/listing/{type}
|
|
5586
|
+
* @secure
|
|
5587
|
+
*/
|
|
5588
|
+
policyValues(type: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5589
|
+
/**
|
|
5590
|
+
* @tags Legal Documents
|
|
5591
|
+
* @name DocumentContent
|
|
5592
|
+
* @summary Document content
|
|
5593
|
+
* @request GET:/user/legal/document/content
|
|
5594
|
+
* @secure
|
|
5595
|
+
*/
|
|
5596
|
+
documentContent(query?: {
|
|
5597
|
+
/** @example "{as provided}" */
|
|
5598
|
+
id?: any;
|
|
5599
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5600
|
+
/**
|
|
5601
|
+
* @tags Legal Documents
|
|
5602
|
+
* @name DocumentDownload
|
|
5603
|
+
* @summary Document download
|
|
5604
|
+
* @request GET:/user/legal/document/download
|
|
5605
|
+
* @secure
|
|
5606
|
+
*/
|
|
5607
|
+
documentDownload(query?: {
|
|
5608
|
+
/** @example "{as provided}" */
|
|
5609
|
+
id?: any;
|
|
5610
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5611
|
+
/**
|
|
5612
|
+
* @tags Legal Documents
|
|
5613
|
+
* @name SignTheDocument
|
|
5614
|
+
* @summary Sign the document
|
|
5615
|
+
* @request POST:/user/legal/document/sign
|
|
5616
|
+
* @secure
|
|
5617
|
+
*/
|
|
5618
|
+
signTheDocument(data: {
|
|
5619
|
+
account?: {
|
|
5620
|
+
/** @example 1234 */
|
|
5621
|
+
accountId?: number;
|
|
5622
|
+
/** @example "AC123456" */
|
|
5623
|
+
accountNumber?: string;
|
|
5624
|
+
};
|
|
5625
|
+
data?: {
|
|
5626
|
+
/** @example "{conditional}" */
|
|
5627
|
+
bankAccountNumber?: string;
|
|
5628
|
+
};
|
|
5629
|
+
/** @example "{required}" */
|
|
5630
|
+
documentId?: any;
|
|
5631
|
+
/** @example true */
|
|
5632
|
+
esigned?: any;
|
|
5633
|
+
/** @example "" */
|
|
5634
|
+
remoteAddr?: any;
|
|
5635
|
+
/** @example "{required}" */
|
|
5636
|
+
remoteDevice?: any;
|
|
5637
|
+
/** @example "{required}" */
|
|
5638
|
+
signature?: any;
|
|
5639
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5640
|
+
/**
|
|
5641
|
+
* @tags Legal Documents
|
|
5642
|
+
* @name UpdatesPolicyOnTheAccount
|
|
5643
|
+
* @summary Updates policy on the account
|
|
5644
|
+
* @request POST:/user/legal/policy/{type}
|
|
5645
|
+
* @secure
|
|
5646
|
+
*/
|
|
5647
|
+
updatesPolicyOnTheAccount(type: string, data: {
|
|
5648
|
+
account?: {
|
|
5649
|
+
/** @example 0 */
|
|
5650
|
+
accountId?: number;
|
|
5651
|
+
/** @example "{optional}" */
|
|
5652
|
+
accountNumber?: string;
|
|
5653
|
+
};
|
|
5654
|
+
/** @example true */
|
|
5655
|
+
esigned?: any;
|
|
5656
|
+
/** @example "Allow" */
|
|
5657
|
+
policy?: any;
|
|
5658
|
+
/** @example "" */
|
|
5659
|
+
remoteAddr?: any;
|
|
5660
|
+
/** @example "" */
|
|
5661
|
+
remoteDevice?: any;
|
|
5662
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5663
|
+
}
|
|
5707
5664
|
export class Blacklist<HandleError extends boolean = boolean> {
|
|
5708
5665
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5709
5666
|
adminBusinesses: BlacklistAdminBusinesses<HandleError>;
|
|
@@ -5733,6 +5690,59 @@ export class Blacklist<HandleError extends boolean = boolean> {
|
|
|
5733
5690
|
*/
|
|
5734
5691
|
getHealth(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5735
5692
|
}
|
|
5693
|
+
export class Broker<HandleError extends boolean = boolean> {
|
|
5694
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5695
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5696
|
+
/**
|
|
5697
|
+
* @tags Broker
|
|
5698
|
+
* @name Portfolio
|
|
5699
|
+
* @summary Portfolio
|
|
5700
|
+
* @request GET:/v1/broker/portfolio
|
|
5701
|
+
* @secure
|
|
5702
|
+
*/
|
|
5703
|
+
portfolio(query?: {
|
|
5704
|
+
/**
|
|
5705
|
+
* (true or false) Allows for loading of quotes for each portfolio entry. Defaults to false.
|
|
5706
|
+
* @example "false"
|
|
5707
|
+
*/
|
|
5708
|
+
loadQuotes?: any;
|
|
5709
|
+
/** @example "false" */
|
|
5710
|
+
loadIndustries?: any;
|
|
5711
|
+
/** @example "false" */
|
|
5712
|
+
loadUpgrades?: any;
|
|
5713
|
+
/** @example "false" */
|
|
5714
|
+
loadEarnings?: any;
|
|
5715
|
+
/**
|
|
5716
|
+
* Load balances for weight
|
|
5717
|
+
* @example "false"
|
|
5718
|
+
*/
|
|
5719
|
+
loadRtb?: any;
|
|
5720
|
+
/**
|
|
5721
|
+
* Analyze market caps and get `marketCapWeights`. To be used in conjuction with `loadQuotes`
|
|
5722
|
+
* @example "false"
|
|
5723
|
+
*/
|
|
5724
|
+
marketCapBreakdown?: any;
|
|
5725
|
+
/**
|
|
5726
|
+
* Combined portfolio for the branch
|
|
5727
|
+
* @example "false"
|
|
5728
|
+
*/
|
|
5729
|
+
combined?: any;
|
|
5730
|
+
/** @example "1" */
|
|
5731
|
+
pageNum?: any;
|
|
5732
|
+
/** @example "100" */
|
|
5733
|
+
pageSize?: any;
|
|
5734
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5735
|
+
}
|
|
5736
|
+
export class Advisory<HandleError extends boolean = boolean> {
|
|
5737
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5738
|
+
charges: AdvisoryCharges<HandleError>;
|
|
5739
|
+
models: AdvisoryModels<HandleError>;
|
|
5740
|
+
userAccountManagement: AdvisoryUserAccountManagement<HandleError>;
|
|
5741
|
+
groups: AdvisoryGroups<HandleError>;
|
|
5742
|
+
analytics: AdvisoryAnalytics<HandleError>;
|
|
5743
|
+
allocations: AdvisoryAllocations<HandleError>;
|
|
5744
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5745
|
+
}
|
|
5736
5746
|
export class WatchmenFfiFirmBranch<HandleError extends boolean = boolean> {
|
|
5737
5747
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5738
5748
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -6047,16 +6057,6 @@ export class WatchmenFfiUserAccountManagement<HandleError extends boolean = bool
|
|
|
6047
6057
|
onlyActiveUser?: any;
|
|
6048
6058
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
6049
6059
|
}
|
|
6050
|
-
export class Advisory<HandleError extends boolean = boolean> {
|
|
6051
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6052
|
-
charges: AdvisoryCharges<HandleError>;
|
|
6053
|
-
models: AdvisoryModels<HandleError>;
|
|
6054
|
-
userAccountManagement: AdvisoryUserAccountManagement<HandleError>;
|
|
6055
|
-
groups: AdvisoryGroups<HandleError>;
|
|
6056
|
-
analytics: AdvisoryAnalytics<HandleError>;
|
|
6057
|
-
allocations: AdvisoryAllocations<HandleError>;
|
|
6058
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6059
|
-
}
|
|
6060
6060
|
export class WatchmenFfi<HandleError extends boolean = boolean> {
|
|
6061
6061
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
6062
6062
|
userAccountManagement: WatchmenFfiUserAccountManagement<HandleError>;
|