@orbis-systems/orbis-api-clients 0.7.9 → 0.7.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (43) hide show
  1. package/dist/aesmidas/index.d.ts +136 -127
  2. package/dist/aesmidas/index.d.ts.map +1 -1
  3. package/dist/aesmidas/index.esm.js +1 -1
  4. package/dist/aesmidas/index.esm.js.map +1 -1
  5. package/dist/aesmidas/index.js +1 -1
  6. package/dist/aesmidas/index.js.map +1 -1
  7. package/dist/bridgewise/index.d.ts +473 -464
  8. package/dist/bridgewise/index.d.ts.map +1 -1
  9. package/dist/bridgewise/index.esm.js +1 -1
  10. package/dist/bridgewise/index.esm.js.map +1 -1
  11. package/dist/bridgewise/index.js +1 -1
  12. package/dist/bridgewise/index.js.map +1 -1
  13. package/dist/insight/index.d.ts +440 -355
  14. package/dist/insight/index.d.ts.map +1 -1
  15. package/dist/insight/index.esm.js +1 -1
  16. package/dist/insight/index.esm.js.map +1 -1
  17. package/dist/insight/index.js +1 -1
  18. package/dist/insight/index.js.map +1 -1
  19. package/dist/middleware/index.d.ts +34 -34
  20. package/dist/middleware/index.d.ts.map +1 -1
  21. package/dist/middleware/index.esm.js +1 -1
  22. package/dist/middleware/index.esm.js.map +1 -1
  23. package/dist/middleware/index.js +1 -1
  24. package/dist/middleware/index.js.map +1 -1
  25. package/dist/orbis/index.d.ts +845 -845
  26. package/dist/orbis/index.d.ts.map +1 -1
  27. package/dist/orbis/index.esm.js +1 -1
  28. package/dist/orbis/index.esm.js.map +1 -1
  29. package/dist/orbis/index.js +1 -1
  30. package/dist/orbis/index.js.map +1 -1
  31. package/dist/uma/index.d.ts +379 -379
  32. package/dist/uma/index.d.ts.map +1 -1
  33. package/dist/uma/index.esm.js +1 -1
  34. package/dist/uma/index.esm.js.map +1 -1
  35. package/dist/uma/index.js +1 -1
  36. package/dist/uma/index.js.map +1 -1
  37. package/dist/zerohash/index.d.ts +142 -142
  38. package/dist/zerohash/index.d.ts.map +1 -1
  39. package/dist/zerohash/index.esm.js +1 -1
  40. package/dist/zerohash/index.esm.js.map +1 -1
  41. package/dist/zerohash/index.js +1 -1
  42. package/dist/zerohash/index.js.map +1 -1
  43. package/package.json +1 -1
@@ -2343,50 +2343,6 @@ export class Research<HandleError extends boolean = boolean> {
2343
2343
  dates?: any;
2344
2344
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2345
2345
  }
