@orbis-systems/orbis-api-clients 0.7.3 → 0.7.5
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 +440 -144
- 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 +337 -216
- 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 +166 -142
- package/dist/insight/index.d.ts.map +1 -1
- package/dist/insight/index.esm.js +1 -1
- package/dist/insight/index.esm.js.map +1 -1
- package/dist/insight/index.js +1 -1
- package/dist/insight/index.js.map +1 -1
- package/dist/middleware/index.d.ts +127 -127
- package/dist/middleware/index.d.ts.map +1 -1
- package/dist/middleware/index.esm.js +1 -1
- package/dist/middleware/index.esm.js.map +1 -1
- package/dist/middleware/index.js +1 -1
- package/dist/middleware/index.js.map +1 -1
- package/dist/orbis/index.d.ts +1244 -1236
- 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 +301 -301
- 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 +222 -222
- 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
|
@@ -510,6 +510,80 @@ export class OrdersV2Options<HandleError extends boolean = boolean> {
|
|
|
510
510
|
};
|
|
511
511
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
512
512
|
}
|
|
513
|
+
export class OrdersV2Crypto<HandleError extends boolean = boolean> {
|
|
514
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
515
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
516
|
+
/**
|
|
517
|
+
* @tags Orders V2 Crypto
|
|
518
|
+
* @name OrderPreview
|
|
519
|
+
* @summary Order Preview
|
|
520
|
+
* @request POST:/orders/v2/crypto/preview
|
|
521
|
+
* @secure
|
|
522
|
+
*/
|
|
523
|
+
orderPreview(data: {
|
|
524
|
+
account?: {
|
|
525
|
+
/** @example "ABC123" */
|
|
526
|
+
accountNumber?: string;
|
|
527
|
+
};
|
|
528
|
+
order?: {
|
|
529
|
+
/** @example 100 */
|
|
530
|
+
expectedValue?: number;
|
|
531
|
+
/** @example 1.123 */
|
|
532
|
+
limitPx?: number;
|
|
533
|
+
/** @example "MARKET|LIMIT|STOP|STOP_LIMIG|Notional|NotionalLimit" */
|
|
534
|
+
orderType?: string;
|
|
535
|
+
/** @example 0.0123 */
|
|
536
|
+
quantity?: number;
|
|
537
|
+
quote?: {
|
|
538
|
+
/** @example "BTC/USD" */
|
|
539
|
+
symbol?: string;
|
|
540
|
+
};
|
|
541
|
+
/** @example 1.123 */
|
|
542
|
+
stopPx?: number;
|
|
543
|
+
/** @example "BUY|SELL" */
|
|
544
|
+
transaction?: string;
|
|
545
|
+
/** @example "DAY|GTC" */
|
|
546
|
+
validity?: string;
|
|
547
|
+
};
|
|
548
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
549
|
+
/**
|
|
550
|
+
* @tags Orders V2 Crypto
|
|
551
|
+
* @name OrderPlace
|
|
552
|
+
* @summary Order Place
|
|
553
|
+
* @request POST:/orders/v2/crypto/place
|
|
554
|
+
* @secure
|
|
555
|
+
*/
|
|
556
|
+
orderPlace(data: {
|
|
557
|
+
account?: {
|
|
558
|
+
/** @example "ABC123" */
|
|
559
|
+
accountNumber?: string;
|
|
560
|
+
};
|
|
561
|
+
order?: {
|
|
562
|
+
/** @example "{your own order reference number}" */
|
|
563
|
+
clientRef?: string;
|
|
564
|
+
/** @example "ABC" */
|
|
565
|
+
clientSourceId?: string;
|
|
566
|
+
/** @example 100 */
|
|
567
|
+
expectedValue?: number;
|
|
568
|
+
/** @example 1.123 */
|
|
569
|
+
limitPx?: number;
|
|
570
|
+
/** @example "MARKET|LIMIT|STOP|STOP_LIMIT|Notional|NotionalLimit" */
|
|
571
|
+
orderType?: string;
|
|
572
|
+
/** @example 0.0123 */
|
|
573
|
+
quantity?: number;
|
|
574
|
+
quote?: {
|
|
575
|
+
/** @example "BTC/USD" */
|
|
576
|
+
symbol?: string;
|
|
577
|
+
};
|
|
578
|
+
/** @example 1.123 */
|
|
579
|
+
stopPx?: number;
|
|
580
|
+
/** @example "BUY|SELL" */
|
|
581
|
+
transaction?: string;
|
|
582
|
+
/** @example "DAY|GTC" */
|
|
583
|
+
validity?: string;
|
|
584
|
+
};
|
|
585
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
586
|
+
}
|
|
513
587
|
export class OrdersV2FixedIncome<HandleError extends boolean = boolean> {
|
|
514
588
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
515
589
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -588,80 +662,6 @@ export class OrdersV2FixedIncome<HandleError extends boolean = boolean> {
|
|
|
588
662
|
};
|
|
589
663
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
590
664
|
}
|
|
591
|
-
export class OrdersV2Crypto<HandleError extends boolean = boolean> {
|
|
592
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
593
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
594
|
-
/**
|
|
595
|
-
* @tags Orders V2 Crypto
|
|
596
|
-
* @name OrderPreview
|
|
597
|
-
* @summary Order Preview
|
|
598
|
-
* @request POST:/orders/v2/crypto/preview
|
|
599
|
-
* @secure
|
|
600
|
-
*/
|
|
601
|
-
orderPreview(data: {
|
|
602
|
-
account?: {
|
|
603
|
-
/** @example "ABC123" */
|
|
604
|
-
accountNumber?: string;
|
|
605
|
-
};
|
|
606
|
-
order?: {
|
|
607
|
-
/** @example 100 */
|
|
608
|
-
expectedValue?: number;
|
|
609
|
-
/** @example 1.123 */
|
|
610
|
-
limitPx?: number;
|
|
611
|
-
/** @example "MARKET|LIMIT|STOP|STOP_LIMIG|Notional|NotionalLimit" */
|
|
612
|
-
orderType?: string;
|
|
613
|
-
/** @example 0.0123 */
|
|
614
|
-
quantity?: number;
|
|
615
|
-
quote?: {
|
|
616
|
-
/** @example "BTC/USD" */
|
|
617
|
-
symbol?: string;
|
|
618
|
-
};
|
|
619
|
-
/** @example 1.123 */
|
|
620
|
-
stopPx?: number;
|
|
621
|
-
/** @example "BUY|SELL" */
|
|
622
|
-
transaction?: string;
|
|
623
|
-
/** @example "DAY|GTC" */
|
|
624
|
-
validity?: string;
|
|
625
|
-
};
|
|
626
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
627
|
-
/**
|
|
628
|
-
* @tags Orders V2 Crypto
|
|
629
|
-
* @name OrderPlace
|
|
630
|
-
* @summary Order Place
|
|
631
|
-
* @request POST:/orders/v2/crypto/place
|
|
632
|
-
* @secure
|
|
633
|
-
*/
|
|
634
|
-
orderPlace(data: {
|
|
635
|
-
account?: {
|
|
636
|
-
/** @example "ABC123" */
|
|
637
|
-
accountNumber?: string;
|
|
638
|
-
};
|
|
639
|
-
order?: {
|
|
640
|
-
/** @example "{your own order reference number}" */
|
|
641
|
-
clientRef?: string;
|
|
642
|
-
/** @example "ABC" */
|
|
643
|
-
clientSourceId?: string;
|
|
644
|
-
/** @example 100 */
|
|
645
|
-
expectedValue?: number;
|
|
646
|
-
/** @example 1.123 */
|
|
647
|
-
limitPx?: number;
|
|
648
|
-
/** @example "MARKET|LIMIT|STOP|STOP_LIMIT|Notional|NotionalLimit" */
|
|
649
|
-
orderType?: string;
|
|
650
|
-
/** @example 0.0123 */
|
|
651
|
-
quantity?: number;
|
|
652
|
-
quote?: {
|
|
653
|
-
/** @example "BTC/USD" */
|
|
654
|
-
symbol?: string;
|
|
655
|
-
};
|
|
656
|
-
/** @example 1.123 */
|
|
657
|
-
stopPx?: number;
|
|
658
|
-
/** @example "BUY|SELL" */
|
|
659
|
-
transaction?: string;
|
|
660
|
-
/** @example "DAY|GTC" */
|
|
661
|
-
validity?: string;
|
|
662
|
-
};
|
|
663
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
664
|
-
}
|
|
665
665
|
export class OrdersV2MutualFunds<HandleError extends boolean = boolean> {
|
|
666
666
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
667
667
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -742,12 +742,16 @@ export class OrdersV2Offerings<HandleError extends boolean = boolean> {
|
|
|
742
742
|
order?: {
|
|
743
743
|
/** @example 0 */
|
|
744
744
|
expectedValue?: number;
|
|
745
|
+
/** @example 100 */
|
|
746
|
+
quantity?: number;
|
|
745
747
|
quote?: {
|
|
746
748
|
/** @example "{offering identifier}" */
|
|
747
749
|
identifier?: string;
|
|
748
750
|
};
|
|
749
751
|
/** @example true */
|
|
750
752
|
rule5130And5131Attestation?: boolean;
|
|
753
|
+
/** @example "SPV|Offering" */
|
|
754
|
+
type?: string;
|
|
751
755
|
};
|
|
752
756
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
753
757
|
/**
|
|
@@ -769,12 +773,16 @@ export class OrdersV2Offerings<HandleError extends boolean = boolean> {
|
|
|
769
773
|
clientSourceId?: string;
|
|
770
774
|
/** @example 0 */
|
|
771
775
|
expectedValue?: number;
|
|
776
|
+
/** @example 100 */
|
|
777
|
+
quantity?: number;
|
|
772
778
|
quote?: {
|
|
773
779
|
/** @example "{offering identifier}" */
|
|
774
780
|
identifier?: string;
|
|
775
781
|
};
|
|
776
782
|
/** @example true */
|
|
777
783
|
rule5130And5131Attestation?: boolean;
|
|
784
|
+
/** @example "SPV|Offering" */
|
|
785
|
+
type?: string;
|
|
778
786
|
};
|
|
779
787
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
780
788
|
/**
|
|
@@ -1446,66 +1454,242 @@ export class Quotes<HandleError extends boolean = boolean> {
|
|
|
1446
1454
|
symbols?: any;
|
|
1447
1455
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1448
1456
|
}
|
|
1449
|
-
export class
|
|
1457
|
+
export class ResearchEtfs<HandleError extends boolean = boolean> {
|
|
1450
1458
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
1451
1459
|
constructor(apiClient: JwtClient<HandleError>);
|
|
1452
1460
|
/**
|
|
1453
|
-
* @tags Research
|
|
1454
|
-
* @name
|
|
1455
|
-
* @summary
|
|
1456
|
-
* @request GET:/research/
|
|
1461
|
+
* @tags Research Etfs
|
|
1462
|
+
* @name InitScreener
|
|
1463
|
+
* @summary Init Screener
|
|
1464
|
+
* @request GET:/research/etf/init
|
|
1457
1465
|
* @secure
|
|
1458
1466
|
*/
|
|
1459
|
-
|
|
1460
|
-
/**
|
|
1461
|
-
* Amount to include. Defaults to 20.
|
|
1462
|
-
* @example "20"
|
|
1463
|
-
*/
|
|
1464
|
-
count?: any;
|
|
1465
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1467
|
+
initScreener(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1466
1468
|
/**
|
|
1467
|
-
* @tags Research
|
|
1468
|
-
* @name
|
|
1469
|
-
* @summary
|
|
1470
|
-
* @request GET:/research/
|
|
1469
|
+
* @tags Research Etfs
|
|
1470
|
+
* @name Screener
|
|
1471
|
+
* @summary Screener
|
|
1472
|
+
* @request GET:/research/etf/screener
|
|
1471
1473
|
* @secure
|
|
1472
1474
|
*/
|
|
1473
|
-
|
|
1475
|
+
screener(query?: {
|
|
1476
|
+
/** * see init */
|
|
1477
|
+
inverseType?: any;
|
|
1478
|
+
/** * see init */
|
|
1479
|
+
leverageType?: any;
|
|
1480
|
+
/** * see init */
|
|
1481
|
+
assetId?: any;
|
|
1482
|
+
/** * see init */
|
|
1483
|
+
categoryId?: any;
|
|
1484
|
+
/** * see init */
|
|
1485
|
+
sponsorId?: any;
|
|
1486
|
+
/** Entry to start at */
|
|
1487
|
+
start?: any;
|
|
1488
|
+
/** Entries per page */
|
|
1489
|
+
num?: any;
|
|
1490
|
+
/** Sort by: symbol, last, change, volume, marketcap, expense, asset, sponsor, category, leverage, countrypct, countinentpct, sectorpct, exposure */
|
|
1491
|
+
sort?: any;
|
|
1492
|
+
/** True/false */
|
|
1493
|
+
asc?: any;
|
|
1474
1494
|
/**
|
|
1475
|
-
*
|
|
1476
|
-
* @example "
|
|
1495
|
+
* True/false
|
|
1496
|
+
* @example "false"
|
|
1477
1497
|
*/
|
|
1478
|
-
|
|
1498
|
+
loadIndustries?: any;
|
|
1479
1499
|
/**
|
|
1480
|
-
*
|
|
1481
|
-
* @example "
|
|
1500
|
+
* True/false
|
|
1501
|
+
* @example "false"
|
|
1482
1502
|
*/
|
|
1483
|
-
|
|
1503
|
+
loadUpgrades?: any;
|
|
1504
|
+
/**
|
|
1505
|
+
* True/false
|
|
1506
|
+
* @example "false"
|
|
1507
|
+
*/
|
|
1508
|
+
loadEarnings?: any;
|
|
1509
|
+
/**
|
|
1510
|
+
* Repeating set of:
|
|
1511
|
+
* * paying dividend
|
|
1512
|
+
* * 5pct - paying at least 5% dividend
|
|
1513
|
+
* * 3pct
|
|
1514
|
+
* * mcbelow2b – market cap under 2B
|
|
1515
|
+
* * mcbetween2and10b
|
|
1516
|
+
* * mcbetween10and200b
|
|
1517
|
+
* * mcabove200b
|
|
1518
|
+
*/
|
|
1519
|
+
filters?: any;
|
|
1484
1520
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1485
1521
|
/**
|
|
1486
|
-
* @tags Research
|
|
1487
|
-
* @name
|
|
1488
|
-
* @summary
|
|
1489
|
-
* @request GET:/research/
|
|
1490
|
-
* @secure
|
|
1491
|
-
*/
|
|
1492
|
-
analystProfile(expertUid: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1493
|
-
/**
|
|
1494
|
-
* @tags Research Tipranks
|
|
1495
|
-
* @name TopAnalysts
|
|
1496
|
-
* @summary Top Analysts
|
|
1497
|
-
* @request GET:/research/tipranks/analyst/top
|
|
1522
|
+
* @tags Research Etfs
|
|
1523
|
+
* @name Top10
|
|
1524
|
+
* @summary Top 10
|
|
1525
|
+
* @request GET:/research/etf/top10
|
|
1498
1526
|
* @secure
|
|
1499
1527
|
*/
|
|
1500
|
-
|
|
1528
|
+
top10(query?: {
|
|
1501
1529
|
/**
|
|
1502
|
-
*
|
|
1503
|
-
* @example "
|
|
1530
|
+
* * see Inverse Types table
|
|
1531
|
+
* @example "ALL"
|
|
1504
1532
|
*/
|
|
1505
|
-
|
|
1533
|
+
inverseType?: any;
|
|
1534
|
+
/**
|
|
1535
|
+
* * see Leverage Types table
|
|
1536
|
+
* @example "LEVERAGE"
|
|
1537
|
+
*/
|
|
1538
|
+
leverageType?: any;
|
|
1506
1539
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1507
1540
|
/**
|
|
1508
|
-
* @tags Research
|
|
1541
|
+
* @tags Research Etfs
|
|
1542
|
+
* @name Details
|
|
1543
|
+
* @summary Details
|
|
1544
|
+
* @request GET:/research/etf/details
|
|
1545
|
+
* @secure
|
|
1546
|
+
*/
|
|
1547
|
+
details(query?: {
|
|
1548
|
+
/**
|
|
1549
|
+
* ETF symbol
|
|
1550
|
+
* @example "VXF"
|
|
1551
|
+
*/
|
|
1552
|
+
symbol?: any;
|
|
1553
|
+
/**
|
|
1554
|
+
* Use true to include quotes. Defaults to false.
|
|
1555
|
+
* @example "false"
|
|
1556
|
+
*/
|
|
1557
|
+
loadQuotes?: any;
|
|
1558
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1559
|
+
/**
|
|
1560
|
+
* @tags Research Etfs
|
|
1561
|
+
* @name BreakdownBySector
|
|
1562
|
+
* @summary Breakdown by Sector
|
|
1563
|
+
* @request GET:/research/etf/breakdown
|
|
1564
|
+
* @secure
|
|
1565
|
+
*/
|
|
1566
|
+
breakdownBySector(query?: {
|
|
1567
|
+
/**
|
|
1568
|
+
* 1d, 1w, 2w, 1m where d is day, w is week, and m is month
|
|
1569
|
+
* @example "1d"
|
|
1570
|
+
*/
|
|
1571
|
+
duration?: any;
|
|
1572
|
+
/**
|
|
1573
|
+
* Amount of ETFs to include per sector. Defaults to 5, max is 10
|
|
1574
|
+
* @example "5"
|
|
1575
|
+
*/
|
|
1576
|
+
displaySize?: any;
|
|
1577
|
+
/**
|
|
1578
|
+
* Exposure to specific sector. Defaults to 90
|
|
1579
|
+
* @example "90"
|
|
1580
|
+
*/
|
|
1581
|
+
exposure?: any;
|
|
1582
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1583
|
+
}
|
|
1584
|
+
export class ResearchAdrs<HandleError extends boolean = boolean> {
|
|
1585
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
1586
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
1587
|
+
/**
|
|
1588
|
+
* @tags Research Adrs
|
|
1589
|
+
* @name Top10
|
|
1590
|
+
* @summary Top 10
|
|
1591
|
+
* @request GET:/research/adrs/top10
|
|
1592
|
+
* @secure
|
|
1593
|
+
*/
|
|
1594
|
+
top10(query?: {
|
|
1595
|
+
/** See description */
|
|
1596
|
+
country?: any;
|
|
1597
|
+
/** `true` or `false` */
|
|
1598
|
+
loadQuotes?: any;
|
|
1599
|
+
/** `true` or `false` */
|
|
1600
|
+
loadEarningReleases?: any;
|
|
1601
|
+
/** `true` or `false` */
|
|
1602
|
+
loadUpgradesDowngrades?: any;
|
|
1603
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1604
|
+
/**
|
|
1605
|
+
* @tags Research Adrs
|
|
1606
|
+
* @name Defaults
|
|
1607
|
+
* @summary Defaults
|
|
1608
|
+
* @request GET:/research/adrs/top10/defaults
|
|
1609
|
+
* @secure
|
|
1610
|
+
*/
|
|
1611
|
+
defaults(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1612
|
+
/**
|
|
1613
|
+
* @tags Research Adrs
|
|
1614
|
+
* @name Search
|
|
1615
|
+
* @summary Search
|
|
1616
|
+
* @request GET:/research/adrs
|
|
1617
|
+
* @secure
|
|
1618
|
+
*/
|
|
1619
|
+
search(query?: {
|
|
1620
|
+
/**
|
|
1621
|
+
* Country code such as JPN. See `Defaults` endpoint
|
|
1622
|
+
* @example "JPN"
|
|
1623
|
+
*/
|
|
1624
|
+
country?: any;
|
|
1625
|
+
/** `true` or `false` */
|
|
1626
|
+
loadQuotes?: any;
|
|
1627
|
+
/** `true` or `false` */
|
|
1628
|
+
loadEarningReleases?: any;
|
|
1629
|
+
/** `true` or `false` */
|
|
1630
|
+
loadUpgradesDowngrades?: any;
|
|
1631
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1632
|
+
}
|
|
1633
|
+
export class ResearchTipranks<HandleError extends boolean = boolean> {
|
|
1634
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
1635
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
1636
|
+
/**
|
|
1637
|
+
* @tags Research Tipranks
|
|
1638
|
+
* @name Livefeed
|
|
1639
|
+
* @summary Livefeed
|
|
1640
|
+
* @request GET:/research/tipranks/livefeed
|
|
1641
|
+
* @secure
|
|
1642
|
+
*/
|
|
1643
|
+
livefeed(query?: {
|
|
1644
|
+
/**
|
|
1645
|
+
* Amount to include. Defaults to 20.
|
|
1646
|
+
* @example "20"
|
|
1647
|
+
*/
|
|
1648
|
+
count?: any;
|
|
1649
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1650
|
+
/**
|
|
1651
|
+
* @tags Research Tipranks
|
|
1652
|
+
* @name AnalystPortfolio
|
|
1653
|
+
* @summary Analyst Portfolio
|
|
1654
|
+
* @request GET:/research/tipranks/analyst/portfolio/{expertUID}
|
|
1655
|
+
* @secure
|
|
1656
|
+
*/
|
|
1657
|
+
analystPortfolio(expertUid: string, query?: {
|
|
1658
|
+
/**
|
|
1659
|
+
* Total number of entries
|
|
1660
|
+
* @example "5"
|
|
1661
|
+
*/
|
|
1662
|
+
count?: any;
|
|
1663
|
+
/**
|
|
1664
|
+
* Optional. Defaults to false
|
|
1665
|
+
* @example "true"
|
|
1666
|
+
*/
|
|
1667
|
+
loadQuotes?: any;
|
|
1668
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1669
|
+
/**
|
|
1670
|
+
* @tags Research Tipranks
|
|
1671
|
+
* @name AnalystProfile
|
|
1672
|
+
* @summary Analyst Profile
|
|
1673
|
+
* @request GET:/research/tipranks/analyst/profile/{expertUID}
|
|
1674
|
+
* @secure
|
|
1675
|
+
*/
|
|
1676
|
+
analystProfile(expertUid: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1677
|
+
/**
|
|
1678
|
+
* @tags Research Tipranks
|
|
1679
|
+
* @name TopAnalysts
|
|
1680
|
+
* @summary Top Analysts
|
|
1681
|
+
* @request GET:/research/tipranks/analyst/top
|
|
1682
|
+
* @secure
|
|
1683
|
+
*/
|
|
1684
|
+
topAnalysts(query?: {
|
|
1685
|
+
/**
|
|
1686
|
+
* Total entries. Defaults to 20.
|
|
1687
|
+
* @example "25"
|
|
1688
|
+
*/
|
|
1689
|
+
count?: any;
|
|
1690
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1691
|
+
/**
|
|
1692
|
+
* @tags Research Tipranks
|
|
1509
1693
|
* @name RatingsBySymbol
|
|
1510
1694
|
* @summary Ratings by Symbol
|
|
1511
1695
|
* @request GET:/research/tipranks/analyst/{symbol}
|
|
@@ -1627,249 +1811,73 @@ export class ResearchTipranks<HandleError extends boolean = boolean> {
|
|
|
1627
1811
|
*/
|
|
1628
1812
|
bloggerRatings(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1629
1813
|
}
|
|
1630
|
-
export class
|
|
1814
|
+
export class ResearchCorporateActions<HandleError extends boolean = boolean> {
|
|
1631
1815
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
1632
1816
|
constructor(apiClient: JwtClient<HandleError>);
|
|
1633
1817
|
/**
|
|
1634
|
-
* @tags Research
|
|
1635
|
-
* @name
|
|
1636
|
-
* @summary
|
|
1637
|
-
* @request GET:/research/
|
|
1818
|
+
* @tags Research Corporate Actions
|
|
1819
|
+
* @name Types
|
|
1820
|
+
* @summary Types
|
|
1821
|
+
* @request GET:/research/actions/types
|
|
1638
1822
|
* @secure
|
|
1639
1823
|
*/
|
|
1640
|
-
|
|
1824
|
+
types(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1641
1825
|
/**
|
|
1642
|
-
* @tags Research
|
|
1643
|
-
* @name
|
|
1644
|
-
* @summary
|
|
1645
|
-
* @request GET:/research/
|
|
1826
|
+
* @tags Research Corporate Actions
|
|
1827
|
+
* @name PaymentTypes
|
|
1828
|
+
* @summary Payment types
|
|
1829
|
+
* @request GET:/research/actions/paymentTypes
|
|
1646
1830
|
* @secure
|
|
1647
1831
|
*/
|
|
1648
|
-
|
|
1649
|
-
|
|
1650
|
-
|
|
1651
|
-
|
|
1652
|
-
|
|
1653
|
-
|
|
1654
|
-
|
|
1655
|
-
|
|
1656
|
-
|
|
1657
|
-
/** * see init */
|
|
1658
|
-
sponsorId?: any;
|
|
1659
|
-
/** Entry to start at */
|
|
1660
|
-
start?: any;
|
|
1661
|
-
/** Entries per page */
|
|
1662
|
-
num?: any;
|
|
1663
|
-
/** Sort by: symbol, last, change, volume, marketcap, expense, asset, sponsor, category, leverage, countrypct, countinentpct, sectorpct, exposure */
|
|
1664
|
-
sort?: any;
|
|
1665
|
-
/** True/false */
|
|
1666
|
-
asc?: any;
|
|
1832
|
+
paymentTypes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1833
|
+
/**
|
|
1834
|
+
* @tags Research Corporate Actions
|
|
1835
|
+
* @name Search
|
|
1836
|
+
* @summary Search
|
|
1837
|
+
* @request GET:/research/actions/search
|
|
1838
|
+
* @secure
|
|
1839
|
+
*/
|
|
1840
|
+
search(query?: {
|
|
1667
1841
|
/**
|
|
1668
|
-
*
|
|
1669
|
-
* @example "
|
|
1842
|
+
* Old or new symbol (multiple tickers separated by comma)
|
|
1843
|
+
* @example "{symbol}"
|
|
1670
1844
|
*/
|
|
1671
|
-
|
|
1845
|
+
symbol?: any;
|
|
1672
1846
|
/**
|
|
1673
|
-
*
|
|
1674
|
-
* @example "
|
|
1847
|
+
* Defaults to today's date in America/New_York timezone.
|
|
1848
|
+
* @example "{date}"
|
|
1675
1849
|
*/
|
|
1676
|
-
|
|
1850
|
+
dateFrom?: any;
|
|
1851
|
+
/** @example "{date}" */
|
|
1852
|
+
dateTo?: any;
|
|
1677
1853
|
/**
|
|
1678
|
-
*
|
|
1679
|
-
* @example "
|
|
1854
|
+
* (separate multiple types with comma)
|
|
1855
|
+
* @example "{type}"
|
|
1680
1856
|
*/
|
|
1681
|
-
|
|
1857
|
+
type?: any;
|
|
1682
1858
|
/**
|
|
1683
|
-
*
|
|
1684
|
-
*
|
|
1685
|
-
* * 5pct - paying at least 5% dividend
|
|
1686
|
-
* * 3pct
|
|
1687
|
-
* * mcbelow2b – market cap under 2B
|
|
1688
|
-
* * mcbetween2and10b
|
|
1689
|
-
* * mcbetween10and200b
|
|
1690
|
-
* * mcabove200b
|
|
1859
|
+
* (search for Dividends using payment date instead of ex-date)
|
|
1860
|
+
* @example "false"
|
|
1691
1861
|
*/
|
|
1692
|
-
|
|
1862
|
+
usePayDate?: any;
|
|
1693
1863
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1864
|
+
}
|
|
1865
|
+
export class ResearchNews<HandleError extends boolean = boolean> {
|
|
1866
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
1867
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
1694
1868
|
/**
|
|
1695
|
-
* @tags Research
|
|
1696
|
-
* @name
|
|
1697
|
-
* @summary
|
|
1698
|
-
* @request GET:/research/
|
|
1869
|
+
* @tags Research News
|
|
1870
|
+
* @name List
|
|
1871
|
+
* @summary List
|
|
1872
|
+
* @request GET:/research/news
|
|
1699
1873
|
* @secure
|
|
1700
1874
|
*/
|
|
1701
|
-
|
|
1875
|
+
list(query?: {
|
|
1876
|
+
/** @example "0" */
|
|
1877
|
+
start?: any;
|
|
1702
1878
|
/**
|
|
1703
|
-
*
|
|
1704
|
-
* @example "
|
|
1705
|
-
*/
|
|
1706
|
-
inverseType?: any;
|
|
1707
|
-
/**
|
|
1708
|
-
* * see Leverage Types table
|
|
1709
|
-
* @example "LEVERAGE"
|
|
1710
|
-
*/
|
|
1711
|
-
leverageType?: any;
|
|
1712
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1713
|
-
/**
|
|
1714
|
-
* @tags Research Etfs
|
|
1715
|
-
* @name Details
|
|
1716
|
-
* @summary Details
|
|
1717
|
-
* @request GET:/research/etf/details
|
|
1718
|
-
* @secure
|
|
1719
|
-
*/
|
|
1720
|
-
details(query?: {
|
|
1721
|
-
/**
|
|
1722
|
-
* ETF symbol
|
|
1723
|
-
* @example "VXF"
|
|
1724
|
-
*/
|
|
1725
|
-
symbol?: any;
|
|
1726
|
-
/**
|
|
1727
|
-
* Use true to include quotes. Defaults to false.
|
|
1728
|
-
* @example "false"
|
|
1729
|
-
*/
|
|
1730
|
-
loadQuotes?: any;
|
|
1731
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1732
|
-
/**
|
|
1733
|
-
* @tags Research Etfs
|
|
1734
|
-
* @name BreakdownBySector
|
|
1735
|
-
* @summary Breakdown by Sector
|
|
1736
|
-
* @request GET:/research/etf/breakdown
|
|
1737
|
-
* @secure
|
|
1738
|
-
*/
|
|
1739
|
-
breakdownBySector(query?: {
|
|
1740
|
-
/**
|
|
1741
|
-
* 1d, 1w, 2w, 1m where d is day, w is week, and m is month
|
|
1742
|
-
* @example "1d"
|
|
1743
|
-
*/
|
|
1744
|
-
duration?: any;
|
|
1745
|
-
/**
|
|
1746
|
-
* Amount of ETFs to include per sector. Defaults to 5, max is 10
|
|
1747
|
-
* @example "5"
|
|
1748
|
-
*/
|
|
1749
|
-
displaySize?: any;
|
|
1750
|
-
/**
|
|
1751
|
-
* Exposure to specific sector. Defaults to 90
|
|
1752
|
-
* @example "90"
|
|
1753
|
-
*/
|
|
1754
|
-
exposure?: any;
|
|
1755
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1756
|
-
}
|
|
1757
|
-
export class ResearchAdrs<HandleError extends boolean = boolean> {
|
|
1758
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
1759
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
1760
|
-
/**
|
|
1761
|
-
* @tags Research Adrs
|
|
1762
|
-
* @name Top10
|
|
1763
|
-
* @summary Top 10
|
|
1764
|
-
* @request GET:/research/adrs/top10
|
|
1765
|
-
* @secure
|
|
1766
|
-
*/
|
|
1767
|
-
top10(query?: {
|
|
1768
|
-
/** See description */
|
|
1769
|
-
country?: any;
|
|
1770
|
-
/** `true` or `false` */
|
|
1771
|
-
loadQuotes?: any;
|
|
1772
|
-
/** `true` or `false` */
|
|
1773
|
-
loadEarningReleases?: any;
|
|
1774
|
-
/** `true` or `false` */
|
|
1775
|
-
loadUpgradesDowngrades?: any;
|
|
1776
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1777
|
-
/**
|
|
1778
|
-
* @tags Research Adrs
|
|
1779
|
-
* @name Defaults
|
|
1780
|
-
* @summary Defaults
|
|
1781
|
-
* @request GET:/research/adrs/top10/defaults
|
|
1782
|
-
* @secure
|
|
1783
|
-
*/
|
|
1784
|
-
defaults(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1785
|
-
/**
|
|
1786
|
-
* @tags Research Adrs
|
|
1787
|
-
* @name Search
|
|
1788
|
-
* @summary Search
|
|
1789
|
-
* @request GET:/research/adrs
|
|
1790
|
-
* @secure
|
|
1791
|
-
*/
|
|
1792
|
-
search(query?: {
|
|
1793
|
-
/**
|
|
1794
|
-
* Country code such as JPN. See `Defaults` endpoint
|
|
1795
|
-
* @example "JPN"
|
|
1796
|
-
*/
|
|
1797
|
-
country?: any;
|
|
1798
|
-
/** `true` or `false` */
|
|
1799
|
-
loadQuotes?: any;
|
|
1800
|
-
/** `true` or `false` */
|
|
1801
|
-
loadEarningReleases?: any;
|
|
1802
|
-
/** `true` or `false` */
|
|
1803
|
-
loadUpgradesDowngrades?: any;
|
|
1804
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1805
|
-
}
|
|
1806
|
-
export class ResearchCorporateActions<HandleError extends boolean = boolean> {
|
|
1807
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
1808
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
1809
|
-
/**
|
|
1810
|
-
* @tags Research Corporate Actions
|
|
1811
|
-
* @name Types
|
|
1812
|
-
* @summary Types
|
|
1813
|
-
* @request GET:/research/actions/types
|
|
1814
|
-
* @secure
|
|
1815
|
-
*/
|
|
1816
|
-
types(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1817
|
-
/**
|
|
1818
|
-
* @tags Research Corporate Actions
|
|
1819
|
-
* @name PaymentTypes
|
|
1820
|
-
* @summary Payment types
|
|
1821
|
-
* @request GET:/research/actions/paymentTypes
|
|
1822
|
-
* @secure
|
|
1823
|
-
*/
|
|
1824
|
-
paymentTypes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1825
|
-
/**
|
|
1826
|
-
* @tags Research Corporate Actions
|
|
1827
|
-
* @name Search
|
|
1828
|
-
* @summary Search
|
|
1829
|
-
* @request GET:/research/actions/search
|
|
1830
|
-
* @secure
|
|
1831
|
-
*/
|
|
1832
|
-
search(query?: {
|
|
1833
|
-
/**
|
|
1834
|
-
* Old or new symbol (multiple tickers separated by comma)
|
|
1835
|
-
* @example "{symbol}"
|
|
1836
|
-
*/
|
|
1837
|
-
symbol?: any;
|
|
1838
|
-
/**
|
|
1839
|
-
* Defaults to today's date in America/New_York timezone.
|
|
1840
|
-
* @example "{date}"
|
|
1841
|
-
*/
|
|
1842
|
-
dateFrom?: any;
|
|
1843
|
-
/** @example "{date}" */
|
|
1844
|
-
dateTo?: any;
|
|
1845
|
-
/**
|
|
1846
|
-
* (separate multiple types with comma)
|
|
1847
|
-
* @example "{type}"
|
|
1848
|
-
*/
|
|
1849
|
-
type?: any;
|
|
1850
|
-
/**
|
|
1851
|
-
* (search for Dividends using payment date instead of ex-date)
|
|
1852
|
-
* @example "false"
|
|
1853
|
-
*/
|
|
1854
|
-
usePayDate?: any;
|
|
1855
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1856
|
-
}
|
|
1857
|
-
export class ResearchNews<HandleError extends boolean = boolean> {
|
|
1858
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
1859
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
1860
|
-
/**
|
|
1861
|
-
* @tags Research News
|
|
1862
|
-
* @name List
|
|
1863
|
-
* @summary List
|
|
1864
|
-
* @request GET:/research/news
|
|
1865
|
-
* @secure
|
|
1866
|
-
*/
|
|
1867
|
-
list(query?: {
|
|
1868
|
-
/** @example "0" */
|
|
1869
|
-
start?: any;
|
|
1870
|
-
/**
|
|
1871
|
-
* Defaults to 20
|
|
1872
|
-
* @example "100"
|
|
1879
|
+
* Defaults to 20
|
|
1880
|
+
* @example "100"
|
|
1873
1881
|
*/
|
|
1874
1882
|
count?: any;
|
|
1875
1883
|
/** @example "[[-](provider|aggregator):value1,valueN];" */
|
|
@@ -2331,52 +2339,6 @@ export class Research<HandleError extends boolean = boolean> {
|
|
|
2331
2339
|
dates?: any;
|
|
2332
2340
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2333
2341
|
}
|
|
2334
|
-
export class UserDevice<HandleError extends boolean = boolean> {
|
|
2335
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
2336
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
2337
|
-
/**
|
|
2338
|
-
* @tags User Device
|
|
2339
|
-
* @name Register
|
|
2340
|
-
* @summary Register
|
|
2341
|
-
* @request GET:/user/device/register
|
|
2342
|
-
* @secure
|
|
2343
|
-
*/
|
|
2344
|
-
register(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2345
|
-
/**
|
|
2346
|
-
* @tags User Device
|
|
2347
|
-
* @name Deregister
|
|
2348
|
-
* @summary Deregister
|
|
2349
|
-
* @request GET:/user/device/deregister
|
|
2350
|
-
* @secure
|
|
2351
|
-
*/
|
|
2352
|
-
deregister(query?: {
|
|
2353
|
-
token?: any;
|
|
2354
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2355
|
-
/**
|
|
2356
|
-
* @tags User Device
|
|
2357
|
-
* @name FirebaseRegistration
|
|
2358
|
-
* @summary Firebase - registration
|
|
2359
|
-
* @request POST:/user/device/firebase/register
|
|
2360
|
-
* @secure
|
|
2361
|
-
*/
|
|
2362
|
-
firebaseRegistration(data: {
|
|
2363
|
-
/** @example "/optional/ predfined scope name" */
|
|
2364
|
-
scope?: any;
|
|
2365
|
-
/** @example "a1s2d3f4g5h6" */
|
|
2366
|
-
token?: any;
|
|
2367
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2368
|
-
/**
|
|
2369
|
-
* @tags User Device
|
|
2370
|
-
* @name FirebaseRemoval
|
|
2371
|
-
* @summary Firebase - removal
|
|
2372
|
-
* @request POST:/user/device/firebase/deregister
|
|
2373
|
-
* @secure
|
|
2374
|
-
*/
|
|
2375
|
-
firebaseRemoval(data: {
|
|
2376
|
-
/** @example "a1s2d3f4g5h6" */
|
|
2377
|
-
token?: any;
|
|
2378
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2379
|
-
}
|
|
2380
2342
|
export class UserWatchlists<HandleError extends boolean = boolean> {
|
|
2381
2343
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2382
2344
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -2583,6 +2545,52 @@ export class UserAgreements<HandleError extends boolean = boolean> {
|
|
|
2583
2545
|
*/
|
|
2584
2546
|
cryptoSign(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2585
2547
|
}
|
|
2548
|
+
export class UserDevice<HandleError extends boolean = boolean> {
|
|
2549
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2550
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2551
|
+
/**
|
|
2552
|
+
* @tags User Device
|
|
2553
|
+
* @name Register
|
|
2554
|
+
* @summary Register
|
|
2555
|
+
* @request GET:/user/device/register
|
|
2556
|
+
* @secure
|
|
2557
|
+
*/
|
|
2558
|
+
register(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2559
|
+
/**
|
|
2560
|
+
* @tags User Device
|
|
2561
|
+
* @name Deregister
|
|
2562
|
+
* @summary Deregister
|
|
2563
|
+
* @request GET:/user/device/deregister
|
|
2564
|
+
* @secure
|
|
2565
|
+
*/
|
|
2566
|
+
deregister(query?: {
|
|
2567
|
+
token?: any;
|
|
2568
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2569
|
+
/**
|
|
2570
|
+
* @tags User Device
|
|
2571
|
+
* @name FirebaseRegistration
|
|
2572
|
+
* @summary Firebase - registration
|
|
2573
|
+
* @request POST:/user/device/firebase/register
|
|
2574
|
+
* @secure
|
|
2575
|
+
*/
|
|
2576
|
+
firebaseRegistration(data: {
|
|
2577
|
+
/** @example "/optional/ predfined scope name" */
|
|
2578
|
+
scope?: any;
|
|
2579
|
+
/** @example "a1s2d3f4g5h6" */
|
|
2580
|
+
token?: any;
|
|
2581
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2582
|
+
/**
|
|
2583
|
+
* @tags User Device
|
|
2584
|
+
* @name FirebaseRemoval
|
|
2585
|
+
* @summary Firebase - removal
|
|
2586
|
+
* @request POST:/user/device/firebase/deregister
|
|
2587
|
+
* @secure
|
|
2588
|
+
*/
|
|
2589
|
+
firebaseRemoval(data: {
|
|
2590
|
+
/** @example "a1s2d3f4g5h6" */
|
|
2591
|
+
token?: any;
|
|
2592
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2593
|
+
}
|
|
2586
2594
|
export class User<HandleError extends boolean = boolean> {
|
|
2587
2595
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2588
2596
|
watchlists: UserWatchlists<HandleError>;
|
|
@@ -3212,6 +3220,67 @@ export class User<HandleError extends boolean = boolean> {
|
|
|
3212
3220
|
*/
|
|
3213
3221
|
passwordChange(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3214
3222
|
}
|
|
3223
|
+
export class AdvisoryCharges<HandleError extends boolean = boolean> {
|
|
3224
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3225
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3226
|
+
/**
|
|
3227
|
+
* @tags Advisory Charges
|
|
3228
|
+
* @name Search
|
|
3229
|
+
* @summary /search
|
|
3230
|
+
* @request GET:/v2/charges/search
|
|
3231
|
+
* @secure
|
|
3232
|
+
*/
|
|
3233
|
+
search(query?: {
|
|
3234
|
+
/**
|
|
3235
|
+
* Must be either this or `AccountNumber`
|
|
3236
|
+
* @example "12345"
|
|
3237
|
+
*/
|
|
3238
|
+
AccountId?: any;
|
|
3239
|
+
/**
|
|
3240
|
+
* Must be either this or `AccountId`
|
|
3241
|
+
* @example "AB321654"
|
|
3242
|
+
*/
|
|
3243
|
+
AccountNumber?: any;
|
|
3244
|
+
/**
|
|
3245
|
+
* `optional` - defaults to today
|
|
3246
|
+
* @example "7/1/2018"
|
|
3247
|
+
*/
|
|
3248
|
+
DateFrom?: any;
|
|
3249
|
+
/**
|
|
3250
|
+
* `optional`
|
|
3251
|
+
* @example "7/1/2018"
|
|
3252
|
+
*/
|
|
3253
|
+
DateTo?: any;
|
|
3254
|
+
/**
|
|
3255
|
+
* `optional`
|
|
3256
|
+
* @example "CH321654"
|
|
3257
|
+
*/
|
|
3258
|
+
ChargeRef?: any;
|
|
3259
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3260
|
+
/**
|
|
3261
|
+
* @tags Advisory Charges
|
|
3262
|
+
* @name Apply
|
|
3263
|
+
* @summary /apply
|
|
3264
|
+
* @request POST:/v2/charges/apply
|
|
3265
|
+
* @secure
|
|
3266
|
+
*/
|
|
3267
|
+
apply(data: {
|
|
3268
|
+
/** @example 1234 */
|
|
3269
|
+
accountId?: any;
|
|
3270
|
+
/** @example 7.11 */
|
|
3271
|
+
amount?: any;
|
|
3272
|
+
/** @example "{timestamp}" */
|
|
3273
|
+
date?: any;
|
|
3274
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3275
|
+
/**
|
|
3276
|
+
* @tags Advisory Charges
|
|
3277
|
+
* @name Cancel
|
|
3278
|
+
* @summary /cancel
|
|
3279
|
+
* @request POST:/v2/charges/cancel
|
|
3280
|
+
* @secure
|
|
3281
|
+
*/
|
|
3282
|
+
cancel(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3283
|
+
}
|
|
3215
3284
|
export class AdvisoryModels<HandleError extends boolean = boolean> {
|
|
3216
3285
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3217
3286
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -3487,66 +3556,76 @@ export class AdvisoryModels<HandleError extends boolean = boolean> {
|
|
|
3487
3556
|
*/
|
|
3488
3557
|
allocations(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3489
3558
|
}
|
|
3490
|
-
export class
|
|
3559
|
+
export class AdvisoryUserAccountManagement<HandleError extends boolean = boolean> {
|
|
3491
3560
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3492
3561
|
constructor(apiClient: JwtClient<HandleError>);
|
|
3493
3562
|
/**
|
|
3494
|
-
* @tags Advisory
|
|
3495
|
-
* @name
|
|
3496
|
-
* @summary /
|
|
3497
|
-
* @request GET:/v2/
|
|
3563
|
+
* @tags Advisory User Account Management
|
|
3564
|
+
* @name List
|
|
3565
|
+
* @summary /list
|
|
3566
|
+
* @request GET:/v2/advisory/users/list
|
|
3498
3567
|
* @secure
|
|
3499
3568
|
*/
|
|
3500
|
-
|
|
3501
|
-
|
|
3502
|
-
|
|
3503
|
-
|
|
3504
|
-
|
|
3505
|
-
|
|
3506
|
-
|
|
3507
|
-
|
|
3508
|
-
|
|
3509
|
-
|
|
3510
|
-
|
|
3511
|
-
/**
|
|
3512
|
-
* `optional` - defaults to today
|
|
3513
|
-
* @example "7/1/2018"
|
|
3514
|
-
*/
|
|
3515
|
-
DateFrom?: any;
|
|
3569
|
+
list(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3570
|
+
/**
|
|
3571
|
+
* @tags Advisory User Account Management
|
|
3572
|
+
* @name Accounts
|
|
3573
|
+
* @summary /accounts
|
|
3574
|
+
* @request GET:/v2/advisory/users/accounts
|
|
3575
|
+
* @secure
|
|
3576
|
+
*/
|
|
3577
|
+
accounts(query?: {
|
|
3578
|
+
/** @example "1234" */
|
|
3579
|
+
uid?: any;
|
|
3516
3580
|
/**
|
|
3517
|
-
*
|
|
3518
|
-
* @example "
|
|
3581
|
+
* true|false
|
|
3582
|
+
* @example "false"
|
|
3519
3583
|
*/
|
|
3520
|
-
|
|
3584
|
+
loadRtb?: any;
|
|
3585
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3586
|
+
/**
|
|
3587
|
+
* @tags Advisory User Account Management
|
|
3588
|
+
* @name AccountsStats
|
|
3589
|
+
* @summary /accounts/stats
|
|
3590
|
+
* @request GET:/v2/advisory/users/accounts/stats
|
|
3591
|
+
* @secure
|
|
3592
|
+
*/
|
|
3593
|
+
accountsStats(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3594
|
+
/**
|
|
3595
|
+
* @tags Advisory User Account Management
|
|
3596
|
+
* @name AccountNotes
|
|
3597
|
+
* @summary /account/notes
|
|
3598
|
+
* @request GET:/v2/advisory/users/account/notes
|
|
3599
|
+
* @secure
|
|
3600
|
+
*/
|
|
3601
|
+
accountNotes(query?: {
|
|
3521
3602
|
/**
|
|
3522
|
-
*
|
|
3523
|
-
* @example "
|
|
3603
|
+
* Account's ID
|
|
3604
|
+
* @example "1234"
|
|
3524
3605
|
*/
|
|
3525
|
-
|
|
3606
|
+
aid?: any;
|
|
3526
3607
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3527
3608
|
/**
|
|
3528
|
-
* @tags Advisory
|
|
3529
|
-
* @name
|
|
3530
|
-
* @summary /
|
|
3531
|
-
* @request
|
|
3609
|
+
* @tags Advisory User Account Management
|
|
3610
|
+
* @name Notes
|
|
3611
|
+
* @summary /notes
|
|
3612
|
+
* @request GET:/v2/advisory/users/notes
|
|
3532
3613
|
* @secure
|
|
3533
3614
|
*/
|
|
3534
|
-
|
|
3535
|
-
/**
|
|
3536
|
-
|
|
3537
|
-
|
|
3538
|
-
|
|
3539
|
-
|
|
3540
|
-
date?: any;
|
|
3615
|
+
notes(query?: {
|
|
3616
|
+
/**
|
|
3617
|
+
* User's ID
|
|
3618
|
+
* @example "1234"
|
|
3619
|
+
*/
|
|
3620
|
+
uid?: any;
|
|
3541
3621
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3542
3622
|
/**
|
|
3543
|
-
* @tags Advisory
|
|
3544
|
-
* @name
|
|
3545
|
-
* @
|
|
3546
|
-
* @request POST:/v2/charges/cancel
|
|
3623
|
+
* @tags Advisory User Account Management
|
|
3624
|
+
* @name NotesPost
|
|
3625
|
+
* @request POST:/v2/advisory/users/notes/{action}
|
|
3547
3626
|
* @secure
|
|
3548
3627
|
*/
|
|
3549
|
-
|
|
3628
|
+
notesPost(action: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3550
3629
|
}
|
|
3551
3630
|
export class AdvisoryGroups<HandleError extends boolean = boolean> {
|
|
3552
3631
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -3731,24 +3810,6 @@ export class AdvisoryAllocations<HandleError extends boolean = boolean> {
|
|
|
3731
3810
|
*/
|
|
3732
3811
|
trigger(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3733
3812
|
}
|
|
3734
|
-
export class Device<HandleError extends boolean = boolean> {
|
|
3735
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
3736
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
3737
|
-
/**
|
|
3738
|
-
* @tags Device
|
|
3739
|
-
* @name DeviceDeactivate
|
|
3740
|
-
* @summary /device/deactivate
|
|
3741
|
-
* @request POST:/device/deactivate
|
|
3742
|
-
* @secure
|
|
3743
|
-
*/
|
|
3744
|
-
deviceDeactivate(data: {
|
|
3745
|
-
/**
|
|
3746
|
-
* Token previously registered
|
|
3747
|
-
* @example "123456789"
|
|
3748
|
-
*/
|
|
3749
|
-
Token?: string;
|
|
3750
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3751
|
-
}
|
|
3752
3813
|
export class TransfersRelationships<HandleError extends boolean = boolean> {
|
|
3753
3814
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3754
3815
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -3993,77 +4054,6 @@ export class TransfersRelationships<HandleError extends boolean = boolean> {
|
|
|
3993
4054
|
};
|
|
3994
4055
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3995
4056
|
}
|
|
3996
|
-
export class AdvisoryUserAccountManagement<HandleError extends boolean = boolean> {
|
|
3997
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
3998
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
3999
|
-
/**
|
|
4000
|
-
* @tags Advisory User Account Management
|
|
4001
|
-
* @name List
|
|
4002
|
-
* @summary /list
|
|
4003
|
-
* @request GET:/v2/advisory/users/list
|
|
4004
|
-
* @secure
|
|
4005
|
-
*/
|
|
4006
|
-
list(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4007
|
-
/**
|
|
4008
|
-
* @tags Advisory User Account Management
|
|
4009
|
-
* @name Accounts
|
|
4010
|
-
* @summary /accounts
|
|
4011
|
-
* @request GET:/v2/advisory/users/accounts
|
|
4012
|
-
* @secure
|
|
4013
|
-
*/
|
|
4014
|
-
accounts(query?: {
|
|
4015
|
-
/** @example "1234" */
|
|
4016
|
-
uid?: any;
|
|
4017
|
-
/**
|
|
4018
|
-
* true|false
|
|
4019
|
-
* @example "false"
|
|
4020
|
-
*/
|
|
4021
|
-
loadRtb?: any;
|
|
4022
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4023
|
-
/**
|
|
4024
|
-
* @tags Advisory User Account Management
|
|
4025
|
-
* @name AccountsStats
|
|
4026
|
-
* @summary /accounts/stats
|
|
4027
|
-
* @request GET:/v2/advisory/users/accounts/stats
|
|
4028
|
-
* @secure
|
|
4029
|
-
*/
|
|
4030
|
-
accountsStats(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4031
|
-
/**
|
|
4032
|
-
* @tags Advisory User Account Management
|
|
4033
|
-
* @name AccountNotes
|
|
4034
|
-
* @summary /account/notes
|
|
4035
|
-
* @request GET:/v2/advisory/users/account/notes
|
|
4036
|
-
* @secure
|
|
4037
|
-
*/
|
|
4038
|
-
accountNotes(query?: {
|
|
4039
|
-
/**
|
|
4040
|
-
* Account's ID
|
|
4041
|
-
* @example "1234"
|
|
4042
|
-
*/
|
|
4043
|
-
aid?: any;
|
|
4044
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4045
|
-
/**
|
|
4046
|
-
* @tags Advisory User Account Management
|
|
4047
|
-
* @name Notes
|
|
4048
|
-
* @summary /notes
|
|
4049
|
-
* @request GET:/v2/advisory/users/notes
|
|
4050
|
-
* @secure
|
|
4051
|
-
*/
|
|
4052
|
-
notes(query?: {
|
|
4053
|
-
/**
|
|
4054
|
-
* User's ID
|
|
4055
|
-
* @example "1234"
|
|
4056
|
-
*/
|
|
4057
|
-
uid?: any;
|
|
4058
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4059
|
-
/**
|
|
4060
|
-
* @tags Advisory User Account Management
|
|
4061
|
-
* @name NotesPost
|
|
4062
|
-
* @request POST:/v2/advisory/users/notes/{action}
|
|
4063
|
-
* @secure
|
|
4064
|
-
*/
|
|
4065
|
-
notesPost(action: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4066
|
-
}
|
|
4067
4057
|
export class TransfersInstantAccountVerification<HandleError extends boolean = boolean> {
|
|
4068
4058
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4069
4059
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4163,89 +4153,14 @@ export class TransfersAch<HandleError extends boolean = boolean> {
|
|
|
4163
4153
|
*/
|
|
4164
4154
|
withdraw(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4165
4155
|
}
|
|
4166
|
-
export class
|
|
4156
|
+
export class TransfersAcats<HandleError extends boolean = boolean> {
|
|
4167
4157
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4168
4158
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4169
4159
|
/**
|
|
4170
|
-
* @tags Transfers
|
|
4171
|
-
* @name
|
|
4172
|
-
* @summary
|
|
4173
|
-
* @request
|
|
4174
|
-
* @secure
|
|
4175
|
-
*/
|
|
4176
|
-
outgoing(data: {
|
|
4177
|
-
/** @example "TRACCOUNT" */
|
|
4178
|
-
account?: any;
|
|
4179
|
-
/** @example 200 */
|
|
4180
|
-
amount?: any;
|
|
4181
|
-
beneficiary?: {
|
|
4182
|
-
/** @example "AAA012345" */
|
|
4183
|
-
account?: string;
|
|
4184
|
-
/** @example "CHECKING|SAVINGS" */
|
|
4185
|
-
accountType?: string;
|
|
4186
|
-
address?: {
|
|
4187
|
-
/** @example "Central City" */
|
|
4188
|
-
city?: string;
|
|
4189
|
-
/** @example "USA" */
|
|
4190
|
-
country?: string;
|
|
4191
|
-
/** @example "11235" */
|
|
4192
|
-
postalCode?: string;
|
|
4193
|
-
/** @example "ST" */
|
|
4194
|
-
stateProvince?: string;
|
|
4195
|
-
/** @example ["123 Main St"] */
|
|
4196
|
-
streetAddress?: string[];
|
|
4197
|
-
};
|
|
4198
|
-
/** @example "John Smith" */
|
|
4199
|
-
name?: string;
|
|
4200
|
-
/** @example false */
|
|
4201
|
-
thirdParty?: boolean;
|
|
4202
|
-
};
|
|
4203
|
-
/** @example "Partial|Full" */
|
|
4204
|
-
disbursementType?: any;
|
|
4205
|
-
/** @example 1234 */
|
|
4206
|
-
entryId?: any;
|
|
4207
|
-
/** @example false */
|
|
4208
|
-
international?: any;
|
|
4209
|
-
iraDetails?: {
|
|
4210
|
-
/** @example "" */
|
|
4211
|
-
contributionType?: string;
|
|
4212
|
-
/** @example 2020 */
|
|
4213
|
-
contributionYear?: number;
|
|
4214
|
-
};
|
|
4215
|
-
recipientBank?: {
|
|
4216
|
-
/** @example "" */
|
|
4217
|
-
additionalInformation?: string;
|
|
4218
|
-
/** @example "" */
|
|
4219
|
-
city?: string;
|
|
4220
|
-
/** @example "" */
|
|
4221
|
-
country?: string;
|
|
4222
|
-
identifier?: {
|
|
4223
|
-
/** @example "021202162" */
|
|
4224
|
-
id?: string;
|
|
4225
|
-
/** @example "ABA|BIC" */
|
|
4226
|
-
type?: string;
|
|
4227
|
-
};
|
|
4228
|
-
/** @example "" */
|
|
4229
|
-
name?: string;
|
|
4230
|
-
/** @example "" */
|
|
4231
|
-
postalCode?: string;
|
|
4232
|
-
/** @example "" */
|
|
4233
|
-
stateProvince?: string;
|
|
4234
|
-
};
|
|
4235
|
-
/** @example "0.0.0.0" */
|
|
4236
|
-
remoteAddr?: any;
|
|
4237
|
-
/** @example "ultra fast browser 1.1" */
|
|
4238
|
-
remoteDevice?: any;
|
|
4239
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4240
|
-
}
|
|
4241
|
-
export class TransfersAcats<HandleError extends boolean = boolean> {
|
|
4242
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4243
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4244
|
-
/**
|
|
4245
|
-
* @tags Transfers Acats
|
|
4246
|
-
* @name Search
|
|
4247
|
-
* @summary Search
|
|
4248
|
-
* @request GET:/transfer/acat/search
|
|
4160
|
+
* @tags Transfers Acats
|
|
4161
|
+
* @name Search
|
|
4162
|
+
* @summary Search
|
|
4163
|
+
* @request GET:/transfer/acat/search
|
|
4249
4164
|
* @secure
|
|
4250
4165
|
*/
|
|
4251
4166
|
search(query?: {
|
|
@@ -4371,6 +4286,81 @@ export class TransfersAcats<HandleError extends boolean = boolean> {
|
|
|
4371
4286
|
type?: string;
|
|
4372
4287
|
}[], config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4373
4288
|
}
|
|
4289
|
+
export class TransfersWires<HandleError extends boolean = boolean> {
|
|
4290
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4291
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4292
|
+
/**
|
|
4293
|
+
* @tags Transfers Wires
|
|
4294
|
+
* @name Outgoing
|
|
4295
|
+
* @summary Outgoing
|
|
4296
|
+
* @request POST:/transfer/wire/outgoing
|
|
4297
|
+
* @secure
|
|
4298
|
+
*/
|
|
4299
|
+
outgoing(data: {
|
|
4300
|
+
/** @example "TRACCOUNT" */
|
|
4301
|
+
account?: any;
|
|
4302
|
+
/** @example 200 */
|
|
4303
|
+
amount?: any;
|
|
4304
|
+
beneficiary?: {
|
|
4305
|
+
/** @example "AAA012345" */
|
|
4306
|
+
account?: string;
|
|
4307
|
+
/** @example "CHECKING|SAVINGS" */
|
|
4308
|
+
accountType?: string;
|
|
4309
|
+
address?: {
|
|
4310
|
+
/** @example "Central City" */
|
|
4311
|
+
city?: string;
|
|
4312
|
+
/** @example "USA" */
|
|
4313
|
+
country?: string;
|
|
4314
|
+
/** @example "11235" */
|
|
4315
|
+
postalCode?: string;
|
|
4316
|
+
/** @example "ST" */
|
|
4317
|
+
stateProvince?: string;
|
|
4318
|
+
/** @example ["123 Main St"] */
|
|
4319
|
+
streetAddress?: string[];
|
|
4320
|
+
};
|
|
4321
|
+
/** @example "John Smith" */
|
|
4322
|
+
name?: string;
|
|
4323
|
+
/** @example false */
|
|
4324
|
+
thirdParty?: boolean;
|
|
4325
|
+
};
|
|
4326
|
+
/** @example "Partial|Full" */
|
|
4327
|
+
disbursementType?: any;
|
|
4328
|
+
/** @example 1234 */
|
|
4329
|
+
entryId?: any;
|
|
4330
|
+
/** @example false */
|
|
4331
|
+
international?: any;
|
|
4332
|
+
iraDetails?: {
|
|
4333
|
+
/** @example "" */
|
|
4334
|
+
contributionType?: string;
|
|
4335
|
+
/** @example 2020 */
|
|
4336
|
+
contributionYear?: number;
|
|
4337
|
+
};
|
|
4338
|
+
recipientBank?: {
|
|
4339
|
+
/** @example "" */
|
|
4340
|
+
additionalInformation?: string;
|
|
4341
|
+
/** @example "" */
|
|
4342
|
+
city?: string;
|
|
4343
|
+
/** @example "" */
|
|
4344
|
+
country?: string;
|
|
4345
|
+
identifier?: {
|
|
4346
|
+
/** @example "021202162" */
|
|
4347
|
+
id?: string;
|
|
4348
|
+
/** @example "ABA|BIC" */
|
|
4349
|
+
type?: string;
|
|
4350
|
+
};
|
|
4351
|
+
/** @example "" */
|
|
4352
|
+
name?: string;
|
|
4353
|
+
/** @example "" */
|
|
4354
|
+
postalCode?: string;
|
|
4355
|
+
/** @example "" */
|
|
4356
|
+
stateProvince?: string;
|
|
4357
|
+
};
|
|
4358
|
+
/** @example "0.0.0.0" */
|
|
4359
|
+
remoteAddr?: any;
|
|
4360
|
+
/** @example "ultra fast browser 1.1" */
|
|
4361
|
+
remoteDevice?: any;
|
|
4362
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4363
|
+
}
|
|
4374
4364
|
export class TransfersJournals<HandleError extends boolean = boolean> {
|
|
4375
4365
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4376
4366
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4492,17 +4482,110 @@ export class TransfersBank<HandleError extends boolean = boolean> {
|
|
|
4492
4482
|
*/
|
|
4493
4483
|
fundTransfer(direction: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4494
4484
|
}
|
|
4495
|
-
export class
|
|
4485
|
+
export class TransfersInstantCashTransfers<HandleError extends boolean = boolean> {
|
|
4496
4486
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4497
4487
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4498
4488
|
/**
|
|
4499
|
-
* @tags Transfers
|
|
4500
|
-
* @name
|
|
4501
|
-
* @summary Withdrawal
|
|
4502
|
-
* @request POST:/transfer/
|
|
4489
|
+
* @tags Transfers Instant Cash Transfers
|
|
4490
|
+
* @name DepositWithdrawal
|
|
4491
|
+
* @summary Deposit/Withdrawal
|
|
4492
|
+
* @request POST:/transfer/ict/${direction}
|
|
4503
4493
|
* @secure
|
|
4504
4494
|
*/
|
|
4505
|
-
|
|
4495
|
+
depositWithdrawal(direction: string, data: {
|
|
4496
|
+
/** @example "ABC123456" */
|
|
4497
|
+
account?: any;
|
|
4498
|
+
/** @example 100 */
|
|
4499
|
+
amount?: any;
|
|
4500
|
+
/** @example "USD" */
|
|
4501
|
+
currency?: any;
|
|
4502
|
+
originator?: {
|
|
4503
|
+
address?: {
|
|
4504
|
+
/** @example "Central City" */
|
|
4505
|
+
city?: string;
|
|
4506
|
+
/** @example "USA" */
|
|
4507
|
+
country?: string;
|
|
4508
|
+
/** @example "12345" */
|
|
4509
|
+
postalCode?: string;
|
|
4510
|
+
/** @example "NY" */
|
|
4511
|
+
stateProvince?: string;
|
|
4512
|
+
/** @example ["123 Main St"] */
|
|
4513
|
+
streetAddress?: string[];
|
|
4514
|
+
};
|
|
4515
|
+
/** @example "John" */
|
|
4516
|
+
firstName?: string;
|
|
4517
|
+
institution?: {
|
|
4518
|
+
/** @example "123456789" */
|
|
4519
|
+
accountNumber?: string;
|
|
4520
|
+
/** @example "Central City Central Bank" */
|
|
4521
|
+
name?: string;
|
|
4522
|
+
};
|
|
4523
|
+
/** @example "Smith" */
|
|
4524
|
+
lastName?: string;
|
|
4525
|
+
};
|
|
4526
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4527
|
+
/**
|
|
4528
|
+
* @tags Transfers Instant Cash Transfers
|
|
4529
|
+
* @name DepositWithdrawalV2
|
|
4530
|
+
* @summary Deposit/Withdrawal V2
|
|
4531
|
+
* @request POST:/transfer/v2/ict/${direction}
|
|
4532
|
+
* @secure
|
|
4533
|
+
*/
|
|
4534
|
+
depositWithdrawalV2(direction: string, data: {
|
|
4535
|
+
/** @example "AB123456" */
|
|
4536
|
+
account?: any;
|
|
4537
|
+
/** @example 100.32 */
|
|
4538
|
+
amount?: any;
|
|
4539
|
+
counterparty?: {
|
|
4540
|
+
address?: {
|
|
4541
|
+
/** @example "Central City" */
|
|
4542
|
+
city?: string;
|
|
4543
|
+
/** @example "12345" */
|
|
4544
|
+
postalCode?: string;
|
|
4545
|
+
/** @example "CC" */
|
|
4546
|
+
stateProvince?: string;
|
|
4547
|
+
/** @example ["225 Baker St"] */
|
|
4548
|
+
streetAddress?: string[];
|
|
4549
|
+
};
|
|
4550
|
+
/** @example "James" */
|
|
4551
|
+
firstName?: string;
|
|
4552
|
+
institution?: {
|
|
4553
|
+
/** @example "123456" */
|
|
4554
|
+
accountNumber?: string;
|
|
4555
|
+
/** @example "Royal Central Bank" */
|
|
4556
|
+
name?: string;
|
|
4557
|
+
};
|
|
4558
|
+
/** @example "Bond" */
|
|
4559
|
+
lastName?: string;
|
|
4560
|
+
};
|
|
4561
|
+
/** @example "USD" */
|
|
4562
|
+
currency?: any;
|
|
4563
|
+
/** @example "1.1.1.1" */
|
|
4564
|
+
remoteAddr?: any;
|
|
4565
|
+
/** @example "Droid Phone" */
|
|
4566
|
+
remoteDevice?: any;
|
|
4567
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4568
|
+
/**
|
|
4569
|
+
* @tags Transfers Instant Cash Transfers
|
|
4570
|
+
* @name ObtainTheReport
|
|
4571
|
+
* @summary Obtain the report
|
|
4572
|
+
* @request POST:/transfer/reports/obtain
|
|
4573
|
+
* @secure
|
|
4574
|
+
*/
|
|
4575
|
+
obtainTheReport(data: {
|
|
4576
|
+
/** @example "MM/DD/YYYY HH:MM:SS ZZZ" */
|
|
4577
|
+
date?: any;
|
|
4578
|
+
/** @example "RETAIL_BANKING" */
|
|
4579
|
+
reportType?: any;
|
|
4580
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4581
|
+
/**
|
|
4582
|
+
* @tags Transfers Instant Cash Transfers
|
|
4583
|
+
* @name ListReports
|
|
4584
|
+
* @summary List reports
|
|
4585
|
+
* @request GET:/transfer/reports
|
|
4586
|
+
* @secure
|
|
4587
|
+
*/
|
|
4588
|
+
listReports(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4506
4589
|
}
|
|
4507
4590
|
export class Documents<HandleError extends boolean = boolean> {
|
|
4508
4591
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -4835,7 +4918,253 @@ export class Miscellaneous<HandleError extends boolean = boolean> {
|
|
|
4835
4918
|
*/
|
|
4836
4919
|
optionStrategyClassifications(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4837
4920
|
}
|
|
4838
|
-
export class
|
|
4921
|
+
export class TransfersCheques<HandleError extends boolean = boolean> {
|
|
4922
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4923
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4924
|
+
/**
|
|
4925
|
+
* @tags Transfers Cheques
|
|
4926
|
+
* @name Withdrawal
|
|
4927
|
+
* @summary Withdrawal
|
|
4928
|
+
* @request POST:/transfer/check/outgoing
|
|
4929
|
+
* @secure
|
|
4930
|
+
*/
|
|
4931
|
+
withdrawal(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4932
|
+
}
|
|
4933
|
+
export class Transfers<HandleError extends boolean = boolean> {
|
|
4934
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4935
|
+
relationships: TransfersRelationships<HandleError>;
|
|
4936
|
+
instantAccountVerification: TransfersInstantAccountVerification<HandleError>;
|
|
4937
|
+
ach: TransfersAch<HandleError>;
|
|
4938
|
+
acats: TransfersAcats<HandleError>;
|
|
4939
|
+
wires: TransfersWires<HandleError>;
|
|
4940
|
+
journals: TransfersJournals<HandleError>;
|
|
4941
|
+
positions: TransfersPositions<HandleError>;
|
|
4942
|
+
bank: TransfersBank<HandleError>;
|
|
4943
|
+
instantCashTransfers: TransfersInstantCashTransfers<HandleError>;
|
|
4944
|
+
cheques: TransfersCheques<HandleError>;
|
|
4945
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4946
|
+
/**
|
|
4947
|
+
* @tags Transfers
|
|
4948
|
+
* @name TransferDetails
|
|
4949
|
+
* @summary Transfer Details
|
|
4950
|
+
* @request GET:/transfer/details/{account}/{transferId}
|
|
4951
|
+
* @secure
|
|
4952
|
+
*/
|
|
4953
|
+
transferDetails(account: string, transferId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4954
|
+
/**
|
|
4955
|
+
* @tags Transfers
|
|
4956
|
+
* @name TransferStatus
|
|
4957
|
+
* @summary Transfer Status
|
|
4958
|
+
* @request GET:/transfer/status/{account}
|
|
4959
|
+
* @secure
|
|
4960
|
+
*/
|
|
4961
|
+
transferStatus(account: string, query?: {
|
|
4962
|
+
/** INCOMING|OUTGOING */
|
|
4963
|
+
direction?: any;
|
|
4964
|
+
/** ACH|WIRE|CHECK|Bank|CustodyJournal|ALL */
|
|
4965
|
+
mechanism?: any;
|
|
4966
|
+
/** MM/DD/YYYY */
|
|
4967
|
+
dateFrom?: any;
|
|
4968
|
+
/** MM/DD/YYYY */
|
|
4969
|
+
dateTo?: any;
|
|
4970
|
+
/** Overrides `dateFrom` and `dateTo`. See description. */
|
|
4971
|
+
range?: any;
|
|
4972
|
+
start?: any;
|
|
4973
|
+
perPage?: any;
|
|
4974
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4975
|
+
/**
|
|
4976
|
+
* @tags Transfers
|
|
4977
|
+
* @name TransferStatusModel
|
|
4978
|
+
* @summary Transfer Status Model
|
|
4979
|
+
* @request GET:/transfer/status/model/{modelId}
|
|
4980
|
+
* @secure
|
|
4981
|
+
*/
|
|
4982
|
+
transferStatusModel(modelId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4983
|
+
/**
|
|
4984
|
+
* @tags Transfers
|
|
4985
|
+
* @name TransferStatusBranch
|
|
4986
|
+
* @summary Transfer Status Branch
|
|
4987
|
+
* @request GET:/transfer/status/branch
|
|
4988
|
+
* @secure
|
|
4989
|
+
*/
|
|
4990
|
+
transferStatusBranch(query?: {
|
|
4991
|
+
/**
|
|
4992
|
+
* INCOMING|OUTGOING|ALL
|
|
4993
|
+
* @example "ALL"
|
|
4994
|
+
*/
|
|
4995
|
+
direction?: any;
|
|
4996
|
+
/**
|
|
4997
|
+
* ACH|WIRE|CHECK|Bank|CustodyJournal
|
|
4998
|
+
* @example "ALL"
|
|
4999
|
+
*/
|
|
5000
|
+
mechanism?: any;
|
|
5001
|
+
dateFrom?: any;
|
|
5002
|
+
dateTo?: any;
|
|
5003
|
+
/** Per regex: \d+[ymdw]$ (will override `dateFrom` and `dateTo`) */
|
|
5004
|
+
range?: any;
|
|
5005
|
+
start?: any;
|
|
5006
|
+
perPage?: any;
|
|
5007
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5008
|
+
/**
|
|
5009
|
+
* @tags Transfers
|
|
5010
|
+
* @name AmountAvailable
|
|
5011
|
+
* @summary Amount Available
|
|
5012
|
+
* @request GET:/transfer/available/{account}
|
|
5013
|
+
* @secure
|
|
5014
|
+
*/
|
|
5015
|
+
amountAvailable(account: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5016
|
+
/**
|
|
5017
|
+
* @tags Transfers
|
|
5018
|
+
* @name LegalDocumentTypes
|
|
5019
|
+
* @summary Legal document types
|
|
5020
|
+
* @request GET:/transfer/legal/types
|
|
5021
|
+
* @secure
|
|
5022
|
+
*/
|
|
5023
|
+
legalDocumentTypes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5024
|
+
/**
|
|
5025
|
+
* @tags Transfers
|
|
5026
|
+
* @name LegalDocument
|
|
5027
|
+
* @summary Legal document
|
|
5028
|
+
* @request GET:/transfer/legal/content
|
|
5029
|
+
* @secure
|
|
5030
|
+
*/
|
|
5031
|
+
legalDocument(query?: {
|
|
5032
|
+
/** Unique ID given in the types endpoint */
|
|
5033
|
+
id?: any;
|
|
5034
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5035
|
+
/**
|
|
5036
|
+
* @tags Transfers
|
|
5037
|
+
* @name Cancel
|
|
5038
|
+
* @summary Cancel
|
|
5039
|
+
* @request POST:/transfer/ach/cancel
|
|
5040
|
+
* @secure
|
|
5041
|
+
*/
|
|
5042
|
+
cancel(data: {
|
|
5043
|
+
/** @example "5VA0XXXX" */
|
|
5044
|
+
account?: any;
|
|
5045
|
+
/** @example "0.0.0.0" */
|
|
5046
|
+
remoteAddr?: any;
|
|
5047
|
+
/** @example "ultra fast browser 1.1" */
|
|
5048
|
+
remoteDevice?: any;
|
|
5049
|
+
/** @example "CC123456" */
|
|
5050
|
+
transferId?: any;
|
|
5051
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5052
|
+
/**
|
|
5053
|
+
* @tags Transfers
|
|
5054
|
+
* @name FeesAndCredits
|
|
5055
|
+
* @summary Fees and Credits
|
|
5056
|
+
* @request POST:/transfer/fees/apply
|
|
5057
|
+
* @secure
|
|
5058
|
+
*/
|
|
5059
|
+
feesAndCredits(data: {
|
|
5060
|
+
/** @example "5VA0XXXX" */
|
|
5061
|
+
account?: any;
|
|
5062
|
+
/** @example 100 */
|
|
5063
|
+
amount?: any;
|
|
5064
|
+
/** @example "FeeReversal|Promotion|WriteOff|Rebate|Courtesy|Advisory|Management|Admin|Exchange|Tech|Platform|Inactivity|MarginInterest|Custodian|CryptoGift" */
|
|
5065
|
+
classification?: any;
|
|
5066
|
+
/** @example "" */
|
|
5067
|
+
contraNote?: any;
|
|
5068
|
+
/** @example "USD" */
|
|
5069
|
+
currency?: any;
|
|
5070
|
+
/** @example "" */
|
|
5071
|
+
note?: any;
|
|
5072
|
+
/** @example 0.01 */
|
|
5073
|
+
quantity?: any;
|
|
5074
|
+
/** @example "0.0.0.0" */
|
|
5075
|
+
remoteAddr?: any;
|
|
5076
|
+
/** @example "ultra fast browser 1.1" */
|
|
5077
|
+
remoteDevice?: any;
|
|
5078
|
+
/** @example "BTC/USD" */
|
|
5079
|
+
symbol?: any;
|
|
5080
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5081
|
+
/**
|
|
5082
|
+
* @tags Transfers
|
|
5083
|
+
* @name ListFees
|
|
5084
|
+
* @summary List fees
|
|
5085
|
+
* @request GET:/transfer/fees/classifications/fees
|
|
5086
|
+
* @secure
|
|
5087
|
+
*/
|
|
5088
|
+
listFees(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5089
|
+
/**
|
|
5090
|
+
* @tags Transfers
|
|
5091
|
+
* @name ListCredits
|
|
5092
|
+
* @summary List credits
|
|
5093
|
+
* @request GET:/transfer/fees/classifications/credits
|
|
5094
|
+
* @secure
|
|
5095
|
+
*/
|
|
5096
|
+
listCredits(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5097
|
+
/**
|
|
5098
|
+
* @tags Transfers
|
|
5099
|
+
* @name CryptoDepositAddress
|
|
5100
|
+
* @summary Crypto Deposit Address
|
|
5101
|
+
* @request GET:/transfer/crypto/deposit/wallet/address
|
|
5102
|
+
* @secure
|
|
5103
|
+
*/
|
|
5104
|
+
cryptoDepositAddress(data: {
|
|
5105
|
+
/** @example "AB123456" */
|
|
5106
|
+
account?: any;
|
|
5107
|
+
/** @example "BTC" */
|
|
5108
|
+
currency?: any;
|
|
5109
|
+
/** @example "{optional}" */
|
|
5110
|
+
network?: any;
|
|
5111
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5112
|
+
/**
|
|
5113
|
+
* @tags Transfers
|
|
5114
|
+
* @name CryptoWithdrawalEstimate
|
|
5115
|
+
* @summary Crypto Withdrawal Estimate
|
|
5116
|
+
* @request POST:/transfer/crypto/withdrawal/estimate
|
|
5117
|
+
* @secure
|
|
5118
|
+
*/
|
|
5119
|
+
cryptoWithdrawalEstimate(data: {
|
|
5120
|
+
/** @example "BTC" */
|
|
5121
|
+
currency?: any;
|
|
5122
|
+
/** @example "{optional}" */
|
|
5123
|
+
network?: any;
|
|
5124
|
+
/** @example "0.1" */
|
|
5125
|
+
quantity?: any;
|
|
5126
|
+
/** @example "{optional}" */
|
|
5127
|
+
wallet?: any;
|
|
5128
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5129
|
+
/**
|
|
5130
|
+
* @tags Transfers
|
|
5131
|
+
* @name CryptoWithdrawal
|
|
5132
|
+
* @summary Crypto Withdrawal
|
|
5133
|
+
* @request POST:/transfer/crypto/withdraw
|
|
5134
|
+
* @secure
|
|
5135
|
+
*/
|
|
5136
|
+
cryptoWithdrawal(data: {
|
|
5137
|
+
/** @example "AB123456" */
|
|
5138
|
+
account?: any;
|
|
5139
|
+
/** @example "BTC" */
|
|
5140
|
+
currency?: any;
|
|
5141
|
+
/** @example "{optional}" */
|
|
5142
|
+
estimateExtension?: any;
|
|
5143
|
+
/** @example "abc123" */
|
|
5144
|
+
estimateId?: any;
|
|
5145
|
+
/** @example "{optional}" */
|
|
5146
|
+
network?: any;
|
|
5147
|
+
/** @example 0.1 */
|
|
5148
|
+
quantity?: any;
|
|
5149
|
+
/** @example "{conditional}" */
|
|
5150
|
+
recipientFirstName?: any;
|
|
5151
|
+
/** @example "{conditional}" */
|
|
5152
|
+
recipientLastName?: any;
|
|
5153
|
+
/** @example "{optional} 1.1.1.1" */
|
|
5154
|
+
remoteAddr?: any;
|
|
5155
|
+
/** @example "{optional} Some phone" */
|
|
5156
|
+
remoteDevice?: any;
|
|
5157
|
+
/** @example "{optional} true|false" */
|
|
5158
|
+
selfHosted?: any;
|
|
5159
|
+
/** @example "{optional}" */
|
|
5160
|
+
tag?: any;
|
|
5161
|
+
/** @example "{conditional}" */
|
|
5162
|
+
vaspName?: any;
|
|
5163
|
+
/** @example "wallet address" */
|
|
5164
|
+
wallet?: any;
|
|
5165
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5166
|
+
}
|
|
5167
|
+
export class Branch<HandleError extends boolean = boolean> {
|
|
4839
5168
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4840
5169
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4841
5170
|
/**
|
|
@@ -4926,112 +5255,7 @@ export class Branch<HandleError extends boolean = boolean> {
|
|
|
4926
5255
|
maturity?: any;
|
|
4927
5256
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4928
5257
|
}
|
|
4929
|
-
export class
|
|
4930
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4931
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4932
|
-
/**
|
|
4933
|
-
* @tags Blacklist Admin Businesses
|
|
4934
|
-
* @name GetBusinessesList
|
|
4935
|
-
* @summary Get Businesses list
|
|
4936
|
-
* @request GET:/v1/admin/businesses
|
|
4937
|
-
* @secure
|
|
4938
|
-
*/
|
|
4939
|
-
getBusinessesList(query?: {
|
|
4940
|
-
/**
|
|
4941
|
-
* (Required) page number
|
|
4942
|
-
* @example "5567183"
|
|
4943
|
-
*/
|
|
4944
|
-
page?: any;
|
|
4945
|
-
/**
|
|
4946
|
-
* (Required) page size in records displayed
|
|
4947
|
-
* @example "5567183"
|
|
4948
|
-
*/
|
|
4949
|
-
page_size?: any;
|
|
4950
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4951
|
-
/**
|
|
4952
|
-
* @tags Blacklist Admin Businesses
|
|
4953
|
-
* @name CreateBusiness
|
|
4954
|
-
* @summary Create Business
|
|
4955
|
-
* @request POST:/v1/admin/businesses
|
|
4956
|
-
* @secure
|
|
4957
|
-
*/
|
|
4958
|
-
createBusiness(data: {
|
|
4959
|
-
/** @example "Gracia Marina" */
|
|
4960
|
-
business_name?: any;
|
|
4961
|
-
/** @example "Los Angeles" */
|
|
4962
|
-
city?: any;
|
|
4963
|
-
/** @example "US" */
|
|
4964
|
-
country?: any;
|
|
4965
|
-
/** @example "La Granja Del Camaron" */
|
|
4966
|
-
dba_name?: any;
|
|
4967
|
-
/** @example "" */
|
|
4968
|
-
incorporated?: any;
|
|
4969
|
-
/** @example "812748955" */
|
|
4970
|
-
number?: any;
|
|
4971
|
-
/** @example "EIN" */
|
|
4972
|
-
number_type?: any;
|
|
4973
|
-
/** @example "" */
|
|
4974
|
-
phone?: any;
|
|
4975
|
-
/** @example "CA" */
|
|
4976
|
-
state?: any;
|
|
4977
|
-
/** @example "1119 E 8th St Ste C" */
|
|
4978
|
-
street?: any;
|
|
4979
|
-
/** @example "304902" */
|
|
4980
|
-
tracking_number?: any;
|
|
4981
|
-
/** @example "90021" */
|
|
4982
|
-
zip?: any;
|
|
4983
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4984
|
-
/**
|
|
4985
|
-
* @tags Blacklist Admin Businesses
|
|
4986
|
-
* @name GetBusinessById
|
|
4987
|
-
* @summary Get Business by ID
|
|
4988
|
-
* @request GET:/v1/admin/businesses/{id}
|
|
4989
|
-
* @secure
|
|
4990
|
-
*/
|
|
4991
|
-
getBusinessById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4992
|
-
/**
|
|
4993
|
-
* @tags Blacklist Admin Businesses
|
|
4994
|
-
* @name UpdateBusiness
|
|
4995
|
-
* @summary Update Business
|
|
4996
|
-
* @request PUT:/v1/admin/businesses/{id}
|
|
4997
|
-
* @secure
|
|
4998
|
-
*/
|
|
4999
|
-
updateBusiness(id: string, data: {
|
|
5000
|
-
/** @example "Gracia Marina" */
|
|
5001
|
-
business_name?: any;
|
|
5002
|
-
/** @example "Los Angeles" */
|
|
5003
|
-
city?: any;
|
|
5004
|
-
/** @example "US" */
|
|
5005
|
-
country?: any;
|
|
5006
|
-
/** @example "La Granja Del Camaron" */
|
|
5007
|
-
dba_name?: any;
|
|
5008
|
-
/** @example "" */
|
|
5009
|
-
incorporated?: any;
|
|
5010
|
-
/** @example "812748955" */
|
|
5011
|
-
number?: any;
|
|
5012
|
-
/** @example "EIN" */
|
|
5013
|
-
number_type?: any;
|
|
5014
|
-
/** @example "" */
|
|
5015
|
-
phone?: any;
|
|
5016
|
-
/** @example "CA" */
|
|
5017
|
-
state?: any;
|
|
5018
|
-
/** @example "1119 E 8th St Ste C" */
|
|
5019
|
-
street?: any;
|
|
5020
|
-
/** @example "304902" */
|
|
5021
|
-
tracking_number?: any;
|
|
5022
|
-
/** @example "90021" */
|
|
5023
|
-
zip?: any;
|
|
5024
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5025
|
-
/**
|
|
5026
|
-
* @tags Blacklist Admin Businesses
|
|
5027
|
-
* @name DeleteBusiness
|
|
5028
|
-
* @summary Delete Business
|
|
5029
|
-
* @request DELETE:/v1/admin/businesses/{id}
|
|
5030
|
-
* @secure
|
|
5031
|
-
*/
|
|
5032
|
-
deleteBusiness(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5033
|
-
}
|
|
5034
|
-
export class LegalDocuments<HandleError extends boolean = boolean> {
|
|
5258
|
+
export class LegalDocuments<HandleError extends boolean = boolean> {
|
|
5035
5259
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5036
5260
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5037
5261
|
/**
|
|
@@ -5139,6 +5363,111 @@ export class LegalDocuments<HandleError extends boolean = boolean> {
|
|
|
5139
5363
|
remoteDevice?: any;
|
|
5140
5364
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5141
5365
|
}
|
|
5366
|
+
export class BlacklistAdminBusinesses<HandleError extends boolean = boolean> {
|
|
5367
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5368
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5369
|
+
/**
|
|
5370
|
+
* @tags Blacklist Admin Businesses
|
|
5371
|
+
* @name GetBusinessesList
|
|
5372
|
+
* @summary Get Businesses list
|
|
5373
|
+
* @request GET:/v1/admin/businesses
|
|
5374
|
+
* @secure
|
|
5375
|
+
*/
|
|
5376
|
+
getBusinessesList(query?: {
|
|
5377
|
+
/**
|
|
5378
|
+
* (Required) page number
|
|
5379
|
+
* @example "5567183"
|
|
5380
|
+
*/
|
|
5381
|
+
page?: any;
|
|
5382
|
+
/**
|
|
5383
|
+
* (Required) page size in records displayed
|
|
5384
|
+
* @example "5567183"
|
|
5385
|
+
*/
|
|
5386
|
+
page_size?: any;
|
|
5387
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5388
|
+
/**
|
|
5389
|
+
* @tags Blacklist Admin Businesses
|
|
5390
|
+
* @name CreateBusiness
|
|
5391
|
+
* @summary Create Business
|
|
5392
|
+
* @request POST:/v1/admin/businesses
|
|
5393
|
+
* @secure
|
|
5394
|
+
*/
|
|
5395
|
+
createBusiness(data: {
|
|
5396
|
+
/** @example "Gracia Marina" */
|
|
5397
|
+
business_name?: any;
|
|
5398
|
+
/** @example "Los Angeles" */
|
|
5399
|
+
city?: any;
|
|
5400
|
+
/** @example "US" */
|
|
5401
|
+
country?: any;
|
|
5402
|
+
/** @example "La Granja Del Camaron" */
|
|
5403
|
+
dba_name?: any;
|
|
5404
|
+
/** @example "" */
|
|
5405
|
+
incorporated?: any;
|
|
5406
|
+
/** @example "812748955" */
|
|
5407
|
+
number?: any;
|
|
5408
|
+
/** @example "EIN" */
|
|
5409
|
+
number_type?: any;
|
|
5410
|
+
/** @example "" */
|
|
5411
|
+
phone?: any;
|
|
5412
|
+
/** @example "CA" */
|
|
5413
|
+
state?: any;
|
|
5414
|
+
/** @example "1119 E 8th St Ste C" */
|
|
5415
|
+
street?: any;
|
|
5416
|
+
/** @example "304902" */
|
|
5417
|
+
tracking_number?: any;
|
|
5418
|
+
/** @example "90021" */
|
|
5419
|
+
zip?: any;
|
|
5420
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5421
|
+
/**
|
|
5422
|
+
* @tags Blacklist Admin Businesses
|
|
5423
|
+
* @name GetBusinessById
|
|
5424
|
+
* @summary Get Business by ID
|
|
5425
|
+
* @request GET:/v1/admin/businesses/{id}
|
|
5426
|
+
* @secure
|
|
5427
|
+
*/
|
|
5428
|
+
getBusinessById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5429
|
+
/**
|
|
5430
|
+
* @tags Blacklist Admin Businesses
|
|
5431
|
+
* @name UpdateBusiness
|
|
5432
|
+
* @summary Update Business
|
|
5433
|
+
* @request PUT:/v1/admin/businesses/{id}
|
|
5434
|
+
* @secure
|
|
5435
|
+
*/
|
|
5436
|
+
updateBusiness(id: string, data: {
|
|
5437
|
+
/** @example "Gracia Marina" */
|
|
5438
|
+
business_name?: any;
|
|
5439
|
+
/** @example "Los Angeles" */
|
|
5440
|
+
city?: any;
|
|
5441
|
+
/** @example "US" */
|
|
5442
|
+
country?: any;
|
|
5443
|
+
/** @example "La Granja Del Camaron" */
|
|
5444
|
+
dba_name?: any;
|
|
5445
|
+
/** @example "" */
|
|
5446
|
+
incorporated?: any;
|
|
5447
|
+
/** @example "812748955" */
|
|
5448
|
+
number?: any;
|
|
5449
|
+
/** @example "EIN" */
|
|
5450
|
+
number_type?: any;
|
|
5451
|
+
/** @example "" */
|
|
5452
|
+
phone?: any;
|
|
5453
|
+
/** @example "CA" */
|
|
5454
|
+
state?: any;
|
|
5455
|
+
/** @example "1119 E 8th St Ste C" */
|
|
5456
|
+
street?: any;
|
|
5457
|
+
/** @example "304902" */
|
|
5458
|
+
tracking_number?: any;
|
|
5459
|
+
/** @example "90021" */
|
|
5460
|
+
zip?: any;
|
|
5461
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5462
|
+
/**
|
|
5463
|
+
* @tags Blacklist Admin Businesses
|
|
5464
|
+
* @name DeleteBusiness
|
|
5465
|
+
* @summary Delete Business
|
|
5466
|
+
* @request DELETE:/v1/admin/businesses/{id}
|
|
5467
|
+
* @secure
|
|
5468
|
+
*/
|
|
5469
|
+
deleteBusiness(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5470
|
+
}
|
|
5142
5471
|
export class BlacklistAdminIndividuals<HandleError extends boolean = boolean> {
|
|
5143
5472
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5144
5473
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5268,49 +5597,6 @@ export class BlacklistAdminIndividuals<HandleError extends boolean = boolean> {
|
|
|
5268
5597
|
*/
|
|
5269
5598
|
deleteIndividual(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5270
5599
|
}
|
|
5271
|
-
export class Broker<HandleError extends boolean = boolean> {
|
|
5272
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5273
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5274
|
-
/**
|
|
5275
|
-
* @tags Broker
|
|
5276
|
-
* @name Portfolio
|
|
5277
|
-
* @summary Portfolio
|
|
5278
|
-
* @request GET:/v1/broker/portfolio
|
|
5279
|
-
* @secure
|
|
5280
|
-
*/
|
|
5281
|
-
portfolio(query?: {
|
|
5282
|
-
/**
|
|
5283
|
-
* (true or false) Allows for loading of quotes for each portfolio entry. Defaults to false.
|
|
5284
|
-
* @example "false"
|
|
5285
|
-
*/
|
|
5286
|
-
loadQuotes?: any;
|
|
5287
|
-
/** @example "false" */
|
|
5288
|
-
loadIndustries?: any;
|
|
5289
|
-
/** @example "false" */
|
|
5290
|
-
loadUpgrades?: any;
|
|
5291
|
-
/** @example "false" */
|
|
5292
|
-
loadEarnings?: any;
|
|
5293
|
-
/**
|
|
5294
|
-
* Load balances for weight
|
|
5295
|
-
* @example "false"
|
|
5296
|
-
*/
|
|
5297
|
-
loadRtb?: any;
|
|
5298
|
-
/**
|
|
5299
|
-
* Analyze market caps and get `marketCapWeights`. To be used in conjuction with `loadQuotes`
|
|
5300
|
-
* @example "false"
|
|
5301
|
-
*/
|
|
5302
|
-
marketCapBreakdown?: any;
|
|
5303
|
-
/**
|
|
5304
|
-
* Combined portfolio for the branch
|
|
5305
|
-
* @example "false"
|
|
5306
|
-
*/
|
|
5307
|
-
combined?: any;
|
|
5308
|
-
/** @example "1" */
|
|
5309
|
-
pageNum?: any;
|
|
5310
|
-
/** @example "100" */
|
|
5311
|
-
pageSize?: any;
|
|
5312
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5313
|
-
}
|
|
5314
5600
|
export class BlacklistSearch<HandleError extends boolean = boolean> {
|
|
5315
5601
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5316
5602
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5382,14 +5668,206 @@ export class Blacklist<HandleError extends boolean = boolean> {
|
|
|
5382
5668
|
*/
|
|
5383
5669
|
getHealth(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5384
5670
|
}
|
|
5385
|
-
export class
|
|
5671
|
+
export class Broker<HandleError extends boolean = boolean> {
|
|
5386
5672
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5387
5673
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5388
5674
|
/**
|
|
5389
|
-
* @tags
|
|
5390
|
-
* @name
|
|
5391
|
-
* @summary
|
|
5392
|
-
* @request GET:/
|
|
5675
|
+
* @tags Broker
|
|
5676
|
+
* @name Portfolio
|
|
5677
|
+
* @summary Portfolio
|
|
5678
|
+
* @request GET:/v1/broker/portfolio
|
|
5679
|
+
* @secure
|
|
5680
|
+
*/
|
|
5681
|
+
portfolio(query?: {
|
|
5682
|
+
/**
|
|
5683
|
+
* (true or false) Allows for loading of quotes for each portfolio entry. Defaults to false.
|
|
5684
|
+
* @example "false"
|
|
5685
|
+
*/
|
|
5686
|
+
loadQuotes?: any;
|
|
5687
|
+
/** @example "false" */
|
|
5688
|
+
loadIndustries?: any;
|
|
5689
|
+
/** @example "false" */
|
|
5690
|
+
loadUpgrades?: any;
|
|
5691
|
+
/** @example "false" */
|
|
5692
|
+
loadEarnings?: any;
|
|
5693
|
+
/**
|
|
5694
|
+
* Load balances for weight
|
|
5695
|
+
* @example "false"
|
|
5696
|
+
*/
|
|
5697
|
+
loadRtb?: any;
|
|
5698
|
+
/**
|
|
5699
|
+
* Analyze market caps and get `marketCapWeights`. To be used in conjuction with `loadQuotes`
|
|
5700
|
+
* @example "false"
|
|
5701
|
+
*/
|
|
5702
|
+
marketCapBreakdown?: any;
|
|
5703
|
+
/**
|
|
5704
|
+
* Combined portfolio for the branch
|
|
5705
|
+
* @example "false"
|
|
5706
|
+
*/
|
|
5707
|
+
combined?: any;
|
|
5708
|
+
/** @example "1" */
|
|
5709
|
+
pageNum?: any;
|
|
5710
|
+
/** @example "100" */
|
|
5711
|
+
pageSize?: any;
|
|
5712
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5713
|
+
}
|
|
5714
|
+
export class WatchmenFfiUserAccountManagement<HandleError extends boolean = boolean> {
|
|
5715
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5716
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5717
|
+
/**
|
|
5718
|
+
* @tags Watchmen Ffi User Account Management
|
|
5719
|
+
* @name CreateUser
|
|
5720
|
+
* @summary Create User
|
|
5721
|
+
* @request POST:/rest/v1/uam/user/create
|
|
5722
|
+
* @secure
|
|
5723
|
+
*/
|
|
5724
|
+
createUser(data: {
|
|
5725
|
+
/** @example "{optional} enable|disable - whether or not enable user for TipRanks" */
|
|
5726
|
+
Tipranks?: any;
|
|
5727
|
+
/** @example "{optional} true|false - defaults to false" */
|
|
5728
|
+
algos?: any;
|
|
5729
|
+
/** @example "{optional} true|false - defaults to false" */
|
|
5730
|
+
allSession?: any;
|
|
5731
|
+
/** @example "{optional} Full Name" */
|
|
5732
|
+
associatedName?: any;
|
|
5733
|
+
/** @example "{optional} true|false - defaults to false" */
|
|
5734
|
+
buyWrite?: any;
|
|
5735
|
+
/** @example "{optional} e-mail address" */
|
|
5736
|
+
email?: any;
|
|
5737
|
+
/** @example "{optional} true|false - defaults to true" */
|
|
5738
|
+
isTradingEnabled?: any;
|
|
5739
|
+
/** @example "{optional} Limit On Close - true|false - defaults to false" */
|
|
5740
|
+
loc?: any;
|
|
5741
|
+
/** @example "{optional} true|false - whether user is locked" */
|
|
5742
|
+
locked?: any;
|
|
5743
|
+
/** @example "{optional} Limit On Open - true|false - defaults to false" */
|
|
5744
|
+
loo?: any;
|
|
5745
|
+
/** @example "{optional} Market On Open - true|false - defaults to false" */
|
|
5746
|
+
moc?: any;
|
|
5747
|
+
/** @example "{optional} Market On Close - true|false - defaults to false" */
|
|
5748
|
+
moo?: any;
|
|
5749
|
+
/** @example "{optional} One Cancels Other - true|false - defaults to false" */
|
|
5750
|
+
oco?: any;
|
|
5751
|
+
/** @example "{optional} true|false - defaults to false" */
|
|
5752
|
+
optionRoll?: any;
|
|
5753
|
+
/** @example "{optional} true|false - defaults to false" */
|
|
5754
|
+
options?: any;
|
|
5755
|
+
/** @example "{optional}" */
|
|
5756
|
+
password?: any;
|
|
5757
|
+
/** @example "{optional} true|false - defaults to false" */
|
|
5758
|
+
prePostTrading?: any;
|
|
5759
|
+
/** @example "{optional} 1 - delayed, 0 - realtime, 4 - CBOE1, 3 - BATS" */
|
|
5760
|
+
quoteType?: any;
|
|
5761
|
+
/** @example "{optional} true|false - defaults to false" */
|
|
5762
|
+
spreads?: any;
|
|
5763
|
+
/** @example "A - active, S - suspended == initial user status" */
|
|
5764
|
+
status?: any;
|
|
5765
|
+
/** @example "{optional} true|false - defaults to false" */
|
|
5766
|
+
trailingStops?: any;
|
|
5767
|
+
/** @example "UNIQUE_USERNAME" */
|
|
5768
|
+
username?: any;
|
|
5769
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5770
|
+
/**
|
|
5771
|
+
* @tags Watchmen Ffi User Account Management
|
|
5772
|
+
* @name CreateAccount
|
|
5773
|
+
* @summary Create Account
|
|
5774
|
+
* @request POST:/rest/v1/uam/account/create
|
|
5775
|
+
* @secure
|
|
5776
|
+
*/
|
|
5777
|
+
createAccount(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5778
|
+
/**
|
|
5779
|
+
* @tags Watchmen Ffi User Account Management
|
|
5780
|
+
* @name AccountInformation
|
|
5781
|
+
* @summary Account Information
|
|
5782
|
+
* @request GET:/rest/v1/uam/account/data
|
|
5783
|
+
* @secure
|
|
5784
|
+
*/
|
|
5785
|
+
accountInformation(query?: {
|
|
5786
|
+
/** @example "AC123456" */
|
|
5787
|
+
accountNumber?: any;
|
|
5788
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5789
|
+
/**
|
|
5790
|
+
* @tags Watchmen Ffi User Account Management
|
|
5791
|
+
* @name UserInformation
|
|
5792
|
+
* @summary User Information
|
|
5793
|
+
* @request GET:/rest/v1/uam/user/data
|
|
5794
|
+
* @secure
|
|
5795
|
+
*/
|
|
5796
|
+
userInformation(query?: {
|
|
5797
|
+
/** @example "USERNAME" */
|
|
5798
|
+
username?: any;
|
|
5799
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5800
|
+
/**
|
|
5801
|
+
* @tags Watchmen Ffi User Account Management
|
|
5802
|
+
* @name ListLinkedAccounts
|
|
5803
|
+
* @summary List Linked Accounts
|
|
5804
|
+
* @request GET:/rest/v1/linkedaccounts/listAccounts
|
|
5805
|
+
* @secure
|
|
5806
|
+
*/
|
|
5807
|
+
listLinkedAccounts(query?: {
|
|
5808
|
+
/** @example "TEST.USER" */
|
|
5809
|
+
username?: any;
|
|
5810
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5811
|
+
/**
|
|
5812
|
+
* @tags Watchmen Ffi User Account Management
|
|
5813
|
+
* @name LinkUnlinkAccount
|
|
5814
|
+
* @summary Link/Unlink Account
|
|
5815
|
+
* @request POST:/rest/v1/linkedaccounts/linkUnlinkAccount
|
|
5816
|
+
* @secure
|
|
5817
|
+
*/
|
|
5818
|
+
linkUnlinkAccount(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5819
|
+
/**
|
|
5820
|
+
* @tags Watchmen Ffi User Account Management
|
|
5821
|
+
* @name Visibility
|
|
5822
|
+
* @summary Visibility
|
|
5823
|
+
* @request POST:/rest/v1/linkedaccounts/visibility
|
|
5824
|
+
* @secure
|
|
5825
|
+
*/
|
|
5826
|
+
visibility(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5827
|
+
/**
|
|
5828
|
+
* @tags Watchmen Ffi User Account Management
|
|
5829
|
+
* @name UserAccountSearch
|
|
5830
|
+
* @summary User/Account Search
|
|
5831
|
+
* @request POST:/rest/v1/uam/user-account-search
|
|
5832
|
+
* @secure
|
|
5833
|
+
*/
|
|
5834
|
+
userAccountSearch(data: {
|
|
5835
|
+
/** @example "desired account number" */
|
|
5836
|
+
accountNumber?: any;
|
|
5837
|
+
/** @example 100 */
|
|
5838
|
+
limit?: any;
|
|
5839
|
+
/** @example 0 */
|
|
5840
|
+
lockedBit?: any;
|
|
5841
|
+
/** @example "desired username" */
|
|
5842
|
+
login?: any;
|
|
5843
|
+
/** @example false */
|
|
5844
|
+
noBrokers?: any;
|
|
5845
|
+
/** @example "" */
|
|
5846
|
+
omnibus?: any;
|
|
5847
|
+
/** @example false */
|
|
5848
|
+
onlyActiveAccount?: any;
|
|
5849
|
+
/** @example false */
|
|
5850
|
+
onlyActiveUser?: any;
|
|
5851
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5852
|
+
}
|
|
5853
|
+
export class Advisory<HandleError extends boolean = boolean> {
|
|
5854
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5855
|
+
charges: AdvisoryCharges<HandleError>;
|
|
5856
|
+
models: AdvisoryModels<HandleError>;
|
|
5857
|
+
userAccountManagement: AdvisoryUserAccountManagement<HandleError>;
|
|
5858
|
+
groups: AdvisoryGroups<HandleError>;
|
|
5859
|
+
analytics: AdvisoryAnalytics<HandleError>;
|
|
5860
|
+
allocations: AdvisoryAllocations<HandleError>;
|
|
5861
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5862
|
+
}
|
|
5863
|
+
export class WatchmenFfiFirmBranch<HandleError extends boolean = boolean> {
|
|
5864
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5865
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5866
|
+
/**
|
|
5867
|
+
* @tags Watchmen Ffi Firm Branch
|
|
5868
|
+
* @name FirmPortfolioAvailabilityCheck
|
|
5869
|
+
* @summary Firm Portfolio : Availability Check
|
|
5870
|
+
* @request GET:/rest/v1/branch/portfolio/availability
|
|
5393
5871
|
* @secure
|
|
5394
5872
|
*/
|
|
5395
5873
|
firmPortfolioAvailabilityCheck(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
@@ -5557,153 +6035,22 @@ export class WatchmenFfiFirmBranch<HandleError extends boolean = boolean> {
|
|
|
5557
6035
|
id?: any;
|
|
5558
6036
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5559
6037
|
}
|
|
5560
|
-
export class
|
|
5561
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5562
|
-
charges: AdvisoryCharges<HandleError>;
|
|
5563
|
-
models: AdvisoryModels<HandleError>;
|
|
5564
|
-
userAccountManagement: AdvisoryUserAccountManagement<HandleError>;
|
|
5565
|
-
groups: AdvisoryGroups<HandleError>;
|
|
5566
|
-
analytics: AdvisoryAnalytics<HandleError>;
|
|
5567
|
-
allocations: AdvisoryAllocations<HandleError>;
|
|
5568
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5569
|
-
}
|
|
5570
|
-
export class WatchmenFfiUserAccountManagement<HandleError extends boolean = boolean> {
|
|
6038
|
+
export class Device<HandleError extends boolean = boolean> {
|
|
5571
6039
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5572
6040
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5573
6041
|
/**
|
|
5574
|
-
* @tags
|
|
5575
|
-
* @name
|
|
5576
|
-
* @summary
|
|
5577
|
-
* @request POST:/
|
|
6042
|
+
* @tags Device
|
|
6043
|
+
* @name DeviceDeactivate
|
|
6044
|
+
* @summary /device/deactivate
|
|
6045
|
+
* @request POST:/device/deactivate
|
|
5578
6046
|
* @secure
|
|
5579
6047
|
*/
|
|
5580
|
-
|
|
5581
|
-
/**
|
|
5582
|
-
|
|
5583
|
-
|
|
5584
|
-
|
|
5585
|
-
|
|
5586
|
-
allSession?: any;
|
|
5587
|
-
/** @example "{optional} Full Name" */
|
|
5588
|
-
associatedName?: any;
|
|
5589
|
-
/** @example "{optional} true|false - defaults to false" */
|
|
5590
|
-
buyWrite?: any;
|
|
5591
|
-
/** @example "{optional} e-mail address" */
|
|
5592
|
-
email?: any;
|
|
5593
|
-
/** @example "{optional} true|false - defaults to true" */
|
|
5594
|
-
isTradingEnabled?: any;
|
|
5595
|
-
/** @example "{optional} Limit On Close - true|false - defaults to false" */
|
|
5596
|
-
loc?: any;
|
|
5597
|
-
/** @example "{optional} true|false - whether user is locked" */
|
|
5598
|
-
locked?: any;
|
|
5599
|
-
/** @example "{optional} Limit On Open - true|false - defaults to false" */
|
|
5600
|
-
loo?: any;
|
|
5601
|
-
/** @example "{optional} Market On Open - true|false - defaults to false" */
|
|
5602
|
-
moc?: any;
|
|
5603
|
-
/** @example "{optional} Market On Close - true|false - defaults to false" */
|
|
5604
|
-
moo?: any;
|
|
5605
|
-
/** @example "{optional} One Cancels Other - true|false - defaults to false" */
|
|
5606
|
-
oco?: any;
|
|
5607
|
-
/** @example "{optional} true|false - defaults to false" */
|
|
5608
|
-
optionRoll?: any;
|
|
5609
|
-
/** @example "{optional} true|false - defaults to false" */
|
|
5610
|
-
options?: any;
|
|
5611
|
-
/** @example "{optional}" */
|
|
5612
|
-
password?: any;
|
|
5613
|
-
/** @example "{optional} true|false - defaults to false" */
|
|
5614
|
-
prePostTrading?: any;
|
|
5615
|
-
/** @example "{optional} 1 - delayed, 0 - realtime, 4 - CBOE1, 3 - BATS" */
|
|
5616
|
-
quoteType?: any;
|
|
5617
|
-
/** @example "{optional} true|false - defaults to false" */
|
|
5618
|
-
spreads?: any;
|
|
5619
|
-
/** @example "A - active, S - suspended == initial user status" */
|
|
5620
|
-
status?: any;
|
|
5621
|
-
/** @example "{optional} true|false - defaults to false" */
|
|
5622
|
-
trailingStops?: any;
|
|
5623
|
-
/** @example "UNIQUE_USERNAME" */
|
|
5624
|
-
username?: any;
|
|
5625
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5626
|
-
/**
|
|
5627
|
-
* @tags Watchmen Ffi User Account Management
|
|
5628
|
-
* @name CreateAccount
|
|
5629
|
-
* @summary Create Account
|
|
5630
|
-
* @request POST:/rest/v1/uam/account/create
|
|
5631
|
-
* @secure
|
|
5632
|
-
*/
|
|
5633
|
-
createAccount(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5634
|
-
/**
|
|
5635
|
-
* @tags Watchmen Ffi User Account Management
|
|
5636
|
-
* @name AccountInformation
|
|
5637
|
-
* @summary Account Information
|
|
5638
|
-
* @request GET:/rest/v1/uam/account/data
|
|
5639
|
-
* @secure
|
|
5640
|
-
*/
|
|
5641
|
-
accountInformation(query?: {
|
|
5642
|
-
/** @example "AC123456" */
|
|
5643
|
-
accountNumber?: any;
|
|
5644
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5645
|
-
/**
|
|
5646
|
-
* @tags Watchmen Ffi User Account Management
|
|
5647
|
-
* @name UserInformation
|
|
5648
|
-
* @summary User Information
|
|
5649
|
-
* @request GET:/rest/v1/uam/user/data
|
|
5650
|
-
* @secure
|
|
5651
|
-
*/
|
|
5652
|
-
userInformation(query?: {
|
|
5653
|
-
/** @example "USERNAME" */
|
|
5654
|
-
username?: any;
|
|
5655
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5656
|
-
/**
|
|
5657
|
-
* @tags Watchmen Ffi User Account Management
|
|
5658
|
-
* @name ListLinkedAccounts
|
|
5659
|
-
* @summary List Linked Accounts
|
|
5660
|
-
* @request GET:/rest/v1/linkedaccounts/listAccounts
|
|
5661
|
-
* @secure
|
|
5662
|
-
*/
|
|
5663
|
-
listLinkedAccounts(query?: {
|
|
5664
|
-
/** @example "TEST.USER" */
|
|
5665
|
-
username?: any;
|
|
5666
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5667
|
-
/**
|
|
5668
|
-
* @tags Watchmen Ffi User Account Management
|
|
5669
|
-
* @name LinkUnlinkAccount
|
|
5670
|
-
* @summary Link/Unlink Account
|
|
5671
|
-
* @request POST:/rest/v1/linkedaccounts/linkUnlinkAccount
|
|
5672
|
-
* @secure
|
|
5673
|
-
*/
|
|
5674
|
-
linkUnlinkAccount(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5675
|
-
/**
|
|
5676
|
-
* @tags Watchmen Ffi User Account Management
|
|
5677
|
-
* @name Visibility
|
|
5678
|
-
* @summary Visibility
|
|
5679
|
-
* @request POST:/rest/v1/linkedaccounts/visibility
|
|
5680
|
-
* @secure
|
|
5681
|
-
*/
|
|
5682
|
-
visibility(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5683
|
-
/**
|
|
5684
|
-
* @tags Watchmen Ffi User Account Management
|
|
5685
|
-
* @name UserAccountSearch
|
|
5686
|
-
* @summary User/Account Search
|
|
5687
|
-
* @request POST:/rest/v1/uam/user-account-search
|
|
5688
|
-
* @secure
|
|
5689
|
-
*/
|
|
5690
|
-
userAccountSearch(data: {
|
|
5691
|
-
/** @example "desired account number" */
|
|
5692
|
-
accountNumber?: any;
|
|
5693
|
-
/** @example 100 */
|
|
5694
|
-
limit?: any;
|
|
5695
|
-
/** @example 0 */
|
|
5696
|
-
lockedBit?: any;
|
|
5697
|
-
/** @example "desired username" */
|
|
5698
|
-
login?: any;
|
|
5699
|
-
/** @example false */
|
|
5700
|
-
noBrokers?: any;
|
|
5701
|
-
/** @example "" */
|
|
5702
|
-
omnibus?: any;
|
|
5703
|
-
/** @example false */
|
|
5704
|
-
onlyActiveAccount?: any;
|
|
5705
|
-
/** @example false */
|
|
5706
|
-
onlyActiveUser?: any;
|
|
6048
|
+
deviceDeactivate(data: {
|
|
6049
|
+
/**
|
|
6050
|
+
* Token previously registered
|
|
6051
|
+
* @example "123456789"
|
|
6052
|
+
*/
|
|
6053
|
+
Token?: string;
|
|
5707
6054
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5708
6055
|
}
|
|
5709
6056
|
export class WatchmenFfi<HandleError extends boolean = boolean> {
|
|
@@ -5712,345 +6059,6 @@ export class WatchmenFfi<HandleError extends boolean = boolean> {
|
|
|
5712
6059
|
firmBranch: WatchmenFfiFirmBranch<HandleError>;
|
|
5713
6060
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5714
6061
|
}
|
|
5715
|
-
export class TransfersInstantCashTransfers<HandleError extends boolean = boolean> {
|
|
5716
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5717
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5718
|
-
/**
|
|
5719
|
-
* @tags Transfers Instant Cash Transfers
|
|
5720
|
-
* @name DepositWithdrawal
|
|
5721
|
-
* @summary Deposit/Withdrawal
|
|
5722
|
-
* @request POST:/transfer/ict/${direction}
|
|
5723
|
-
* @secure
|
|
5724
|
-
*/
|
|
5725
|
-
depositWithdrawal(direction: string, data: {
|
|
5726
|
-
/** @example "ABC123456" */
|
|
5727
|
-
account?: any;
|
|
5728
|
-
/** @example 100 */
|
|
5729
|
-
amount?: any;
|
|
5730
|
-
/** @example "USD" */
|
|
5731
|
-
currency?: any;
|
|
5732
|
-
originator?: {
|
|
5733
|
-
address?: {
|
|
5734
|
-
/** @example "Central City" */
|
|
5735
|
-
city?: string;
|
|
5736
|
-
/** @example "USA" */
|
|
5737
|
-
country?: string;
|
|
5738
|
-
/** @example "12345" */
|
|
5739
|
-
postalCode?: string;
|
|
5740
|
-
/** @example "NY" */
|
|
5741
|
-
stateProvince?: string;
|
|
5742
|
-
/** @example ["123 Main St"] */
|
|
5743
|
-
streetAddress?: string[];
|
|
5744
|
-
};
|
|
5745
|
-
/** @example "John" */
|
|
5746
|
-
firstName?: string;
|
|
5747
|
-
institution?: {
|
|
5748
|
-
/** @example "123456789" */
|
|
5749
|
-
accountNumber?: string;
|
|
5750
|
-
/** @example "Central City Central Bank" */
|
|
5751
|
-
name?: string;
|
|
5752
|
-
};
|
|
5753
|
-
/** @example "Smith" */
|
|
5754
|
-
lastName?: string;
|
|
5755
|
-
};
|
|
5756
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5757
|
-
/**
|
|
5758
|
-
* @tags Transfers Instant Cash Transfers
|
|
5759
|
-
* @name DepositWithdrawalV2
|
|
5760
|
-
* @summary Deposit/Withdrawal V2
|
|
5761
|
-
* @request POST:/transfer/v2/ict/${direction}
|
|
5762
|
-
* @secure
|
|
5763
|
-
*/
|
|
5764
|
-
depositWithdrawalV2(direction: string, data: {
|
|
5765
|
-
/** @example "AB123456" */
|
|
5766
|
-
account?: any;
|
|
5767
|
-
/** @example 100.32 */
|
|
5768
|
-
amount?: any;
|
|
5769
|
-
counterparty?: {
|
|
5770
|
-
address?: {
|
|
5771
|
-
/** @example "Central City" */
|
|
5772
|
-
city?: string;
|
|
5773
|
-
/** @example "12345" */
|
|
5774
|
-
postalCode?: string;
|
|
5775
|
-
/** @example "CC" */
|
|
5776
|
-
stateProvince?: string;
|
|
5777
|
-
/** @example ["225 Baker St"] */
|
|
5778
|
-
streetAddress?: string[];
|
|
5779
|
-
};
|
|
5780
|
-
/** @example "James" */
|
|
5781
|
-
firstName?: string;
|
|
5782
|
-
institution?: {
|
|
5783
|
-
/** @example "123456" */
|
|
5784
|
-
accountNumber?: string;
|
|
5785
|
-
/** @example "Royal Central Bank" */
|
|
5786
|
-
name?: string;
|
|
5787
|
-
};
|
|
5788
|
-
/** @example "Bond" */
|
|
5789
|
-
lastName?: string;
|
|
5790
|
-
};
|
|
5791
|
-
/** @example "USD" */
|
|
5792
|
-
currency?: any;
|
|
5793
|
-
/** @example "1.1.1.1" */
|
|
5794
|
-
remoteAddr?: any;
|
|
5795
|
-
/** @example "Droid Phone" */
|
|
5796
|
-
remoteDevice?: any;
|
|
5797
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5798
|
-
/**
|
|
5799
|
-
* @tags Transfers Instant Cash Transfers
|
|
5800
|
-
* @name ObtainTheReport
|
|
5801
|
-
* @summary Obtain the report
|
|
5802
|
-
* @request POST:/transfer/reports/obtain
|
|
5803
|
-
* @secure
|
|
5804
|
-
*/
|
|
5805
|
-
obtainTheReport(data: {
|
|
5806
|
-
/** @example "MM/DD/YYYY HH:MM:SS ZZZ" */
|
|
5807
|
-
date?: any;
|
|
5808
|
-
/** @example "RETAIL_BANKING" */
|
|
5809
|
-
reportType?: any;
|
|
5810
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5811
|
-
/**
|
|
5812
|
-
* @tags Transfers Instant Cash Transfers
|
|
5813
|
-
* @name ListReports
|
|
5814
|
-
* @summary List reports
|
|
5815
|
-
* @request GET:/transfer/reports
|
|
5816
|
-
* @secure
|
|
5817
|
-
*/
|
|
5818
|
-
listReports(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5819
|
-
}
|
|
5820
|
-
export class Transfers<HandleError extends boolean = boolean> {
|
|
5821
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5822
|
-
relationships: TransfersRelationships<HandleError>;
|
|
5823
|
-
instantAccountVerification: TransfersInstantAccountVerification<HandleError>;
|
|
5824
|
-
ach: TransfersAch<HandleError>;
|
|
5825
|
-
acats: TransfersAcats<HandleError>;
|
|
5826
|
-
wires: TransfersWires<HandleError>;
|
|
5827
|
-
journals: TransfersJournals<HandleError>;
|
|
5828
|
-
positions: TransfersPositions<HandleError>;
|
|
5829
|
-
bank: TransfersBank<HandleError>;
|
|
5830
|
-
instantCashTransfers: TransfersInstantCashTransfers<HandleError>;
|
|
5831
|
-
cheques: TransfersCheques<HandleError>;
|
|
5832
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5833
|
-
/**
|
|
5834
|
-
* @tags Transfers
|
|
5835
|
-
* @name TransferDetails
|
|
5836
|
-
* @summary Transfer Details
|
|
5837
|
-
* @request GET:/transfer/details/{account}/{transferId}
|
|
5838
|
-
* @secure
|
|
5839
|
-
*/
|
|
5840
|
-
transferDetails(account: string, transferId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5841
|
-
/**
|
|
5842
|
-
* @tags Transfers
|
|
5843
|
-
* @name TransferStatus
|
|
5844
|
-
* @summary Transfer Status
|
|
5845
|
-
* @request GET:/transfer/status/{account}
|
|
5846
|
-
* @secure
|
|
5847
|
-
*/
|
|
5848
|
-
transferStatus(account: string, query?: {
|
|
5849
|
-
/** INCOMING|OUTGOING */
|
|
5850
|
-
direction?: any;
|
|
5851
|
-
/** ACH|WIRE|CHECK|Bank|CustodyJournal|ALL */
|
|
5852
|
-
mechanism?: any;
|
|
5853
|
-
/** MM/DD/YYYY */
|
|
5854
|
-
dateFrom?: any;
|
|
5855
|
-
/** MM/DD/YYYY */
|
|
5856
|
-
dateTo?: any;
|
|
5857
|
-
/** Overrides `dateFrom` and `dateTo`. See description. */
|
|
5858
|
-
range?: any;
|
|
5859
|
-
start?: any;
|
|
5860
|
-
perPage?: any;
|
|
5861
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5862
|
-
/**
|
|
5863
|
-
* @tags Transfers
|
|
5864
|
-
* @name TransferStatusModel
|
|
5865
|
-
* @summary Transfer Status Model
|
|
5866
|
-
* @request GET:/transfer/status/model/{modelId}
|
|
5867
|
-
* @secure
|
|
5868
|
-
*/
|
|
5869
|
-
transferStatusModel(modelId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5870
|
-
/**
|
|
5871
|
-
* @tags Transfers
|
|
5872
|
-
* @name TransferStatusBranch
|
|
5873
|
-
* @summary Transfer Status Branch
|
|
5874
|
-
* @request GET:/transfer/status/branch
|
|
5875
|
-
* @secure
|
|
5876
|
-
*/
|
|
5877
|
-
transferStatusBranch(query?: {
|
|
5878
|
-
/**
|
|
5879
|
-
* INCOMING|OUTGOING|ALL
|
|
5880
|
-
* @example "ALL"
|
|
5881
|
-
*/
|
|
5882
|
-
direction?: any;
|
|
5883
|
-
/**
|
|
5884
|
-
* ACH|WIRE|CHECK|Bank|CustodyJournal
|
|
5885
|
-
* @example "ALL"
|
|
5886
|
-
*/
|
|
5887
|
-
mechanism?: any;
|
|
5888
|
-
dateFrom?: any;
|
|
5889
|
-
dateTo?: any;
|
|
5890
|
-
/** Per regex: \d+[ymdw]$ (will override `dateFrom` and `dateTo`) */
|
|
5891
|
-
range?: any;
|
|
5892
|
-
start?: any;
|
|
5893
|
-
perPage?: any;
|
|
5894
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5895
|
-
/**
|
|
5896
|
-
* @tags Transfers
|
|
5897
|
-
* @name AmountAvailable
|
|
5898
|
-
* @summary Amount Available
|
|
5899
|
-
* @request GET:/transfer/available/{account}
|
|
5900
|
-
* @secure
|
|
5901
|
-
*/
|
|
5902
|
-
amountAvailable(account: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5903
|
-
/**
|
|
5904
|
-
* @tags Transfers
|
|
5905
|
-
* @name LegalDocumentTypes
|
|
5906
|
-
* @summary Legal document types
|
|
5907
|
-
* @request GET:/transfer/legal/types
|
|
5908
|
-
* @secure
|
|
5909
|
-
*/
|
|
5910
|
-
legalDocumentTypes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5911
|
-
/**
|
|
5912
|
-
* @tags Transfers
|
|
5913
|
-
* @name LegalDocument
|
|
5914
|
-
* @summary Legal document
|
|
5915
|
-
* @request GET:/transfer/legal/content
|
|
5916
|
-
* @secure
|
|
5917
|
-
*/
|
|
5918
|
-
legalDocument(query?: {
|
|
5919
|
-
/** Unique ID given in the types endpoint */
|
|
5920
|
-
id?: any;
|
|
5921
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5922
|
-
/**
|
|
5923
|
-
* @tags Transfers
|
|
5924
|
-
* @name Cancel
|
|
5925
|
-
* @summary Cancel
|
|
5926
|
-
* @request POST:/transfer/ach/cancel
|
|
5927
|
-
* @secure
|
|
5928
|
-
*/
|
|
5929
|
-
cancel(data: {
|
|
5930
|
-
/** @example "5VA0XXXX" */
|
|
5931
|
-
account?: any;
|
|
5932
|
-
/** @example "0.0.0.0" */
|
|
5933
|
-
remoteAddr?: any;
|
|
5934
|
-
/** @example "ultra fast browser 1.1" */
|
|
5935
|
-
remoteDevice?: any;
|
|
5936
|
-
/** @example "CC123456" */
|
|
5937
|
-
transferId?: any;
|
|
5938
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5939
|
-
/**
|
|
5940
|
-
* @tags Transfers
|
|
5941
|
-
* @name FeesAndCredits
|
|
5942
|
-
* @summary Fees and Credits
|
|
5943
|
-
* @request POST:/transfer/fees/apply
|
|
5944
|
-
* @secure
|
|
5945
|
-
*/
|
|
5946
|
-
feesAndCredits(data: {
|
|
5947
|
-
/** @example "5VA0XXXX" */
|
|
5948
|
-
account?: any;
|
|
5949
|
-
/** @example 100 */
|
|
5950
|
-
amount?: any;
|
|
5951
|
-
/** @example "FeeReversal|Promotion|WriteOff|Rebate|Courtesy|Advisory|Management|Admin|Exchange|Tech|Platform|Inactivity|MarginInterest|Custodian|CryptoGift" */
|
|
5952
|
-
classification?: any;
|
|
5953
|
-
/** @example "" */
|
|
5954
|
-
contraNote?: any;
|
|
5955
|
-
/** @example "USD" */
|
|
5956
|
-
currency?: any;
|
|
5957
|
-
/** @example "" */
|
|
5958
|
-
note?: any;
|
|
5959
|
-
/** @example 0.01 */
|
|
5960
|
-
quantity?: any;
|
|
5961
|
-
/** @example "0.0.0.0" */
|
|
5962
|
-
remoteAddr?: any;
|
|
5963
|
-
/** @example "ultra fast browser 1.1" */
|
|
5964
|
-
remoteDevice?: any;
|
|
5965
|
-
/** @example "BTC/USD" */
|
|
5966
|
-
symbol?: any;
|
|
5967
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5968
|
-
/**
|
|
5969
|
-
* @tags Transfers
|
|
5970
|
-
* @name ListFees
|
|
5971
|
-
* @summary List fees
|
|
5972
|
-
* @request GET:/transfer/fees/classifications/fees
|
|
5973
|
-
* @secure
|
|
5974
|
-
*/
|
|
5975
|
-
listFees(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5976
|
-
/**
|
|
5977
|
-
* @tags Transfers
|
|
5978
|
-
* @name ListCredits
|
|
5979
|
-
* @summary List credits
|
|
5980
|
-
* @request GET:/transfer/fees/classifications/credits
|
|
5981
|
-
* @secure
|
|
5982
|
-
*/
|
|
5983
|
-
listCredits(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5984
|
-
/**
|
|
5985
|
-
* @tags Transfers
|
|
5986
|
-
* @name CryptoDepositAddress
|
|
5987
|
-
* @summary Crypto Deposit Address
|
|
5988
|
-
* @request GET:/transfer/crypto/deposit/wallet/address
|
|
5989
|
-
* @secure
|
|
5990
|
-
*/
|
|
5991
|
-
cryptoDepositAddress(data: {
|
|
5992
|
-
/** @example "AB123456" */
|
|
5993
|
-
account?: any;
|
|
5994
|
-
/** @example "BTC" */
|
|
5995
|
-
currency?: any;
|
|
5996
|
-
/** @example "{optional}" */
|
|
5997
|
-
network?: any;
|
|
5998
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5999
|
-
/**
|
|
6000
|
-
* @tags Transfers
|
|
6001
|
-
* @name CryptoWithdrawalEstimate
|
|
6002
|
-
* @summary Crypto Withdrawal Estimate
|
|
6003
|
-
* @request POST:/transfer/crypto/withdrawal/estimate
|
|
6004
|
-
* @secure
|
|
6005
|
-
*/
|
|
6006
|
-
cryptoWithdrawalEstimate(data: {
|
|
6007
|
-
/** @example "BTC" */
|
|
6008
|
-
currency?: any;
|
|
6009
|
-
/** @example "{optional}" */
|
|
6010
|
-
network?: any;
|
|
6011
|
-
/** @example "0.1" */
|
|
6012
|
-
quantity?: any;
|
|
6013
|
-
/** @example "{optional}" */
|
|
6014
|
-
wallet?: any;
|
|
6015
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
6016
|
-
/**
|
|
6017
|
-
* @tags Transfers
|
|
6018
|
-
* @name CryptoWithdrawal
|
|
6019
|
-
* @summary Crypto Withdrawal
|
|
6020
|
-
* @request POST:/transfer/crypto/withdraw
|
|
6021
|
-
* @secure
|
|
6022
|
-
*/
|
|
6023
|
-
cryptoWithdrawal(data: {
|
|
6024
|
-
/** @example "AB123456" */
|
|
6025
|
-
account?: any;
|
|
6026
|
-
/** @example "BTC" */
|
|
6027
|
-
currency?: any;
|
|
6028
|
-
/** @example "{optional}" */
|
|
6029
|
-
estimateExtension?: any;
|
|
6030
|
-
/** @example "abc123" */
|
|
6031
|
-
estimateId?: any;
|
|
6032
|
-
/** @example "{optional}" */
|
|
6033
|
-
network?: any;
|
|
6034
|
-
/** @example 0.1 */
|
|
6035
|
-
quantity?: any;
|
|
6036
|
-
/** @example "{conditional}" */
|
|
6037
|
-
recipientFirstName?: any;
|
|
6038
|
-
/** @example "{conditional}" */
|
|
6039
|
-
recipientLastName?: any;
|
|
6040
|
-
/** @example "{optional} 1.1.1.1" */
|
|
6041
|
-
remoteAddr?: any;
|
|
6042
|
-
/** @example "{optional} Some phone" */
|
|
6043
|
-
remoteDevice?: any;
|
|
6044
|
-
/** @example "{optional} true|false" */
|
|
6045
|
-
selfHosted?: any;
|
|
6046
|
-
/** @example "{optional}" */
|
|
6047
|
-
tag?: any;
|
|
6048
|
-
/** @example "{conditional}" */
|
|
6049
|
-
vaspName?: any;
|
|
6050
|
-
/** @example "wallet address" */
|
|
6051
|
-
wallet?: any;
|
|
6052
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
6053
|
-
}
|
|
6054
6062
|
export class OrbisApi<HandleError extends boolean = false> extends BaseApi<HandleError, OrbisClient<HandleError>> {
|
|
6055
6063
|
readonly config: OrbisClientConfig<HandleError>;
|
|
6056
6064
|
advisory: Advisory<HandleError>;
|