@orbis-systems/orbis-api-clients 0.7.5 → 0.7.7
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 +43 -41
- 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 +232 -213
- 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 +243 -200
- 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 +117 -117
- 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 +772 -768
- 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 +363 -351
- 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 +13 -13
- package/dist/zerohash/index.d.ts.map +1 -1
- package/dist/zerohash/index.esm.js +1 -1
- package/dist/zerohash/index.esm.js.map +1 -1
- package/dist/zerohash/index.js +1 -1
- package/dist/zerohash/index.js.map +1 -1
- package/package.json +1 -1
package/dist/orbis/index.d.ts
CHANGED
|
@@ -305,6 +305,84 @@ export class OrdersV2Equities<HandleError extends boolean = boolean> {
|
|
|
305
305
|
*/
|
|
306
306
|
previewSnapshot(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
307
307
|
}
|
|
308
|
+
export class OrdersV2FixedIncome<HandleError extends boolean = boolean> {
|
|
309
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
310
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
311
|
+
/**
|
|
312
|
+
* @tags Orders V2 Fixed Income
|
|
313
|
+
* @name BondPlacement
|
|
314
|
+
* @summary Bond placement
|
|
315
|
+
* @request POST:/orders/v2/bonds/place
|
|
316
|
+
* @secure
|
|
317
|
+
*/
|
|
318
|
+
bondPlacement(data: {
|
|
319
|
+
account?: {
|
|
320
|
+
/** @example 123 */
|
|
321
|
+
accountId?: number;
|
|
322
|
+
/** @example "AC00123" */
|
|
323
|
+
accountNumber?: string;
|
|
324
|
+
};
|
|
325
|
+
order?: {
|
|
326
|
+
/** @example "LIMIT" */
|
|
327
|
+
orderType?: string;
|
|
328
|
+
/** @example 100 */
|
|
329
|
+
price?: number;
|
|
330
|
+
/** @example "Percentage|Decimal" */
|
|
331
|
+
priceType?: string;
|
|
332
|
+
/** @example 1000 */
|
|
333
|
+
quantity?: number;
|
|
334
|
+
/** @example "Par|Unit" */
|
|
335
|
+
quantityType?: string;
|
|
336
|
+
quote?: {
|
|
337
|
+
/** @example "412001269" */
|
|
338
|
+
cusip?: string;
|
|
339
|
+
/** @example "CUSIP:ISIN" */
|
|
340
|
+
identType?: string;
|
|
341
|
+
/** @example "SK4120012691" */
|
|
342
|
+
isin?: string;
|
|
343
|
+
};
|
|
344
|
+
/** @example "BUY|SELL" */
|
|
345
|
+
transaction?: string;
|
|
346
|
+
};
|
|
347
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
348
|
+
/**
|
|
349
|
+
* @tags Orders V2 Fixed Income
|
|
350
|
+
* @name BondOrderPreview
|
|
351
|
+
* @summary Bond order preview
|
|
352
|
+
* @request POST:/orders/v2/bonds/preview
|
|
353
|
+
* @secure
|
|
354
|
+
*/
|
|
355
|
+
bondOrderPreview(data: {
|
|
356
|
+
account?: {
|
|
357
|
+
/** @example 123 */
|
|
358
|
+
accountId?: number;
|
|
359
|
+
/** @example "AC00123" */
|
|
360
|
+
accountNumber?: string;
|
|
361
|
+
};
|
|
362
|
+
order?: {
|
|
363
|
+
/** @example "LIMIT" */
|
|
364
|
+
orderType?: string;
|
|
365
|
+
/** @example 100 */
|
|
366
|
+
price?: number;
|
|
367
|
+
/** @example "Percentage|Decimal" */
|
|
368
|
+
priceType?: string;
|
|
369
|
+
/** @example 1000 */
|
|
370
|
+
quantity?: number;
|
|
371
|
+
/** @example "Par|Unit" */
|
|
372
|
+
quantityType?: string;
|
|
373
|
+
quote?: {
|
|
374
|
+
/** @example "412001269" */
|
|
375
|
+
cusip?: string;
|
|
376
|
+
/** @example "CUSIP:ISIN" */
|
|
377
|
+
identType?: string;
|
|
378
|
+
/** @example "SK4120012691" */
|
|
379
|
+
isin?: string;
|
|
380
|
+
};
|
|
381
|
+
/** @example "BUY|SELL" */
|
|
382
|
+
transaction?: string;
|
|
383
|
+
};
|
|
384
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
385
|
+
}
|
|
308
386
|
export class OrdersV2Options<HandleError extends boolean = boolean> {
|
|
309
387
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
310
388
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -584,84 +662,6 @@ export class OrdersV2Crypto<HandleError extends boolean = boolean> {
|
|
|
584
662
|
};
|
|
585
663
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
586
664
|
}
|
|
587
|
-
export class OrdersV2FixedIncome<HandleError extends boolean = boolean> {
|
|
588
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
589
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
590
|
-
/**
|
|
591
|
-
* @tags Orders V2 Fixed Income
|
|
592
|
-
* @name BondPlacement
|
|
593
|
-
* @summary Bond placement
|
|
594
|
-
* @request POST:/orders/v2/bonds/place
|
|
595
|
-
* @secure
|
|
596
|
-
*/
|
|
597
|
-
bondPlacement(data: {
|
|
598
|
-
account?: {
|
|
599
|
-
/** @example 123 */
|
|
600
|
-
accountId?: number;
|
|
601
|
-
/** @example "AC00123" */
|
|
602
|
-
accountNumber?: string;
|
|
603
|
-
};
|
|
604
|
-
order?: {
|
|
605
|
-
/** @example "LIMIT" */
|
|
606
|
-
orderType?: string;
|
|
607
|
-
/** @example 100 */
|
|
608
|
-
price?: number;
|
|
609
|
-
/** @example "Percentage|Decimal" */
|
|
610
|
-
priceType?: string;
|
|
611
|
-
/** @example 1000 */
|
|
612
|
-
quantity?: number;
|
|
613
|
-
/** @example "Par|Unit" */
|
|
614
|
-
quantityType?: string;
|
|
615
|
-
quote?: {
|
|
616
|
-
/** @example "412001269" */
|
|
617
|
-
cusip?: string;
|
|
618
|
-
/** @example "CUSIP:ISIN" */
|
|
619
|
-
identType?: string;
|
|
620
|
-
/** @example "SK4120012691" */
|
|
621
|
-
isin?: string;
|
|
622
|
-
};
|
|
623
|
-
/** @example "BUY|SELL" */
|
|
624
|
-
transaction?: string;
|
|
625
|
-
};
|
|
626
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
627
|
-
/**
|
|
628
|
-
* @tags Orders V2 Fixed Income
|
|
629
|
-
* @name BondOrderPreview
|
|
630
|
-
* @summary Bond order preview
|
|
631
|
-
* @request POST:/orders/v2/bonds/preview
|
|
632
|
-
* @secure
|
|
633
|
-
*/
|
|
634
|
-
bondOrderPreview(data: {
|
|
635
|
-
account?: {
|
|
636
|
-
/** @example 123 */
|
|
637
|
-
accountId?: number;
|
|
638
|
-
/** @example "AC00123" */
|
|
639
|
-
accountNumber?: string;
|
|
640
|
-
};
|
|
641
|
-
order?: {
|
|
642
|
-
/** @example "LIMIT" */
|
|
643
|
-
orderType?: string;
|
|
644
|
-
/** @example 100 */
|
|
645
|
-
price?: number;
|
|
646
|
-
/** @example "Percentage|Decimal" */
|
|
647
|
-
priceType?: string;
|
|
648
|
-
/** @example 1000 */
|
|
649
|
-
quantity?: number;
|
|
650
|
-
/** @example "Par|Unit" */
|
|
651
|
-
quantityType?: string;
|
|
652
|
-
quote?: {
|
|
653
|
-
/** @example "412001269" */
|
|
654
|
-
cusip?: string;
|
|
655
|
-
/** @example "CUSIP:ISIN" */
|
|
656
|
-
identType?: string;
|
|
657
|
-
/** @example "SK4120012691" */
|
|
658
|
-
isin?: string;
|
|
659
|
-
};
|
|
660
|
-
/** @example "BUY|SELL" */
|
|
661
|
-
transaction?: 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>);
|
|
@@ -752,6 +752,8 @@ export class OrdersV2Offerings<HandleError extends boolean = boolean> {
|
|
|
752
752
|
rule5130And5131Attestation?: boolean;
|
|
753
753
|
/** @example "SPV|Offering" */
|
|
754
754
|
type?: string;
|
|
755
|
+
/** @example "" */
|
|
756
|
+
vendorRef?: string;
|
|
755
757
|
};
|
|
756
758
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
757
759
|
/**
|
|
@@ -783,6 +785,8 @@ export class OrdersV2Offerings<HandleError extends boolean = boolean> {
|
|
|
783
785
|
rule5130And5131Attestation?: boolean;
|
|
784
786
|
/** @example "SPV|Offering" */
|
|
785
787
|
type?: string;
|
|
788
|
+
/** @example "" */
|
|
789
|
+
vendorRef?: string;
|
|
786
790
|
};
|
|
787
791
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
788
792
|
/**
|
|
@@ -1454,223 +1458,47 @@ export class Quotes<HandleError extends boolean = boolean> {
|
|
|
1454
1458
|
symbols?: any;
|
|
1455
1459
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1456
1460
|
}
|
|
1457
|
-
export class
|
|
1461
|
+
export class ResearchTipranks<HandleError extends boolean = boolean> {
|
|
1458
1462
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
1459
1463
|
constructor(apiClient: JwtClient<HandleError>);
|
|
1460
1464
|
/**
|
|
1461
|
-
* @tags Research
|
|
1462
|
-
* @name
|
|
1463
|
-
* @summary
|
|
1464
|
-
* @request GET:/research/
|
|
1465
|
-
* @secure
|
|
1466
|
-
*/
|
|
1467
|
-
initScreener(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1468
|
-
/**
|
|
1469
|
-
* @tags Research Etfs
|
|
1470
|
-
* @name Screener
|
|
1471
|
-
* @summary Screener
|
|
1472
|
-
* @request GET:/research/etf/screener
|
|
1465
|
+
* @tags Research Tipranks
|
|
1466
|
+
* @name Livefeed
|
|
1467
|
+
* @summary Livefeed
|
|
1468
|
+
* @request GET:/research/tipranks/livefeed
|
|
1473
1469
|
* @secure
|
|
1474
1470
|
*/
|
|
1475
|
-
|
|
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;
|
|
1494
|
-
/**
|
|
1495
|
-
* True/false
|
|
1496
|
-
* @example "false"
|
|
1497
|
-
*/
|
|
1498
|
-
loadIndustries?: any;
|
|
1499
|
-
/**
|
|
1500
|
-
* True/false
|
|
1501
|
-
* @example "false"
|
|
1502
|
-
*/
|
|
1503
|
-
loadUpgrades?: any;
|
|
1504
|
-
/**
|
|
1505
|
-
* True/false
|
|
1506
|
-
* @example "false"
|
|
1507
|
-
*/
|
|
1508
|
-
loadEarnings?: any;
|
|
1471
|
+
livefeed(query?: {
|
|
1509
1472
|
/**
|
|
1510
|
-
*
|
|
1511
|
-
*
|
|
1512
|
-
* * 5pct - paying at least 5% dividend
|
|
1513
|
-
* * 3pct
|
|
1514
|
-
* * mcbelow2b – market cap under 2B
|
|
1515
|
-
* * mcbetween2and10b
|
|
1516
|
-
* * mcbetween10and200b
|
|
1517
|
-
* * mcabove200b
|
|
1473
|
+
* Amount to include. Defaults to 20.
|
|
1474
|
+
* @example "20"
|
|
1518
1475
|
*/
|
|
1519
|
-
|
|
1476
|
+
count?: any;
|
|
1520
1477
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1521
1478
|
/**
|
|
1522
|
-
* @tags Research
|
|
1523
|
-
* @name
|
|
1524
|
-
* @summary
|
|
1525
|
-
* @request GET:/research/
|
|
1479
|
+
* @tags Research Tipranks
|
|
1480
|
+
* @name AnalystPortfolio
|
|
1481
|
+
* @summary Analyst Portfolio
|
|
1482
|
+
* @request GET:/research/tipranks/analyst/portfolio/{expertUID}
|
|
1526
1483
|
* @secure
|
|
1527
1484
|
*/
|
|
1528
|
-
|
|
1485
|
+
analystPortfolio(expertUid: string, query?: {
|
|
1529
1486
|
/**
|
|
1530
|
-
*
|
|
1531
|
-
* @example "
|
|
1487
|
+
* Total number of entries
|
|
1488
|
+
* @example "5"
|
|
1532
1489
|
*/
|
|
1533
|
-
|
|
1490
|
+
count?: any;
|
|
1534
1491
|
/**
|
|
1535
|
-
*
|
|
1536
|
-
* @example "
|
|
1492
|
+
* Optional. Defaults to false
|
|
1493
|
+
* @example "true"
|
|
1537
1494
|
*/
|
|
1538
|
-
|
|
1495
|
+
loadQuotes?: any;
|
|
1539
1496
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1540
1497
|
/**
|
|
1541
|
-
* @tags Research
|
|
1542
|
-
* @name
|
|
1543
|
-
* @summary
|
|
1544
|
-
* @request GET:/research/
|
|
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}
|
|
1498
|
+
* @tags Research Tipranks
|
|
1499
|
+
* @name AnalystProfile
|
|
1500
|
+
* @summary Analyst Profile
|
|
1501
|
+
* @request GET:/research/tipranks/analyst/profile/{expertUID}
|
|
1674
1502
|
* @secure
|
|
1675
1503
|
*/
|
|
1676
1504
|
analystProfile(expertUid: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
@@ -1811,6 +1639,182 @@ export class ResearchTipranks<HandleError extends boolean = boolean> {
|
|
|
1811
1639
|
*/
|
|
1812
1640
|
bloggerRatings(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1813
1641
|
}
|
|
1642
|
+
export class ResearchEtfs<HandleError extends boolean = boolean> {
|
|
1643
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
1644
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
1645
|
+
/**
|
|
1646
|
+
* @tags Research Etfs
|
|
1647
|
+
* @name InitScreener
|
|
1648
|
+
* @summary Init Screener
|
|
1649
|
+
* @request GET:/research/etf/init
|
|
1650
|
+
* @secure
|
|
1651
|
+
*/
|
|
1652
|
+
initScreener(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1653
|
+
/**
|
|
1654
|
+
* @tags Research Etfs
|
|
1655
|
+
* @name Screener
|
|
1656
|
+
* @summary Screener
|
|
1657
|
+
* @request GET:/research/etf/screener
|
|
1658
|
+
* @secure
|
|
1659
|
+
*/
|
|
1660
|
+
screener(query?: {
|
|
1661
|
+
/** * see init */
|
|
1662
|
+
inverseType?: any;
|
|
1663
|
+
/** * see init */
|
|
1664
|
+
leverageType?: any;
|
|
1665
|
+
/** * see init */
|
|
1666
|
+
assetId?: any;
|
|
1667
|
+
/** * see init */
|
|
1668
|
+
categoryId?: any;
|
|
1669
|
+
/** * see init */
|
|
1670
|
+
sponsorId?: any;
|
|
1671
|
+
/** Entry to start at */
|
|
1672
|
+
start?: any;
|
|
1673
|
+
/** Entries per page */
|
|
1674
|
+
num?: any;
|
|
1675
|
+
/** Sort by: symbol, last, change, volume, marketcap, expense, asset, sponsor, category, leverage, countrypct, countinentpct, sectorpct, exposure */
|
|
1676
|
+
sort?: any;
|
|
1677
|
+
/** True/false */
|
|
1678
|
+
asc?: any;
|
|
1679
|
+
/**
|
|
1680
|
+
* True/false
|
|
1681
|
+
* @example "false"
|
|
1682
|
+
*/
|
|
1683
|
+
loadIndustries?: any;
|
|
1684
|
+
/**
|
|
1685
|
+
* True/false
|
|
1686
|
+
* @example "false"
|
|
1687
|
+
*/
|
|
1688
|
+
loadUpgrades?: any;
|
|
1689
|
+
/**
|
|
1690
|
+
* True/false
|
|
1691
|
+
* @example "false"
|
|
1692
|
+
*/
|
|
1693
|
+
loadEarnings?: any;
|
|
1694
|
+
/**
|
|
1695
|
+
* Repeating set of:
|
|
1696
|
+
* * paying dividend
|
|
1697
|
+
* * 5pct - paying at least 5% dividend
|
|
1698
|
+
* * 3pct
|
|
1699
|
+
* * mcbelow2b – market cap under 2B
|
|
1700
|
+
* * mcbetween2and10b
|
|
1701
|
+
* * mcbetween10and200b
|
|
1702
|
+
* * mcabove200b
|
|
1703
|
+
*/
|
|
1704
|
+
filters?: any;
|
|
1705
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1706
|
+
/**
|
|
1707
|
+
* @tags Research Etfs
|
|
1708
|
+
* @name Top10
|
|
1709
|
+
* @summary Top 10
|
|
1710
|
+
* @request GET:/research/etf/top10
|
|
1711
|
+
* @secure
|
|
1712
|
+
*/
|
|
1713
|
+
top10(query?: {
|
|
1714
|
+
/**
|
|
1715
|
+
* * see Inverse Types table
|
|
1716
|
+
* @example "ALL"
|
|
1717
|
+
*/
|
|
1718
|
+
inverseType?: any;
|
|
1719
|
+
/**
|
|
1720
|
+
* * see Leverage Types table
|
|
1721
|
+
* @example "LEVERAGE"
|
|
1722
|
+
*/
|
|
1723
|
+
leverageType?: any;
|
|
1724
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1725
|
+
/**
|
|
1726
|
+
* @tags Research Etfs
|
|
1727
|
+
* @name Details
|
|
1728
|
+
* @summary Details
|
|
1729
|
+
* @request GET:/research/etf/details
|
|
1730
|
+
* @secure
|
|
1731
|
+
*/
|
|
1732
|
+
details(query?: {
|
|
1733
|
+
/**
|
|
1734
|
+
* ETF symbol
|
|
1735
|
+
* @example "VXF"
|
|
1736
|
+
*/
|
|
1737
|
+
symbol?: any;
|
|
1738
|
+
/**
|
|
1739
|
+
* Use true to include quotes. Defaults to false.
|
|
1740
|
+
* @example "false"
|
|
1741
|
+
*/
|
|
1742
|
+
loadQuotes?: any;
|
|
1743
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1744
|
+
/**
|
|
1745
|
+
* @tags Research Etfs
|
|
1746
|
+
* @name BreakdownBySector
|
|
1747
|
+
* @summary Breakdown by Sector
|
|
1748
|
+
* @request GET:/research/etf/breakdown
|
|
1749
|
+
* @secure
|
|
1750
|
+
*/
|
|
1751
|
+
breakdownBySector(query?: {
|
|
1752
|
+
/**
|
|
1753
|
+
* 1d, 1w, 2w, 1m where d is day, w is week, and m is month
|
|
1754
|
+
* @example "1d"
|
|
1755
|
+
*/
|
|
1756
|
+
duration?: any;
|
|
1757
|
+
/**
|
|
1758
|
+
* Amount of ETFs to include per sector. Defaults to 5, max is 10
|
|
1759
|
+
* @example "5"
|
|
1760
|
+
*/
|
|
1761
|
+
displaySize?: any;
|
|
1762
|
+
/**
|
|
1763
|
+
* Exposure to specific sector. Defaults to 90
|
|
1764
|
+
* @example "90"
|
|
1765
|
+
*/
|
|
1766
|
+
exposure?: any;
|
|
1767
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1768
|
+
}
|
|
1769
|
+
export class ResearchAdrs<HandleError extends boolean = boolean> {
|
|
1770
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
1771
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
1772
|
+
/**
|
|
1773
|
+
* @tags Research Adrs
|
|
1774
|
+
* @name Top10
|
|
1775
|
+
* @summary Top 10
|
|
1776
|
+
* @request GET:/research/adrs/top10
|
|
1777
|
+
* @secure
|
|
1778
|
+
*/
|
|
1779
|
+
top10(query?: {
|
|
1780
|
+
/** See description */
|
|
1781
|
+
country?: any;
|
|
1782
|
+
/** `true` or `false` */
|
|
1783
|
+
loadQuotes?: any;
|
|
1784
|
+
/** `true` or `false` */
|
|
1785
|
+
loadEarningReleases?: any;
|
|
1786
|
+
/** `true` or `false` */
|
|
1787
|
+
loadUpgradesDowngrades?: any;
|
|
1788
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1789
|
+
/**
|
|
1790
|
+
* @tags Research Adrs
|
|
1791
|
+
* @name Defaults
|
|
1792
|
+
* @summary Defaults
|
|
1793
|
+
* @request GET:/research/adrs/top10/defaults
|
|
1794
|
+
* @secure
|
|
1795
|
+
*/
|
|
1796
|
+
defaults(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1797
|
+
/**
|
|
1798
|
+
* @tags Research Adrs
|
|
1799
|
+
* @name Search
|
|
1800
|
+
* @summary Search
|
|
1801
|
+
* @request GET:/research/adrs
|
|
1802
|
+
* @secure
|
|
1803
|
+
*/
|
|
1804
|
+
search(query?: {
|
|
1805
|
+
/**
|
|
1806
|
+
* Country code such as JPN. See `Defaults` endpoint
|
|
1807
|
+
* @example "JPN"
|
|
1808
|
+
*/
|
|
1809
|
+
country?: any;
|
|
1810
|
+
/** `true` or `false` */
|
|
1811
|
+
loadQuotes?: any;
|
|
1812
|
+
/** `true` or `false` */
|
|
1813
|
+
loadEarningReleases?: any;
|
|
1814
|
+
/** `true` or `false` */
|
|
1815
|
+
loadUpgradesDowngrades?: any;
|
|
1816
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1817
|
+
}
|
|
1814
1818
|
export class ResearchCorporateActions<HandleError extends boolean = boolean> {
|
|
1815
1819
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
1816
1820
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -2383,6 +2387,112 @@ export class UserWatchlists<HandleError extends boolean = boolean> {
|
|
|
2383
2387
|
*/
|
|
2384
2388
|
removeFromWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2385
2389
|
}
|
|
2390
|
+
export class UserDevice<HandleError extends boolean = boolean> {
|
|
2391
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2392
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2393
|
+
/**
|
|
2394
|
+
* @tags User Device
|
|
2395
|
+
* @name Register
|
|
2396
|
+
* @summary Register
|
|
2397
|
+
* @request GET:/user/device/register
|
|
2398
|
+
* @secure
|
|
2399
|
+
*/
|
|
2400
|
+
register(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2401
|
+
/**
|
|
2402
|
+
* @tags User Device
|
|
2403
|
+
* @name Deregister
|
|
2404
|
+
* @summary Deregister
|
|
2405
|
+
* @request GET:/user/device/deregister
|
|
2406
|
+
* @secure
|
|
2407
|
+
*/
|
|
2408
|
+
deregister(query?: {
|
|
2409
|
+
token?: any;
|
|
2410
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2411
|
+
/**
|
|
2412
|
+
* @tags User Device
|
|
2413
|
+
* @name FirebaseRegistration
|
|
2414
|
+
* @summary Firebase - registration
|
|
2415
|
+
* @request POST:/user/device/firebase/register
|
|
2416
|
+
* @secure
|
|
2417
|
+
*/
|
|
2418
|
+
firebaseRegistration(data: {
|
|
2419
|
+
/** @example "{predfined scope name}" */
|
|
2420
|
+
scope?: any;
|
|
2421
|
+
/** @example "a1s2d3f4g5h6" */
|
|
2422
|
+
token?: any;
|
|
2423
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2424
|
+
/**
|
|
2425
|
+
* @tags User Device
|
|
2426
|
+
* @name FirebaseRemoval
|
|
2427
|
+
* @summary Firebase - removal
|
|
2428
|
+
* @request POST:/user/device/firebase/deregister
|
|
2429
|
+
* @secure
|
|
2430
|
+
*/
|
|
2431
|
+
firebaseRemoval(data: {
|
|
2432
|
+
/** @example "a1s2d3f4g5h6" */
|
|
2433
|
+
token?: any;
|
|
2434
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2435
|
+
}
|
|
2436
|
+
export class UserAgreements<HandleError extends boolean = boolean> {
|
|
2437
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2438
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2439
|
+
/**
|
|
2440
|
+
* @tags User Agreements
|
|
2441
|
+
* @name Available
|
|
2442
|
+
* @summary Available
|
|
2443
|
+
* @request GET:/user/agreements/all/active
|
|
2444
|
+
* @secure
|
|
2445
|
+
*/
|
|
2446
|
+
available(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2447
|
+
/**
|
|
2448
|
+
* @tags User Agreements
|
|
2449
|
+
* @name Agreement
|
|
2450
|
+
* @summary Agreement
|
|
2451
|
+
* @request GET:/user/agreements/contents/{version}/{code}/body.html
|
|
2452
|
+
* @secure
|
|
2453
|
+
*/
|
|
2454
|
+
agreement(version: string, code: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2455
|
+
/**
|
|
2456
|
+
* @tags User Agreements
|
|
2457
|
+
* @name Unsigned
|
|
2458
|
+
* @summary Unsigned
|
|
2459
|
+
* @request GET:/user/agreements/unsigned
|
|
2460
|
+
* @secure
|
|
2461
|
+
*/
|
|
2462
|
+
unsigned(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2463
|
+
/**
|
|
2464
|
+
* @tags User Agreements
|
|
2465
|
+
* @name AttestStatus
|
|
2466
|
+
* @summary Attest status
|
|
2467
|
+
* @request POST:/user/professional/attest
|
|
2468
|
+
* @secure
|
|
2469
|
+
*/
|
|
2470
|
+
attestStatus(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2471
|
+
/**
|
|
2472
|
+
* @tags User Agreements
|
|
2473
|
+
* @name Sign
|
|
2474
|
+
* @summary Sign
|
|
2475
|
+
* @request POST:/user/agreements/sign
|
|
2476
|
+
* @secure
|
|
2477
|
+
*/
|
|
2478
|
+
sign(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2479
|
+
/**
|
|
2480
|
+
* @tags User Agreements
|
|
2481
|
+
* @name CryptoAgreement
|
|
2482
|
+
* @summary Crypto Agreement
|
|
2483
|
+
* @request GET:/user/agreements/crypto/Agreement
|
|
2484
|
+
* @secure
|
|
2485
|
+
*/
|
|
2486
|
+
cryptoAgreement(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2487
|
+
/**
|
|
2488
|
+
* @tags User Agreements
|
|
2489
|
+
* @name CryptoSign
|
|
2490
|
+
* @summary Crypto Sign
|
|
2491
|
+
* @request POST:/user/agreements/crypto/sign
|
|
2492
|
+
* @secure
|
|
2493
|
+
*/
|
|
2494
|
+
cryptoSign(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2495
|
+
}
|
|
2386
2496
|
export class UserTradingLimitManagement<HandleError extends boolean = boolean> {
|
|
2387
2497
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2388
2498
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -2485,112 +2595,6 @@ export class UserProfitLoss<HandleError extends boolean = boolean> {
|
|
|
2485
2595
|
requestId?: any;
|
|
2486
2596
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2487
2597
|
}
|
|
2488
|
-
export class UserAgreements<HandleError extends boolean = boolean> {
|
|
2489
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
2490
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
2491
|
-
/**
|
|
2492
|
-
* @tags User Agreements
|
|
2493
|
-
* @name Available
|
|
2494
|
-
* @summary Available
|
|
2495
|
-
* @request GET:/user/agreements/all/active
|
|
2496
|
-
* @secure
|
|
2497
|
-
*/
|
|
2498
|
-
available(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2499
|
-
/**
|
|
2500
|
-
* @tags User Agreements
|
|
2501
|
-
* @name Agreement
|
|
2502
|
-
* @summary Agreement
|
|
2503
|
-
* @request GET:/user/agreements/contents/{version}/{code}/body.html
|
|
2504
|
-
* @secure
|
|
2505
|
-
*/
|
|
2506
|
-
agreement(version: string, code: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2507
|
-
/**
|
|
2508
|
-
* @tags User Agreements
|
|
2509
|
-
* @name Unsigned
|
|
2510
|
-
* @summary Unsigned
|
|
2511
|
-
* @request GET:/user/agreements/unsigned
|
|
2512
|
-
* @secure
|
|
2513
|
-
*/
|
|
2514
|
-
unsigned(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2515
|
-
/**
|
|
2516
|
-
* @tags User Agreements
|
|
2517
|
-
* @name AttestStatus
|
|
2518
|
-
* @summary Attest status
|
|
2519
|
-
* @request POST:/user/professional/attest
|
|
2520
|
-
* @secure
|
|
2521
|
-
*/
|
|
2522
|
-
attestStatus(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2523
|
-
/**
|
|
2524
|
-
* @tags User Agreements
|
|
2525
|
-
* @name Sign
|
|
2526
|
-
* @summary Sign
|
|
2527
|
-
* @request POST:/user/agreements/sign
|
|
2528
|
-
* @secure
|
|
2529
|
-
*/
|
|
2530
|
-
sign(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2531
|
-
/**
|
|
2532
|
-
* @tags User Agreements
|
|
2533
|
-
* @name CryptoAgreement
|
|
2534
|
-
* @summary Crypto Agreement
|
|
2535
|
-
* @request GET:/user/agreements/crypto/Agreement
|
|
2536
|
-
* @secure
|
|
2537
|
-
*/
|
|
2538
|
-
cryptoAgreement(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2539
|
-
/**
|
|
2540
|
-
* @tags User Agreements
|
|
2541
|
-
* @name CryptoSign
|
|
2542
|
-
* @summary Crypto Sign
|
|
2543
|
-
* @request POST:/user/agreements/crypto/sign
|
|
2544
|
-
* @secure
|
|
2545
|
-
*/
|
|
2546
|
-
cryptoSign(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
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
|
-
}
|
|
2594
2598
|
export class User<HandleError extends boolean = boolean> {
|
|
2595
2599
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2596
2600
|
watchlists: UserWatchlists<HandleError>;
|
|
@@ -3810,6 +3814,24 @@ export class AdvisoryAllocations<HandleError extends boolean = boolean> {
|
|
|
3810
3814
|
*/
|
|
3811
3815
|
trigger(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3812
3816
|
}
|
|
3817
|
+
export class Device<HandleError extends boolean = boolean> {
|
|
3818
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3819
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3820
|
+
/**
|
|
3821
|
+
* @tags Device
|
|
3822
|
+
* @name DeviceDeactivate
|
|
3823
|
+
* @summary /device/deactivate
|
|
3824
|
+
* @request POST:/device/deactivate
|
|
3825
|
+
* @secure
|
|
3826
|
+
*/
|
|
3827
|
+
deviceDeactivate(data: {
|
|
3828
|
+
/**
|
|
3829
|
+
* Token previously registered
|
|
3830
|
+
* @example "123456789"
|
|
3831
|
+
*/
|
|
3832
|
+
Token?: string;
|
|
3833
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3834
|
+
}
|
|
3813
3835
|
export class TransfersRelationships<HandleError extends boolean = boolean> {
|
|
3814
3836
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3815
3837
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4534,58 +4556,304 @@ export class TransfersInstantCashTransfers<HandleError extends boolean = boolean
|
|
|
4534
4556
|
depositWithdrawalV2(direction: string, data: {
|
|
4535
4557
|
/** @example "AB123456" */
|
|
4536
4558
|
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" */
|
|
4559
|
+
/** @example 100.32 */
|
|
4560
|
+
amount?: any;
|
|
4561
|
+
counterparty?: {
|
|
4562
|
+
address?: {
|
|
4563
|
+
/** @example "Central City" */
|
|
4564
|
+
city?: string;
|
|
4565
|
+
/** @example "12345" */
|
|
4566
|
+
postalCode?: string;
|
|
4567
|
+
/** @example "CC" */
|
|
4568
|
+
stateProvince?: string;
|
|
4569
|
+
/** @example ["225 Baker St"] */
|
|
4570
|
+
streetAddress?: string[];
|
|
4571
|
+
};
|
|
4572
|
+
/** @example "James" */
|
|
4573
|
+
firstName?: string;
|
|
4574
|
+
institution?: {
|
|
4575
|
+
/** @example "123456" */
|
|
4576
|
+
accountNumber?: string;
|
|
4577
|
+
/** @example "Royal Central Bank" */
|
|
4578
|
+
name?: string;
|
|
4579
|
+
};
|
|
4580
|
+
/** @example "Bond" */
|
|
4581
|
+
lastName?: string;
|
|
4582
|
+
};
|
|
4583
|
+
/** @example "USD" */
|
|
4584
|
+
currency?: any;
|
|
4585
|
+
/** @example "1.1.1.1" */
|
|
4586
|
+
remoteAddr?: any;
|
|
4587
|
+
/** @example "Droid Phone" */
|
|
4588
|
+
remoteDevice?: any;
|
|
4589
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4590
|
+
/**
|
|
4591
|
+
* @tags Transfers Instant Cash Transfers
|
|
4592
|
+
* @name ObtainTheReport
|
|
4593
|
+
* @summary Obtain the report
|
|
4594
|
+
* @request POST:/transfer/reports/obtain
|
|
4595
|
+
* @secure
|
|
4596
|
+
*/
|
|
4597
|
+
obtainTheReport(data: {
|
|
4598
|
+
/** @example "MM/DD/YYYY HH:MM:SS ZZZ" */
|
|
4599
|
+
date?: any;
|
|
4600
|
+
/** @example "RETAIL_BANKING" */
|
|
4601
|
+
reportType?: any;
|
|
4602
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4603
|
+
/**
|
|
4604
|
+
* @tags Transfers Instant Cash Transfers
|
|
4605
|
+
* @name ListReports
|
|
4606
|
+
* @summary List reports
|
|
4607
|
+
* @request GET:/transfer/reports
|
|
4608
|
+
* @secure
|
|
4609
|
+
*/
|
|
4610
|
+
listReports(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4611
|
+
}
|
|
4612
|
+
export class TransfersCheques<HandleError extends boolean = boolean> {
|
|
4613
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4614
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4615
|
+
/**
|
|
4616
|
+
* @tags Transfers Cheques
|
|
4617
|
+
* @name Withdrawal
|
|
4618
|
+
* @summary Withdrawal
|
|
4619
|
+
* @request POST:/transfer/check/outgoing
|
|
4620
|
+
* @secure
|
|
4621
|
+
*/
|
|
4622
|
+
withdrawal(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4623
|
+
}
|
|
4624
|
+
export class Transfers<HandleError extends boolean = boolean> {
|
|
4625
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4626
|
+
relationships: TransfersRelationships<HandleError>;
|
|
4627
|
+
instantAccountVerification: TransfersInstantAccountVerification<HandleError>;
|
|
4628
|
+
ach: TransfersAch<HandleError>;
|
|
4629
|
+
acats: TransfersAcats<HandleError>;
|
|
4630
|
+
wires: TransfersWires<HandleError>;
|
|
4631
|
+
journals: TransfersJournals<HandleError>;
|
|
4632
|
+
positions: TransfersPositions<HandleError>;
|
|
4633
|
+
bank: TransfersBank<HandleError>;
|
|
4634
|
+
instantCashTransfers: TransfersInstantCashTransfers<HandleError>;
|
|
4635
|
+
cheques: TransfersCheques<HandleError>;
|
|
4636
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4637
|
+
/**
|
|
4638
|
+
* @tags Transfers
|
|
4639
|
+
* @name TransferDetails
|
|
4640
|
+
* @summary Transfer Details
|
|
4641
|
+
* @request GET:/transfer/details/{account}/{transferId}
|
|
4642
|
+
* @secure
|
|
4643
|
+
*/
|
|
4644
|
+
transferDetails(account: string, transferId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4645
|
+
/**
|
|
4646
|
+
* @tags Transfers
|
|
4647
|
+
* @name TransferStatus
|
|
4648
|
+
* @summary Transfer Status
|
|
4649
|
+
* @request GET:/transfer/status/{account}
|
|
4650
|
+
* @secure
|
|
4651
|
+
*/
|
|
4652
|
+
transferStatus(account: string, query?: {
|
|
4653
|
+
/** INCOMING|OUTGOING */
|
|
4654
|
+
direction?: any;
|
|
4655
|
+
/** ACH|WIRE|CHECK|Bank|CustodyJournal|ALL */
|
|
4656
|
+
mechanism?: any;
|
|
4657
|
+
/** MM/DD/YYYY */
|
|
4658
|
+
dateFrom?: any;
|
|
4659
|
+
/** MM/DD/YYYY */
|
|
4660
|
+
dateTo?: any;
|
|
4661
|
+
/** Overrides `dateFrom` and `dateTo`. See description. */
|
|
4662
|
+
range?: any;
|
|
4663
|
+
start?: any;
|
|
4664
|
+
perPage?: any;
|
|
4665
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4666
|
+
/**
|
|
4667
|
+
* @tags Transfers
|
|
4668
|
+
* @name TransferStatusModel
|
|
4669
|
+
* @summary Transfer Status Model
|
|
4670
|
+
* @request GET:/transfer/status/model/{modelId}
|
|
4671
|
+
* @secure
|
|
4672
|
+
*/
|
|
4673
|
+
transferStatusModel(modelId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4674
|
+
/**
|
|
4675
|
+
* @tags Transfers
|
|
4676
|
+
* @name TransferStatusBranch
|
|
4677
|
+
* @summary Transfer Status Branch
|
|
4678
|
+
* @request GET:/transfer/status/branch
|
|
4679
|
+
* @secure
|
|
4680
|
+
*/
|
|
4681
|
+
transferStatusBranch(query?: {
|
|
4682
|
+
/**
|
|
4683
|
+
* INCOMING|OUTGOING|ALL
|
|
4684
|
+
* @example "ALL"
|
|
4685
|
+
*/
|
|
4686
|
+
direction?: any;
|
|
4687
|
+
/**
|
|
4688
|
+
* ACH|WIRE|CHECK|Bank|CustodyJournal
|
|
4689
|
+
* @example "ALL"
|
|
4690
|
+
*/
|
|
4691
|
+
mechanism?: any;
|
|
4692
|
+
dateFrom?: any;
|
|
4693
|
+
dateTo?: any;
|
|
4694
|
+
/** Per regex: \d+[ymdw]$ (will override `dateFrom` and `dateTo`) */
|
|
4695
|
+
range?: any;
|
|
4696
|
+
start?: any;
|
|
4697
|
+
perPage?: any;
|
|
4698
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4699
|
+
/**
|
|
4700
|
+
* @tags Transfers
|
|
4701
|
+
* @name AmountAvailable
|
|
4702
|
+
* @summary Amount Available
|
|
4703
|
+
* @request GET:/transfer/available/{account}
|
|
4704
|
+
* @secure
|
|
4705
|
+
*/
|
|
4706
|
+
amountAvailable(account: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4707
|
+
/**
|
|
4708
|
+
* @tags Transfers
|
|
4709
|
+
* @name LegalDocumentTypes
|
|
4710
|
+
* @summary Legal document types
|
|
4711
|
+
* @request GET:/transfer/legal/types
|
|
4712
|
+
* @secure
|
|
4713
|
+
*/
|
|
4714
|
+
legalDocumentTypes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4715
|
+
/**
|
|
4716
|
+
* @tags Transfers
|
|
4717
|
+
* @name LegalDocument
|
|
4718
|
+
* @summary Legal document
|
|
4719
|
+
* @request GET:/transfer/legal/content
|
|
4720
|
+
* @secure
|
|
4721
|
+
*/
|
|
4722
|
+
legalDocument(query?: {
|
|
4723
|
+
/** Unique ID given in the types endpoint */
|
|
4724
|
+
id?: any;
|
|
4725
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4726
|
+
/**
|
|
4727
|
+
* @tags Transfers
|
|
4728
|
+
* @name Cancel
|
|
4729
|
+
* @summary Cancel
|
|
4730
|
+
* @request POST:/transfer/ach/cancel
|
|
4731
|
+
* @secure
|
|
4732
|
+
*/
|
|
4733
|
+
cancel(data: {
|
|
4734
|
+
/** @example "5VA0XXXX" */
|
|
4735
|
+
account?: any;
|
|
4736
|
+
/** @example "0.0.0.0" */
|
|
4737
|
+
remoteAddr?: any;
|
|
4738
|
+
/** @example "ultra fast browser 1.1" */
|
|
4739
|
+
remoteDevice?: any;
|
|
4740
|
+
/** @example "CC123456" */
|
|
4741
|
+
transferId?: any;
|
|
4742
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4743
|
+
/**
|
|
4744
|
+
* @tags Transfers
|
|
4745
|
+
* @name FeesAndCredits
|
|
4746
|
+
* @summary Fees and Credits
|
|
4747
|
+
* @request POST:/transfer/fees/apply
|
|
4748
|
+
* @secure
|
|
4749
|
+
*/
|
|
4750
|
+
feesAndCredits(data: {
|
|
4751
|
+
/** @example "5VA0XXXX" */
|
|
4752
|
+
account?: any;
|
|
4753
|
+
/** @example 100 */
|
|
4754
|
+
amount?: any;
|
|
4755
|
+
/** @example "FeeReversal|Promotion|WriteOff|Rebate|Courtesy|Advisory|Management|Admin|Exchange|Tech|Platform|Inactivity|MarginInterest|Custodian|CryptoGift" */
|
|
4756
|
+
classification?: any;
|
|
4757
|
+
/** @example "" */
|
|
4758
|
+
contraNote?: any;
|
|
4759
|
+
/** @example "USD" */
|
|
4760
|
+
currency?: any;
|
|
4761
|
+
/** @example "" */
|
|
4762
|
+
note?: any;
|
|
4763
|
+
/** @example 0.01 */
|
|
4764
|
+
quantity?: any;
|
|
4765
|
+
/** @example "0.0.0.0" */
|
|
4766
|
+
remoteAddr?: any;
|
|
4767
|
+
/** @example "ultra fast browser 1.1" */
|
|
4768
|
+
remoteDevice?: any;
|
|
4769
|
+
/** @example "BTC/USD" */
|
|
4770
|
+
symbol?: any;
|
|
4771
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4772
|
+
/**
|
|
4773
|
+
* @tags Transfers
|
|
4774
|
+
* @name ListFees
|
|
4775
|
+
* @summary List fees
|
|
4776
|
+
* @request GET:/transfer/fees/classifications/fees
|
|
4777
|
+
* @secure
|
|
4778
|
+
*/
|
|
4779
|
+
listFees(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4780
|
+
/**
|
|
4781
|
+
* @tags Transfers
|
|
4782
|
+
* @name ListCredits
|
|
4783
|
+
* @summary List credits
|
|
4784
|
+
* @request GET:/transfer/fees/classifications/credits
|
|
4785
|
+
* @secure
|
|
4786
|
+
*/
|
|
4787
|
+
listCredits(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4788
|
+
/**
|
|
4789
|
+
* @tags Transfers
|
|
4790
|
+
* @name CryptoDepositAddress
|
|
4791
|
+
* @summary Crypto Deposit Address
|
|
4792
|
+
* @request GET:/transfer/crypto/deposit/wallet/address
|
|
4793
|
+
* @secure
|
|
4794
|
+
*/
|
|
4795
|
+
cryptoDepositAddress(data: {
|
|
4796
|
+
/** @example "AB123456" */
|
|
4797
|
+
account?: any;
|
|
4798
|
+
/** @example "BTC" */
|
|
4562
4799
|
currency?: any;
|
|
4563
|
-
/** @example "
|
|
4564
|
-
|
|
4565
|
-
/** @example "Droid Phone" */
|
|
4566
|
-
remoteDevice?: any;
|
|
4800
|
+
/** @example "{optional}" */
|
|
4801
|
+
network?: any;
|
|
4567
4802
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4568
4803
|
/**
|
|
4569
|
-
* @tags Transfers
|
|
4570
|
-
* @name
|
|
4571
|
-
* @summary
|
|
4572
|
-
* @request POST:/transfer/
|
|
4804
|
+
* @tags Transfers
|
|
4805
|
+
* @name CryptoWithdrawalEstimate
|
|
4806
|
+
* @summary Crypto Withdrawal Estimate
|
|
4807
|
+
* @request POST:/transfer/crypto/withdrawal/estimate
|
|
4573
4808
|
* @secure
|
|
4574
4809
|
*/
|
|
4575
|
-
|
|
4576
|
-
/** @example "
|
|
4577
|
-
|
|
4578
|
-
/** @example "
|
|
4579
|
-
|
|
4810
|
+
cryptoWithdrawalEstimate(data: {
|
|
4811
|
+
/** @example "BTC" */
|
|
4812
|
+
currency?: any;
|
|
4813
|
+
/** @example "{optional}" */
|
|
4814
|
+
network?: any;
|
|
4815
|
+
/** @example "0.1" */
|
|
4816
|
+
quantity?: any;
|
|
4817
|
+
/** @example "{optional}" */
|
|
4818
|
+
wallet?: any;
|
|
4580
4819
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4581
4820
|
/**
|
|
4582
|
-
* @tags Transfers
|
|
4583
|
-
* @name
|
|
4584
|
-
* @summary
|
|
4585
|
-
* @request
|
|
4821
|
+
* @tags Transfers
|
|
4822
|
+
* @name CryptoWithdrawal
|
|
4823
|
+
* @summary Crypto Withdrawal
|
|
4824
|
+
* @request POST:/transfer/crypto/withdraw
|
|
4586
4825
|
* @secure
|
|
4587
4826
|
*/
|
|
4588
|
-
|
|
4827
|
+
cryptoWithdrawal(data: {
|
|
4828
|
+
/** @example "AB123456" */
|
|
4829
|
+
account?: any;
|
|
4830
|
+
/** @example "BTC" */
|
|
4831
|
+
currency?: any;
|
|
4832
|
+
/** @example "{optional}" */
|
|
4833
|
+
estimateExtension?: any;
|
|
4834
|
+
/** @example "abc123" */
|
|
4835
|
+
estimateId?: any;
|
|
4836
|
+
/** @example "{optional}" */
|
|
4837
|
+
network?: any;
|
|
4838
|
+
/** @example 0.1 */
|
|
4839
|
+
quantity?: any;
|
|
4840
|
+
/** @example "{conditional}" */
|
|
4841
|
+
recipientFirstName?: any;
|
|
4842
|
+
/** @example "{conditional}" */
|
|
4843
|
+
recipientLastName?: any;
|
|
4844
|
+
/** @example "{optional} 1.1.1.1" */
|
|
4845
|
+
remoteAddr?: any;
|
|
4846
|
+
/** @example "{optional} Some phone" */
|
|
4847
|
+
remoteDevice?: any;
|
|
4848
|
+
/** @example "{optional} true|false" */
|
|
4849
|
+
selfHosted?: any;
|
|
4850
|
+
/** @example "{optional}" */
|
|
4851
|
+
tag?: any;
|
|
4852
|
+
/** @example "{conditional}" */
|
|
4853
|
+
vaspName?: any;
|
|
4854
|
+
/** @example "wallet address" */
|
|
4855
|
+
wallet?: any;
|
|
4856
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4589
4857
|
}
|
|
4590
4858
|
export class Documents<HandleError extends boolean = boolean> {
|
|
4591
4859
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -4810,359 +5078,113 @@ export class Miscellaneous<HandleError extends boolean = boolean> {
|
|
|
4810
5078
|
*/
|
|
4811
5079
|
filesUserAvatarUpload(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4812
5080
|
/**
|
|
4813
|
-
* @tags Miscellaneous
|
|
4814
|
-
* @name FilesUpload
|
|
4815
|
-
* @request POST:/v1/files/upload
|
|
4816
|
-
* @secure
|
|
4817
|
-
*/
|
|
4818
|
-
filesUpload(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4819
|
-
/**
|
|
4820
|
-
* @tags Miscellaneous
|
|
4821
|
-
* @name FilesUploadAvatar
|
|
4822
|
-
* @request POST:/v1/files/upload/avatar/{userId}
|
|
4823
|
-
* @secure
|
|
4824
|
-
*/
|
|
4825
|
-
filesUploadAvatar(userId: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4826
|
-
/**
|
|
4827
|
-
* @tags Miscellaneous
|
|
4828
|
-
* @name FilesUserAvatar
|
|
4829
|
-
* @request GET:/v1/files/user/avatar
|
|
4830
|
-
* @secure
|
|
4831
|
-
*/
|
|
4832
|
-
filesUserAvatar(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4833
|
-
/**
|
|
4834
|
-
* @tags Miscellaneous
|
|
4835
|
-
* @name FilesAvatar
|
|
4836
|
-
* @request GET:/v1/files/{userId}/avatar
|
|
4837
|
-
* @secure
|
|
4838
|
-
*/
|
|
4839
|
-
filesAvatar(userId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4840
|
-
/**
|
|
4841
|
-
* @tags Miscellaneous
|
|
4842
|
-
* @name FilesDownload
|
|
4843
|
-
* @request GET:/v1/files/download/{tag}/{id}
|
|
4844
|
-
* @secure
|
|
4845
|
-
*/
|
|
4846
|
-
filesDownload(tag: string, id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4847
|
-
/**
|
|
4848
|
-
* @tags Miscellaneous
|
|
4849
|
-
* @name FilesList
|
|
4850
|
-
* @request GET:/v1/files/list
|
|
4851
|
-
* @secure
|
|
4852
|
-
*/
|
|
4853
|
-
filesList(query?: {
|
|
4854
|
-
/**
|
|
4855
|
-
* Optional. Allows filtering for tags
|
|
4856
|
-
* @example "document*"
|
|
4857
|
-
*/
|
|
4858
|
-
tag?: any;
|
|
4859
|
-
/**
|
|
4860
|
-
* Optional. Allows filtering for filenames
|
|
4861
|
-
* @example "application*"
|
|
4862
|
-
*/
|
|
4863
|
-
filename?: any;
|
|
4864
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4865
|
-
/**
|
|
4866
|
-
* @tags Miscellaneous
|
|
4867
|
-
* @name FilesAllowedExts
|
|
4868
|
-
* @request GET:/v1/files/allowed/exts
|
|
4869
|
-
* @secure
|
|
4870
|
-
*/
|
|
4871
|
-
filesAllowedExts(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4872
|
-
/**
|
|
4873
|
-
* @tags Miscellaneous
|
|
4874
|
-
* @name ErrorCodeListing
|
|
4875
|
-
* @summary Error code listing
|
|
4876
|
-
* @request GET:/general/errors
|
|
4877
|
-
* @secure
|
|
4878
|
-
*/
|
|
4879
|
-
errorCodeListing(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4880
|
-
/**
|
|
4881
|
-
* @tags Miscellaneous
|
|
4882
|
-
* @name Ping
|
|
4883
|
-
* @summary Ping
|
|
4884
|
-
* @request GET:/general/ping
|
|
4885
|
-
* @secure
|
|
4886
|
-
*/
|
|
4887
|
-
ping(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4888
|
-
/**
|
|
4889
|
-
* @tags Miscellaneous
|
|
4890
|
-
* @name CurrencyList
|
|
4891
|
-
* @summary Currency list
|
|
4892
|
-
* @request GET:/general/available-currencies
|
|
4893
|
-
* @secure
|
|
4894
|
-
*/
|
|
4895
|
-
currencyList(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4896
|
-
/**
|
|
4897
|
-
* @tags Miscellaneous
|
|
4898
|
-
* @name TradableCurrencyList
|
|
4899
|
-
* @summary Tradable currency list
|
|
4900
|
-
* @request GET:/general/tradable-currencies
|
|
4901
|
-
* @secure
|
|
4902
|
-
*/
|
|
4903
|
-
tradableCurrencyList(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4904
|
-
/**
|
|
4905
|
-
* @tags Miscellaneous
|
|
4906
|
-
* @name OptionStrategyTypes
|
|
4907
|
-
* @summary Option Strategy Types
|
|
4908
|
-
* @request GET:/general/options/strategyTypes
|
|
4909
|
-
* @secure
|
|
4910
|
-
*/
|
|
4911
|
-
optionStrategyTypes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4912
|
-
/**
|
|
4913
|
-
* @tags Miscellaneous
|
|
4914
|
-
* @name OptionStrategyClassifications
|
|
4915
|
-
* @summary Option Strategy Classifications
|
|
4916
|
-
* @request GET:/general/options/strategyClassifications
|
|
4917
|
-
* @secure
|
|
4918
|
-
*/
|
|
4919
|
-
optionStrategyClassifications(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4920
|
-
}
|
|
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>>;
|
|
5081
|
+
* @tags Miscellaneous
|
|
5082
|
+
* @name FilesUpload
|
|
5083
|
+
* @request POST:/v1/files/upload
|
|
5084
|
+
* @secure
|
|
5085
|
+
*/
|
|
5086
|
+
filesUpload(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4975
5087
|
/**
|
|
4976
|
-
* @tags
|
|
4977
|
-
* @name
|
|
4978
|
-
* @
|
|
4979
|
-
* @request GET:/transfer/status/model/{modelId}
|
|
5088
|
+
* @tags Miscellaneous
|
|
5089
|
+
* @name FilesUploadAvatar
|
|
5090
|
+
* @request POST:/v1/files/upload/avatar/{userId}
|
|
4980
5091
|
* @secure
|
|
4981
5092
|
*/
|
|
4982
|
-
|
|
5093
|
+
filesUploadAvatar(userId: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4983
5094
|
/**
|
|
4984
|
-
* @tags
|
|
4985
|
-
* @name
|
|
4986
|
-
* @
|
|
4987
|
-
* @request GET:/transfer/status/branch
|
|
5095
|
+
* @tags Miscellaneous
|
|
5096
|
+
* @name FilesUserAvatar
|
|
5097
|
+
* @request GET:/v1/files/user/avatar
|
|
4988
5098
|
* @secure
|
|
4989
5099
|
*/
|
|
4990
|
-
|
|
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>>;
|
|
5100
|
+
filesUserAvatar(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5008
5101
|
/**
|
|
5009
|
-
* @tags
|
|
5010
|
-
* @name
|
|
5011
|
-
* @
|
|
5012
|
-
* @request GET:/transfer/available/{account}
|
|
5102
|
+
* @tags Miscellaneous
|
|
5103
|
+
* @name FilesAvatar
|
|
5104
|
+
* @request GET:/v1/files/{userId}/avatar
|
|
5013
5105
|
* @secure
|
|
5014
5106
|
*/
|
|
5015
|
-
|
|
5107
|
+
filesAvatar(userId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5016
5108
|
/**
|
|
5017
|
-
* @tags
|
|
5018
|
-
* @name
|
|
5019
|
-
* @
|
|
5020
|
-
* @request GET:/transfer/legal/types
|
|
5109
|
+
* @tags Miscellaneous
|
|
5110
|
+
* @name FilesDownload
|
|
5111
|
+
* @request GET:/v1/files/download/{tag}/{id}
|
|
5021
5112
|
* @secure
|
|
5022
5113
|
*/
|
|
5023
|
-
|
|
5114
|
+
filesDownload(tag: string, id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5024
5115
|
/**
|
|
5025
|
-
* @tags
|
|
5026
|
-
* @name
|
|
5027
|
-
* @
|
|
5028
|
-
* @request GET:/transfer/legal/content
|
|
5116
|
+
* @tags Miscellaneous
|
|
5117
|
+
* @name FilesList
|
|
5118
|
+
* @request GET:/v1/files/list
|
|
5029
5119
|
* @secure
|
|
5030
5120
|
*/
|
|
5031
|
-
|
|
5032
|
-
/**
|
|
5033
|
-
|
|
5121
|
+
filesList(query?: {
|
|
5122
|
+
/**
|
|
5123
|
+
* Optional. Allows filtering for tags
|
|
5124
|
+
* @example "document*"
|
|
5125
|
+
*/
|
|
5126
|
+
tag?: any;
|
|
5127
|
+
/**
|
|
5128
|
+
* Optional. Allows filtering for filenames
|
|
5129
|
+
* @example "application*"
|
|
5130
|
+
*/
|
|
5131
|
+
filename?: any;
|
|
5034
5132
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5035
5133
|
/**
|
|
5036
|
-
* @tags
|
|
5037
|
-
* @name
|
|
5038
|
-
* @
|
|
5039
|
-
* @request POST:/transfer/ach/cancel
|
|
5134
|
+
* @tags Miscellaneous
|
|
5135
|
+
* @name FilesAllowedExts
|
|
5136
|
+
* @request GET:/v1/files/allowed/exts
|
|
5040
5137
|
* @secure
|
|
5041
5138
|
*/
|
|
5042
|
-
|
|
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>>;
|
|
5139
|
+
filesAllowedExts(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5052
5140
|
/**
|
|
5053
|
-
* @tags
|
|
5054
|
-
* @name
|
|
5055
|
-
* @summary
|
|
5056
|
-
* @request
|
|
5141
|
+
* @tags Miscellaneous
|
|
5142
|
+
* @name ErrorCodeListing
|
|
5143
|
+
* @summary Error code listing
|
|
5144
|
+
* @request GET:/general/errors
|
|
5057
5145
|
* @secure
|
|
5058
5146
|
*/
|
|
5059
|
-
|
|
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>>;
|
|
5147
|
+
errorCodeListing(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5081
5148
|
/**
|
|
5082
|
-
* @tags
|
|
5083
|
-
* @name
|
|
5084
|
-
* @summary
|
|
5085
|
-
* @request GET:/
|
|
5149
|
+
* @tags Miscellaneous
|
|
5150
|
+
* @name Ping
|
|
5151
|
+
* @summary Ping
|
|
5152
|
+
* @request GET:/general/ping
|
|
5086
5153
|
* @secure
|
|
5087
5154
|
*/
|
|
5088
|
-
|
|
5155
|
+
ping(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5089
5156
|
/**
|
|
5090
|
-
* @tags
|
|
5091
|
-
* @name
|
|
5092
|
-
* @summary
|
|
5093
|
-
* @request GET:/
|
|
5157
|
+
* @tags Miscellaneous
|
|
5158
|
+
* @name CurrencyList
|
|
5159
|
+
* @summary Currency list
|
|
5160
|
+
* @request GET:/general/available-currencies
|
|
5094
5161
|
* @secure
|
|
5095
5162
|
*/
|
|
5096
|
-
|
|
5163
|
+
currencyList(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5097
5164
|
/**
|
|
5098
|
-
* @tags
|
|
5099
|
-
* @name
|
|
5100
|
-
* @summary
|
|
5101
|
-
* @request GET:/
|
|
5165
|
+
* @tags Miscellaneous
|
|
5166
|
+
* @name TradableCurrencyList
|
|
5167
|
+
* @summary Tradable currency list
|
|
5168
|
+
* @request GET:/general/tradable-currencies
|
|
5102
5169
|
* @secure
|
|
5103
5170
|
*/
|
|
5104
|
-
|
|
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>>;
|
|
5171
|
+
tradableCurrencyList(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5112
5172
|
/**
|
|
5113
|
-
* @tags
|
|
5114
|
-
* @name
|
|
5115
|
-
* @summary
|
|
5116
|
-
* @request
|
|
5173
|
+
* @tags Miscellaneous
|
|
5174
|
+
* @name OptionStrategyTypes
|
|
5175
|
+
* @summary Option Strategy Types
|
|
5176
|
+
* @request GET:/general/options/strategyTypes
|
|
5117
5177
|
* @secure
|
|
5118
5178
|
*/
|
|
5119
|
-
|
|
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>>;
|
|
5179
|
+
optionStrategyTypes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5129
5180
|
/**
|
|
5130
|
-
* @tags
|
|
5131
|
-
* @name
|
|
5132
|
-
* @summary
|
|
5133
|
-
* @request
|
|
5181
|
+
* @tags Miscellaneous
|
|
5182
|
+
* @name OptionStrategyClassifications
|
|
5183
|
+
* @summary Option Strategy Classifications
|
|
5184
|
+
* @request GET:/general/options/strategyClassifications
|
|
5134
5185
|
* @secure
|
|
5135
5186
|
*/
|
|
5136
|
-
|
|
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>>;
|
|
5187
|
+
optionStrategyClassifications(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5166
5188
|
}
|
|
5167
5189
|
export class Branch<HandleError extends boolean = boolean> {
|
|
5168
5190
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -5850,16 +5872,6 @@ export class WatchmenFfiUserAccountManagement<HandleError extends boolean = bool
|
|
|
5850
5872
|
onlyActiveUser?: any;
|
|
5851
5873
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5852
5874
|
}
|
|
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
5875
|
export class WatchmenFfiFirmBranch<HandleError extends boolean = boolean> {
|
|
5864
5876
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5865
5877
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -6035,23 +6047,15 @@ export class WatchmenFfiFirmBranch<HandleError extends boolean = boolean> {
|
|
|
6035
6047
|
id?: any;
|
|
6036
6048
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
6037
6049
|
}
|
|
6038
|
-
export class
|
|
6050
|
+
export class Advisory<HandleError extends boolean = boolean> {
|
|
6039
6051
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
6052
|
+
charges: AdvisoryCharges<HandleError>;
|
|
6053
|
+
models: AdvisoryModels<HandleError>;
|
|
6054
|
+
userAccountManagement: AdvisoryUserAccountManagement<HandleError>;
|
|
6055
|
+
groups: AdvisoryGroups<HandleError>;
|
|
6056
|
+
analytics: AdvisoryAnalytics<HandleError>;
|
|
6057
|
+
allocations: AdvisoryAllocations<HandleError>;
|
|
6040
6058
|
constructor(apiClient: JwtClient<HandleError>);
|
|
6041
|
-
/**
|
|
6042
|
-
* @tags Device
|
|
6043
|
-
* @name DeviceDeactivate
|
|
6044
|
-
* @summary /device/deactivate
|
|
6045
|
-
* @request POST:/device/deactivate
|
|
6046
|
-
* @secure
|
|
6047
|
-
*/
|
|
6048
|
-
deviceDeactivate(data: {
|
|
6049
|
-
/**
|
|
6050
|
-
* Token previously registered
|
|
6051
|
-
* @example "123456789"
|
|
6052
|
-
*/
|
|
6053
|
-
Token?: string;
|
|
6054
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
6055
6059
|
}
|
|
6056
6060
|
export class WatchmenFfi<HandleError extends boolean = boolean> {
|
|
6057
6061
|
protected readonly apiClient: JwtClient<HandleError>;
|