@orbis-systems/orbis-api-clients 0.7.16 → 0.7.17

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.
@@ -392,6 +392,70 @@ export class OrdersV2FixedIncome<HandleError extends boolean = boolean> {
392
392
  */
393
393
  bondOrderPreview(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
394
394
  }
395
+ export class OrdersV2Crypto<HandleError extends boolean = boolean> {
396
+ protected readonly apiClient: JwtClient<HandleError>;
397
+ constructor(apiClient: JwtClient<HandleError>);
398
+ /**
399
+ * @tags Orders V2 Crypto
400
+ * @name OrderPreview
401
+ * @summary Order Preview
402
+ * @request POST:/orders/v2/crypto/preview
403
+ * @secure
404
+ */
405
+ orderPreview(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
406
+ /**
407
+ * @tags Orders V2 Crypto
408
+ * @name OrderPlace
409
+ * @summary Order Place
410
+ * @request POST:/orders/v2/crypto/place
411
+ * @secure
412
+ */
413
+ orderPlace(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
414
+ }
415
+ export class OrdersV2MutualFunds<HandleError extends boolean = boolean> {
416
+ protected readonly apiClient: JwtClient<HandleError>;
417
+ constructor(apiClient: JwtClient<HandleError>);
418
+ /**
419
+ * @tags Orders V2 Mutual Funds
420
+ * @name ListMutualFunds
421
+ * @summary List Mutual Funds
422
+ * @request GET:/quotes/mf/allowed
423
+ * @secure
424
+ */
425
+ listMutualFunds(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
426
+ /**
427
+ * @tags Orders V2 Mutual Funds
428
+ * @name MutualFundDetails
429
+ * @summary Mutual Fund Details
430
+ * @request GET:/quotes/mf/allowed/details/{symbol}
431
+ * @secure
432
+ */
433
+ mutualFundDetails(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
434
+ /**
435
+ * @tags Orders V2 Mutual Funds
436
+ * @name CheckMutualFund
437
+ * @summary Check Mutual Fund
438
+ * @request GET:/quotes/mf/check/{symbol}
439
+ * @secure
440
+ */
441
+ checkMutualFund(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
442
+ /**
443
+ * @tags Orders V2 Mutual Funds
444
+ * @name MutualFundPlacement
445
+ * @summary Mutual fund placement
446
+ * @request POST:/orders/v2/mf/place
447
+ * @secure
448
+ */
449
+ mutualFundPlacement(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
450
+ /**
451
+ * @tags Orders V2 Mutual Funds
452
+ * @name MutualFundPreview
453
+ * @summary Mutual fund preview
454
+ * @request POST:/orders/v2/mf/preview
455
+ * @secure
456
+ */
457
+ mutualFundPreview(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
458
+ }
395
459
  export class OrdersV2Equities<HandleError extends boolean = boolean> {
396
460
  protected readonly apiClient: JwtClient<HandleError>;
397
461
  constructor(apiClient: JwtClient<HandleError>);
@@ -468,70 +532,6 @@ export class OrdersV2Equities<HandleError extends boolean = boolean> {
468
532
  */
469
533
  previewSnapshot(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
470
534
  }
471
- export class OrdersV2Crypto<HandleError extends boolean = boolean> {
472
- protected readonly apiClient: JwtClient<HandleError>;
473
- constructor(apiClient: JwtClient<HandleError>);
474
- /**
475
- * @tags Orders V2 Crypto
476
- * @name OrderPreview
477
- * @summary Order Preview
478
- * @request POST:/orders/v2/crypto/preview
479
- * @secure
480
- */
481
- orderPreview(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
482
- /**
483
- * @tags Orders V2 Crypto
484
- * @name OrderPlace
485
- * @summary Order Place
486
- * @request POST:/orders/v2/crypto/place
487
- * @secure
488
- */
489
- orderPlace(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
490
- }
491
- export class OrdersV2MutualFunds<HandleError extends boolean = boolean> {
492
- protected readonly apiClient: JwtClient<HandleError>;
493
- constructor(apiClient: JwtClient<HandleError>);
494
- /**
495
- * @tags Orders V2 Mutual Funds
496
- * @name ListMutualFunds
497
- * @summary List Mutual Funds
498
- * @request GET:/quotes/mf/allowed
499
- * @secure
500
- */
501
- listMutualFunds(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
502
- /**
503
- * @tags Orders V2 Mutual Funds
504
- * @name MutualFundDetails
505
- * @summary Mutual Fund Details
506
- * @request GET:/quotes/mf/allowed/details/{symbol}
507
- * @secure
508
- */
509
- mutualFundDetails(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
510
- /**
511
- * @tags Orders V2 Mutual Funds
512
- * @name CheckMutualFund
513
- * @summary Check Mutual Fund
514
- * @request GET:/quotes/mf/check/{symbol}
515
- * @secure
516
- */
517
- checkMutualFund(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
518
- /**
519
- * @tags Orders V2 Mutual Funds
520
- * @name MutualFundPlacement
521
- * @summary Mutual fund placement
522
- * @request POST:/orders/v2/mf/place
523
- * @secure
524
- */
525
- mutualFundPlacement(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
526
- /**
527
- * @tags Orders V2 Mutual Funds
528
- * @name MutualFundPreview
529
- * @summary Mutual fund preview
530
- * @request POST:/orders/v2/mf/preview
531
- * @secure
532
- */
533
- mutualFundPreview(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
534
- }
535
535
  export class OrdersV2Offerings<HandleError extends boolean = boolean> {
536
536
  protected readonly apiClient: JwtClient<HandleError>;
537
537
  constructor(apiClient: JwtClient<HandleError>);
@@ -691,6 +691,43 @@ export class OrdersV2Offerings<HandleError extends boolean = boolean> {
691
691
  };
692
692
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
693
693
  }
694
+ export class OrdersViolationManagement<HandleError extends boolean = boolean> {
695
+ protected readonly apiClient: JwtClient<HandleError>;
696
+ constructor(apiClient: JwtClient<HandleError>);
697
+ /**
698
+ * @tags Orders Violation Management
699
+ * @name GfvEquities
700
+ * @summary GFV (equities)
701
+ * @request POST:/trading/violations/gfv/equity
702
+ * @secure
703
+ */
704
+ gfvEquities(data: {
705
+ account?: {
706
+ /** @example "optional" */
707
+ accountNumber?: string;
708
+ };
709
+ order?: {
710
+ /** @example 101.5 */
711
+ expectedValue?: number;
712
+ /** @example 123.45 */
713
+ limitPrice?: number;
714
+ /** @example "PRE_MARKET|CORE_MARKET|POST_MARKET|ALL_MARKET|PRE_CORE|POST_CORE" */
715
+ marketTime?: string;
716
+ /** @example "MARKET|LIMIT|STOP|STOP_LIMIT|TRAILING_STOP|Notional|NotionalLimit" */
717
+ orderType?: string;
718
+ /** @example 123.45 */
719
+ quantity?: number;
720
+ quote?: {
721
+ /** @example "ZVZZT" */
722
+ symbol?: string;
723
+ };
724
+ /** @example 123.45 */
725
+ stopPrice?: number;
726
+ /** @example "BUY|SELL|SHORT_SELL|BUY_TO_COVER|Liquidate" */
727
+ transaction?: string;
728
+ };
729
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
730
+ }
694
731
  export class OrdersV2<HandleError extends boolean = boolean> {
695
732
  protected readonly apiClient: JwtClient<HandleError>;
696
733
  equities: OrdersV2Equities<HandleError>;
@@ -753,43 +790,6 @@ export class OrdersV2<HandleError extends boolean = boolean> {
753
790
  };
754
791
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
755
792
  }
756
- export class OrdersViolationManagement<HandleError extends boolean = boolean> {
757
- protected readonly apiClient: JwtClient<HandleError>;
758
- constructor(apiClient: JwtClient<HandleError>);
759
- /**
760
- * @tags Orders Violation Management
761
- * @name GfvEquities
762
- * @summary GFV (equities)
763
- * @request POST:/trading/violations/gfv/equity
764
- * @secure
765
- */
766
- gfvEquities(data: {
767
- account?: {
768
- /** @example "optional" */
769
- accountNumber?: string;
770
- };
771
- order?: {
772
- /** @example 101.5 */
773
- expectedValue?: number;
774
- /** @example 123.45 */
775
- limitPrice?: number;
776
- /** @example "PRE_MARKET|CORE_MARKET|POST_MARKET|ALL_MARKET|PRE_CORE|POST_CORE" */
777
- marketTime?: string;
778
- /** @example "MARKET|LIMIT|STOP|STOP_LIMIT|TRAILING_STOP|Notional|NotionalLimit" */
779
- orderType?: string;
780
- /** @example 123.45 */
781
- quantity?: number;
782
- quote?: {
783
- /** @example "ZVZZT" */
784
- symbol?: string;
785
- };
786
- /** @example 123.45 */
787
- stopPrice?: number;
788
- /** @example "BUY|SELL|SHORT_SELL|BUY_TO_COVER|Liquidate" */
789
- transaction?: string;
790
- };
791
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
792
- }
793
793
  export class OrdersArchived<HandleError extends boolean = boolean> {
794
794
  protected readonly apiClient: JwtClient<HandleError>;
795
795
  constructor(apiClient: JwtClient<HandleError>);
@@ -2169,52 +2169,142 @@ export class Research<HandleError extends boolean = boolean> {
2169
2169
  dates?: any;
2170
2170
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2171
2171
  }
2172
- export class UserAgreements<HandleError extends boolean = boolean> {
2172
+ export class UserWatchlists<HandleError extends boolean = boolean> {
2173
2173
  protected readonly apiClient: JwtClient<HandleError>;
2174
2174
  constructor(apiClient: JwtClient<HandleError>);
2175
2175
  /**
2176
- * @tags User Agreements
2177
- * @name Available
2178
- * @summary Available
2179
- * @request GET:/user/agreements/all/active
2176
+ * @tags User Watchlists
2177
+ * @name CreateWatchlist
2178
+ * @summary Create Watchlist
2179
+ * @request POST:/user/v2/watchlist/create
2180
2180
  * @secure
2181
2181
  */
2182
- available(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2182
+ createWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2183
2183
  /**
2184
- * @tags User Agreements
2185
- * @name Agreement
2186
- * @summary Agreement
2187
- * @request GET:/user/agreements/contents/{version}/{code}/body.html
2184
+ * @tags User Watchlists
2185
+ * @name RenameWatchlist
2186
+ * @summary Rename Watchlist
2187
+ * @request POST:/user/v2/watchlist/rename
2188
2188
  * @secure
2189
2189
  */
2190
- agreement(version: string, code: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2190
+ renameWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2191
2191
  /**
2192
- * @tags User Agreements
2193
- * @name Unsigned
2194
- * @summary Unsigned
2195
- * @request GET:/user/agreements/unsigned
2192
+ * @tags User Watchlists
2193
+ * @name DeleteWatchlist
2194
+ * @summary Delete Watchlist
2195
+ * @request POST:/user/v2/watchlist/delete
2196
2196
  * @secure
2197
2197
  */
2198
- unsigned(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2198
+ deleteWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2199
2199
  /**
2200
- * @tags User Agreements
2201
- * @name AttestStatus
2202
- * @summary Attest status
2203
- * @request POST:/user/professional/attest
2200
+ * @tags User Watchlists
2201
+ * @name AddToWatchlist
2202
+ * @summary Add to Watchlist
2203
+ * @request POST:/user/v2/watchlist/addEntry
2204
2204
  * @secure
2205
2205
  */
2206
- attestStatus(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2206
+ addToWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2207
2207
  /**
2208
- * @tags User Agreements
2209
- * @name Sign
2210
- * @summary Sign
2211
- * @request POST:/user/agreements/sign
2208
+ * @tags User Watchlists
2209
+ * @name RemoveFromWatchlist
2210
+ * @summary Remove from Watchlist
2211
+ * @request POST:/user/v2/watchlist/removeEntry
2212
2212
  * @secure
2213
2213
  */
2214
- sign(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2215
- /**
2216
- * @tags User Agreements
2217
- * @name CryptoAgreement
2214
+ removeFromWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2215
+ }
2216
+ export class UserDevice<HandleError extends boolean = boolean> {
2217
+ protected readonly apiClient: JwtClient<HandleError>;
2218
+ constructor(apiClient: JwtClient<HandleError>);
2219
+ /**
2220
+ * @tags User Device
2221
+ * @name Register
2222
+ * @summary Register
2223
+ * @request GET:/user/device/register
2224
+ * @secure
2225
+ */
2226
+ register(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2227
+ /**
2228
+ * @tags User Device
2229
+ * @name Deregister
2230
+ * @summary Deregister
2231
+ * @request GET:/user/device/deregister
2232
+ * @secure
2233
+ */
2234
+ deregister(query?: {
2235
+ token?: any;
2236
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2237
+ /**
2238
+ * @tags User Device
2239
+ * @name FirebaseRegistration
2240
+ * @summary Firebase - registration
2241
+ * @request POST:/user/device/firebase/register
2242
+ * @secure
2243
+ */
2244
+ firebaseRegistration(data: {
2245
+ /** @example "{predfined scope name}" */
2246
+ scope?: any;
2247
+ /** @example "a1s2d3f4g5h6" */
2248
+ token?: any;
2249
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2250
+ /**
2251
+ * @tags User Device
2252
+ * @name FirebaseRemoval
2253
+ * @summary Firebase - removal
2254
+ * @request POST:/user/device/firebase/deregister
2255
+ * @secure
2256
+ */
2257
+ firebaseRemoval(data: {
2258
+ /** @example "a1s2d3f4g5h6" */
2259
+ token?: any;
2260
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2261
+ }
2262
+ export class UserAgreements<HandleError extends boolean = boolean> {
2263
+ protected readonly apiClient: JwtClient<HandleError>;
2264
+ constructor(apiClient: JwtClient<HandleError>);
2265
+ /**
2266
+ * @tags User Agreements
2267
+ * @name Available
2268
+ * @summary Available
2269
+ * @request GET:/user/agreements/all/active
2270
+ * @secure
2271
+ */
2272
+ available(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2273
+ /**
2274
+ * @tags User Agreements
2275
+ * @name Agreement
2276
+ * @summary Agreement
2277
+ * @request GET:/user/agreements/contents/{version}/{code}/body.html
2278
+ * @secure
2279
+ */
2280
+ agreement(version: string, code: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2281
+ /**
2282
+ * @tags User Agreements
2283
+ * @name Unsigned
2284
+ * @summary Unsigned
2285
+ * @request GET:/user/agreements/unsigned
2286
+ * @secure
2287
+ */
2288
+ unsigned(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2289
+ /**
2290
+ * @tags User Agreements
2291
+ * @name AttestStatus
2292
+ * @summary Attest status
2293
+ * @request POST:/user/professional/attest
2294
+ * @secure
2295
+ */
2296
+ attestStatus(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2297
+ /**
2298
+ * @tags User Agreements
2299
+ * @name Sign
2300
+ * @summary Sign
2301
+ * @request POST:/user/agreements/sign
2302
+ * @secure
2303
+ */
2304
+ sign(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2305
+ /**
2306
+ * @tags User Agreements
2307
+ * @name CryptoAgreement
2218
2308
  * @summary Crypto Agreement
2219
2309
  * @request GET:/user/agreements/crypto/Agreement
2220
2310
  * @secure
@@ -2331,96 +2421,6 @@ export class UserProfitLoss<HandleError extends boolean = boolean> {
2331
2421
  requestId?: any;
2332
2422
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2333
2423
  }
2334
- export class UserWatchlists<HandleError extends boolean = boolean> {
2335
- protected readonly apiClient: JwtClient<HandleError>;
2336
- constructor(apiClient: JwtClient<HandleError>);
2337
- /**
2338
- * @tags User Watchlists
2339
- * @name CreateWatchlist
2340
- * @summary Create Watchlist
2341
- * @request POST:/user/v2/watchlist/create
2342
- * @secure
2343
- */
2344
- createWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2345
- /**
2346
- * @tags User Watchlists
2347
- * @name RenameWatchlist
2348
- * @summary Rename Watchlist
2349
- * @request POST:/user/v2/watchlist/rename
2350
- * @secure
2351
- */
2352
- renameWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2353
- /**
2354
- * @tags User Watchlists
2355
- * @name DeleteWatchlist
2356
- * @summary Delete Watchlist
2357
- * @request POST:/user/v2/watchlist/delete
2358
- * @secure
2359
- */
2360
- deleteWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2361
- /**
2362
- * @tags User Watchlists
2363
- * @name AddToWatchlist
2364
- * @summary Add to Watchlist
2365
- * @request POST:/user/v2/watchlist/addEntry
2366
- * @secure
2367
- */
2368
- addToWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2369
- /**
2370
- * @tags User Watchlists
2371
- * @name RemoveFromWatchlist
2372
- * @summary Remove from Watchlist
2373
- * @request POST:/user/v2/watchlist/removeEntry
2374
- * @secure
2375
- */
2376
- removeFromWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2377
- }
2378
- export class UserDevice<HandleError extends boolean = boolean> {
2379
- protected readonly apiClient: JwtClient<HandleError>;
2380
- constructor(apiClient: JwtClient<HandleError>);
2381
- /**
2382
- * @tags User Device
2383
- * @name Register
2384
- * @summary Register
2385
- * @request GET:/user/device/register
2386
- * @secure
2387
- */
2388
- register(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2389
- /**
2390
- * @tags User Device
2391
- * @name Deregister
2392
- * @summary Deregister
2393
- * @request GET:/user/device/deregister
2394
- * @secure
2395
- */
2396
- deregister(query?: {
2397
- token?: any;
2398
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2399
- /**
2400
- * @tags User Device
2401
- * @name FirebaseRegistration
2402
- * @summary Firebase - registration
2403
- * @request POST:/user/device/firebase/register
2404
- * @secure
2405
- */
2406
- firebaseRegistration(data: {
2407
- /** @example "{predfined scope name}" */
2408
- scope?: any;
2409
- /** @example "a1s2d3f4g5h6" */
2410
- token?: any;
2411
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2412
- /**
2413
- * @tags User Device
2414
- * @name FirebaseRemoval
2415
- * @summary Firebase - removal
2416
- * @request POST:/user/device/firebase/deregister
2417
- * @secure
2418
- */
2419
- firebaseRemoval(data: {
2420
- /** @example "a1s2d3f4g5h6" */
2421
- token?: any;
2422
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2423
- }
2424
2424
  export class User<HandleError extends boolean = boolean> {
2425
2425
  protected readonly apiClient: JwtClient<HandleError>;
2426
2426
  watchlists: UserWatchlists<HandleError>;
@@ -3050,66 +3050,82 @@ export class User<HandleError extends boolean = boolean> {
3050
3050
  */
3051
3051
  passwordChange(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3052
3052
  }
3053
- export class AdvisoryCharges<HandleError extends boolean = boolean> {
3053
+ export class AdvisoryGroups<HandleError extends boolean = boolean> {
3054
3054
  protected readonly apiClient: JwtClient<HandleError>;
3055
3055
  constructor(apiClient: JwtClient<HandleError>);
3056
3056
  /**
3057
- * @tags Advisory Charges
3058
- * @name Search
3059
- * @summary /search
3060
- * @request GET:/v2/charges/search
3057
+ * @tags Advisory Groups
3058
+ * @name GroupsManage
3059
+ * @request POST:/v1/groups/manage/{action}
3061
3060
  * @secure
3062
3061
  */
3063
- search(query?: {
3064
- /**
3065
- * Must be either this or `AccountNumber`
3066
- * @example "12345"
3067
- */
3068
- AccountId?: any;
3062
+ groupsManage(action: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3063
+ /**
3064
+ * @tags Advisory Groups
3065
+ * @name GroupsList
3066
+ * @request GET:/v1/groups/list
3067
+ * @secure
3068
+ */
3069
+ groupsList(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3070
+ /**
3071
+ * @tags Advisory Groups
3072
+ * @name GroupAccountsStats
3073
+ * @request GET:/v2/advisory/group/accounts/stats/{groupsId}
3074
+ * @secure
3075
+ */
3076
+ groupAccountsStats(groupsId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3077
+ /**
3078
+ * @tags Advisory Groups
3079
+ * @name GroupPortfolios
3080
+ * @request GET:/v2/advisory/group/portfolios/{groupId}
3081
+ * @secure
3082
+ */
3083
+ groupPortfolios(groupId: string, query?: {
3069
3084
  /**
3070
- * Must be either this or `AccountId`
3071
- * @example "AB321654"
3085
+ * Should load quotes or not.
3086
+ * @example "false"
3072
3087
  */
3073
- AccountNumber?: any;
3088
+ loadQuotes?: any;
3074
3089
  /**
3075
- * `optional` - defaults to today
3076
- * @example "7/1/2018"
3090
+ * Whether to return combined portfolio (no accounts, with approximate prices)
3091
+ * @example "false"
3077
3092
  */
3078
- DateFrom?: any;
3093
+ combined?: any;
3094
+ /** @example "false" */
3095
+ loadIndustries?: any;
3096
+ /** @example "false" */
3097
+ loadUpgrades?: any;
3098
+ /** @example "false" */
3099
+ loadEarnings?: any;
3079
3100
  /**
3080
- * `optional`
3081
- * @example "7/1/2018"
3101
+ * Whether or not to include orders comprising each position's cost
3102
+ * @example "false"
3082
3103
  */
3083
- DateTo?: any;
3104
+ loadCost?: any;
3084
3105
  /**
3085
- * `optional`
3086
- * @example "CH321654"
3106
+ * Analyze market caps and get `marketCapWeights`. To be used in conjuction with `loadQuotes`
3107
+ * @example "false"
3087
3108
  */
3088
- ChargeRef?: any;
3109
+ marketCapWeights?: any;
3110
+ /** @example "1" */
3111
+ pageNum?: any;
3112
+ /** @example "100" */
3113
+ pageSize?: any;
3089
3114
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3090
3115
  /**
3091
- * @tags Advisory Charges
3092
- * @name Apply
3093
- * @summary /apply
3094
- * @request POST:/v2/charges/apply
3116
+ * @tags Advisory Groups
3117
+ * @name GroupRtb
3118
+ * @request GET:/v2/advisory/group/rtb/{groupId}
3095
3119
  * @secure
3096
3120
  */
3097
- apply(data: {
3098
- /** @example 1234 */
3099
- accountId?: any;
3100
- /** @example 7.11 */
3101
- amount?: any;
3102
- /** @example "{timestamp}" */
3103
- date?: any;
3104
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3121
+ groupRtb(groupId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3105
3122
  /**
3106
- * @tags Advisory Charges
3107
- * @name Cancel
3108
- * @summary /cancel
3109
- * @request POST:/v2/charges/cancel
3123
+ * @tags Advisory Groups
3124
+ * @name GroupRtbs
3125
+ * @request GET:/v2/advisory/group/rtbs/{groupId}
3110
3126
  * @secure
3111
3127
  */
3112
- cancel(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3128
+ groupRtbs(groupId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3113
3129
  }
3114
3130
  export class AdvisoryModels<HandleError extends boolean = boolean> {
3115
3131
  protected readonly apiClient: JwtClient<HandleError>;
@@ -3386,83 +3402,6 @@ export class AdvisoryModels<HandleError extends boolean = boolean> {
3386
3402
  */
3387
3403
  allocations(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3388
3404
  }
3389
- export class AdvisoryGroups<HandleError extends boolean = boolean> {
3390
- protected readonly apiClient: JwtClient<HandleError>;
3391
- constructor(apiClient: JwtClient<HandleError>);
3392
- /**
3393
- * @tags Advisory Groups
3394
- * @name GroupsManage
3395
- * @request POST:/v1/groups/manage/{action}
3396
- * @secure
3397
- */
3398
- groupsManage(action: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3399
- /**
3400
- * @tags Advisory Groups
3401
- * @name GroupsList
3402
- * @request GET:/v1/groups/list
3403
- * @secure
3404
- */
3405
- groupsList(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3406
- /**
3407
- * @tags Advisory Groups
3408
- * @name GroupAccountsStats
3409
- * @request GET:/v2/advisory/group/accounts/stats/{groupsId}
3410
- * @secure
3411
- */
3412
- groupAccountsStats(groupsId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3413
- /**
3414
- * @tags Advisory Groups
3415
- * @name GroupPortfolios
3416
- * @request GET:/v2/advisory/group/portfolios/{groupId}
3417
- * @secure
3418
- */
3419
- groupPortfolios(groupId: string, query?: {
3420
- /**
3421
- * Should load quotes or not.
3422
- * @example "false"
3423
- */
3424
- loadQuotes?: any;
3425
- /**
3426
- * Whether to return combined portfolio (no accounts, with approximate prices)
3427
- * @example "false"
3428
- */
3429
- combined?: any;
3430
- /** @example "false" */
3431
- loadIndustries?: any;
3432
- /** @example "false" */
3433
- loadUpgrades?: any;
3434
- /** @example "false" */
3435
- loadEarnings?: any;
3436
- /**
3437
- * Whether or not to include orders comprising each position's cost
3438
- * @example "false"
3439
- */
3440
- loadCost?: any;
3441
- /**
3442
- * Analyze market caps and get `marketCapWeights`. To be used in conjuction with `loadQuotes`
3443
- * @example "false"
3444
- */
3445
- marketCapWeights?: any;
3446
- /** @example "1" */
3447
- pageNum?: any;
3448
- /** @example "100" */
3449
- pageSize?: any;
3450
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3451
- /**
3452
- * @tags Advisory Groups
3453
- * @name GroupRtb
3454
- * @request GET:/v2/advisory/group/rtb/{groupId}
3455
- * @secure
3456
- */
3457
- groupRtb(groupId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3458
- /**
3459
- * @tags Advisory Groups
3460
- * @name GroupRtbs
3461
- * @request GET:/v2/advisory/group/rtbs/{groupId}
3462
- * @secure
3463
- */
3464
- groupRtbs(groupId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3465
- }
3466
3405
  export class AdvisoryAnalytics<HandleError extends boolean = boolean> {
3467
3406
  protected readonly apiClient: JwtClient<HandleError>;
3468
3407
  constructor(apiClient: JwtClient<HandleError>);
@@ -3569,24 +3508,6 @@ export class AdvisoryAllocations<HandleError extends boolean = boolean> {
3569
3508
  */
3570
3509
  trigger(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3571
3510
  }
3572
- export class Device<HandleError extends boolean = boolean> {
3573
- protected readonly apiClient: JwtClient<HandleError>;
3574
- constructor(apiClient: JwtClient<HandleError>);
3575
- /**
3576
- * @tags Device
3577
- * @name DeviceDeactivate
3578
- * @summary /device/deactivate
3579
- * @request POST:/device/deactivate
3580
- * @secure
3581
- */
3582
- deviceDeactivate(data: {
3583
- /**
3584
- * Token previously registered
3585
- * @example "123456789"
3586
- */
3587
- Token?: string;
3588
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3589
- }
3590
3511
  export class TransfersRelationships<HandleError extends boolean = boolean> {
3591
3512
  protected readonly apiClient: JwtClient<HandleError>;
3592
3513
  constructor(apiClient: JwtClient<HandleError>);
@@ -3831,76 +3752,23 @@ export class TransfersRelationships<HandleError extends boolean = boolean> {
3831
3752
  };
3832
3753
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3833
3754
  }
3834
- export class AdvisoryUserAccountManagement<HandleError extends boolean = boolean> {
3755
+ export class Device<HandleError extends boolean = boolean> {
3835
3756
  protected readonly apiClient: JwtClient<HandleError>;
3836
3757
  constructor(apiClient: JwtClient<HandleError>);
3837
3758
  /**
3838
- * @tags Advisory User Account Management
3839
- * @name List
3840
- * @summary /list
3841
- * @request GET:/v2/advisory/users/list
3842
- * @secure
3843
- */
3844
- list(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3845
- /**
3846
- * @tags Advisory User Account Management
3847
- * @name Accounts
3848
- * @summary /accounts
3849
- * @request GET:/v2/advisory/users/accounts
3850
- * @secure
3851
- */
3852
- accounts(query?: {
3853
- /** @example "1234" */
3854
- uid?: any;
3855
- /**
3856
- * true|false
3857
- * @example "false"
3858
- */
3859
- loadRtb?: any;
3860
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3861
- /**
3862
- * @tags Advisory User Account Management
3863
- * @name AccountsStats
3864
- * @summary /accounts/stats
3865
- * @request GET:/v2/advisory/users/accounts/stats
3866
- * @secure
3867
- */
3868
- accountsStats(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3869
- /**
3870
- * @tags Advisory User Account Management
3871
- * @name AccountNotes
3872
- * @summary /account/notes
3873
- * @request GET:/v2/advisory/users/account/notes
3874
- * @secure
3875
- */
3876
- accountNotes(query?: {
3877
- /**
3878
- * Account's ID
3879
- * @example "1234"
3880
- */
3881
- aid?: any;
3882
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3883
- /**
3884
- * @tags Advisory User Account Management
3885
- * @name Notes
3886
- * @summary /notes
3887
- * @request GET:/v2/advisory/users/notes
3759
+ * @tags Device
3760
+ * @name DeviceDeactivate
3761
+ * @summary /device/deactivate
3762
+ * @request POST:/device/deactivate
3888
3763
  * @secure
3889
3764
  */
3890
- notes(query?: {
3765
+ deviceDeactivate(data: {
3891
3766
  /**
3892
- * User's ID
3893
- * @example "1234"
3767
+ * Token previously registered
3768
+ * @example "123456789"
3894
3769
  */
3895
- uid?: any;
3770
+ Token?: string;
3896
3771
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3897
- /**
3898
- * @tags Advisory User Account Management
3899
- * @name NotesPost
3900
- * @request POST:/v2/advisory/users/notes/{action}
3901
- * @secure
3902
- */
3903
- notesPost(action: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3904
3772
  }
3905
3773
  export class TransfersInstantAccountVerification<HandleError extends boolean = boolean> {
3906
3774
  protected readonly apiClient: JwtClient<HandleError>;
@@ -4134,17 +4002,19 @@ export class TransfersAcats<HandleError extends boolean = boolean> {
4134
4002
  type?: string;
4135
4003
  }[], config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4136
4004
  }
4137
- export class TransfersPositions<HandleError extends boolean = boolean> {
4005
+ export class TransfersJournals<HandleError extends boolean = boolean> {
4138
4006
  protected readonly apiClient: JwtClient<HandleError>;
4139
4007
  constructor(apiClient: JwtClient<HandleError>);
4140
4008
  /**
4141
- * @tags Transfers Positions
4142
- * @name TransferRequest
4143
- * @summary Transfer request
4144
- * @request POST:/transfer/position/request
4009
+ * @tags Transfers Journals
4010
+ * @name JournalRequest
4011
+ * @summary Journal request
4012
+ * @request POST:/transfer/journal/request
4145
4013
  * @secure
4146
4014
  */
4147
- transferRequest(data: {
4015
+ journalRequest(data: {
4016
+ /** @example 1000 */
4017
+ amount?: any;
4148
4018
  deliverFrom?: {
4149
4019
  /** @example 124 */
4150
4020
  accountId?: number;
@@ -4157,33 +4027,101 @@ export class TransfersPositions<HandleError extends boolean = boolean> {
4157
4027
  /** @example "DEF123456" */
4158
4028
  accountNumber?: string;
4159
4029
  };
4160
- /** @example "NoPurpose|Gift" */
4161
- purpose?: any;
4162
- /** @example 1000 */
4163
- quantity?: any;
4164
- quote?: {
4165
- /** @example "IBM" */
4166
- symbol?: string;
4030
+ /** @example "MM/dd/yyyy HH:mm:ss z" */
4031
+ deliveryDate?: any;
4032
+ loa?: {
4033
+ /** @example "" */
4034
+ fullName?: string;
4035
+ /** @example "" */
4036
+ remoteAddr?: string;
4037
+ /** @example "" */
4038
+ remoteDevice?: string;
4039
+ /** @example "" */
4040
+ signature?: string;
4041
+ /** @example "MM/dd/yyyy HH:mm:ss z" */
4042
+ timestamp?: string;
4167
4043
  };
4044
+ /** @example "NoPurpose|Gift|StockGift" */
4045
+ purpose?: any;
4168
4046
  /** @example "" */
4169
4047
  reason?: any;
4170
4048
  /** @example "0.0.0.0" */
4171
4049
  remoteAddr?: any;
4172
4050
  /** @example "Ultra fast proxy" */
4173
4051
  remoteDevice?: any;
4052
+ /** @example "required for StockGift" */
4053
+ symbol?: any;
4054
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4055
+ /**
4056
+ * @tags Transfers Journals
4057
+ * @name Search
4058
+ * @summary Search
4059
+ * @request POST:/transfer/journal/search
4060
+ * @secure
4061
+ */
4062
+ search(data: {
4063
+ account?: {
4064
+ /** @example 0 */
4065
+ accountId?: number;
4066
+ /** @example "ABC123456" */
4067
+ accountNumber?: string;
4068
+ };
4069
+ /** @example "PLACED|SENT|..." */
4070
+ status?: any;
4071
+ /** @example "AB123456" */
4072
+ transferId?: any;
4174
4073
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4175
4074
  }
4176
- export class TransfersWires<HandleError extends boolean = boolean> {
4075
+ export class TransfersPositions<HandleError extends boolean = boolean> {
4177
4076
  protected readonly apiClient: JwtClient<HandleError>;
4178
4077
  constructor(apiClient: JwtClient<HandleError>);
4179
4078
  /**
4180
- * @tags Transfers Wires
4181
- * @name Outgoing
4182
- * @summary Outgoing
4183
- * @request POST:/transfer/wire/outgoing
4184
- * @secure
4185
- */
4186
- outgoing(data: {
4079
+ * @tags Transfers Positions
4080
+ * @name TransferRequest
4081
+ * @summary Transfer request
4082
+ * @request POST:/transfer/position/request
4083
+ * @secure
4084
+ */
4085
+ transferRequest(data: {
4086
+ deliverFrom?: {
4087
+ /** @example 124 */
4088
+ accountId?: number;
4089
+ /** @example "ABC123456" */
4090
+ accountNumber?: string;
4091
+ };
4092
+ deliverTo?: {
4093
+ /** @example 456 */
4094
+ accountId?: number;
4095
+ /** @example "DEF123456" */
4096
+ accountNumber?: string;
4097
+ };
4098
+ /** @example "NoPurpose|Gift" */
4099
+ purpose?: any;
4100
+ /** @example 1000 */
4101
+ quantity?: any;
4102
+ quote?: {
4103
+ /** @example "IBM" */
4104
+ symbol?: string;
4105
+ };
4106
+ /** @example "" */
4107
+ reason?: any;
4108
+ /** @example "0.0.0.0" */
4109
+ remoteAddr?: any;
4110
+ /** @example "Ultra fast proxy" */
4111
+ remoteDevice?: any;
4112
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4113
+ }
4114
+ export class TransfersWires<HandleError extends boolean = boolean> {
4115
+ protected readonly apiClient: JwtClient<HandleError>;
4116
+ constructor(apiClient: JwtClient<HandleError>);
4117
+ /**
4118
+ * @tags Transfers Wires
4119
+ * @name Outgoing
4120
+ * @summary Outgoing
4121
+ * @request POST:/transfer/wire/outgoing
4122
+ * @secure
4123
+ */
4124
+ outgoing(data: {
4187
4125
  /** @example "TRACCOUNT" */
4188
4126
  account?: any;
4189
4127
  /** @example 200 */
@@ -4266,76 +4204,6 @@ export class TransfersWires<HandleError extends boolean = boolean> {
4266
4204
  remoteDevice?: any;
4267
4205
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4268
4206
  }
4269
- export class TransfersJournals<HandleError extends boolean = boolean> {
4270
- protected readonly apiClient: JwtClient<HandleError>;
4271
- constructor(apiClient: JwtClient<HandleError>);
4272
- /**
4273
- * @tags Transfers Journals
4274
- * @name JournalRequest
4275
- * @summary Journal request
4276
- * @request POST:/transfer/journal/request
4277
- * @secure
4278
- */
4279
- journalRequest(data: {
4280
- /** @example 1000 */
4281
- amount?: any;
4282
- deliverFrom?: {
4283
- /** @example 124 */
4284
- accountId?: number;
4285
- /** @example "ABC123456" */
4286
- accountNumber?: string;
4287
- };
4288
- deliverTo?: {
4289
- /** @example 456 */
4290
- accountId?: number;
4291
- /** @example "DEF123456" */
4292
- accountNumber?: string;
4293
- };
4294
- /** @example "MM/dd/yyyy HH:mm:ss z" */
4295
- deliveryDate?: any;
4296
- loa?: {
4297
- /** @example "" */
4298
- fullName?: string;
4299
- /** @example "" */
4300
- remoteAddr?: string;
4301
- /** @example "" */
4302
- remoteDevice?: string;
4303
- /** @example "" */
4304
- signature?: string;
4305
- /** @example "MM/dd/yyyy HH:mm:ss z" */
4306
- timestamp?: string;
4307
- };
4308
- /** @example "NoPurpose|Gift|StockGift" */
4309
- purpose?: any;
4310
- /** @example "" */
4311
- reason?: any;
4312
- /** @example "0.0.0.0" */
4313
- remoteAddr?: any;
4314
- /** @example "Ultra fast proxy" */
4315
- remoteDevice?: any;
4316
- /** @example "required for StockGift" */
4317
- symbol?: any;
4318
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4319
- /**
4320
- * @tags Transfers Journals
4321
- * @name Search
4322
- * @summary Search
4323
- * @request POST:/transfer/journal/search
4324
- * @secure
4325
- */
4326
- search(data: {
4327
- account?: {
4328
- /** @example 0 */
4329
- accountId?: number;
4330
- /** @example "ABC123456" */
4331
- accountNumber?: string;
4332
- };
4333
- /** @example "PLACED|SENT|..." */
4334
- status?: any;
4335
- /** @example "AB123456" */
4336
- transferId?: any;
4337
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4338
- }
4339
4207
  export class TransfersBank<HandleError extends boolean = boolean> {
4340
4208
  protected readonly apiClient: JwtClient<HandleError>;
4341
4209
  constructor(apiClient: JwtClient<HandleError>);
@@ -4453,166 +4321,108 @@ export class TransfersInstantCashTransfers<HandleError extends boolean = boolean
4453
4321
  */
4454
4322
  listReports(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4455
4323
  }
4456
- export class Documents<HandleError extends boolean = boolean> {
4324
+ export class TransfersCheques<HandleError extends boolean = boolean> {
4457
4325
  protected readonly apiClient: JwtClient<HandleError>;
4458
4326
  constructor(apiClient: JwtClient<HandleError>);
4459
4327
  /**
4460
- * @tags Documents
4461
- * @name Confirm
4462
- * @summary Confirm
4463
- * @request GET:/documents/confirm
4328
+ * @tags Transfers Cheques
4329
+ * @name Withdrawal
4330
+ * @summary Withdrawal
4331
+ * @request POST:/transfer/check/outgoing
4464
4332
  * @secure
4465
4333
  */
4466
- confirm(query?: {
4467
- /**
4468
- * *_accountNumber_ is accepted as well*
4469
- * @example "5VA0XXXX"
4470
- */
4471
- account?: any;
4472
- /**
4473
- * Date for the confirm. The required date format is: mm/dd/yyyy.
4474
- * @example "03/03/2018"
4475
- */
4476
- date?: any;
4477
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4334
+ withdrawal(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4335
+ }
4336
+ export class Branch<HandleError extends boolean = boolean> {
4337
+ protected readonly apiClient: JwtClient<HandleError>;
4338
+ constructor(apiClient: JwtClient<HandleError>);
4478
4339
  /**
4479
- * @tags Documents
4480
- * @name ListOfConfirms
4481
- * @summary List of Confirms
4482
- * @request GET:/documents/confirm/list
4340
+ * @tags Branch
4341
+ * @name BranchRtb
4342
+ * @request GET:/v1/branch/rtb
4483
4343
  * @secure
4484
4344
  */
4485
- listOfConfirms(query?: {
4486
- /**
4487
- * *_accountNumber_ is accepted as well*
4488
- * @example "5VA0XXXX"
4489
- */
4490
- account?: any;
4491
- /**
4492
- * Start date for the list of confirms. The required date format is: `mm/dd/yyyy`.
4493
- * @example "01/01/2017"
4494
- */
4495
- beginDate?: any;
4496
- /**
4497
- * End date for the list of confirms. The required date format is: `mm/dd/yyyy`.
4498
- * @example "03/01/2018"
4499
- */
4500
- endDate?: any;
4501
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4345
+ branchRtb(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4502
4346
  /**
4503
- * @tags Documents
4504
- * @name ServiceDocs
4505
- * @summary Service Docs
4506
- * @request GET:/documents/service
4347
+ * @tags Branch
4348
+ * @name BranchRtbs
4349
+ * @request GET:/v1/branch/rtbs
4507
4350
  * @secure
4508
4351
  */
4509
- serviceDocs(query?: {
4510
- /** @example "5VA0XXXX" */
4511
- accountNumber?: any;
4512
- /** See table for details. Leave blank for all document types. */
4513
- docType?: any;
4352
+ branchRtbs(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4353
+ /**
4354
+ * @tags Branch
4355
+ * @name BranchInventory
4356
+ * @request GET:/v1/branch/inventory
4357
+ * @secure
4358
+ */
4359
+ branchInventory(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4360
+ /**
4361
+ * @tags Branch
4362
+ * @name BranchRtbsTotal
4363
+ * @request GET:/v1/branch/rtbs/total
4364
+ * @secure
4365
+ */
4366
+ branchRtbsTotal(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4367
+ /**
4368
+ * @tags Branch
4369
+ * @name BranchPortfolio
4370
+ * @request GET:/v1/branch/portfolio
4371
+ * @secure
4372
+ */
4373
+ branchPortfolio(query?: {
4514
4374
  /**
4515
- * The beginning 2-digit month (MM) to be used as search criteria.
4516
- * @example "01"
4375
+ * (true or false) Allows for loading of quotes for each portfolio entry. Defaults to false.
4376
+ * @example "false"
4517
4377
  */
4518
- beginMonth?: any;
4378
+ loadQuotes?: any;
4379
+ /** @example "false" */
4380
+ loadIndustries?: any;
4381
+ /** @example "false" */
4382
+ loadUpgrades?: any;
4383
+ /** @example "false" */
4384
+ loadEarnings?: any;
4519
4385
  /**
4520
- * The beginning 4-digit year (YYYY) to be used as search criteria.
4521
- * @example "2012"
4386
+ * Load balances for weight
4387
+ * @example "false"
4522
4388
  */
4523
- beginYear?: any;
4389
+ loadRtb?: any;
4524
4390
  /**
4525
- * The ending 2-digit month (MM) to be used as search criteria.
4526
- * @example "12"
4391
+ * Analyze market caps and get `marketCapWeights`. To be used in conjuction with `loadQuotes`
4392
+ * @example "false"
4527
4393
  */
4528
- endMonth?: any;
4394
+ marketCapBreakdown?: any;
4529
4395
  /**
4530
- * The ending 4-digit year (YYYY) to be used as search criteria.
4531
- * @example "2017"
4396
+ * Combined portfolio for the branch
4397
+ * @example "false"
4532
4398
  */
4533
- endYear?: any;
4399
+ combined?: any;
4400
+ /** @example "1" */
4401
+ pageNum?: any;
4402
+ /** @example "100" */
4403
+ pageSize?: any;
4534
4404
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4535
4405
  /**
4536
- * @tags Documents
4537
- * @name DocumentList
4538
- * @summary Document list
4539
- * @request GET:/documents/list
4406
+ * @tags Branch
4407
+ * @name OptionExpirations
4408
+ * @summary Option expirations
4409
+ * @request GET:/v1/branch/portfolio/options/upcoming
4540
4410
  * @secure
4541
4411
  */
4542
- documentList(query?: {
4543
- /** @example "5VA0XXXX" */
4544
- account?: any;
4545
- /**
4546
- * Omit for all document types.
4547
- * @example "All"
4548
- */
4549
- documentType?: any;
4550
- /**
4551
- * Indicates start month & year (day of month is not used)
4552
- * @example "1/1/2021"
4553
- */
4554
- fromMonth?: any;
4555
- /**
4556
- * Indicates end month & year (day of month is not used)
4557
- * @example "12/1/2021"
4558
- */
4559
- toMonth?: any;
4560
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4561
- /**
4562
- * @tags Documents
4563
- * @name AvailableDocumentTypes
4564
- * @summary Available document types
4565
- * @request GET:/documents/types
4566
- * @secure
4567
- */
4568
- availableDocumentTypes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4569
- /**
4570
- * @tags Documents
4571
- * @name AvailableDocumentTypesAndCodes
4572
- * @summary Available document types and codes
4573
- * @request GET:/documents/typesAndCodes
4574
- * @secure
4575
- */
4576
- availableDocumentTypesAndCodes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4412
+ optionExpirations(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4577
4413
  /**
4578
- * @tags Documents
4579
- * @name Download
4580
- * @summary Download
4581
- * @request GET:/documents/download
4414
+ * @tags Branch
4415
+ * @name OptionExpirationsDetails
4416
+ * @summary Option expirations details
4417
+ * @request POST:/v1/branch/portfolio/options/upcoming/details
4582
4418
  * @secure
4583
4419
  */
4584
- download(query?: {
4585
- /**
4586
- * Account Number
4587
- * @example "{accountNumber}"
4588
- */
4589
- account?: any;
4590
- /**
4591
- * UUID for finding specific document
4592
- * @example "{key}"
4593
- */
4594
- key?: any;
4420
+ optionExpirationsDetails(data: {
4421
+ /** @example "true|false" */
4422
+ loadQuotes?: any;
4423
+ /** @example "01/15/2021 00:00:00 EST" */
4424
+ maturity?: any;
4595
4425
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4596
- /**
4597
- * @tags Documents
4598
- * @name GetAllBranchDocuments
4599
- * @summary Get all Branch Documents
4600
- * @request GET:/documents/branch/list
4601
- * @secure
4602
- */
4603
- getAllBranchDocuments(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4604
- }
4605
- export class TransfersCheques<HandleError extends boolean = boolean> {
4606
- protected readonly apiClient: JwtClient<HandleError>;
4607
- constructor(apiClient: JwtClient<HandleError>);
4608
- /**
4609
- * @tags Transfers Cheques
4610
- * @name Withdrawal
4611
- * @summary Withdrawal
4612
- * @request POST:/transfer/check/outgoing
4613
- * @secure
4614
- */
4615
- withdrawal(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4616
4426
  }
4617
4427
  export class Transfers<HandleError extends boolean = boolean> {
4618
4428
  protected readonly apiClient: JwtClient<HandleError>;
@@ -4848,278 +4658,154 @@ export class Transfers<HandleError extends boolean = boolean> {
4848
4658
  wallet?: any;
4849
4659
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4850
4660
  }
4851
- export class Branch<HandleError extends boolean = boolean> {
4661
+ export class Documents<HandleError extends boolean = boolean> {
4852
4662
  protected readonly apiClient: JwtClient<HandleError>;
4853
4663
  constructor(apiClient: JwtClient<HandleError>);
4854
4664
  /**
4855
- * @tags Branch
4856
- * @name BranchRtb
4857
- * @request GET:/v1/branch/rtb
4858
- * @secure
4859
- */
4860
- branchRtb(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4861
- /**
4862
- * @tags Branch
4863
- * @name BranchRtbs
4864
- * @request GET:/v1/branch/rtbs
4865
- * @secure
4866
- */
4867
- branchRtbs(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4868
- /**
4869
- * @tags Branch
4870
- * @name BranchInventory
4871
- * @request GET:/v1/branch/inventory
4665
+ * @tags Documents
4666
+ * @name Confirm
4667
+ * @summary Confirm
4668
+ * @request GET:/documents/confirm
4872
4669
  * @secure
4873
4670
  */
4874
- branchInventory(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4671
+ confirm(query?: {
4672
+ /**
4673
+ * *_accountNumber_ is accepted as well*
4674
+ * @example "5VA0XXXX"
4675
+ */
4676
+ account?: any;
4677
+ /**
4678
+ * Date for the confirm. The required date format is: mm/dd/yyyy.
4679
+ * @example "03/03/2018"
4680
+ */
4681
+ date?: any;
4682
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4875
4683
  /**
4876
- * @tags Branch
4877
- * @name BranchRtbsTotal
4878
- * @request GET:/v1/branch/rtbs/total
4684
+ * @tags Documents
4685
+ * @name ListOfConfirms
4686
+ * @summary List of Confirms
4687
+ * @request GET:/documents/confirm/list
4879
4688
  * @secure
4880
4689
  */
4881
- branchRtbsTotal(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4690
+ listOfConfirms(query?: {
4691
+ /**
4692
+ * *_accountNumber_ is accepted as well*
4693
+ * @example "5VA0XXXX"
4694
+ */
4695
+ account?: any;
4696
+ /**
4697
+ * Start date for the list of confirms. The required date format is: `mm/dd/yyyy`.
4698
+ * @example "01/01/2017"
4699
+ */
4700
+ beginDate?: any;
4701
+ /**
4702
+ * End date for the list of confirms. The required date format is: `mm/dd/yyyy`.
4703
+ * @example "03/01/2018"
4704
+ */
4705
+ endDate?: any;
4706
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4882
4707
  /**
4883
- * @tags Branch
4884
- * @name BranchPortfolio
4885
- * @request GET:/v1/branch/portfolio
4708
+ * @tags Documents
4709
+ * @name ServiceDocs
4710
+ * @summary Service Docs
4711
+ * @request GET:/documents/service
4886
4712
  * @secure
4887
4713
  */
4888
- branchPortfolio(query?: {
4714
+ serviceDocs(query?: {
4715
+ /** @example "5VA0XXXX" */
4716
+ accountNumber?: any;
4717
+ /** See table for details. Leave blank for all document types. */
4718
+ docType?: any;
4889
4719
  /**
4890
- * (true or false) Allows for loading of quotes for each portfolio entry. Defaults to false.
4891
- * @example "false"
4720
+ * The beginning 2-digit month (MM) to be used as search criteria.
4721
+ * @example "01"
4892
4722
  */
4893
- loadQuotes?: any;
4894
- /** @example "false" */
4895
- loadIndustries?: any;
4896
- /** @example "false" */
4897
- loadUpgrades?: any;
4898
- /** @example "false" */
4899
- loadEarnings?: any;
4723
+ beginMonth?: any;
4900
4724
  /**
4901
- * Load balances for weight
4902
- * @example "false"
4725
+ * The beginning 4-digit year (YYYY) to be used as search criteria.
4726
+ * @example "2012"
4903
4727
  */
4904
- loadRtb?: any;
4728
+ beginYear?: any;
4905
4729
  /**
4906
- * Analyze market caps and get `marketCapWeights`. To be used in conjuction with `loadQuotes`
4907
- * @example "false"
4730
+ * The ending 2-digit month (MM) to be used as search criteria.
4731
+ * @example "12"
4908
4732
  */
4909
- marketCapBreakdown?: any;
4733
+ endMonth?: any;
4910
4734
  /**
4911
- * Combined portfolio for the branch
4912
- * @example "false"
4735
+ * The ending 4-digit year (YYYY) to be used as search criteria.
4736
+ * @example "2017"
4913
4737
  */
4914
- combined?: any;
4915
- /** @example "1" */
4916
- pageNum?: any;
4917
- /** @example "100" */
4918
- pageSize?: any;
4738
+ endYear?: any;
4919
4739
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4920
4740
  /**
4921
- * @tags Branch
4922
- * @name OptionExpirations
4923
- * @summary Option expirations
4924
- * @request GET:/v1/branch/portfolio/options/upcoming
4925
- * @secure
4926
- */
4927
- optionExpirations(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4928
- /**
4929
- * @tags Branch
4930
- * @name OptionExpirationsDetails
4931
- * @summary Option expirations details
4932
- * @request POST:/v1/branch/portfolio/options/upcoming/details
4741
+ * @tags Documents
4742
+ * @name DocumentList
4743
+ * @summary Document list
4744
+ * @request GET:/documents/list
4933
4745
  * @secure
4934
4746
  */
4935
- optionExpirationsDetails(data: {
4936
- /** @example "true|false" */
4937
- loadQuotes?: any;
4938
- /** @example "01/15/2021 00:00:00 EST" */
4939
- maturity?: any;
4747
+ documentList(query?: {
4748
+ /** @example "5VA0XXXX" */
4749
+ account?: any;
4750
+ /**
4751
+ * Omit for all document types.
4752
+ * @example "All"
4753
+ */
4754
+ documentType?: any;
4755
+ /**
4756
+ * Indicates start month & year (day of month is not used)
4757
+ * @example "1/1/2021"
4758
+ */
4759
+ fromMonth?: any;
4760
+ /**
4761
+ * Indicates end month & year (day of month is not used)
4762
+ * @example "12/1/2021"
4763
+ */
4764
+ toMonth?: any;
4940
4765
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4941
- }
4942
- export class Miscellaneous<HandleError extends boolean = boolean> {
4943
- protected readonly apiClient: JwtClient<HandleError>;
4944
- constructor(apiClient: JwtClient<HandleError>);
4945
4766
  /**
4946
- * @tags Miscellaneous
4947
- * @name ResearchMarketdate
4948
- * @summary /research/marketDate
4949
- * @request GET:/research/marketDate
4767
+ * @tags Documents
4768
+ * @name AvailableDocumentTypes
4769
+ * @summary Available document types
4770
+ * @request GET:/documents/types
4950
4771
  * @secure
4951
4772
  */
4952
- researchMarketdate(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4773
+ availableDocumentTypes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4953
4774
  /**
4954
- * @tags Miscellaneous
4955
- * @name ResearchDatesMarkets
4956
- * @summary /research/dates/markets
4957
- * @request GET:/research/dates/markets
4775
+ * @tags Documents
4776
+ * @name AvailableDocumentTypesAndCodes
4777
+ * @summary Available document types and codes
4778
+ * @request GET:/documents/typesAndCodes
4958
4779
  * @secure
4959
4780
  */
4960
- researchDatesMarkets(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4781
+ availableDocumentTypesAndCodes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4961
4782
  /**
4962
- * @tags Miscellaneous
4963
- * @name ResearchDatesLastopen
4964
- * @summary /research/dates/lastOpen
4965
- * @request GET:/research/dates/lastOpen
4783
+ * @tags Documents
4784
+ * @name Download
4785
+ * @summary Download
4786
+ * @request GET:/documents/download
4966
4787
  * @secure
4967
4788
  */
4968
- researchDatesLastopen(query?: {
4789
+ download(query?: {
4969
4790
  /**
4970
- * Optional value for the market
4971
- * @example "U"
4791
+ * Account Number
4792
+ * @example "{accountNumber}"
4972
4793
  */
4973
- market?: any;
4974
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4975
- /**
4976
- * @tags Miscellaneous
4977
- * @name ResearchDatesCheck
4978
- * @summary /research/dates/check
4979
- * @request GET:/research/dates/check
4980
- * @secure
4981
- */
4982
- researchDatesCheck(query?: {
4983
- /**
4984
- * Optional value for the market
4985
- * @example "U"
4986
- */
4987
- market?: any;
4988
- /**
4989
- * Optional
4990
- * @example "9/24/2018"
4991
- */
4992
- date?: any;
4993
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4994
- /**
4995
- * @tags Miscellaneous
4996
- * @name AdvisoryInfo
4997
- * @request GET:/v2/advisory/info
4998
- * @secure
4999
- */
5000
- advisoryInfo(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5001
- /**
5002
- * @tags Miscellaneous
5003
- * @name AdvisoryInfoUpdate
5004
- * @request POST:/v2/advisory/info/update
5005
- * @secure
5006
- */
5007
- advisoryInfoUpdate(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5008
- /**
5009
- * @tags Miscellaneous
5010
- * @name FilesUserAvatarUpload
5011
- * @request POST:/v1/files/user/avatar/upload
5012
- * @secure
5013
- */
5014
- filesUserAvatarUpload(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5015
- /**
5016
- * @tags Miscellaneous
5017
- * @name FilesUpload
5018
- * @request POST:/v1/files/upload
5019
- * @secure
5020
- */
5021
- filesUpload(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5022
- /**
5023
- * @tags Miscellaneous
5024
- * @name FilesUploadAvatar
5025
- * @request POST:/v1/files/upload/avatar/{userId}
5026
- * @secure
5027
- */
5028
- filesUploadAvatar(userId: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5029
- /**
5030
- * @tags Miscellaneous
5031
- * @name FilesUserAvatar
5032
- * @request GET:/v1/files/user/avatar
5033
- * @secure
5034
- */
5035
- filesUserAvatar(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5036
- /**
5037
- * @tags Miscellaneous
5038
- * @name FilesAvatar
5039
- * @request GET:/v1/files/{userId}/avatar
5040
- * @secure
5041
- */
5042
- filesAvatar(userId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5043
- /**
5044
- * @tags Miscellaneous
5045
- * @name FilesDownload
5046
- * @request GET:/v1/files/download/{tag}/{id}
5047
- * @secure
5048
- */
5049
- filesDownload(tag: string, id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5050
- /**
5051
- * @tags Miscellaneous
5052
- * @name FilesList
5053
- * @request GET:/v1/files/list
5054
- * @secure
5055
- */
5056
- filesList(query?: {
5057
- /**
5058
- * Optional. Allows filtering for tags
5059
- * @example "document*"
5060
- */
5061
- tag?: any;
4794
+ account?: any;
5062
4795
  /**
5063
- * Optional. Allows filtering for filenames
5064
- * @example "application*"
4796
+ * UUID for finding specific document
4797
+ * @example "{key}"
5065
4798
  */
5066
- filename?: any;
4799
+ key?: any;
5067
4800
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5068
4801
  /**
5069
- * @tags Miscellaneous
5070
- * @name FilesAllowedExts
5071
- * @request GET:/v1/files/allowed/exts
5072
- * @secure
5073
- */
5074
- filesAllowedExts(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5075
- /**
5076
- * @tags Miscellaneous
5077
- * @name ErrorCodeListing
5078
- * @summary Error code listing
5079
- * @request GET:/general/errors
5080
- * @secure
5081
- */
5082
- errorCodeListing(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5083
- /**
5084
- * @tags Miscellaneous
5085
- * @name Ping
5086
- * @summary Ping
5087
- * @request GET:/general/ping
5088
- * @secure
5089
- */
5090
- ping(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5091
- /**
5092
- * @tags Miscellaneous
5093
- * @name CurrencyList
5094
- * @summary Currency list
5095
- * @request GET:/general/available-currencies
5096
- * @secure
5097
- */
5098
- currencyList(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5099
- /**
5100
- * @tags Miscellaneous
5101
- * @name TradableCurrencyList
5102
- * @summary Tradable currency list
5103
- * @request GET:/general/tradable-currencies
5104
- * @secure
5105
- */
5106
- tradableCurrencyList(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5107
- /**
5108
- * @tags Miscellaneous
5109
- * @name OptionStrategyTypes
5110
- * @summary Option Strategy Types
5111
- * @request GET:/general/options/strategyTypes
5112
- * @secure
5113
- */
5114
- optionStrategyTypes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5115
- /**
5116
- * @tags Miscellaneous
5117
- * @name OptionStrategyClassifications
5118
- * @summary Option Strategy Classifications
5119
- * @request GET:/general/options/strategyClassifications
4802
+ * @tags Documents
4803
+ * @name GetAllBranchDocuments
4804
+ * @summary Get all Branch Documents
4805
+ * @request GET:/documents/branch/list
5120
4806
  * @secure
5121
4807
  */
5122
- optionStrategyClassifications(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4808
+ getAllBranchDocuments(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5123
4809
  }
5124
4810
  export class LegalDocuments<HandleError extends boolean = boolean> {
5125
4811
  protected readonly apiClient: JwtClient<HandleError>;
@@ -5229,6 +4915,111 @@ export class LegalDocuments<HandleError extends boolean = boolean> {
5229
4915
  remoteDevice?: any;
5230
4916
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5231
4917
  }
4918
+ export class BlacklistAdminBusinesses<HandleError extends boolean = boolean> {
4919
+ protected readonly apiClient: JwtClient<HandleError>;
4920
+ constructor(apiClient: JwtClient<HandleError>);
4921
+ /**
4922
+ * @tags Blacklist Admin Businesses
4923
+ * @name GetBusinessesList
4924
+ * @summary Get Businesses list
4925
+ * @request GET:/v1/admin/businesses
4926
+ * @secure
4927
+ */
4928
+ getBusinessesList(query?: {
4929
+ /**
4930
+ * (Required) page number
4931
+ * @example "5567183"
4932
+ */
4933
+ page?: any;
4934
+ /**
4935
+ * (Required) page size in records displayed
4936
+ * @example "5567183"
4937
+ */
4938
+ page_size?: any;
4939
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4940
+ /**
4941
+ * @tags Blacklist Admin Businesses
4942
+ * @name CreateBusiness
4943
+ * @summary Create Business
4944
+ * @request POST:/v1/admin/businesses
4945
+ * @secure
4946
+ */
4947
+ createBusiness(data: {
4948
+ /** @example "Gracia Marina" */
4949
+ business_name?: any;
4950
+ /** @example "Los Angeles" */
4951
+ city?: any;
4952
+ /** @example "US" */
4953
+ country?: any;
4954
+ /** @example "La Granja Del Camaron" */
4955
+ dba_name?: any;
4956
+ /** @example "" */
4957
+ incorporated?: any;
4958
+ /** @example "812748955" */
4959
+ number?: any;
4960
+ /** @example "EIN" */
4961
+ number_type?: any;
4962
+ /** @example "" */
4963
+ phone?: any;
4964
+ /** @example "CA" */
4965
+ state?: any;
4966
+ /** @example "1119 E 8th St Ste C" */
4967
+ street?: any;
4968
+ /** @example "304902" */
4969
+ tracking_number?: any;
4970
+ /** @example "90021" */
4971
+ zip?: any;
4972
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4973
+ /**
4974
+ * @tags Blacklist Admin Businesses
4975
+ * @name GetBusinessById
4976
+ * @summary Get Business by ID
4977
+ * @request GET:/v1/admin/businesses/{id}
4978
+ * @secure
4979
+ */
4980
+ getBusinessById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4981
+ /**
4982
+ * @tags Blacklist Admin Businesses
4983
+ * @name UpdateBusiness
4984
+ * @summary Update Business
4985
+ * @request PUT:/v1/admin/businesses/{id}
4986
+ * @secure
4987
+ */
4988
+ updateBusiness(id: string, data: {
4989
+ /** @example "Gracia Marina" */
4990
+ business_name?: any;
4991
+ /** @example "Los Angeles" */
4992
+ city?: any;
4993
+ /** @example "US" */
4994
+ country?: any;
4995
+ /** @example "La Granja Del Camaron" */
4996
+ dba_name?: any;
4997
+ /** @example "" */
4998
+ incorporated?: any;
4999
+ /** @example "812748955" */
5000
+ number?: any;
5001
+ /** @example "EIN" */
5002
+ number_type?: any;
5003
+ /** @example "" */
5004
+ phone?: any;
5005
+ /** @example "CA" */
5006
+ state?: any;
5007
+ /** @example "1119 E 8th St Ste C" */
5008
+ street?: any;
5009
+ /** @example "304902" */
5010
+ tracking_number?: any;
5011
+ /** @example "90021" */
5012
+ zip?: any;
5013
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5014
+ /**
5015
+ * @tags Blacklist Admin Businesses
5016
+ * @name DeleteBusiness
5017
+ * @summary Delete Business
5018
+ * @request DELETE:/v1/admin/businesses/{id}
5019
+ * @secure
5020
+ */
5021
+ deleteBusiness(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5022
+ }
5232
5023
  export class BlacklistAdminIndividuals<HandleError extends boolean = boolean> {
5233
5024
  protected readonly apiClient: JwtClient<HandleError>;
5234
5025
  constructor(apiClient: JwtClient<HandleError>);
@@ -5358,111 +5149,6 @@ export class BlacklistAdminIndividuals<HandleError extends boolean = boolean> {
5358
5149
  */
5359
5150
  deleteIndividual(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5360
5151
  }
5361
- export class BlacklistAdminBusinesses<HandleError extends boolean = boolean> {
5362
- protected readonly apiClient: JwtClient<HandleError>;
5363
- constructor(apiClient: JwtClient<HandleError>);
5364
- /**
5365
- * @tags Blacklist Admin Businesses
5366
- * @name GetBusinessesList
5367
- * @summary Get Businesses list
5368
- * @request GET:/v1/admin/businesses
5369
- * @secure
5370
- */
5371
- getBusinessesList(query?: {
5372
- /**
5373
- * (Required) page number
5374
- * @example "5567183"
5375
- */
5376
- page?: any;
5377
- /**
5378
- * (Required) page size in records displayed
5379
- * @example "5567183"
5380
- */
5381
- page_size?: any;
5382
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5383
- /**
5384
- * @tags Blacklist Admin Businesses
5385
- * @name CreateBusiness
5386
- * @summary Create Business
5387
- * @request POST:/v1/admin/businesses
5388
- * @secure
5389
- */
5390
- createBusiness(data: {
5391
- /** @example "Gracia Marina" */
5392
- business_name?: any;
5393
- /** @example "Los Angeles" */
5394
- city?: any;
5395
- /** @example "US" */
5396
- country?: any;
5397
- /** @example "La Granja Del Camaron" */
5398
- dba_name?: any;
5399
- /** @example "" */
5400
- incorporated?: any;
5401
- /** @example "812748955" */
5402
- number?: any;
5403
- /** @example "EIN" */
5404
- number_type?: any;
5405
- /** @example "" */
5406
- phone?: any;
5407
- /** @example "CA" */
5408
- state?: any;
5409
- /** @example "1119 E 8th St Ste C" */
5410
- street?: any;
5411
- /** @example "304902" */
5412
- tracking_number?: any;
5413
- /** @example "90021" */
5414
- zip?: any;
5415
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5416
- /**
5417
- * @tags Blacklist Admin Businesses
5418
- * @name GetBusinessById
5419
- * @summary Get Business by ID
5420
- * @request GET:/v1/admin/businesses/{id}
5421
- * @secure
5422
- */
5423
- getBusinessById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5424
- /**
5425
- * @tags Blacklist Admin Businesses
5426
- * @name UpdateBusiness
5427
- * @summary Update Business
5428
- * @request PUT:/v1/admin/businesses/{id}
5429
- * @secure
5430
- */
5431
- updateBusiness(id: string, data: {
5432
- /** @example "Gracia Marina" */
5433
- business_name?: any;
5434
- /** @example "Los Angeles" */
5435
- city?: any;
5436
- /** @example "US" */
5437
- country?: any;
5438
- /** @example "La Granja Del Camaron" */
5439
- dba_name?: any;
5440
- /** @example "" */
5441
- incorporated?: any;
5442
- /** @example "812748955" */
5443
- number?: any;
5444
- /** @example "EIN" */
5445
- number_type?: any;
5446
- /** @example "" */
5447
- phone?: any;
5448
- /** @example "CA" */
5449
- state?: any;
5450
- /** @example "1119 E 8th St Ste C" */
5451
- street?: any;
5452
- /** @example "304902" */
5453
- tracking_number?: any;
5454
- /** @example "90021" */
5455
- zip?: any;
5456
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5457
- /**
5458
- * @tags Blacklist Admin Businesses
5459
- * @name DeleteBusiness
5460
- * @summary Delete Business
5461
- * @request DELETE:/v1/admin/businesses/{id}
5462
- * @secure
5463
- */
5464
- deleteBusiness(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5465
- }
5466
5152
  export class BlacklistSearch<HandleError extends boolean = boolean> {
5467
5153
  protected readonly apiClient: JwtClient<HandleError>;
5468
5154
  constructor(apiClient: JwtClient<HandleError>);
@@ -5534,6 +5220,188 @@ export class Blacklist<HandleError extends boolean = boolean> {
5534
5220
  */
5535
5221
  getHealth(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5536
5222
  }
5223
+ export class Miscellaneous<HandleError extends boolean = boolean> {
5224
+ protected readonly apiClient: JwtClient<HandleError>;
5225
+ constructor(apiClient: JwtClient<HandleError>);
5226
+ /**
5227
+ * @tags Miscellaneous
5228
+ * @name ResearchMarketdate
5229
+ * @summary /research/marketDate
5230
+ * @request GET:/research/marketDate
5231
+ * @secure
5232
+ */
5233
+ researchMarketdate(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5234
+ /**
5235
+ * @tags Miscellaneous
5236
+ * @name ResearchDatesMarkets
5237
+ * @summary /research/dates/markets
5238
+ * @request GET:/research/dates/markets
5239
+ * @secure
5240
+ */
5241
+ researchDatesMarkets(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5242
+ /**
5243
+ * @tags Miscellaneous
5244
+ * @name ResearchDatesLastopen
5245
+ * @summary /research/dates/lastOpen
5246
+ * @request GET:/research/dates/lastOpen
5247
+ * @secure
5248
+ */
5249
+ researchDatesLastopen(query?: {
5250
+ /**
5251
+ * Optional value for the market
5252
+ * @example "U"
5253
+ */
5254
+ market?: any;
5255
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5256
+ /**
5257
+ * @tags Miscellaneous
5258
+ * @name ResearchDatesCheck
5259
+ * @summary /research/dates/check
5260
+ * @request GET:/research/dates/check
5261
+ * @secure
5262
+ */
5263
+ researchDatesCheck(query?: {
5264
+ /**
5265
+ * Optional value for the market
5266
+ * @example "U"
5267
+ */
5268
+ market?: any;
5269
+ /**
5270
+ * Optional
5271
+ * @example "9/24/2018"
5272
+ */
5273
+ date?: any;
5274
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5275
+ /**
5276
+ * @tags Miscellaneous
5277
+ * @name AdvisoryInfo
5278
+ * @request GET:/v2/advisory/info
5279
+ * @secure
5280
+ */
5281
+ advisoryInfo(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5282
+ /**
5283
+ * @tags Miscellaneous
5284
+ * @name AdvisoryInfoUpdate
5285
+ * @request POST:/v2/advisory/info/update
5286
+ * @secure
5287
+ */
5288
+ advisoryInfoUpdate(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5289
+ /**
5290
+ * @tags Miscellaneous
5291
+ * @name FilesUserAvatarUpload
5292
+ * @request POST:/v1/files/user/avatar/upload
5293
+ * @secure
5294
+ */
5295
+ filesUserAvatarUpload(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5296
+ /**
5297
+ * @tags Miscellaneous
5298
+ * @name FilesUpload
5299
+ * @request POST:/v1/files/upload
5300
+ * @secure
5301
+ */
5302
+ filesUpload(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5303
+ /**
5304
+ * @tags Miscellaneous
5305
+ * @name FilesUploadAvatar
5306
+ * @request POST:/v1/files/upload/avatar/{userId}
5307
+ * @secure
5308
+ */
5309
+ filesUploadAvatar(userId: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5310
+ /**
5311
+ * @tags Miscellaneous
5312
+ * @name FilesUserAvatar
5313
+ * @request GET:/v1/files/user/avatar
5314
+ * @secure
5315
+ */
5316
+ filesUserAvatar(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5317
+ /**
5318
+ * @tags Miscellaneous
5319
+ * @name FilesAvatar
5320
+ * @request GET:/v1/files/{userId}/avatar
5321
+ * @secure
5322
+ */
5323
+ filesAvatar(userId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5324
+ /**
5325
+ * @tags Miscellaneous
5326
+ * @name FilesDownload
5327
+ * @request GET:/v1/files/download/{tag}/{id}
5328
+ * @secure
5329
+ */
5330
+ filesDownload(tag: string, id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5331
+ /**
5332
+ * @tags Miscellaneous
5333
+ * @name FilesList
5334
+ * @request GET:/v1/files/list
5335
+ * @secure
5336
+ */
5337
+ filesList(query?: {
5338
+ /**
5339
+ * Optional. Allows filtering for tags
5340
+ * @example "document*"
5341
+ */
5342
+ tag?: any;
5343
+ /**
5344
+ * Optional. Allows filtering for filenames
5345
+ * @example "application*"
5346
+ */
5347
+ filename?: any;
5348
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5349
+ /**
5350
+ * @tags Miscellaneous
5351
+ * @name FilesAllowedExts
5352
+ * @request GET:/v1/files/allowed/exts
5353
+ * @secure
5354
+ */
5355
+ filesAllowedExts(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5356
+ /**
5357
+ * @tags Miscellaneous
5358
+ * @name ErrorCodeListing
5359
+ * @summary Error code listing
5360
+ * @request GET:/general/errors
5361
+ * @secure
5362
+ */
5363
+ errorCodeListing(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5364
+ /**
5365
+ * @tags Miscellaneous
5366
+ * @name Ping
5367
+ * @summary Ping
5368
+ * @request GET:/general/ping
5369
+ * @secure
5370
+ */
5371
+ ping(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5372
+ /**
5373
+ * @tags Miscellaneous
5374
+ * @name CurrencyList
5375
+ * @summary Currency list
5376
+ * @request GET:/general/available-currencies
5377
+ * @secure
5378
+ */
5379
+ currencyList(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5380
+ /**
5381
+ * @tags Miscellaneous
5382
+ * @name TradableCurrencyList
5383
+ * @summary Tradable currency list
5384
+ * @request GET:/general/tradable-currencies
5385
+ * @secure
5386
+ */
5387
+ tradableCurrencyList(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5388
+ /**
5389
+ * @tags Miscellaneous
5390
+ * @name OptionStrategyTypes
5391
+ * @summary Option Strategy Types
5392
+ * @request GET:/general/options/strategyTypes
5393
+ * @secure
5394
+ */
5395
+ optionStrategyTypes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5396
+ /**
5397
+ * @tags Miscellaneous
5398
+ * @name OptionStrategyClassifications
5399
+ * @summary Option Strategy Classifications
5400
+ * @request GET:/general/options/strategyClassifications
5401
+ * @secure
5402
+ */
5403
+ optionStrategyClassifications(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5404
+ }
5537
5405
  export class Broker<HandleError extends boolean = boolean> {
5538
5406
  protected readonly apiClient: JwtClient<HandleError>;
5539
5407
  constructor(apiClient: JwtClient<HandleError>);
@@ -5577,6 +5445,145 @@ export class Broker<HandleError extends boolean = boolean> {
5577
5445
  pageSize?: any;
5578
5446
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5579
5447
  }
5448
+ export class WatchmenFfiUserAccountManagement<HandleError extends boolean = boolean> {
5449
+ protected readonly apiClient: JwtClient<HandleError>;
5450
+ constructor(apiClient: JwtClient<HandleError>);
5451
+ /**
5452
+ * @tags Watchmen Ffi User Account Management
5453
+ * @name CreateUser
5454
+ * @summary Create User
5455
+ * @request POST:/rest/v1/uam/user/create
5456
+ * @secure
5457
+ */
5458
+ createUser(data: {
5459
+ /** @example "{optional} enable|disable - whether or not enable user for TipRanks" */
5460
+ Tipranks?: any;
5461
+ /** @example "{optional} true|false - defaults to false" */
5462
+ algos?: any;
5463
+ /** @example "{optional} true|false - defaults to false" */
5464
+ allSession?: any;
5465
+ /** @example "{optional} Full Name" */
5466
+ associatedName?: any;
5467
+ /** @example "{optional} true|false - defaults to false" */
5468
+ buyWrite?: any;
5469
+ /** @example "{optional} e-mail address" */
5470
+ email?: any;
5471
+ /** @example "{optional} true|false - defaults to true" */
5472
+ isTradingEnabled?: any;
5473
+ /** @example "{optional} Limit On Close - true|false - defaults to false" */
5474
+ loc?: any;
5475
+ /** @example "{optional} true|false - whether user is locked" */
5476
+ locked?: any;
5477
+ /** @example "{optional} Limit On Open - true|false - defaults to false" */
5478
+ loo?: any;
5479
+ /** @example "{optional} Market On Open - true|false - defaults to false" */
5480
+ moc?: any;
5481
+ /** @example "{optional} Market On Close - true|false - defaults to false" */
5482
+ moo?: any;
5483
+ /** @example "{optional} One Cancels Other - true|false - defaults to false" */
5484
+ oco?: any;
5485
+ /** @example "{optional} true|false - defaults to false" */
5486
+ optionRoll?: any;
5487
+ /** @example "{optional} true|false - defaults to false" */
5488
+ options?: any;
5489
+ /** @example "{optional}" */
5490
+ password?: any;
5491
+ /** @example "{optional} true|false - defaults to false" */
5492
+ prePostTrading?: any;
5493
+ /** @example "{optional} 1 - delayed, 0 - realtime, 4 - CBOE1, 3 - BATS" */
5494
+ quoteType?: any;
5495
+ /** @example "{optional} true|false - defaults to false" */
5496
+ spreads?: any;
5497
+ /** @example "A - active, S - suspended == initial user status" */
5498
+ status?: any;
5499
+ /** @example "{optional} true|false - defaults to false" */
5500
+ trailingStops?: any;
5501
+ /** @example "UNIQUE_USERNAME" */
5502
+ username?: any;
5503
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5504
+ /**
5505
+ * @tags Watchmen Ffi User Account Management
5506
+ * @name CreateAccount
5507
+ * @summary Create Account
5508
+ * @request POST:/rest/v1/uam/account/create
5509
+ * @secure
5510
+ */
5511
+ createAccount(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5512
+ /**
5513
+ * @tags Watchmen Ffi User Account Management
5514
+ * @name AccountInformation
5515
+ * @summary Account Information
5516
+ * @request GET:/rest/v1/uam/account/data
5517
+ * @secure
5518
+ */
5519
+ accountInformation(query?: {
5520
+ /** @example "AC123456" */
5521
+ accountNumber?: any;
5522
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5523
+ /**
5524
+ * @tags Watchmen Ffi User Account Management
5525
+ * @name UserInformation
5526
+ * @summary User Information
5527
+ * @request GET:/rest/v1/uam/user/data
5528
+ * @secure
5529
+ */
5530
+ userInformation(query?: {
5531
+ /** @example "USERNAME" */
5532
+ username?: any;
5533
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5534
+ /**
5535
+ * @tags Watchmen Ffi User Account Management
5536
+ * @name ListLinkedAccounts
5537
+ * @summary List Linked Accounts
5538
+ * @request GET:/rest/v1/linkedaccounts/listAccounts
5539
+ * @secure
5540
+ */
5541
+ listLinkedAccounts(query?: {
5542
+ /** @example "TEST.USER" */
5543
+ username?: any;
5544
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5545
+ /**
5546
+ * @tags Watchmen Ffi User Account Management
5547
+ * @name LinkUnlinkAccount
5548
+ * @summary Link/Unlink Account
5549
+ * @request POST:/rest/v1/linkedaccounts/linkUnlinkAccount
5550
+ * @secure
5551
+ */
5552
+ linkUnlinkAccount(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5553
+ /**
5554
+ * @tags Watchmen Ffi User Account Management
5555
+ * @name Visibility
5556
+ * @summary Visibility
5557
+ * @request POST:/rest/v1/linkedaccounts/visibility
5558
+ * @secure
5559
+ */
5560
+ visibility(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5561
+ /**
5562
+ * @tags Watchmen Ffi User Account Management
5563
+ * @name UserAccountSearch
5564
+ * @summary User/Account Search
5565
+ * @request POST:/rest/v1/uam/user-account-search
5566
+ * @secure
5567
+ */
5568
+ userAccountSearch(data: {
5569
+ /** @example "desired account number" */
5570
+ accountNumber?: any;
5571
+ /** @example 100 */
5572
+ limit?: any;
5573
+ /** @example 0 */
5574
+ lockedBit?: any;
5575
+ /** @example "desired username" */
5576
+ login?: any;
5577
+ /** @example false */
5578
+ noBrokers?: any;
5579
+ /** @example "" */
5580
+ omnibus?: any;
5581
+ /** @example false */
5582
+ onlyActiveAccount?: any;
5583
+ /** @example false */
5584
+ onlyActiveUser?: any;
5585
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5586
+ }
5580
5587
  export class WatchmenFfiFirmBranch<HandleError extends boolean = boolean> {
5581
5588
  protected readonly apiClient: JwtClient<HandleError>;
5582
5589
  constructor(apiClient: JwtClient<HandleError>);
@@ -5752,144 +5759,137 @@ export class WatchmenFfiFirmBranch<HandleError extends boolean = boolean> {
5752
5759
  id?: any;
5753
5760
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5754
5761
  }
5755
- export class WatchmenFfiUserAccountManagement<HandleError extends boolean = boolean> {
5762
+ export class AdvisoryCharges<HandleError extends boolean = boolean> {
5756
5763
  protected readonly apiClient: JwtClient<HandleError>;
5757
5764
  constructor(apiClient: JwtClient<HandleError>);
5758
5765
  /**
5759
- * @tags Watchmen Ffi User Account Management
5760
- * @name CreateUser
5761
- * @summary Create User
5762
- * @request POST:/rest/v1/uam/user/create
5766
+ * @tags Advisory Charges
5767
+ * @name Search
5768
+ * @summary /search
5769
+ * @request GET:/v2/charges/search
5763
5770
  * @secure
5764
5771
  */
5765
- createUser(data: {
5766
- /** @example "{optional} enable|disable - whether or not enable user for TipRanks" */
5767
- Tipranks?: any;
5768
- /** @example "{optional} true|false - defaults to false" */
5769
- algos?: any;
5770
- /** @example "{optional} true|false - defaults to false" */
5771
- allSession?: any;
5772
- /** @example "{optional} Full Name" */
5773
- associatedName?: any;
5774
- /** @example "{optional} true|false - defaults to false" */
5775
- buyWrite?: any;
5776
- /** @example "{optional} e-mail address" */
5777
- email?: any;
5778
- /** @example "{optional} true|false - defaults to true" */
5779
- isTradingEnabled?: any;
5780
- /** @example "{optional} Limit On Close - true|false - defaults to false" */
5781
- loc?: any;
5782
- /** @example "{optional} true|false - whether user is locked" */
5783
- locked?: any;
5784
- /** @example "{optional} Limit On Open - true|false - defaults to false" */
5785
- loo?: any;
5786
- /** @example "{optional} Market On Open - true|false - defaults to false" */
5787
- moc?: any;
5788
- /** @example "{optional} Market On Close - true|false - defaults to false" */
5789
- moo?: any;
5790
- /** @example "{optional} One Cancels Other - true|false - defaults to false" */
5791
- oco?: any;
5792
- /** @example "{optional} true|false - defaults to false" */
5793
- optionRoll?: any;
5794
- /** @example "{optional} true|false - defaults to false" */
5795
- options?: any;
5796
- /** @example "{optional}" */
5797
- password?: any;
5798
- /** @example "{optional} true|false - defaults to false" */
5799
- prePostTrading?: any;
5800
- /** @example "{optional} 1 - delayed, 0 - realtime, 4 - CBOE1, 3 - BATS" */
5801
- quoteType?: any;
5802
- /** @example "{optional} true|false - defaults to false" */
5803
- spreads?: any;
5804
- /** @example "A - active, S - suspended == initial user status" */
5805
- status?: any;
5806
- /** @example "{optional} true|false - defaults to false" */
5807
- trailingStops?: any;
5808
- /** @example "UNIQUE_USERNAME" */
5809
- username?: any;
5772
+ search(query?: {
5773
+ /**
5774
+ * Must be either this or `AccountNumber`
5775
+ * @example "12345"
5776
+ */
5777
+ AccountId?: any;
5778
+ /**
5779
+ * Must be either this or `AccountId`
5780
+ * @example "AB321654"
5781
+ */
5782
+ AccountNumber?: any;
5783
+ /**
5784
+ * `optional` - defaults to today
5785
+ * @example "7/1/2018"
5786
+ */
5787
+ DateFrom?: any;
5788
+ /**
5789
+ * `optional`
5790
+ * @example "7/1/2018"
5791
+ */
5792
+ DateTo?: any;
5793
+ /**
5794
+ * `optional`
5795
+ * @example "CH321654"
5796
+ */
5797
+ ChargeRef?: any;
5810
5798
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5811
5799
  /**
5812
- * @tags Watchmen Ffi User Account Management
5813
- * @name CreateAccount
5814
- * @summary Create Account
5815
- * @request POST:/rest/v1/uam/account/create
5800
+ * @tags Advisory Charges
5801
+ * @name Apply
5802
+ * @summary /apply
5803
+ * @request POST:/v2/charges/apply
5816
5804
  * @secure
5817
5805
  */
5818
- createAccount(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5806
+ apply(data: {
5807
+ /** @example 1234 */
5808
+ accountId?: any;
5809
+ /** @example 7.11 */
5810
+ amount?: any;
5811
+ /** @example "{timestamp}" */
5812
+ date?: any;
5813
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5819
5814
  /**
5820
- * @tags Watchmen Ffi User Account Management
5821
- * @name AccountInformation
5822
- * @summary Account Information
5823
- * @request GET:/rest/v1/uam/account/data
5815
+ * @tags Advisory Charges
5816
+ * @name Cancel
5817
+ * @summary /cancel
5818
+ * @request POST:/v2/charges/cancel
5824
5819
  * @secure
5825
5820
  */
5826
- accountInformation(query?: {
5827
- /** @example "AC123456" */
5828
- accountNumber?: any;
5829
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5821
+ cancel(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5822
+ }
5823
+ export class AdvisoryUserAccountManagement<HandleError extends boolean = boolean> {
5824
+ protected readonly apiClient: JwtClient<HandleError>;
5825
+ constructor(apiClient: JwtClient<HandleError>);
5830
5826
  /**
5831
- * @tags Watchmen Ffi User Account Management
5832
- * @name UserInformation
5833
- * @summary User Information
5834
- * @request GET:/rest/v1/uam/user/data
5827
+ * @tags Advisory User Account Management
5828
+ * @name List
5829
+ * @summary /list
5830
+ * @request GET:/v2/advisory/users/list
5835
5831
  * @secure
5836
5832
  */
5837
- userInformation(query?: {
5838
- /** @example "USERNAME" */
5839
- username?: any;
5840
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5833
+ list(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5841
5834
  /**
5842
- * @tags Watchmen Ffi User Account Management
5843
- * @name ListLinkedAccounts
5844
- * @summary List Linked Accounts
5845
- * @request GET:/rest/v1/linkedaccounts/listAccounts
5835
+ * @tags Advisory User Account Management
5836
+ * @name Accounts
5837
+ * @summary /accounts
5838
+ * @request GET:/v2/advisory/users/accounts
5846
5839
  * @secure
5847
5840
  */
5848
- listLinkedAccounts(query?: {
5849
- /** @example "TEST.USER" */
5850
- username?: any;
5841
+ accounts(query?: {
5842
+ /** @example "1234" */
5843
+ uid?: any;
5844
+ /**
5845
+ * true|false
5846
+ * @example "false"
5847
+ */
5848
+ loadRtb?: any;
5851
5849
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5852
5850
  /**
5853
- * @tags Watchmen Ffi User Account Management
5854
- * @name LinkUnlinkAccount
5855
- * @summary Link/Unlink Account
5856
- * @request POST:/rest/v1/linkedaccounts/linkUnlinkAccount
5851
+ * @tags Advisory User Account Management
5852
+ * @name AccountsStats
5853
+ * @summary /accounts/stats
5854
+ * @request GET:/v2/advisory/users/accounts/stats
5857
5855
  * @secure
5858
5856
  */
5859
- linkUnlinkAccount(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5857
+ accountsStats(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5860
5858
  /**
5861
- * @tags Watchmen Ffi User Account Management
5862
- * @name Visibility
5863
- * @summary Visibility
5864
- * @request POST:/rest/v1/linkedaccounts/visibility
5859
+ * @tags Advisory User Account Management
5860
+ * @name AccountNotes
5861
+ * @summary /account/notes
5862
+ * @request GET:/v2/advisory/users/account/notes
5865
5863
  * @secure
5866
5864
  */
5867
- visibility(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5865
+ accountNotes(query?: {
5866
+ /**
5867
+ * Account's ID
5868
+ * @example "1234"
5869
+ */
5870
+ aid?: any;
5871
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5868
5872
  /**
5869
- * @tags Watchmen Ffi User Account Management
5870
- * @name UserAccountSearch
5871
- * @summary User/Account Search
5872
- * @request POST:/rest/v1/uam/user-account-search
5873
+ * @tags Advisory User Account Management
5874
+ * @name Notes
5875
+ * @summary /notes
5876
+ * @request GET:/v2/advisory/users/notes
5873
5877
  * @secure
5874
5878
  */
5875
- userAccountSearch(data: {
5876
- /** @example "desired account number" */
5877
- accountNumber?: any;
5878
- /** @example 100 */
5879
- limit?: any;
5880
- /** @example 0 */
5881
- lockedBit?: any;
5882
- /** @example "desired username" */
5883
- login?: any;
5884
- /** @example false */
5885
- noBrokers?: any;
5886
- /** @example "" */
5887
- omnibus?: any;
5888
- /** @example false */
5889
- onlyActiveAccount?: any;
5890
- /** @example false */
5891
- onlyActiveUser?: any;
5879
+ notes(query?: {
5880
+ /**
5881
+ * User's ID
5882
+ * @example "1234"
5883
+ */
5884
+ uid?: any;
5892
5885
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5886
+ /**
5887
+ * @tags Advisory User Account Management
5888
+ * @name NotesPost
5889
+ * @request POST:/v2/advisory/users/notes/{action}
5890
+ * @secure
5891
+ */
5892
+ notesPost(action: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5893
5893
  }
5894
5894
  export class Advisory<HandleError extends boolean = boolean> {
5895
5895
  protected readonly apiClient: JwtClient<HandleError>;