2346
- export class UserWatchlists<HandleError extends boolean = boolean> {
2347
- protected readonly apiClient: JwtClient<HandleError>;
2348
- constructor(apiClient: JwtClient<HandleError>);
2349
- /**
2350
- * @tags User Watchlists
2351
- * @name CreateWatchlist
2352
- * @summary Create Watchlist
2353
- * @request POST:/user/v2/watchlist/create
2354
- * @secure
2355
- */
2356
- createWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2357
- /**
2358
- * @tags User Watchlists
2359
- * @name RenameWatchlist
2360
- * @summary Rename Watchlist
2361
- * @request POST:/user/v2/watchlist/rename
2362
- * @secure
2363
- */
2364
- renameWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2365
- /**
2366
- * @tags User Watchlists
2367
- * @name DeleteWatchlist
2368
- * @summary Delete Watchlist
2369
- * @request POST:/user/v2/watchlist/delete
2370
- * @secure
2371
- */
2372
- deleteWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2373
- /**
2374
- * @tags User Watchlists
2375
- * @name AddToWatchlist
2376
- * @summary Add to Watchlist
2377
- * @request POST:/user/v2/watchlist/addEntry
2378
- * @secure
2379
- */
2380
- addToWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2381
- /**
2382
- * @tags User Watchlists
2383
- * @name RemoveFromWatchlist
2384
- * @summary Remove from Watchlist
2385
- * @request POST:/user/v2/watchlist/removeEntry
2386
- * @secure
2387
- */
2388
- removeFromWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2389
- }
2390
2346
  export class UserDevice<HandleError extends boolean = boolean> {
2391
2347
  protected readonly apiClient: JwtClient<HandleError>;
2392
2348
  constructor(apiClient: JwtClient<HandleError>);
@@ -2433,66 +2389,6 @@ export class UserDevice<HandleError extends boolean = boolean> {
2433
2389
  token?: any;
2434
2390
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2435
2391
  }
2436
- export class UserAgreements<HandleError extends boolean = boolean> {
2437
- protected readonly apiClient: JwtClient<HandleError>;
2438
- constructor(apiClient: JwtClient<HandleError>);
2439
- /**
2440
- * @tags User Agreements
2441
- * @name Available
2442
- * @summary Available
2443
- * @request GET:/user/agreements/all/active
2444
- * @secure
2445
- */
2446
- available(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2447
- /**
2448
- * @tags User Agreements
2449
- * @name Agreement
2450
- * @summary Agreement
2451
- * @request GET:/user/agreements/contents/{version}/{code}/body.html
2452
- * @secure
2453
- */
2454
- agreement(version: string, code: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2455
- /**
2456
- * @tags User Agreements
2457
- * @name Unsigned
2458
- * @summary Unsigned
2459
- * @request GET:/user/agreements/unsigned
2460
- * @secure
2461
- */
2462
- unsigned(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2463
- /**
2464
- * @tags User Agreements
2465
- * @name AttestStatus
2466
- * @summary Attest status
2467
- * @request POST:/user/professional/attest
2468
- * @secure
2469
- */
2470
- attestStatus(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2471
- /**
2472
- * @tags User Agreements
2473
- * @name Sign
2474
- * @summary Sign
2475
- * @request POST:/user/agreements/sign
2476
- * @secure
2477
- */
2478
- sign(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2479
- /**
2480
- * @tags User Agreements
2481
- * @name CryptoAgreement
2482
- * @summary Crypto Agreement
2483
- * @request GET:/user/agreements/crypto/Agreement
2484
- * @secure
2485
- */
2486
- cryptoAgreement(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2487
- /**
2488
- * @tags User Agreements
2489
- * @name CryptoSign
2490
- * @summary Crypto Sign
2491
- * @request POST:/user/agreements/crypto/sign
2492
- * @secure
2493
- */
2494
- cryptoSign(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2495
- }
2496
2392
  export class UserTradingLimitManagement<HandleError extends boolean = boolean> {
2497
2393
  protected readonly apiClient: JwtClient<HandleError>;
2498
2394
  constructor(apiClient: JwtClient<HandleError>);
@@ -2595,6 +2491,110 @@ export class UserProfitLoss<HandleError extends boolean = boolean> {
2595
2491
  requestId?: any;
2596
2492
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2597
2493
  }
2494
+ export class UserWatchlists<HandleError extends boolean = boolean> {
2495
+ protected readonly apiClient: JwtClient<HandleError>;
2496
+ constructor(apiClient: JwtClient<HandleError>);
2497
+ /**
2498
+ * @tags User Watchlists
2499
+ * @name CreateWatchlist
2500
+ * @summary Create Watchlist
2501
+ * @request POST:/user/v2/watchlist/create
2502
+ * @secure
2503
+ */
2504
+ createWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2505
+ /**
2506
+ * @tags User Watchlists
2507
+ * @name RenameWatchlist
2508
+ * @summary Rename Watchlist
2509
+ * @request POST:/user/v2/watchlist/rename
2510
+ * @secure
2511
+ */
2512
+ renameWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2513
+ /**
2514
+ * @tags User Watchlists
2515
+ * @name DeleteWatchlist
2516
+ * @summary Delete Watchlist
2517
+ * @request POST:/user/v2/watchlist/delete
2518
+ * @secure
2519
+ */
2520
+ deleteWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2521
+ /**
2522
+ * @tags User Watchlists
2523
+ * @name AddToWatchlist
2524
+ * @summary Add to Watchlist
2525
+ * @request POST:/user/v2/watchlist/addEntry
2526
+ * @secure
2527
+ */
2528
+ addToWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2529
+ /**
2530
+ * @tags User Watchlists
2531
+ * @name RemoveFromWatchlist
2532
+ * @summary Remove from Watchlist
2533
+ * @request POST:/user/v2/watchlist/removeEntry
2534
+ * @secure
2535
+ */
2536
+ removeFromWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2537
+ }
2538
+ export class UserAgreements<HandleError extends boolean = boolean> {
2539
+ protected readonly apiClient: JwtClient<HandleError>;
2540
+ constructor(apiClient: JwtClient<HandleError>);
2541
+ /**
2542
+ * @tags User Agreements
2543
+ * @name Available
2544
+ * @summary Available
2545
+ * @request GET:/user/agreements/all/active
2546
+ * @secure
2547
+ */
2548
+ available(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2549
+ /**
2550
+ * @tags User Agreements
2551
+ * @name Agreement
2552
+ * @summary Agreement
2553
+ * @request GET:/user/agreements/contents/{version}/{code}/body.html
2554
+ * @secure
2555
+ */
2556
+ agreement(version: string, code: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2557
+ /**
2558
+ * @tags User Agreements
2559
+ * @name Unsigned
2560
+ * @summary Unsigned
2561
+ * @request GET:/user/agreements/unsigned
2562
+ * @secure
2563
+ */
2564
+ unsigned(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2565
+ /**
2566
+ * @tags User Agreements
2567
+ * @name AttestStatus
2568
+ * @summary Attest status
2569
+ * @request POST:/user/professional/attest
2570
+ * @secure
2571
+ */
2572
+ attestStatus(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2573
+ /**
2574
+ * @tags User Agreements
2575
+ * @name Sign
2576
+ * @summary Sign
2577
+ * @request POST:/user/agreements/sign
2578
+ * @secure
2579
+ */
2580
+ sign(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2581
+ /**
2582
+ * @tags User Agreements
2583
+ * @name CryptoAgreement
2584
+ * @summary Crypto Agreement
2585
+ * @request GET:/user/agreements/crypto/Agreement
2586
+ * @secure
2587
+ */
2588
+ cryptoAgreement(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2589
+ /**
2590
+ * @tags User Agreements
2591
+ * @name CryptoSign
2592
+ * @summary Crypto Sign
2593
+ * @request POST:/user/agreements/crypto/sign
2594
+ * @secure
2595
+ */
2596
+ cryptoSign(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2597
+ }
2598
2598
  export class User<HandleError extends boolean = boolean> {
2599
2599
  protected readonly apiClient: JwtClient<HandleError>;
2600
2600
  watchlists: UserWatchlists<HandleError>;
@@ -3631,127 +3631,50 @@ export class AdvisoryUserAccountManagement<HandleError extends boolean = boolean
3631
3631
  */
3632
3632
  notesPost(action: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3633
3633
  }
3634
- export class AdvisoryGroups<HandleError extends boolean = boolean> {
3634
+ export class AdvisoryAnalytics<HandleError extends boolean = boolean> {
3635
3635
  protected readonly apiClient: JwtClient<HandleError>;
3636
3636
  constructor(apiClient: JwtClient<HandleError>);
3637
3637
  /**
3638
- * @tags Advisory Groups
3639
- * @name GroupsManage
3640
- * @request POST:/v1/groups/manage/{action}
3638
+ * @tags Advisory Analytics
3639
+ * @name OverexposureAnalysis
3640
+ * @summary Overexposure analysis
3641
+ * @request GET:/v2/advisory/analytics/overexposure/{type}/{scope}/{id}
3641
3642
  * @secure
3642
3643
  */
3643
- groupsManage(action: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3644
+ overexposureAnalysis(type: string, scope: string, id: string, query?: {
3645
+ /**
3646
+ * Threshold of 70% or greater
3647
+ * @example ".7"
3648
+ */
3649
+ threshold?: any;
3650
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3644
3651
  /**
3645
- * @tags Advisory Groups
3646
- * @name GroupsList
3647
- * @request GET:/v1/groups/list
3652
+ * @tags Advisory Analytics
3653
+ * @name RealtimeBalanceBreakdown
3654
+ * @summary Realtime balance breakdown
3655
+ * @request GET:/v2/advisory/analytics/breakdown/rtbs/{modelId}
3648
3656
  * @secure
3649
3657
  */
3650
- groupsList(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3658
+ realtimeBalanceBreakdown(modelId: string, query?: {
3659
+ /**
3660
+ * Bucket size
3661
+ * @example "10000"
3662
+ */
3663
+ bucket?: any;
3664
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3651
3665
  /**
3652
- * @tags Advisory Groups
3653
- * @name GroupAccountsStats
3654
- * @request GET:/v2/advisory/group/accounts/stats/{groupsId}
3666
+ * @tags Advisory Analytics
3667
+ * @name ModelPerformance
3668
+ * @summary Model performance
3669
+ * @request GET:/v2/advisory/analytics/model/performance/{modelId}/{range}
3655
3670
  * @secure
3656
3671
  */
3657
- groupAccountsStats(groupsId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3672
+ modelPerformance(modelId: string, range: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3658
3673
  /**
3659
- * @tags Advisory Groups
3660
- * @name GroupPortfolios
3661
- * @request GET:/v2/advisory/group/portfolios/{groupId}
3662
- * @secure
3663
- */
3664
- groupPortfolios(groupId: string, query?: {
3665
- /**
3666
- * Should load quotes or not.
3667
- * @example "false"
3668
- */
3669
- loadQuotes?: any;
3670
- /**
3671
- * Whether to return combined portfolio (no accounts, with approximate prices)
3672
- * @example "false"
3673
- */
3674
- combined?: any;
3675
- /** @example "false" */
3676
- loadIndustries?: any;
3677
- /** @example "false" */
3678
- loadUpgrades?: any;
3679
- /** @example "false" */
3680
- loadEarnings?: any;
3681
- /**
3682
- * Whether or not to include orders comprising each position's cost
3683
- * @example "false"
3684
- */
3685
- loadCost?: any;
3686
- /**
3687
- * Analyze market caps and get `marketCapWeights`. To be used in conjuction with `loadQuotes`
3688
- * @example "false"
3689
- */
3690
- marketCapWeights?: any;
3691
- /** @example "1" */
3692
- pageNum?: any;
3693
- /** @example "100" */
3694
- pageSize?: any;
3695
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3696
- /**
3697
- * @tags Advisory Groups
3698
- * @name GroupRtb
3699
- * @request GET:/v2/advisory/group/rtb/{groupId}
3700
- * @secure
3701
- */
3702
- groupRtb(groupId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3703
- /**
3704
- * @tags Advisory Groups
3705
- * @name GroupRtbs
3706
- * @request GET:/v2/advisory/group/rtbs/{groupId}
3707
- * @secure
3708
- */
3709
- groupRtbs(groupId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3710
- }
3711
- export class AdvisoryAnalytics<HandleError extends boolean = boolean> {
3712
- protected readonly apiClient: JwtClient<HandleError>;
3713
- constructor(apiClient: JwtClient<HandleError>);
3714
- /**
3715
- * @tags Advisory Analytics
3716
- * @name OverexposureAnalysis
3717
- * @summary Overexposure analysis
3718
- * @request GET:/v2/advisory/analytics/overexposure/{type}/{scope}/{id}
3719
- * @secure
3720
- */
3721
- overexposureAnalysis(type: string, scope: string, id: string, query?: {
3722
- /**
3723
- * Threshold of 70% or greater
3724
- * @example ".7"
3725
- */
3726
- threshold?: any;
3727
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3728
- /**
3729
- * @tags Advisory Analytics
3730
- * @name RealtimeBalanceBreakdown
3731
- * @summary Realtime balance breakdown
3732
- * @request GET:/v2/advisory/analytics/breakdown/rtbs/{modelId}
3733
- * @secure
3734
- */
3735
- realtimeBalanceBreakdown(modelId: string, query?: {
3736
- /**
3737
- * Bucket size
3738
- * @example "10000"
3739
- */
3740
- bucket?: any;
3741
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3742
- /**
3743
- * @tags Advisory Analytics
3744
- * @name ModelPerformance
3745
- * @summary Model performance
3746
- * @request GET:/v2/advisory/analytics/model/performance/{modelId}/{range}
3747
- * @secure
3748
- */
3749
- modelPerformance(modelId: string, range: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3750
- /**
3751
- * @tags Advisory Analytics
3752
- * @name ModelDriftReport
3753
- * @summary Model drift report
3754
- * @request GET:/v2/advisory/analytics/model/drift/{modelId}
3674
+ * @tags Advisory Analytics
3675
+ * @name ModelDriftReport
3676
+ * @summary Model drift report
3677
+ * @request GET:/v2/advisory/analytics/model/drift/{modelId}
3755
3678
  * @secure
3756
3679
  */
3757
3680
  modelDriftReport(modelId: string, query?: {
@@ -3814,24 +3737,6 @@ export class AdvisoryAllocations<HandleError extends boolean = boolean> {
3814
3737
  */
3815
3738
  trigger(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3816
3739
  }
3817
- export class Device<HandleError extends boolean = boolean> {
3818
- protected readonly apiClient: JwtClient<HandleError>;
3819
- constructor(apiClient: JwtClient<HandleError>);
3820
- /**
3821
- * @tags Device
3822
- * @name DeviceDeactivate
3823
- * @summary /device/deactivate
3824
- * @request POST:/device/deactivate
3825
- * @secure
3826
- */
3827
- deviceDeactivate(data: {
3828
- /**
3829
- * Token previously registered
3830
- * @example "123456789"
3831
- */
3832
- Token?: string;
3833
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3834
- }
3835
3740
  export class TransfersRelationships<HandleError extends boolean = boolean> {
3836
3741
  protected readonly apiClient: JwtClient<HandleError>;
3837
3742
  constructor(apiClient: JwtClient<HandleError>);
@@ -4076,6 +3981,83 @@ export class TransfersRelationships<HandleError extends boolean = boolean> {
4076
3981
  };
4077
3982
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4078
3983
  }
3984
+ export class AdvisoryGroups<HandleError extends boolean = boolean> {
3985
+ protected readonly apiClient: JwtClient<HandleError>;
3986
+ constructor(apiClient: JwtClient<HandleError>);
3987
+ /**
3988
+ * @tags Advisory Groups
3989
+ * @name GroupsManage
3990
+ * @request POST:/v1/groups/manage/{action}
3991
+ * @secure
3992
+ */
3993
+ groupsManage(action: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3994
+ /**
3995
+ * @tags Advisory Groups
3996
+ * @name GroupsList
3997
+ * @request GET:/v1/groups/list
3998
+ * @secure
3999
+ */
4000
+ groupsList(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4001
+ /**
4002
+ * @tags Advisory Groups
4003
+ * @name GroupAccountsStats
4004
+ * @request GET:/v2/advisory/group/accounts/stats/{groupsId}
4005
+ * @secure
4006
+ */
4007
+ groupAccountsStats(groupsId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4008
+ /**
4009
+ * @tags Advisory Groups
4010
+ * @name GroupPortfolios
4011
+ * @request GET:/v2/advisory/group/portfolios/{groupId}
4012
+ * @secure
4013
+ */
4014
+ groupPortfolios(groupId: string, query?: {
4015
+ /**
4016
+ * Should load quotes or not.
4017
+ * @example "false"
4018
+ */
4019
+ loadQuotes?: any;
4020
+ /**
4021
+ * Whether to return combined portfolio (no accounts, with approximate prices)
4022
+ * @example "false"
4023
+ */
4024
+ combined?: any;
4025
+ /** @example "false" */
4026
+ loadIndustries?: any;
4027
+ /** @example "false" */
4028
+ loadUpgrades?: any;
4029
+ /** @example "false" */
4030
+ loadEarnings?: any;
4031
+ /**
4032
+ * Whether or not to include orders comprising each position's cost
4033
+ * @example "false"
4034
+ */
4035
+ loadCost?: any;
4036
+ /**
4037
+ * Analyze market caps and get `marketCapWeights`. To be used in conjuction with `loadQuotes`
4038
+ * @example "false"
4039
+ */
4040
+ marketCapWeights?: any;
4041
+ /** @example "1" */
4042
+ pageNum?: any;
4043
+ /** @example "100" */
4044
+ pageSize?: any;
4045
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4046
+ /**
4047
+ * @tags Advisory Groups
4048
+ * @name GroupRtb
4049
+ * @request GET:/v2/advisory/group/rtb/{groupId}
4050
+ * @secure
4051
+ */
4052
+ groupRtb(groupId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4053
+ /**
4054
+ * @tags Advisory Groups
4055
+ * @name GroupRtbs
4056
+ * @request GET:/v2/advisory/group/rtbs/{groupId}
4057
+ * @secure
4058
+ */
4059
+ groupRtbs(groupId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4060
+ }
4079
4061
  export class TransfersInstantAccountVerification<HandleError extends boolean = boolean> {
4080
4062
  protected readonly apiClient: JwtClient<HandleError>;
4081
4063
  constructor(apiClient: JwtClient<HandleError>);
@@ -4175,6 +4157,24 @@ export class TransfersAch<HandleError extends boolean = boolean> {
4175
4157
  */
4176
4158
  withdraw(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4177
4159
  }
4160
+ export class Device<HandleError extends boolean = boolean> {
4161
+ protected readonly apiClient: JwtClient<HandleError>;
4162
+ constructor(apiClient: JwtClient<HandleError>);
4163
+ /**
4164
+ * @tags Device
4165
+ * @name DeviceDeactivate
4166
+ * @summary /device/deactivate
4167
+ * @request POST:/device/deactivate
4168
+ * @secure
4169
+ */
4170
+ deviceDeactivate(data: {
4171
+ /**
4172
+ * Token previously registered
4173
+ * @example "123456789"
4174
+ */
4175
+ Token?: string;
4176
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4177
+ }
4178
4178
  export class TransfersAcats<HandleError extends boolean = boolean> {
4179
4179
  protected readonly apiClient: JwtClient<HandleError>;
4180
4180
  constructor(apiClient: JwtClient<HandleError>);
@@ -4383,19 +4383,17 @@ export class TransfersWires<HandleError extends boolean = boolean> {
4383
4383
  remoteDevice?: any;
4384
4384
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4385
4385
  }
4386
- export class TransfersJournals<HandleError extends boolean = boolean> {
4386
+ export class TransfersPositions<HandleError extends boolean = boolean> {
4387
4387
  protected readonly apiClient: JwtClient<HandleError>;
4388
4388
  constructor(apiClient: JwtClient<HandleError>);
4389
4389
  /**
4390
- * @tags Transfers Journals
4391
- * @name JournalRequest
4392
- * @summary Journal request
4393
- * @request POST:/transfer/journal/request
4390
+ * @tags Transfers Positions
4391
+ * @name TransferRequest
4392
+ * @summary Transfer request
4393
+ * @request POST:/transfer/position/request
4394
4394
  * @secure
4395
4395
  */
4396
- journalRequest(data: {
4397
- /** @example 1000 */
4398
- amount?: any;
4396
+ transferRequest(data: {
4399
4397
  deliverFrom?: {
4400
4398
  /** @example 124 */
4401
4399
  accountId?: number;
@@ -4408,62 +4406,47 @@ export class TransfersJournals<HandleError extends boolean = boolean> {
4408
4406
  /** @example "DEF123456" */
4409
4407
  accountNumber?: string;
4410
4408
  };
4411
- /** @example "MM/dd/yyyy HH:mm:ss z" */
4412
- deliveryDate?: any;
4413
- loa?: {
4414
- /** @example "" */
4415
- fullName?: string;
4416
- /** @example "" */
4417
- remoteAddr?: string;
4418
- /** @example "" */
4419
- remoteDevice?: string;
4420
- /** @example "" */
4421
- signature?: string;
4422
- /** @example "MM/dd/yyyy HH:mm:ss z" */
4423
- timestamp?: string;
4424
- };
4425
- /** @example "NoPurpose|Gift|StockGift" */
4409
+ /** @example "NoPurpose|Gift" */
4426
4410
  purpose?: any;
4411
+ /** @example 1000 */
4412
+ quantity?: any;
4413
+ quote?: {
4414
+ /** @example "IBM" */
4415
+ symbol?: string;
4416
+ };
4427
4417
  /** @example "" */
4428
4418
  reason?: any;
4429
4419
  /** @example "0.0.0.0" */
4430
4420
  remoteAddr?: any;
4431
4421
  /** @example "Ultra fast proxy" */
4432
4422
  remoteDevice?: any;
4433
- /** @example "required for StockGift" */
4434
- symbol?: any;
4435
4423
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4424
+ }
4425
+ export class TransfersBank<HandleError extends boolean = boolean> {
4426
+ protected readonly apiClient: JwtClient<HandleError>;
4427
+ constructor(apiClient: JwtClient<HandleError>);
4436
4428
  /**
4437
- * @tags Transfers Journals
4438
- * @name Search
4439
- * @summary Search
4440
- * @request POST:/transfer/journal/search
4429
+ * @tags Transfers Bank
4430
+ * @name FundTransfer
4431
+ * @summary Fund transfer
4432
+ * @request POST:/transfer/bank/{direction}
4441
4433
  * @secure
4442
4434
  */
4443
- search(data: {
4444
- account?: {
4445
- /** @example 0 */
4446
- accountId?: number;
4447
- /** @example "ABC123456" */
4448
- accountNumber?: string;
4449
- };
4450
- /** @example "PLACED|SENT|..." */
4451
- status?: any;
4452
- /** @example "AB123456" */
4453
- transferId?: any;
4454
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4435
+ fundTransfer(direction: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4455
4436
  }
4456
- export class TransfersPositions<HandleError extends boolean = boolean> {
4437
+ export class TransfersJournals<HandleError extends boolean = boolean> {
4457
4438
  protected readonly apiClient: JwtClient<HandleError>;
4458
4439
  constructor(apiClient: JwtClient<HandleError>);
4459
4440
  /**
4460
- * @tags Transfers Positions
4461
- * @name TransferRequest
4462
- * @summary Transfer request
4463
- * @request POST:/transfer/position/request
4441
+ * @tags Transfers Journals
4442
+ * @name JournalRequest
4443
+ * @summary Journal request
4444
+ * @request POST:/transfer/journal/request
4464
4445
  * @secure
4465
4446
  */
4466
- transferRequest(data: {
4447
+ journalRequest(data: {
4448
+ /** @example 1000 */
4449
+ amount?: any;
4467
4450
  deliverFrom?: {
4468
4451
  /** @example 124 */
4469
4452
  accountId?: number;
@@ -4476,33 +4459,50 @@ export class TransfersPositions<HandleError extends boolean = boolean> {
4476
4459
  /** @example "DEF123456" */
4477
4460
  accountNumber?: string;
4478
4461
  };
4479
- /** @example "NoPurpose|Gift" */
4480
- purpose?: any;
4481
- /** @example 1000 */
4482
- quantity?: any;
4483
- quote?: {
4484
- /** @example "IBM" */
4485
- symbol?: string;
4462
+ /** @example "MM/dd/yyyy HH:mm:ss z" */
4463
+ deliveryDate?: any;
4464
+ loa?: {
4465
+ /** @example "" */
4466
+ fullName?: string;
4467
+ /** @example "" */
4468
+ remoteAddr?: string;
4469
+ /** @example "" */
4470
+ remoteDevice?: string;
4471
+ /** @example "" */
4472
+ signature?: string;
4473
+ /** @example "MM/dd/yyyy HH:mm:ss z" */
4474
+ timestamp?: string;
4486
4475
  };
4476
+ /** @example "NoPurpose|Gift|StockGift" */
4477
+ purpose?: any;
4487
4478
  /** @example "" */
4488
4479
  reason?: any;
4489
4480
  /** @example "0.0.0.0" */
4490
4481
  remoteAddr?: any;
4491
4482
  /** @example "Ultra fast proxy" */
4492
4483
  remoteDevice?: any;
4484
+ /** @example "required for StockGift" */
4485
+ symbol?: any;
4493
4486
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4494
- }
4495
- export class TransfersBank<HandleError extends boolean = boolean> {
4496
- protected readonly apiClient: JwtClient<HandleError>;
4497
- constructor(apiClient: JwtClient<HandleError>);
4498
4487
  /**
4499
- * @tags Transfers Bank
4500
- * @name FundTransfer
4501
- * @summary Fund transfer
4502
- * @request POST:/transfer/bank/{direction}
4488
+ * @tags Transfers Journals
4489
+ * @name Search
4490
+ * @summary Search
4491
+ * @request POST:/transfer/journal/search
4503
4492
  * @secure
4504
4493
  */
4505
- fundTransfer(direction: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4494
+ search(data: {
4495
+ account?: {
4496
+ /** @example 0 */
4497
+ accountId?: number;
4498
+ /** @example "ABC123456" */
4499
+ accountNumber?: string;
4500
+ };
4501
+ /** @example "PLACED|SENT|..." */
4502
+ status?: any;
4503
+ /** @example "AB123456" */
4504
+ transferId?: any;
4505
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4506
4506
  }
4507
4507
  export class TransfersInstantCashTransfers<HandleError extends boolean = boolean> {
4508
4508
  protected readonly apiClient: JwtClient<HandleError>;
@@ -4855,155 +4855,6 @@ export class Transfers<HandleError extends boolean = boolean> {
4855
4855
  wallet?: any;
4856
4856
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4857
4857
  }
4858
- export class Documents<HandleError extends boolean = boolean> {
4859
- protected readonly apiClient: JwtClient<HandleError>;
4860
- constructor(apiClient: JwtClient<HandleError>);
4861
- /**
4862
- * @tags Documents
4863
- * @name Confirm
4864
- * @summary Confirm
4865
- * @request GET:/documents/confirm
4866
- * @secure
4867
- */
4868
- confirm(query?: {
4869
- /**
4870
- * *_accountNumber_ is accepted as well*
4871
- * @example "5VA0XXXX"
4872
- */
4873
- account?: any;
4874
- /**
4875
- * Date for the confirm. The required date format is: mm/dd/yyyy.
4876
- * @example "03/03/2018"
4877
- */
4878
- date?: any;
4879
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4880
- /**
4881
- * @tags Documents
4882
- * @name ListOfConfirms
4883
- * @summary List of Confirms
4884
- * @request GET:/documents/confirm/list
4885
- * @secure
4886
- */
4887
- listOfConfirms(query?: {
4888
- /**
4889
- * *_accountNumber_ is accepted as well*
4890
- * @example "5VA0XXXX"
4891
- */
4892
- account?: any;
4893
- /**
4894
- * Start date for the list of confirms. The required date format is: `mm/dd/yyyy`.
4895
- * @example "01/01/2017"
4896
- */
4897
- beginDate?: any;
4898
- /**
4899
- * End date for the list of confirms. The required date format is: `mm/dd/yyyy`.
4900
- * @example "03/01/2018"
4901
- */
4902
- endDate?: any;
4903
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4904
- /**
4905
- * @tags Documents
4906
- * @name ServiceDocs
4907
- * @summary Service Docs
4908
- * @request GET:/documents/service
4909
- * @secure
4910
- */
4911
- serviceDocs(query?: {
4912
- /** @example "5VA0XXXX" */
4913
- accountNumber?: any;
4914
- /** See table for details. Leave blank for all document types. */
4915
- docType?: any;
4916
- /**
4917
- * The beginning 2-digit month (MM) to be used as search criteria.
4918
- * @example "01"
4919
- */
4920
- beginMonth?: any;
4921
- /**
4922
- * The beginning 4-digit year (YYYY) to be used as search criteria.
4923
- * @example "2012"
4924
- */
4925
- beginYear?: any;
4926
- /**
4927
- * The ending 2-digit month (MM) to be used as search criteria.
4928
- * @example "12"
4929
- */
4930
- endMonth?: any;
4931
- /**
4932
- * The ending 4-digit year (YYYY) to be used as search criteria.
4933
- * @example "2017"
4934
- */
4935
- endYear?: any;
4936
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4937
- /**
4938
- * @tags Documents
4939
- * @name DocumentList
4940
- * @summary Document list
4941
- * @request GET:/documents/list
4942
- * @secure
4943
- */
4944
- documentList(query?: {
4945
- /** @example "5VA0XXXX" */
4946
- account?: any;
4947
- /**
4948
- * Omit for all document types.
4949
- * @example "All"
4950
- */
4951
- documentType?: any;
4952
- /**
4953
- * Indicates start month & year (day of month is not used)
4954
- * @example "1/1/2021"
4955
- */
4956
- fromMonth?: any;
4957
- /**
4958
- * Indicates end month & year (day of month is not used)
4959
- * @example "12/1/2021"
4960
- */
4961
- toMonth?: any;
4962
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4963
- /**
4964
- * @tags Documents
4965
- * @name AvailableDocumentTypes
4966
- * @summary Available document types
4967
- * @request GET:/documents/types
4968
- * @secure
4969
- */
4970
- availableDocumentTypes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4971
- /**
4972
- * @tags Documents
4973
- * @name AvailableDocumentTypesAndCodes
4974
- * @summary Available document types and codes
4975
- * @request GET:/documents/typesAndCodes
4976
- * @secure
4977
- */
4978
- availableDocumentTypesAndCodes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4979
- /**
4980
- * @tags Documents
4981
- * @name Download
4982
- * @summary Download
4983
- * @request GET:/documents/download
4984
- * @secure
4985
- */
4986
- download(query?: {
4987
- /**
4988
- * Account Number
4989
- * @example "{accountNumber}"
4990
- */
4991
- account?: any;
4992
- /**
4993
- * UUID for finding specific document
4994
- * @example "{key}"
4995
- */
4996
- key?: any;
4997
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4998
- /**
4999
- * @tags Documents
5000
- * @name GetAllBranchDocuments
5001
- * @summary Get all Branch Documents
5002
- * @request GET:/documents/branch/list
5003
- * @secure
5004
- */
5005
- getAllBranchDocuments(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5006
- }
5007
4858
  export class Miscellaneous<HandleError extends boolean = boolean> {
5008
4859
  protected readonly apiClient: JwtClient<HandleError>;
5009
4860
  constructor(apiClient: JwtClient<HandleError>);
@@ -5186,24 +5037,173 @@ export class Miscellaneous<HandleError extends boolean = boolean> {
5186
5037
  */
5187
5038
  optionStrategyClassifications(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5188
5039
  }
5189
- export class Branch<HandleError extends boolean = boolean> {
5040
+ export class Documents<HandleError extends boolean = boolean> {
5190
5041
  protected readonly apiClient: JwtClient<HandleError>;
5191
5042
  constructor(apiClient: JwtClient<HandleError>);
5192
5043
  /**
5193
- * @tags Branch
5194
- * @name BranchRtb
5195
- * @request GET:/v1/branch/rtb
5044
+ * @tags Documents
5045
+ * @name Confirm
5046
+ * @summary Confirm
5047
+ * @request GET:/documents/confirm
5196
5048
  * @secure
5197
5049
  */
5198
- branchRtb(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5050
+ confirm(query?: {
5051
+ /**
5052
+ * *_accountNumber_ is accepted as well*
5053
+ * @example "5VA0XXXX"
5054
+ */
5055
+ account?: any;
5056
+ /**
5057
+ * Date for the confirm. The required date format is: mm/dd/yyyy.
5058
+ * @example "03/03/2018"
5059
+ */
5060
+ date?: any;
5061
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5199
5062
  /**
5200
- * @tags Branch
5201
- * @name BranchRtbs
5202
- * @request GET:/v1/branch/rtbs
5063
+ * @tags Documents
5064
+ * @name ListOfConfirms
5065
+ * @summary List of Confirms
5066
+ * @request GET:/documents/confirm/list
5203
5067
  * @secure
5204
5068
  */
5205
- branchRtbs(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5206
- /**
5069
+ listOfConfirms(query?: {
5070
+ /**
5071
+ * *_accountNumber_ is accepted as well*
5072
+ * @example "5VA0XXXX"
5073
+ */
5074
+ account?: any;
5075
+ /**
5076
+ * Start date for the list of confirms. The required date format is: `mm/dd/yyyy`.
5077
+ * @example "01/01/2017"
5078
+ */
5079
+ beginDate?: any;
5080
+ /**
5081
+ * End date for the list of confirms. The required date format is: `mm/dd/yyyy`.
5082
+ * @example "03/01/2018"
5083
+ */
5084
+ endDate?: any;
5085
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5086
+ /**
5087
+ * @tags Documents
5088
+ * @name ServiceDocs
5089
+ * @summary Service Docs
5090
+ * @request GET:/documents/service
5091
+ * @secure
5092
+ */
5093
+ serviceDocs(query?: {
5094
+ /** @example "5VA0XXXX" */
5095
+ accountNumber?: any;
5096
+ /** See table for details. Leave blank for all document types. */
5097
+ docType?: any;
5098
+ /**
5099
+ * The beginning 2-digit month (MM) to be used as search criteria.
5100
+ * @example "01"
5101
+ */
5102
+ beginMonth?: any;
5103
+ /**
5104
+ * The beginning 4-digit year (YYYY) to be used as search criteria.
5105
+ * @example "2012"
5106
+ */
5107
+ beginYear?: any;
5108
+ /**
5109
+ * The ending 2-digit month (MM) to be used as search criteria.
5110
+ * @example "12"
5111
+ */
5112
+ endMonth?: any;
5113
+ /**
5114
+ * The ending 4-digit year (YYYY) to be used as search criteria.
5115
+ * @example "2017"
5116
+ */
5117
+ endYear?: any;
5118
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5119
+ /**
5120
+ * @tags Documents
5121
+ * @name DocumentList
5122
+ * @summary Document list
5123
+ * @request GET:/documents/list
5124
+ * @secure
5125
+ */
5126
+ documentList(query?: {
5127
+ /** @example "5VA0XXXX" */
5128
+ account?: any;
5129
+ /**
5130
+ * Omit for all document types.
5131
+ * @example "All"
5132
+ */
5133
+ documentType?: any;
5134
+ /**
5135
+ * Indicates start month & year (day of month is not used)
5136
+ * @example "1/1/2021"
5137
+ */
5138
+ fromMonth?: any;
5139
+ /**
5140
+ * Indicates end month & year (day of month is not used)
5141
+ * @example "12/1/2021"
5142
+ */
5143
+ toMonth?: any;
5144
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5145
+ /**
5146
+ * @tags Documents
5147
+ * @name AvailableDocumentTypes
5148
+ * @summary Available document types
5149
+ * @request GET:/documents/types
5150
+ * @secure
5151
+ */
5152
+ availableDocumentTypes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5153
+ /**
5154
+ * @tags Documents
5155
+ * @name AvailableDocumentTypesAndCodes
5156
+ * @summary Available document types and codes
5157
+ * @request GET:/documents/typesAndCodes
5158
+ * @secure
5159
+ */
5160
+ availableDocumentTypesAndCodes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5161
+ /**
5162
+ * @tags Documents
5163
+ * @name Download
5164
+ * @summary Download
5165
+ * @request GET:/documents/download
5166
+ * @secure
5167
+ */
5168
+ download(query?: {
5169
+ /**
5170
+ * Account Number
5171
+ * @example "{accountNumber}"
5172
+ */
5173
+ account?: any;
5174
+ /**
5175
+ * UUID for finding specific document
5176
+ * @example "{key}"
5177
+ */
5178
+ key?: any;
5179
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5180
+ /**
5181
+ * @tags Documents
5182
+ * @name GetAllBranchDocuments
5183
+ * @summary Get all Branch Documents
5184
+ * @request GET:/documents/branch/list
5185
+ * @secure
5186
+ */
5187
+ getAllBranchDocuments(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5188
+ }
5189
+ export class Branch<HandleError extends boolean = boolean> {
5190
+ protected readonly apiClient: JwtClient<HandleError>;
5191
+ constructor(apiClient: JwtClient<HandleError>);
5192
+ /**
5193
+ * @tags Branch
5194
+ * @name BranchRtb
5195
+ * @request GET:/v1/branch/rtb
5196
+ * @secure
5197
+ */
5198
+ branchRtb(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5199
+ /**
5200
+ * @tags Branch
5201
+ * @name BranchRtbs
5202
+ * @request GET:/v1/branch/rtbs
5203
+ * @secure
5204
+ */
5205
+ branchRtbs(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5206
+ /**
5207
5207
  * @tags Branch
5208
5208
  * @name BranchInventory
5209
5209
  * @request GET:/v1/branch/inventory
@@ -5277,113 +5277,134 @@ export class Branch<HandleError extends boolean = boolean> {
5277
5277
  maturity?: any;
5278
5278
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5279
5279
  }
5280
- export class LegalDocuments<HandleError extends boolean = boolean> {
5280
+ export class BlacklistAdminIndividuals<HandleError extends boolean = boolean> {
5281
5281
  protected readonly apiClient: JwtClient<HandleError>;
5282
5282
  constructor(apiClient: JwtClient<HandleError>);
5283
5283
  /**
5284
- * @tags Legal Documents
5285
- * @name DocumentClassifications
5286
- * @summary Document classifications
5287
- * @request GET:/user/legal/classifications
5288
- * @secure
5289
- */
5290
- documentClassifications(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5291
- /**
5292
- * @tags Legal Documents
5293
- * @name DocumentListing
5294
- * @summary Document listing
5295
- * @request GET:/user/legal/documents
5284
+ * @tags Blacklist Admin Individuals
5285
+ * @name GetIndividualsList
5286
+ * @summary Get Individuals list
5287
+ * @request GET:/v1/admin/individuals
5296
5288
  * @secure
5297
5289
  */
5298
- documentListing(query?: {
5290
+ getIndividualsList(query?: {
5299
5291
  /**
5300
- * {optional}
5301
- * @example "TermsOfUse"
5292
+ * (Required) page number
5293
+ * @example "1"
5302
5294
  */
5303
- classification?: any;
5295
+ page?: any;
5296
+ /**
5297
+ * (Required) page size in records displayed
5298
+ * @example "100"
5299
+ */
5300
+ page_size?: any;
5304
5301
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5305
5302
  /**
5306
- * @tags Legal Documents
5307
- * @name PolicyValues
5308
- * @summary Policy values
5309
- * @request GET:/user/legal/policies/listing/{type}
5310
- * @secure
5311
- */
5312
- policyValues(type: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5313
- /**
5314
- * @tags Legal Documents
5315
- * @name DocumentContent
5316
- * @summary Document content
5317
- * @request GET:/user/legal/document/content
5303
+ * @tags Blacklist Admin Individuals
5304
+ * @name CreateIndividual
5305
+ * @summary Create Individual
5306
+ * @request POST:/v1/admin/individuals
5318
5307
  * @secure
5319
5308
  */
5320
- documentContent(query?: {
5321
- /** @example "{as provided}" */
5322
- id?: any;
5309
+ createIndividual(data: {
5310
+ /** @example "Martin" */
5311
+ alias_first_name?: any;
5312
+ /** @example "Ahn" */
5313
+ alias_last_name?: any;
5314
+ /** @example "Hyodon" */
5315
+ alias_middle_name?: any;
5316
+ /** @example "Mr." */
5317
+ alias_suffix?: any;
5318
+ /** @example "Flushing" */
5319
+ city?: any;
5320
+ /** @example "US" */
5321
+ country?: any;
5322
+ /** @example "5/11/1989" */
5323
+ dob?: any;
5324
+ /** @example "Hyodon" */
5325
+ first_name?: any;
5326
+ /** @example "Ahn" */
5327
+ last_name?: any;
5328
+ /** @example "" */
5329
+ middle_name?: any;
5330
+ /** @example "89884722" */
5331
+ number?: any;
5332
+ /** @example "SSN/ITIN" */
5333
+ number_type?: any;
5334
+ /** @example "" */
5335
+ phone?: any;
5336
+ /** @example "NY" */
5337
+ state?: any;
5338
+ /** @example "4505 162nd St" */
5339
+ street?: any;
5340
+ /** @example "Mr." */
5341
+ suffix?: any;
5342
+ /** @example "305178" */
5343
+ tracking_number?: any;
5344
+ /** @example "11358" */
5345
+ zip?: any;
5323
5346
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5324
5347
  /**
5325
- * @tags Legal Documents
5326
- * @name DocumentDownload
5327
- * @summary Document download
5328
- * @request GET:/user/legal/document/download
5348
+ * @tags Blacklist Admin Individuals
5349
+ * @name GetIndividualById
5350
+ * @summary Get Individual by ID
5351
+ * @request GET:/v1/admin/individuals/{id}
5329
5352
  * @secure
5330
5353
  */
5331
- documentDownload(query?: {
5332
- /** @example "{as provided}" */
5333
- id?: any;
5334
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5354
+ getIndividualById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5335
5355
  /**
5336
- * @tags Legal Documents
5337
- * @name SignTheDocument
5338
- * @summary Sign the document
5339
- * @request POST:/user/legal/document/sign
5356
+ * @tags Blacklist Admin Individuals
5357
+ * @name UpdateIndividual
5358
+ * @summary Update Individual
5359
+ * @request PUT:/v1/admin/individuals/{id}
5340
5360
  * @secure
5341
5361
  */
5342
- signTheDocument(data: {
5343
- account?: {
5344
- /** @example 1234 */
5345
- accountId?: number;
5346
- /** @example "AC123456" */
5347
- accountNumber?: string;
5348
- };
5349
- data?: {
5350
- /** @example "{conditional}" */
5351
- bankAccountNumber?: string;
5352
- };
5353
- /** @example "{required}" */
5354
- documentId?: any;
5355
- /** @example true */
5356
- esigned?: any;
5362
+ updateIndividual(id: string, data: {
5363
+ /** @example "Martin" */
5364
+ alias_first_name?: any;
5365
+ /** @example "Ahn" */
5366
+ alias_last_name?: any;
5367
+ /** @example "Hyodon" */
5368
+ alias_middle_name?: any;
5369
+ /** @example "Mr." */
5370
+ alias_suffix?: any;
5371
+ /** @example "Flushing" */
5372
+ city?: any;
5373
+ /** @example "US" */
5374
+ country?: any;
5375
+ /** @example "5/11/1989" */
5376
+ dob?: any;
5377
+ /** @example "Hyodon" */
5378
+ first_name?: any;
5379
+ /** @example "Ahn" */
5380
+ last_name?: any;
5357
5381
  /** @example "" */
5358
- remoteAddr?: any;
5359
- /** @example "{required}" */
5360
- remoteDevice?: any;
5361
- /** @example "{required}" */
5362
- signature?: any;
5382
+ middle_name?: any;
5383
+ /** @example "89884722" */
5384
+ number?: any;
5385
+ /** @example "SSN/ITIN" */
5386
+ number_type?: any;
5387
+ /** @example "" */
5388
+ phone?: any;
5389
+ /** @example "NY" */
5390
+ state?: any;
5391
+ /** @example "4505 162nd St" */
5392
+ street?: any;
5393
+ /** @example "Mr." */
5394
+ suffix?: any;
5395
+ /** @example "305178" */
5396
+ tracking_number?: any;
5397
+ /** @example "11358" */
5398
+ zip?: any;
5363
5399
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5364
5400
  /**
5365
- * @tags Legal Documents
5366
- * @name UpdatesPolicyOnTheAccount
5367
- * @summary Updates policy on the account
5368
- * @request POST:/user/legal/policy/{type}
5401
+ * @tags Blacklist Admin Individuals
5402
+ * @name DeleteIndividual
5403
+ * @summary Delete Individual
5404
+ * @request DELETE:/v1/admin/individuals/{id}
5369
5405
  * @secure
5370
5406
  */
5371
- updatesPolicyOnTheAccount(type: string, data: {
5372
- account?: {
5373
- /** @example 0 */
5374
- accountId?: number;
5375
- /** @example "{optional}" */
5376
- accountNumber?: string;
5377
- };
5378
- /** @example true */
5379
- esigned?: any;
5380
- /** @example "Allow" */
5381
- policy?: any;
5382
- /** @example "" */
5383
- remoteAddr?: any;
5384
- /** @example "" */
5385
- remoteDevice?: any;
5386
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5407
+ deleteIndividual(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5387
5408
  }
5388
5409
  export class BlacklistAdminBusinesses<HandleError extends boolean = boolean> {
5389
5410
  protected readonly apiClient: JwtClient<HandleError>;
@@ -5490,135 +5511,6 @@ export class BlacklistAdminBusinesses<HandleError extends boolean = boolean> {
5490
5511
  */
5491
5512
  deleteBusiness(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5492
5513
  }
5493
- export class BlacklistAdminIndividuals<HandleError extends boolean = boolean> {
5494
- protected readonly apiClient: JwtClient<HandleError>;
5495
- constructor(apiClient: JwtClient<HandleError>);
5496
- /**
5497
- * @tags Blacklist Admin Individuals
5498
- * @name GetIndividualsList
5499
- * @summary Get Individuals list
5500
- * @request GET:/v1/admin/individuals
5501
- * @secure
5502
- */
5503
- getIndividualsList(query?: {
5504
- /**
5505
- * (Required) page number
5506
- * @example "1"
5507
- */
5508
- page?: any;
5509
- /**
5510
- * (Required) page size in records displayed
5511
- * @example "100"
5512
- */
5513
- page_size?: any;
5514
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5515
- /**
5516
- * @tags Blacklist Admin Individuals
5517
- * @name CreateIndividual
5518
- * @summary Create Individual
5519
- * @request POST:/v1/admin/individuals
5520
- * @secure
5521
- */
5522
- createIndividual(data: {
5523
- /** @example "Martin" */
5524
- alias_first_name?: any;
5525
- /** @example "Ahn" */
5526
- alias_last_name?: any;
5527
- /** @example "Hyodon" */
5528
- alias_middle_name?: any;
5529
- /** @example "Mr." */
5530
- alias_suffix?: any;
5531
- /** @example "Flushing" */
5532
- city?: any;
5533
- /** @example "US" */
5534
- country?: any;
5535
- /** @example "5/11/1989" */
5536
- dob?: any;
5537
- /** @example "Hyodon" */
5538
- first_name?: any;
5539
- /** @example "Ahn" */
5540
- last_name?: any;
5541
- /** @example "" */
5542
- middle_name?: any;
5543
- /** @example "89884722" */
5544
- number?: any;
5545
- /** @example "SSN/ITIN" */
5546
- number_type?: any;
5547
- /** @example "" */
5548
- phone?: any;
5549
- /** @example "NY" */
5550
- state?: any;
5551
- /** @example "4505 162nd St" */
5552
- street?: any;
5553
- /** @example "Mr." */
5554
- suffix?: any;
5555
- /** @example "305178" */
5556
- tracking_number?: any;
5557
- /** @example "11358" */
5558
- zip?: any;
5559
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5560
- /**
5561
- * @tags Blacklist Admin Individuals
5562
- * @name GetIndividualById
5563
- * @summary Get Individual by ID
5564
- * @request GET:/v1/admin/individuals/{id}
5565
- * @secure
5566
- */
5567
- getIndividualById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5568
- /**
5569
- * @tags Blacklist Admin Individuals
5570
- * @name UpdateIndividual
5571
- * @summary Update Individual
5572
- * @request PUT:/v1/admin/individuals/{id}
5573
- * @secure
5574
- */
5575
- updateIndividual(id: string, data: {
5576
- /** @example "Martin" */
5577
- alias_first_name?: any;
5578
- /** @example "Ahn" */
5579
- alias_last_name?: any;
5580
- /** @example "Hyodon" */
5581
- alias_middle_name?: any;
5582
- /** @example "Mr." */
5583
- alias_suffix?: any;
5584
- /** @example "Flushing" */
5585
- city?: any;
5586
- /** @example "US" */
5587
- country?: any;
5588
- /** @example "5/11/1989" */
5589
- dob?: any;
5590
- /** @example "Hyodon" */
5591
- first_name?: any;
5592
- /** @example "Ahn" */
5593
- last_name?: any;
5594
- /** @example "" */
5595
- middle_name?: any;
5596
- /** @example "89884722" */
5597
- number?: any;
5598
- /** @example "SSN/ITIN" */
5599
- number_type?: any;
5600
- /** @example "" */
5601
- phone?: any;
5602
- /** @example "NY" */
5603
- state?: any;
5604
- /** @example "4505 162nd St" */
5605
- street?: any;
5606
- /** @example "Mr." */
5607
- suffix?: any;
5608
- /** @example "305178" */
5609
- tracking_number?: any;
5610
- /** @example "11358" */
5611
- zip?: any;
5612
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5613
- /**
5614
- * @tags Blacklist Admin Individuals
5615
- * @name DeleteIndividual
5616
- * @summary Delete Individual
5617
- * @request DELETE:/v1/admin/individuals/{id}
5618
- * @secure
5619
- */
5620
- deleteIndividual(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5621
- }
5622
5514
  export class BlacklistSearch<HandleError extends boolean = boolean> {
5623
5515
  protected readonly apiClient: JwtClient<HandleError>;
5624
5516
  constructor(apiClient: JwtClient<HandleError>);
@@ -5661,217 +5553,196 @@ export class BlacklistSearch<HandleError extends boolean = boolean> {
5661
5553
  };
5662
5554
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5663
5555
  }
5664
- export class Blacklist<HandleError extends boolean = boolean> {
5556
+ export class LegalDocuments<HandleError extends boolean = boolean> {
5665
5557
  protected readonly apiClient: JwtClient<HandleError>;
5666
- adminBusinesses: BlacklistAdminBusinesses<HandleError>;
5667
- adminIndividuals: BlacklistAdminIndividuals<HandleError>;
5668
- search: BlacklistSearch<HandleError>;
5669
5558
  constructor(apiClient: JwtClient<HandleError>);
5670
5559
  /**
5671
- * @tags Blacklist
5672
- * @name UploadBlacklistCsv
5673
- * @summary Upload Blacklist CSV
5674
- * @request POST:/v1/csv/upload
5560
+ * @tags Legal Documents
5561
+ * @name DocumentClassifications
5562
+ * @summary Document classifications
5563
+ * @request GET:/user/legal/classifications
5675
5564
  * @secure
5676
5565
  */
5677
- uploadBlacklistCsv(data: {
5566
+ documentClassifications(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5567
+ /**
5568
+ * @tags Legal Documents
5569
+ * @name DocumentListing
5570
+ * @summary Document listing
5571
+ * @request GET:/user/legal/documents
5572
+ * @secure
5573
+ */
5574
+ documentListing(query?: {
5678
5575
  /**
5679
- * (Required) file with info to upload
5680
- * @format binary
5576
+ * {optional}
5577
+ * @example "TermsOfUse"
5681
5578
  */
5682
- file_field?: File;
5579
+ classification?: any;
5683
5580
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5684
5581
  /**
5685
- * @tags Blacklist
5686
- * @name GetHealth
5687
- * @summary Get Health
5688
- * @request GET:/v1/healthz
5582
+ * @tags Legal Documents
5583
+ * @name PolicyValues
5584
+ * @summary Policy values
5585
+ * @request GET:/user/legal/policies/listing/{type}
5689
5586
  * @secure
5690
5587
  */
5691
- getHealth(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5692
- }
5693
- export class Broker<HandleError extends boolean = boolean> {
5694
- protected readonly apiClient: JwtClient<HandleError>;
5695
- constructor(apiClient: JwtClient<HandleError>);
5588
+ policyValues(type: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5696
5589
  /**
5697
- * @tags Broker
5698
- * @name Portfolio
5699
- * @summary Portfolio
5700
- * @request GET:/v1/broker/portfolio
5590
+ * @tags Legal Documents
5591
+ * @name DocumentContent
5592
+ * @summary Document content
5593
+ * @request GET:/user/legal/document/content
5701
5594
  * @secure
5702
5595
  */
5703
- portfolio(query?: {
5704
- /**
5705
- * (true or false) Allows for loading of quotes for each portfolio entry. Defaults to false.
5706
- * @example "false"
5707
- */
5708
- loadQuotes?: any;
5709
- /** @example "false" */
5710
- loadIndustries?: any;
5711
- /** @example "false" */
5712
- loadUpgrades?: any;
5713
- /** @example "false" */
5714
- loadEarnings?: any;
5715
- /**
5716
- * Load balances for weight
5717
- * @example "false"
5718
- */
5719
- loadRtb?: any;
5720
- /**
5721
- * Analyze market caps and get `marketCapWeights`. To be used in conjuction with `loadQuotes`
5722
- * @example "false"
5723
- */
5724
- marketCapBreakdown?: any;
5725
- /**
5726
- * Combined portfolio for the branch
5727
- * @example "false"
5728
- */
5729
- combined?: any;
5730
- /** @example "1" */
5731
- pageNum?: any;
5732
- /** @example "100" */
5733
- pageSize?: any;
5596
+ documentContent(query?: {
5597
+ /** @example "{as provided}" */
5598
+ id?: any;
5734
5599
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5735
- }
5736
- export class WatchmenFfiUserAccountManagement<HandleError extends boolean = boolean> {
5737
- protected readonly apiClient: JwtClient<HandleError>;
5738
- constructor(apiClient: JwtClient<HandleError>);
5739
5600
  /**
5740
- * @tags Watchmen Ffi User Account Management
5741
- * @name CreateUser
5742
- * @summary Create User
5743
- * @request POST:/rest/v1/uam/user/create
5601
+ * @tags Legal Documents
5602
+ * @name DocumentDownload
5603
+ * @summary Document download
5604
+ * @request GET:/user/legal/document/download
5744
5605
  * @secure
5745
5606
  */
5746
- createUser(data: {
5747
- /** @example "{optional} enable|disable - whether or not enable user for TipRanks" */
5748
- Tipranks?: any;
5749
- /** @example "{optional} true|false - defaults to false" */
5750
- algos?: any;
5751
- /** @example "{optional} true|false - defaults to false" */
5752
- allSession?: any;
5753
- /** @example "{optional} Full Name" */
5754
- associatedName?: any;
5755
- /** @example "{optional} true|false - defaults to false" */
5756
- buyWrite?: any;
5757
- /** @example "{optional} e-mail address" */
5758
- email?: any;
5759
- /** @example "{optional} true|false - defaults to true" */
5760
- isTradingEnabled?: any;
5761
- /** @example "{optional} Limit On Close - true|false - defaults to false" */
5762
- loc?: any;
5763
- /** @example "{optional} true|false - whether user is locked" */
5764
- locked?: any;
5765
- /** @example "{optional} Limit On Open - true|false - defaults to false" */
5766
- loo?: any;
5767
- /** @example "{optional} Market On Open - true|false - defaults to false" */
5768
- moc?: any;
5769
- /** @example "{optional} Market On Close - true|false - defaults to false" */
5770
- moo?: any;
5771
- /** @example "{optional} One Cancels Other - true|false - defaults to false" */
5772
- oco?: any;
5773
- /** @example "{optional} true|false - defaults to false" */
5774
- optionRoll?: any;
5775
- /** @example "{optional} true|false - defaults to false" */
5776
- options?: any;
5777
- /** @example "{optional}" */
5778
- password?: any;
5779
- /** @example "{optional} true|false - defaults to false" */
5780
- prePostTrading?: any;
5781
- /** @example "{optional} 1 - delayed, 0 - realtime, 4 - CBOE1, 3 - BATS" */
5782
- quoteType?: any;
5783
- /** @example "{optional} true|false - defaults to false" */
5784
- spreads?: any;
5785
- /** @example "A - active, S - suspended == initial user status" */
5786
- status?: any;
5787
- /** @example "{optional} true|false - defaults to false" */
5788
- trailingStops?: any;
5789
- /** @example "UNIQUE_USERNAME" */
5790
- username?: any;
5607
+ documentDownload(query?: {
5608
+ /** @example "{as provided}" */
5609
+ id?: any;
5791
5610
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5792
5611
  /**
5793
- * @tags Watchmen Ffi User Account Management
5794
- * @name CreateAccount
5795
- * @summary Create Account
5796
- * @request POST:/rest/v1/uam/account/create
5797
- * @secure
5798
- */
5799
- createAccount(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5800
- /**
5801
- * @tags Watchmen Ffi User Account Management
5802
- * @name AccountInformation
5803
- * @summary Account Information
5804
- * @request GET:/rest/v1/uam/account/data
5612
+ * @tags Legal Documents
5613
+ * @name SignTheDocument
5614
+ * @summary Sign the document
5615
+ * @request POST:/user/legal/document/sign
5805
5616
  * @secure
5806
5617
  */
5807
- accountInformation(query?: {
5808
- /** @example "AC123456" */
5809
- accountNumber?: any;
5618
+ signTheDocument(data: {
5619
+ account?: {
5620
+ /** @example 1234 */
5621
+ accountId?: number;
5622
+ /** @example "AC123456" */
5623
+ accountNumber?: string;
5624
+ };
5625
+ data?: {
5626
+ /** @example "{conditional}" */
5627
+ bankAccountNumber?: string;
5628
+ };
5629
+ /** @example "{required}" */
5630
+ documentId?: any;
5631
+ /** @example true */
5632
+ esigned?: any;
5633
+ /** @example "" */
5634
+ remoteAddr?: any;
5635
+ /** @example "{required}" */
5636
+ remoteDevice?: any;
5637
+ /** @example "{required}" */
5638
+ signature?: any;
5810
5639
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5811
5640
  /**
5812
- * @tags Watchmen Ffi User Account Management
5813
- * @name UserInformation
5814
- * @summary User Information
5815
- * @request GET:/rest/v1/uam/user/data
5641
+ * @tags Legal Documents
5642
+ * @name UpdatesPolicyOnTheAccount
5643
+ * @summary Updates policy on the account
5644
+ * @request POST:/user/legal/policy/{type}
5816
5645
  * @secure
5817
5646
  */
5818
- userInformation(query?: {
5819
- /** @example "USERNAME" */
5820
- username?: any;
5647
+ updatesPolicyOnTheAccount(type: string, data: {
5648
+ account?: {
5649
+ /** @example 0 */
5650
+ accountId?: number;
5651
+ /** @example "{optional}" */
5652
+ accountNumber?: string;
5653
+ };
5654
+ /** @example true */
5655
+ esigned?: any;
5656
+ /** @example "Allow" */
5657
+ policy?: any;
5658
+ /** @example "" */
5659
+ remoteAddr?: any;
5660
+ /** @example "" */
5661
+ remoteDevice?: any;
5821
5662
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5663
+ }
5664
+ export class Blacklist<HandleError extends boolean = boolean> {
5665
+ protected readonly apiClient: JwtClient<HandleError>;
5666
+ adminBusinesses: BlacklistAdminBusinesses<HandleError>;
5667
+ adminIndividuals: BlacklistAdminIndividuals<HandleError>;
5668
+ search: BlacklistSearch<HandleError>;
5669
+ constructor(apiClient: JwtClient<HandleError>);
5822
5670
  /**
5823
- * @tags Watchmen Ffi User Account Management
5824
- * @name ListLinkedAccounts
5825
- * @summary List Linked Accounts
5826
- * @request GET:/rest/v1/linkedaccounts/listAccounts
5671
+ * @tags Blacklist
5672
+ * @name UploadBlacklistCsv
5673
+ * @summary Upload Blacklist CSV
5674
+ * @request POST:/v1/csv/upload
5827
5675
  * @secure
5828
5676
  */
5829
- listLinkedAccounts(query?: {
5830
- /** @example "TEST.USER" */
5831
- username?: any;
5677
+ uploadBlacklistCsv(data: {
5678
+ /**
5679
+ * (Required) file with info to upload
5680
+ * @format binary
5681
+ */
5682
+ file_field?: File;
5832
5683
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5833
5684
  /**
5834
- * @tags Watchmen Ffi User Account Management
5835
- * @name LinkUnlinkAccount
5836
- * @summary Link/Unlink Account
5837
- * @request POST:/rest/v1/linkedaccounts/linkUnlinkAccount
5838
- * @secure
5839
- */
5840
- linkUnlinkAccount(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5841
- /**
5842
- * @tags Watchmen Ffi User Account Management
5843
- * @name Visibility
5844
- * @summary Visibility
5845
- * @request POST:/rest/v1/linkedaccounts/visibility
5685
+ * @tags Blacklist
5686
+ * @name GetHealth
5687
+ * @summary Get Health
5688
+ * @request GET:/v1/healthz
5846
5689
  * @secure
5847
5690
  */
5848
- visibility(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5691
+ getHealth(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5692
+ }
5693
+ export class Broker<HandleError extends boolean = boolean> {
5694
+ protected readonly apiClient: JwtClient<HandleError>;
5695
+ constructor(apiClient: JwtClient<HandleError>);
5849
5696
  /**
5850
- * @tags Watchmen Ffi User Account Management
5851
- * @name UserAccountSearch
5852
- * @summary User/Account Search
5853
- * @request POST:/rest/v1/uam/user-account-search
5697
+ * @tags Broker
5698
+ * @name Portfolio
5699
+ * @summary Portfolio
5700
+ * @request GET:/v1/broker/portfolio
5854
5701
  * @secure
5855
5702
  */
5856
- userAccountSearch(data: {
5857
- /** @example "desired account number" */
5858
- accountNumber?: any;
5859
- /** @example 100 */
5860
- limit?: any;
5861
- /** @example 0 */
5862
- lockedBit?: any;
5863
- /** @example "desired username" */
5864
- login?: any;
5865
- /** @example false */
5866
- noBrokers?: any;
5867
- /** @example "" */
5868
- omnibus?: any;
5869
- /** @example false */
5870
- onlyActiveAccount?: any;
5871
- /** @example false */
5872
- onlyActiveUser?: any;
5703
+ portfolio(query?: {
5704
+ /**
5705
+ * (true or false) Allows for loading of quotes for each portfolio entry. Defaults to false.
5706
+ * @example "false"
5707
+ */
5708
+ loadQuotes?: any;
5709
+ /** @example "false" */
5710
+ loadIndustries?: any;
5711
+ /** @example "false" */
5712
+ loadUpgrades?: any;
5713
+ /** @example "false" */
5714
+ loadEarnings?: any;
5715
+ /**
5716
+ * Load balances for weight
5717
+ * @example "false"
5718
+ */
5719
+ loadRtb?: any;
5720
+ /**
5721
+ * Analyze market caps and get `marketCapWeights`. To be used in conjuction with `loadQuotes`
5722
+ * @example "false"
5723
+ */
5724
+ marketCapBreakdown?: any;
5725
+ /**
5726
+ * Combined portfolio for the branch
5727
+ * @example "false"
5728
+ */
5729
+ combined?: any;
5730
+ /** @example "1" */
5731
+ pageNum?: any;
5732
+ /** @example "100" */
5733
+ pageSize?: any;
5873
5734
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5874
5735
  }
5736
+ export class Advisory<HandleError extends boolean = boolean> {
5737
+ protected readonly apiClient: JwtClient<HandleError>;
5738
+ charges: AdvisoryCharges<HandleError>;
5739
+ models: AdvisoryModels<HandleError>;
5740
+ userAccountManagement: AdvisoryUserAccountManagement<HandleError>;
5741
+ groups: AdvisoryGroups<HandleError>;
5742
+ analytics: AdvisoryAnalytics<HandleError>;
5743
+ allocations: AdvisoryAllocations<HandleError>;
5744
+ constructor(apiClient: JwtClient<HandleError>);
5745
+ }
5875
5746
  export class WatchmenFfiFirmBranch<HandleError extends boolean = boolean> {
5876
5747
  protected readonly apiClient: JwtClient<HandleError>;
5877
5748
  constructor(apiClient: JwtClient<HandleError>);
@@ -6047,15 +5918,144 @@ export class WatchmenFfiFirmBranch<HandleError extends boolean = boolean> {
6047
5918
  id?: any;
6048
5919
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
6049
5920
  }
6050
- export class Advisory<HandleError extends boolean = boolean> {
5921
+ export class WatchmenFfiUserAccountManagement<HandleError extends boolean = boolean> {
6051
5922
  protected readonly apiClient: JwtClient<HandleError>;
6052
- charges: AdvisoryCharges<HandleError>;
6053
- models: AdvisoryModels<HandleError>;
6054
- userAccountManagement: AdvisoryUserAccountManagement<HandleError>;
6055
- groups: AdvisoryGroups<HandleError>;
6056
- analytics: AdvisoryAnalytics<HandleError>;
6057
- allocations: AdvisoryAllocations<HandleError>;
6058
5923
  constructor(apiClient: JwtClient<HandleError>);
5924
+ /**
5925
+ * @tags Watchmen Ffi User Account Management
5926
+ * @name CreateUser
5927
+ * @summary Create User
5928
+ * @request POST:/rest/v1/uam/user/create
5929
+ * @secure
5930
+ */
5931
+ createUser(data: {
5932
+ /** @example "{optional} enable|disable - whether or not enable user for TipRanks" */
5933
+ Tipranks?: any;
5934
+ /** @example "{optional} true|false - defaults to false" */
5935
+ algos?: any;
5936
+ /** @example "{optional} true|false - defaults to false" */
5937
+ allSession?: any;
5938
+ /** @example "{optional} Full Name" */
5939
+ associatedName?: any;
5940
+ /** @example "{optional} true|false - defaults to false" */
5941
+ buyWrite?: any;
5942
+ /** @example "{optional} e-mail address" */
5943
+ email?: any;
5944
+ /** @example "{optional} true|false - defaults to true" */
5945
+ isTradingEnabled?: any;
5946
+ /** @example "{optional} Limit On Close - true|false - defaults to false" */
5947
+ loc?: any;
5948
+ /** @example "{optional} true|false - whether user is locked" */
5949
+ locked?: any;
5950
+ /** @example "{optional} Limit On Open - true|false - defaults to false" */
5951
+ loo?: any;
5952
+ /** @example "{optional} Market On Open - true|false - defaults to false" */
5953
+ moc?: any;
5954
+ /** @example "{optional} Market On Close - true|false - defaults to false" */
5955
+ moo?: any;
5956
+ /** @example "{optional} One Cancels Other - true|false - defaults to false" */
5957
+ oco?: any;
5958
+ /** @example "{optional} true|false - defaults to false" */
5959
+ optionRoll?: any;
5960
+ /** @example "{optional} true|false - defaults to false" */
5961
+ options?: any;
5962
+ /** @example "{optional}" */
5963
+ password?: any;
5964
+ /** @example "{optional} true|false - defaults to false" */
5965
+ prePostTrading?: any;
5966
+ /** @example "{optional} 1 - delayed, 0 - realtime, 4 - CBOE1, 3 - BATS" */
5967
+ quoteType?: any;
5968
+ /** @example "{optional} true|false - defaults to false" */
5969
+ spreads?: any;
5970
+ /** @example "A - active, S - suspended == initial user status" */
5971
+ status?: any;
5972
+ /** @example "{optional} true|false - defaults to false" */
5973
+ trailingStops?: any;
5974
+ /** @example "UNIQUE_USERNAME" */
5975
+ username?: any;
5976
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5977
+ /**
5978
+ * @tags Watchmen Ffi User Account Management
5979
+ * @name CreateAccount
5980
+ * @summary Create Account
5981
+ * @request POST:/rest/v1/uam/account/create
5982
+ * @secure
5983
+ */
5984
+ createAccount(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5985
+ /**
5986
+ * @tags Watchmen Ffi User Account Management
5987
+ * @name AccountInformation
5988
+ * @summary Account Information
5989
+ * @request GET:/rest/v1/uam/account/data
5990
+ * @secure
5991
+ */
5992
+ accountInformation(query?: {
5993
+ /** @example "AC123456" */
5994
+ accountNumber?: any;
5995
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5996
+ /**
5997
+ * @tags Watchmen Ffi User Account Management
5998
+ * @name UserInformation
5999
+ * @summary User Information
6000
+ * @request GET:/rest/v1/uam/user/data
6001
+ * @secure
6002
+ */
6003
+ userInformation(query?: {
6004
+ /** @example "USERNAME" */
6005
+ username?: any;
6006
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
6007
+ /**
6008
+ * @tags Watchmen Ffi User Account Management
6009
+ * @name ListLinkedAccounts
6010
+ * @summary List Linked Accounts
6011
+ * @request GET:/rest/v1/linkedaccounts/listAccounts
6012
+ * @secure
6013
+ */
6014
+ listLinkedAccounts(query?: {
6015
+ /** @example "TEST.USER" */
6016
+ username?: any;
6017
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
6018
+ /**
6019
+ * @tags Watchmen Ffi User Account Management
6020
+ * @name LinkUnlinkAccount
6021
+ * @summary Link/Unlink Account
6022
+ * @request POST:/rest/v1/linkedaccounts/linkUnlinkAccount
6023
+ * @secure
6024
+ */
6025
+ linkUnlinkAccount(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
6026
+ /**
6027
+ * @tags Watchmen Ffi User Account Management
6028
+ * @name Visibility
6029
+ * @summary Visibility
6030
+ * @request POST:/rest/v1/linkedaccounts/visibility
6031
+ * @secure
6032
+ */
6033
+ visibility(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
6034
+ /**
6035
+ * @tags Watchmen Ffi User Account Management
6036
+ * @name UserAccountSearch
6037
+ * @summary User/Account Search
6038
+ * @request POST:/rest/v1/uam/user-account-search
6039
+ * @secure
6040
+ */
6041
+ userAccountSearch(data: {
6042
+ /** @example "desired account number" */
6043
+ accountNumber?: any;
6044
+ /** @example 100 */
6045
+ limit?: any;
6046
+ /** @example 0 */
6047
+ lockedBit?: any;
6048
+ /** @example "desired username" */
6049
+ login?: any;
6050
+ /** @example false */
6051
+ noBrokers?: any;
6052
+ /** @example "" */
6053
+ omnibus?: any;
6054
+ /** @example false */
6055
+ onlyActiveAccount?: any;
6056
+ /** @example false */
6057
+ onlyActiveUser?: any;
6058
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
6059
6059
  }
6060
6060
  export class WatchmenFfi<HandleError extends boolean = boolean> {
6061
6061
  protected readonly apiClient: JwtClient<HandleError>;