@orbis-systems/orbis-api-clients 0.7.3 → 0.7.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/aesmidas/index.d.ts +301 -129
- package/dist/aesmidas/index.d.ts.map +1 -1
- package/dist/aesmidas/index.esm.js +1 -1
- package/dist/aesmidas/index.esm.js.map +1 -1
- package/dist/aesmidas/index.js +1 -1
- package/dist/aesmidas/index.js.map +1 -1
- package/dist/bridgewise/index.d.ts +345 -224
- package/dist/bridgewise/index.d.ts.map +1 -1
- package/dist/bridgewise/index.esm.js +1 -1
- package/dist/bridgewise/index.esm.js.map +1 -1
- package/dist/bridgewise/index.js +1 -1
- package/dist/bridgewise/index.js.map +1 -1
- package/dist/insight/index.d.ts +135 -114
- package/dist/insight/index.d.ts.map +1 -1
- package/dist/insight/index.esm.js +1 -1
- package/dist/insight/index.esm.js.map +1 -1
- package/dist/insight/index.js +1 -1
- package/dist/insight/index.js.map +1 -1
- package/dist/middleware/index.d.ts +46 -46
- package/dist/middleware/index.d.ts.map +1 -1
- package/dist/middleware/index.esm.js +1 -1
- package/dist/middleware/index.esm.js.map +1 -1
- package/dist/middleware/index.js +1 -1
- package/dist/middleware/index.js.map +1 -1
- package/dist/orbis/index.d.ts +979 -971
- package/dist/orbis/index.d.ts.map +1 -1
- package/dist/orbis/index.esm.js +1 -1
- package/dist/orbis/index.esm.js.map +1 -1
- package/dist/orbis/index.js +1 -1
- package/dist/orbis/index.js.map +1 -1
- package/dist/uma/index.d.ts +312 -312
- package/dist/uma/index.d.ts.map +1 -1
- package/dist/uma/index.esm.js +1 -1
- package/dist/uma/index.esm.js.map +1 -1
- package/dist/uma/index.js +1 -1
- package/dist/uma/index.js.map +1 -1
- package/dist/zerohash/index.d.ts +209 -209
- package/dist/zerohash/index.d.ts.map +1 -1
- package/dist/zerohash/index.esm.js +1 -1
- package/dist/zerohash/index.esm.js.map +1 -1
- package/dist/zerohash/index.js +1 -1
- package/dist/zerohash/index.js.map +1 -1
- package/package.json +1 -1
package/dist/orbis/index.d.ts
CHANGED
|
@@ -742,12 +742,16 @@ export class OrdersV2Offerings<HandleError extends boolean = boolean> {
|
|
|
742
742
|
order?: {
|
|
743
743
|
/** @example 0 */
|
|
744
744
|
expectedValue?: number;
|
|
745
|
+
/** @example 100 */
|
|
746
|
+
quantity?: number;
|
|
745
747
|
quote?: {
|
|
746
748
|
/** @example "{offering identifier}" */
|
|
747
749
|
identifier?: string;
|
|
748
750
|
};
|
|
749
751
|
/** @example true */
|
|
750
752
|
rule5130And5131Attestation?: boolean;
|
|
753
|
+
/** @example "SPV|Offering" */
|
|
754
|
+
type?: string;
|
|
751
755
|
};
|
|
752
756
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
753
757
|
/**
|
|
@@ -769,12 +773,16 @@ export class OrdersV2Offerings<HandleError extends boolean = boolean> {
|
|
|
769
773
|
clientSourceId?: string;
|
|
770
774
|
/** @example 0 */
|
|
771
775
|
expectedValue?: number;
|
|
776
|
+
/** @example 100 */
|
|
777
|
+
quantity?: number;
|
|
772
778
|
quote?: {
|
|
773
779
|
/** @example "{offering identifier}" */
|
|
774
780
|
identifier?: string;
|
|
775
781
|
};
|
|
776
782
|
/** @example true */
|
|
777
783
|
rule5130And5131Attestation?: boolean;
|
|
784
|
+
/** @example "SPV|Offering" */
|
|
785
|
+
type?: string;
|
|
778
786
|
};
|
|
779
787
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
780
788
|
/**
|
|
@@ -2331,6 +2339,50 @@ export class Research<HandleError extends boolean = boolean> {
|
|
|
2331
2339
|
dates?: any;
|
|
2332
2340
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2333
2341
|
}
|
|
2342
|
+
export class UserWatchlists<HandleError extends boolean = boolean> {
|
|
2343
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2344
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2345
|
+
/**
|
|
2346
|
+
* @tags User Watchlists
|
|
2347
|
+
* @name CreateWatchlist
|
|
2348
|
+
* @summary Create Watchlist
|
|
2349
|
+
* @request POST:/user/v2/watchlist/create
|
|
2350
|
+
* @secure
|
|
2351
|
+
*/
|
|
2352
|
+
createWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2353
|
+
/**
|
|
2354
|
+
* @tags User Watchlists
|
|
2355
|
+
* @name RenameWatchlist
|
|
2356
|
+
* @summary Rename Watchlist
|
|
2357
|
+
* @request POST:/user/v2/watchlist/rename
|
|
2358
|
+
* @secure
|
|
2359
|
+
*/
|
|
2360
|
+
renameWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2361
|
+
/**
|
|
2362
|
+
* @tags User Watchlists
|
|
2363
|
+
* @name DeleteWatchlist
|
|
2364
|
+
* @summary Delete Watchlist
|
|
2365
|
+
* @request POST:/user/v2/watchlist/delete
|
|
2366
|
+
* @secure
|
|
2367
|
+
*/
|
|
2368
|
+
deleteWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2369
|
+
/**
|
|
2370
|
+
* @tags User Watchlists
|
|
2371
|
+
* @name AddToWatchlist
|
|
2372
|
+
* @summary Add to Watchlist
|
|
2373
|
+
* @request POST:/user/v2/watchlist/addEntry
|
|
2374
|
+
* @secure
|
|
2375
|
+
*/
|
|
2376
|
+
addToWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2377
|
+
/**
|
|
2378
|
+
* @tags User Watchlists
|
|
2379
|
+
* @name RemoveFromWatchlist
|
|
2380
|
+
* @summary Remove from Watchlist
|
|
2381
|
+
* @request POST:/user/v2/watchlist/removeEntry
|
|
2382
|
+
* @secure
|
|
2383
|
+
*/
|
|
2384
|
+
removeFromWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2385
|
+
}
|
|
2334
2386
|
export class UserDevice<HandleError extends boolean = boolean> {
|
|
2335
2387
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2336
2388
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -2377,49 +2429,65 @@ export class UserDevice<HandleError extends boolean = boolean> {
|
|
|
2377
2429
|
token?: any;
|
|
2378
2430
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2379
2431
|
}
|
|
2380
|
-
export class
|
|
2432
|
+
export class UserAgreements<HandleError extends boolean = boolean> {
|
|
2381
2433
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2382
2434
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2383
2435
|
/**
|
|
2384
|
-
* @tags User
|
|
2385
|
-
* @name
|
|
2386
|
-
* @summary
|
|
2387
|
-
* @request
|
|
2436
|
+
* @tags User Agreements
|
|
2437
|
+
* @name Available
|
|
2438
|
+
* @summary Available
|
|
2439
|
+
* @request GET:/user/agreements/all/active
|
|
2388
2440
|
* @secure
|
|
2389
2441
|
*/
|
|
2390
|
-
|
|
2442
|
+
available(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2391
2443
|
/**
|
|
2392
|
-
* @tags User
|
|
2393
|
-
* @name
|
|
2394
|
-
* @summary
|
|
2395
|
-
* @request
|
|
2444
|
+
* @tags User Agreements
|
|
2445
|
+
* @name Agreement
|
|
2446
|
+
* @summary Agreement
|
|
2447
|
+
* @request GET:/user/agreements/contents/{version}/{code}/body.html
|
|
2396
2448
|
* @secure
|
|
2397
2449
|
*/
|
|
2398
|
-
|
|
2450
|
+
agreement(version: string, code: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2399
2451
|
/**
|
|
2400
|
-
* @tags User
|
|
2401
|
-
* @name
|
|
2402
|
-
* @summary
|
|
2403
|
-
* @request
|
|
2452
|
+
* @tags User Agreements
|
|
2453
|
+
* @name Unsigned
|
|
2454
|
+
* @summary Unsigned
|
|
2455
|
+
* @request GET:/user/agreements/unsigned
|
|
2404
2456
|
* @secure
|
|
2405
2457
|
*/
|
|
2406
|
-
|
|
2458
|
+
unsigned(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2407
2459
|
/**
|
|
2408
|
-
* @tags User
|
|
2409
|
-
* @name
|
|
2410
|
-
* @summary
|
|
2411
|
-
* @request POST:/user/
|
|
2460
|
+
* @tags User Agreements
|
|
2461
|
+
* @name AttestStatus
|
|
2462
|
+
* @summary Attest status
|
|
2463
|
+
* @request POST:/user/professional/attest
|
|
2412
2464
|
* @secure
|
|
2413
2465
|
*/
|
|
2414
|
-
|
|
2466
|
+
attestStatus(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2415
2467
|
/**
|
|
2416
|
-
* @tags User
|
|
2417
|
-
* @name
|
|
2418
|
-
* @summary
|
|
2419
|
-
* @request POST:/user/
|
|
2468
|
+
* @tags User Agreements
|
|
2469
|
+
* @name Sign
|
|
2470
|
+
* @summary Sign
|
|
2471
|
+
* @request POST:/user/agreements/sign
|
|
2420
2472
|
* @secure
|
|
2421
2473
|
*/
|
|
2422
|
-
|
|
2474
|
+
sign(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2475
|
+
/**
|
|
2476
|
+
* @tags User Agreements
|
|
2477
|
+
* @name CryptoAgreement
|
|
2478
|
+
* @summary Crypto Agreement
|
|
2479
|
+
* @request GET:/user/agreements/crypto/Agreement
|
|
2480
|
+
* @secure
|
|
2481
|
+
*/
|
|
2482
|
+
cryptoAgreement(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2483
|
+
/**
|
|
2484
|
+
* @tags User Agreements
|
|
2485
|
+
* @name CryptoSign
|
|
2486
|
+
* @summary Crypto Sign
|
|
2487
|
+
* @request POST:/user/agreements/crypto/sign
|
|
2488
|
+
* @secure
|
|
2489
|
+
*/
|
|
2490
|
+
cryptoSign(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2423
2491
|
}
|
|
2424
2492
|
export class UserTradingLimitManagement<HandleError extends boolean = boolean> {
|
|
2425
2493
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -2523,66 +2591,6 @@ export class UserProfitLoss<HandleError extends boolean = boolean> {
|
|
|
2523
2591
|
requestId?: any;
|
|
2524
2592
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2525
2593
|
}
|
|
2526
|
-
export class UserAgreements<HandleError extends boolean = boolean> {
|
|
2527
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
2528
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
2529
|
-
/**
|
|
2530
|
-
* @tags User Agreements
|
|
2531
|
-
* @name Available
|
|
2532
|
-
* @summary Available
|
|
2533
|
-
* @request GET:/user/agreements/all/active
|
|
2534
|
-
* @secure
|
|
2535
|
-
*/
|
|
2536
|
-
available(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2537
|
-
/**
|
|
2538
|
-
* @tags User Agreements
|
|
2539
|
-
* @name Agreement
|
|
2540
|
-
* @summary Agreement
|
|
2541
|
-
* @request GET:/user/agreements/contents/{version}/{code}/body.html
|
|
2542
|
-
* @secure
|
|
2543
|
-
*/
|
|
2544
|
-
agreement(version: string, code: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2545
|
-
/**
|
|
2546
|
-
* @tags User Agreements
|
|
2547
|
-
* @name Unsigned
|
|
2548
|
-
* @summary Unsigned
|
|
2549
|
-
* @request GET:/user/agreements/unsigned
|
|
2550
|
-
* @secure
|
|
2551
|
-
*/
|
|
2552
|
-
unsigned(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2553
|
-
/**
|
|
2554
|
-
* @tags User Agreements
|
|
2555
|
-
* @name AttestStatus
|
|
2556
|
-
* @summary Attest status
|
|
2557
|
-
* @request POST:/user/professional/attest
|
|
2558
|
-
* @secure
|
|
2559
|
-
*/
|
|
2560
|
-
attestStatus(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2561
|
-
/**
|
|
2562
|
-
* @tags User Agreements
|
|
2563
|
-
* @name Sign
|
|
2564
|
-
* @summary Sign
|
|
2565
|
-
* @request POST:/user/agreements/sign
|
|
2566
|
-
* @secure
|
|
2567
|
-
*/
|
|
2568
|
-
sign(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2569
|
-
/**
|
|
2570
|
-
* @tags User Agreements
|
|
2571
|
-
* @name CryptoAgreement
|
|
2572
|
-
* @summary Crypto Agreement
|
|
2573
|
-
* @request GET:/user/agreements/crypto/Agreement
|
|
2574
|
-
* @secure
|
|
2575
|
-
*/
|
|
2576
|
-
cryptoAgreement(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2577
|
-
/**
|
|
2578
|
-
* @tags User Agreements
|
|
2579
|
-
* @name CryptoSign
|
|
2580
|
-
* @summary Crypto Sign
|
|
2581
|
-
* @request POST:/user/agreements/crypto/sign
|
|
2582
|
-
* @secure
|
|
2583
|
-
*/
|
|
2584
|
-
cryptoSign(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2585
|
-
}
|
|
2586
2594
|
export class User<HandleError extends boolean = boolean> {
|
|
2587
2595
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2588
2596
|
watchlists: UserWatchlists<HandleError>;
|
|
@@ -3212,6 +3220,67 @@ export class User<HandleError extends boolean = boolean> {
|
|
|
3212
3220
|
*/
|
|
3213
3221
|
passwordChange(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3214
3222
|
}
|
|
3223
|
+
export class AdvisoryCharges<HandleError extends boolean = boolean> {
|
|
3224
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3225
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3226
|
+
/**
|
|
3227
|
+
* @tags Advisory Charges
|
|
3228
|
+
* @name Search
|
|
3229
|
+
* @summary /search
|
|
3230
|
+
* @request GET:/v2/charges/search
|
|
3231
|
+
* @secure
|
|
3232
|
+
*/
|
|
3233
|
+
search(query?: {
|
|
3234
|
+
/**
|
|
3235
|
+
* Must be either this or `AccountNumber`
|
|
3236
|
+
* @example "12345"
|
|
3237
|
+
*/
|
|
3238
|
+
AccountId?: any;
|
|
3239
|
+
/**
|
|
3240
|
+
* Must be either this or `AccountId`
|
|
3241
|
+
* @example "AB321654"
|
|
3242
|
+
*/
|
|
3243
|
+
AccountNumber?: any;
|
|
3244
|
+
/**
|
|
3245
|
+
* `optional` - defaults to today
|
|
3246
|
+
* @example "7/1/2018"
|
|
3247
|
+
*/
|
|
3248
|
+
DateFrom?: any;
|
|
3249
|
+
/**
|
|
3250
|
+
* `optional`
|
|
3251
|
+
* @example "7/1/2018"
|
|
3252
|
+
*/
|
|
3253
|
+
DateTo?: any;
|
|
3254
|
+
/**
|
|
3255
|
+
* `optional`
|
|
3256
|
+
* @example "CH321654"
|
|
3257
|
+
*/
|
|
3258
|
+
ChargeRef?: any;
|
|
3259
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3260
|
+
/**
|
|
3261
|
+
* @tags Advisory Charges
|
|
3262
|
+
* @name Apply
|
|
3263
|
+
* @summary /apply
|
|
3264
|
+
* @request POST:/v2/charges/apply
|
|
3265
|
+
* @secure
|
|
3266
|
+
*/
|
|
3267
|
+
apply(data: {
|
|
3268
|
+
/** @example 1234 */
|
|
3269
|
+
accountId?: any;
|
|
3270
|
+
/** @example 7.11 */
|
|
3271
|
+
amount?: any;
|
|
3272
|
+
/** @example "{timestamp}" */
|
|
3273
|
+
date?: any;
|
|
3274
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3275
|
+
/**
|
|
3276
|
+
* @tags Advisory Charges
|
|
3277
|
+
* @name Cancel
|
|
3278
|
+
* @summary /cancel
|
|
3279
|
+
* @request POST:/v2/charges/cancel
|
|
3280
|
+
* @secure
|
|
3281
|
+
*/
|
|
3282
|
+
cancel(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3283
|
+
}
|
|
3215
3284
|
export class AdvisoryModels<HandleError extends boolean = boolean> {
|
|
3216
3285
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3217
3286
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -3487,66 +3556,76 @@ export class AdvisoryModels<HandleError extends boolean = boolean> {
|
|
|
3487
3556
|
*/
|
|
3488
3557
|
allocations(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3489
3558
|
}
|
|
3490
|
-
export class
|
|
3559
|
+
export class AdvisoryUserAccountManagement<HandleError extends boolean = boolean> {
|
|
3491
3560
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3492
3561
|
constructor(apiClient: JwtClient<HandleError>);
|
|
3493
3562
|
/**
|
|
3494
|
-
* @tags Advisory
|
|
3495
|
-
* @name
|
|
3496
|
-
* @summary /
|
|
3497
|
-
* @request GET:/v2/
|
|
3563
|
+
* @tags Advisory User Account Management
|
|
3564
|
+
* @name List
|
|
3565
|
+
* @summary /list
|
|
3566
|
+
* @request GET:/v2/advisory/users/list
|
|
3498
3567
|
* @secure
|
|
3499
3568
|
*/
|
|
3500
|
-
|
|
3501
|
-
|
|
3502
|
-
|
|
3503
|
-
|
|
3504
|
-
|
|
3505
|
-
|
|
3506
|
-
|
|
3507
|
-
|
|
3508
|
-
|
|
3509
|
-
|
|
3510
|
-
|
|
3511
|
-
/**
|
|
3512
|
-
* `optional` - defaults to today
|
|
3513
|
-
* @example "7/1/2018"
|
|
3514
|
-
*/
|
|
3515
|
-
DateFrom?: any;
|
|
3569
|
+
list(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3570
|
+
/**
|
|
3571
|
+
* @tags Advisory User Account Management
|
|
3572
|
+
* @name Accounts
|
|
3573
|
+
* @summary /accounts
|
|
3574
|
+
* @request GET:/v2/advisory/users/accounts
|
|
3575
|
+
* @secure
|
|
3576
|
+
*/
|
|
3577
|
+
accounts(query?: {
|
|
3578
|
+
/** @example "1234" */
|
|
3579
|
+
uid?: any;
|
|
3516
3580
|
/**
|
|
3517
|
-
*
|
|
3518
|
-
* @example "
|
|
3581
|
+
* true|false
|
|
3582
|
+
* @example "false"
|
|
3519
3583
|
*/
|
|
3520
|
-
|
|
3584
|
+
loadRtb?: any;
|
|
3585
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3586
|
+
/**
|
|
3587
|
+
* @tags Advisory User Account Management
|
|
3588
|
+
* @name AccountsStats
|
|
3589
|
+
* @summary /accounts/stats
|
|
3590
|
+
* @request GET:/v2/advisory/users/accounts/stats
|
|
3591
|
+
* @secure
|
|
3592
|
+
*/
|
|
3593
|
+
accountsStats(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3594
|
+
/**
|
|
3595
|
+
* @tags Advisory User Account Management
|
|
3596
|
+
* @name AccountNotes
|
|
3597
|
+
* @summary /account/notes
|
|
3598
|
+
* @request GET:/v2/advisory/users/account/notes
|
|
3599
|
+
* @secure
|
|
3600
|
+
*/
|
|
3601
|
+
accountNotes(query?: {
|
|
3521
3602
|
/**
|
|
3522
|
-
*
|
|
3523
|
-
* @example "
|
|
3603
|
+
* Account's ID
|
|
3604
|
+
* @example "1234"
|
|
3524
3605
|
*/
|
|
3525
|
-
|
|
3606
|
+
aid?: any;
|
|
3526
3607
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3527
3608
|
/**
|
|
3528
|
-
* @tags Advisory
|
|
3529
|
-
* @name
|
|
3530
|
-
* @summary /
|
|
3531
|
-
* @request
|
|
3609
|
+
* @tags Advisory User Account Management
|
|
3610
|
+
* @name Notes
|
|
3611
|
+
* @summary /notes
|
|
3612
|
+
* @request GET:/v2/advisory/users/notes
|
|
3532
3613
|
* @secure
|
|
3533
3614
|
*/
|
|
3534
|
-
|
|
3535
|
-
/**
|
|
3536
|
-
|
|
3537
|
-
|
|
3538
|
-
|
|
3539
|
-
|
|
3540
|
-
date?: any;
|
|
3615
|
+
notes(query?: {
|
|
3616
|
+
/**
|
|
3617
|
+
* User's ID
|
|
3618
|
+
* @example "1234"
|
|
3619
|
+
*/
|
|
3620
|
+
uid?: any;
|
|
3541
3621
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3542
3622
|
/**
|
|
3543
|
-
* @tags Advisory
|
|
3544
|
-
* @name
|
|
3545
|
-
* @
|
|
3546
|
-
* @request POST:/v2/charges/cancel
|
|
3623
|
+
* @tags Advisory User Account Management
|
|
3624
|
+
* @name NotesPost
|
|
3625
|
+
* @request POST:/v2/advisory/users/notes/{action}
|
|
3547
3626
|
* @secure
|
|
3548
3627
|
*/
|
|
3549
|
-
|
|
3628
|
+
notesPost(action: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3550
3629
|
}
|
|
3551
3630
|
export class AdvisoryGroups<HandleError extends boolean = boolean> {
|
|
3552
3631
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -3993,77 +4072,6 @@ export class TransfersRelationships<HandleError extends boolean = boolean> {
|
|
|
3993
4072
|
};
|
|
3994
4073
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3995
4074
|
}
|
|
3996
|
-
export class AdvisoryUserAccountManagement<HandleError extends boolean = boolean> {
|
|
3997
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
3998
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
3999
|
-
/**
|
|
4000
|
-
* @tags Advisory User Account Management
|
|
4001
|
-
* @name List
|
|
4002
|
-
* @summary /list
|
|
4003
|
-
* @request GET:/v2/advisory/users/list
|
|
4004
|
-
* @secure
|
|
4005
|
-
*/
|
|
4006
|
-
list(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4007
|
-
/**
|
|
4008
|
-
* @tags Advisory User Account Management
|
|
4009
|
-
* @name Accounts
|
|
4010
|
-
* @summary /accounts
|
|
4011
|
-
* @request GET:/v2/advisory/users/accounts
|
|
4012
|
-
* @secure
|
|
4013
|
-
*/
|
|
4014
|
-
accounts(query?: {
|
|
4015
|
-
/** @example "1234" */
|
|
4016
|
-
uid?: any;
|
|
4017
|
-
/**
|
|
4018
|
-
* true|false
|
|
4019
|
-
* @example "false"
|
|
4020
|
-
*/
|
|
4021
|
-
loadRtb?: any;
|
|
4022
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4023
|
-
/**
|
|
4024
|
-
* @tags Advisory User Account Management
|
|
4025
|
-
* @name AccountsStats
|
|
4026
|
-
* @summary /accounts/stats
|
|
4027
|
-
* @request GET:/v2/advisory/users/accounts/stats
|
|
4028
|
-
* @secure
|
|
4029
|
-
*/
|
|
4030
|
-
accountsStats(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4031
|
-
/**
|
|
4032
|
-
* @tags Advisory User Account Management
|
|
4033
|
-
* @name AccountNotes
|
|
4034
|
-
* @summary /account/notes
|
|
4035
|
-
* @request GET:/v2/advisory/users/account/notes
|
|
4036
|
-
* @secure
|
|
4037
|
-
*/
|
|
4038
|
-
accountNotes(query?: {
|
|
4039
|
-
/**
|
|
4040
|
-
* Account's ID
|
|
4041
|
-
* @example "1234"
|
|
4042
|
-
*/
|
|
4043
|
-
aid?: any;
|
|
4044
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4045
|
-
/**
|
|
4046
|
-
* @tags Advisory User Account Management
|
|
4047
|
-
* @name Notes
|
|
4048
|
-
* @summary /notes
|
|
4049
|
-
* @request GET:/v2/advisory/users/notes
|
|
4050
|
-
* @secure
|
|
4051
|
-
*/
|
|
4052
|
-
notes(query?: {
|
|
4053
|
-
/**
|
|
4054
|
-
* User's ID
|
|
4055
|
-
* @example "1234"
|
|
4056
|
-
*/
|
|
4057
|
-
uid?: any;
|
|
4058
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4059
|
-
/**
|
|
4060
|
-
* @tags Advisory User Account Management
|
|
4061
|
-
* @name NotesPost
|
|
4062
|
-
* @request POST:/v2/advisory/users/notes/{action}
|
|
4063
|
-
* @secure
|
|
4064
|
-
*/
|
|
4065
|
-
notesPost(action: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4066
|
-
}
|
|
4067
4075
|
export class TransfersInstantAccountVerification<HandleError extends boolean = boolean> {
|
|
4068
4076
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4069
4077
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4163,81 +4171,6 @@ export class TransfersAch<HandleError extends boolean = boolean> {
|
|
|
4163
4171
|
*/
|
|
4164
4172
|
withdraw(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4165
4173
|
}
|
|
4166
|
-
export class TransfersWires<HandleError extends boolean = boolean> {
|
|
4167
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4168
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4169
|
-
/**
|
|
4170
|
-
* @tags Transfers Wires
|
|
4171
|
-
* @name Outgoing
|
|
4172
|
-
* @summary Outgoing
|
|
4173
|
-
* @request POST:/transfer/wire/outgoing
|
|
4174
|
-
* @secure
|
|
4175
|
-
*/
|
|
4176
|
-
outgoing(data: {
|
|
4177
|
-
/** @example "TRACCOUNT" */
|
|
4178
|
-
account?: any;
|
|
4179
|
-
/** @example 200 */
|
|
4180
|
-
amount?: any;
|
|
4181
|
-
beneficiary?: {
|
|
4182
|
-
/** @example "AAA012345" */
|
|
4183
|
-
account?: string;
|
|
4184
|
-
/** @example "CHECKING|SAVINGS" */
|
|
4185
|
-
accountType?: string;
|
|
4186
|
-
address?: {
|
|
4187
|
-
/** @example "Central City" */
|
|
4188
|
-
city?: string;
|
|
4189
|
-
/** @example "USA" */
|
|
4190
|
-
country?: string;
|
|
4191
|
-
/** @example "11235" */
|
|
4192
|
-
postalCode?: string;
|
|
4193
|
-
/** @example "ST" */
|
|
4194
|
-
stateProvince?: string;
|
|
4195
|
-
/** @example ["123 Main St"] */
|
|
4196
|
-
streetAddress?: string[];
|
|
4197
|
-
};
|
|
4198
|
-
/** @example "John Smith" */
|
|
4199
|
-
name?: string;
|
|
4200
|
-
/** @example false */
|
|
4201
|
-
thirdParty?: boolean;
|
|
4202
|
-
};
|
|
4203
|
-
/** @example "Partial|Full" */
|
|
4204
|
-
disbursementType?: any;
|
|
4205
|
-
/** @example 1234 */
|
|
4206
|
-
entryId?: any;
|
|
4207
|
-
/** @example false */
|
|
4208
|
-
international?: any;
|
|
4209
|
-
iraDetails?: {
|
|
4210
|
-
/** @example "" */
|
|
4211
|
-
contributionType?: string;
|
|
4212
|
-
/** @example 2020 */
|
|
4213
|
-
contributionYear?: number;
|
|
4214
|
-
};
|
|
4215
|
-
recipientBank?: {
|
|
4216
|
-
/** @example "" */
|
|
4217
|
-
additionalInformation?: string;
|
|
4218
|
-
/** @example "" */
|
|
4219
|
-
city?: string;
|
|
4220
|
-
/** @example "" */
|
|
4221
|
-
country?: string;
|
|
4222
|
-
identifier?: {
|
|
4223
|
-
/** @example "021202162" */
|
|
4224
|
-
id?: string;
|
|
4225
|
-
/** @example "ABA|BIC" */
|
|
4226
|
-
type?: string;
|
|
4227
|
-
};
|
|
4228
|
-
/** @example "" */
|
|
4229
|
-
name?: string;
|
|
4230
|
-
/** @example "" */
|
|
4231
|
-
postalCode?: string;
|
|
4232
|
-
/** @example "" */
|
|
4233
|
-
stateProvince?: string;
|
|
4234
|
-
};
|
|
4235
|
-
/** @example "0.0.0.0" */
|
|
4236
|
-
remoteAddr?: any;
|
|
4237
|
-
/** @example "ultra fast browser 1.1" */
|
|
4238
|
-
remoteDevice?: any;
|
|
4239
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4240
|
-
}
|
|
4241
4174
|
export class TransfersAcats<HandleError extends boolean = boolean> {
|
|
4242
4175
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4243
4176
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4371,36 +4304,111 @@ export class TransfersAcats<HandleError extends boolean = boolean> {
|
|
|
4371
4304
|
type?: string;
|
|
4372
4305
|
}[], config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4373
4306
|
}
|
|
4374
|
-
export class
|
|
4307
|
+
export class TransfersWires<HandleError extends boolean = boolean> {
|
|
4375
4308
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4376
4309
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4377
4310
|
/**
|
|
4378
|
-
* @tags Transfers
|
|
4379
|
-
* @name
|
|
4380
|
-
* @summary
|
|
4381
|
-
* @request POST:/transfer/
|
|
4311
|
+
* @tags Transfers Wires
|
|
4312
|
+
* @name Outgoing
|
|
4313
|
+
* @summary Outgoing
|
|
4314
|
+
* @request POST:/transfer/wire/outgoing
|
|
4382
4315
|
* @secure
|
|
4383
4316
|
*/
|
|
4384
|
-
|
|
4385
|
-
/** @example
|
|
4317
|
+
outgoing(data: {
|
|
4318
|
+
/** @example "TRACCOUNT" */
|
|
4319
|
+
account?: any;
|
|
4320
|
+
/** @example 200 */
|
|
4386
4321
|
amount?: any;
|
|
4387
|
-
|
|
4388
|
-
/** @example
|
|
4389
|
-
|
|
4390
|
-
/** @example "
|
|
4391
|
-
|
|
4392
|
-
|
|
4393
|
-
|
|
4394
|
-
|
|
4395
|
-
|
|
4396
|
-
|
|
4397
|
-
|
|
4398
|
-
|
|
4399
|
-
|
|
4400
|
-
|
|
4401
|
-
|
|
4402
|
-
|
|
4403
|
-
|
|
4322
|
+
beneficiary?: {
|
|
4323
|
+
/** @example "AAA012345" */
|
|
4324
|
+
account?: string;
|
|
4325
|
+
/** @example "CHECKING|SAVINGS" */
|
|
4326
|
+
accountType?: string;
|
|
4327
|
+
address?: {
|
|
4328
|
+
/** @example "Central City" */
|
|
4329
|
+
city?: string;
|
|
4330
|
+
/** @example "USA" */
|
|
4331
|
+
country?: string;
|
|
4332
|
+
/** @example "11235" */
|
|
4333
|
+
postalCode?: string;
|
|
4334
|
+
/** @example "ST" */
|
|
4335
|
+
stateProvince?: string;
|
|
4336
|
+
/** @example ["123 Main St"] */
|
|
4337
|
+
streetAddress?: string[];
|
|
4338
|
+
};
|
|
4339
|
+
/** @example "John Smith" */
|
|
4340
|
+
name?: string;
|
|
4341
|
+
/** @example false */
|
|
4342
|
+
thirdParty?: boolean;
|
|
4343
|
+
};
|
|
4344
|
+
/** @example "Partial|Full" */
|
|
4345
|
+
disbursementType?: any;
|
|
4346
|
+
/** @example 1234 */
|
|
4347
|
+
entryId?: any;
|
|
4348
|
+
/** @example false */
|
|
4349
|
+
international?: any;
|
|
4350
|
+
iraDetails?: {
|
|
4351
|
+
/** @example "" */
|
|
4352
|
+
contributionType?: string;
|
|
4353
|
+
/** @example 2020 */
|
|
4354
|
+
contributionYear?: number;
|
|
4355
|
+
};
|
|
4356
|
+
recipientBank?: {
|
|
4357
|
+
/** @example "" */
|
|
4358
|
+
additionalInformation?: string;
|
|
4359
|
+
/** @example "" */
|
|
4360
|
+
city?: string;
|
|
4361
|
+
/** @example "" */
|
|
4362
|
+
country?: string;
|
|
4363
|
+
identifier?: {
|
|
4364
|
+
/** @example "021202162" */
|
|
4365
|
+
id?: string;
|
|
4366
|
+
/** @example "ABA|BIC" */
|
|
4367
|
+
type?: string;
|
|
4368
|
+
};
|
|
4369
|
+
/** @example "" */
|
|
4370
|
+
name?: string;
|
|
4371
|
+
/** @example "" */
|
|
4372
|
+
postalCode?: string;
|
|
4373
|
+
/** @example "" */
|
|
4374
|
+
stateProvince?: string;
|
|
4375
|
+
};
|
|
4376
|
+
/** @example "0.0.0.0" */
|
|
4377
|
+
remoteAddr?: any;
|
|
4378
|
+
/** @example "ultra fast browser 1.1" */
|
|
4379
|
+
remoteDevice?: any;
|
|
4380
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4381
|
+
}
|
|
4382
|
+
export class TransfersJournals<HandleError extends boolean = boolean> {
|
|
4383
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4384
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4385
|
+
/**
|
|
4386
|
+
* @tags Transfers Journals
|
|
4387
|
+
* @name JournalRequest
|
|
4388
|
+
* @summary Journal request
|
|
4389
|
+
* @request POST:/transfer/journal/request
|
|
4390
|
+
* @secure
|
|
4391
|
+
*/
|
|
4392
|
+
journalRequest(data: {
|
|
4393
|
+
/** @example 1000 */
|
|
4394
|
+
amount?: any;
|
|
4395
|
+
deliverFrom?: {
|
|
4396
|
+
/** @example 124 */
|
|
4397
|
+
accountId?: number;
|
|
4398
|
+
/** @example "ABC123456" */
|
|
4399
|
+
accountNumber?: string;
|
|
4400
|
+
};
|
|
4401
|
+
deliverTo?: {
|
|
4402
|
+
/** @example 456 */
|
|
4403
|
+
accountId?: number;
|
|
4404
|
+
/** @example "DEF123456" */
|
|
4405
|
+
accountNumber?: string;
|
|
4406
|
+
};
|
|
4407
|
+
/** @example "MM/dd/yyyy HH:mm:ss z" */
|
|
4408
|
+
deliveryDate?: any;
|
|
4409
|
+
loa?: {
|
|
4410
|
+
/** @example "" */
|
|
4411
|
+
fullName?: string;
|
|
4404
4412
|
/** @example "" */
|
|
4405
4413
|
remoteAddr?: string;
|
|
4406
4414
|
/** @example "" */
|
|
@@ -4492,6 +4500,111 @@ export class TransfersBank<HandleError extends boolean = boolean> {
|
|
|
4492
4500
|
*/
|
|
4493
4501
|
fundTransfer(direction: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4494
4502
|
}
|
|
4503
|
+
export class TransfersInstantCashTransfers<HandleError extends boolean = boolean> {
|
|
4504
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4505
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4506
|
+
/**
|
|
4507
|
+
* @tags Transfers Instant Cash Transfers
|
|
4508
|
+
* @name DepositWithdrawal
|
|
4509
|
+
* @summary Deposit/Withdrawal
|
|
4510
|
+
* @request POST:/transfer/ict/${direction}
|
|
4511
|
+
* @secure
|
|
4512
|
+
*/
|
|
4513
|
+
depositWithdrawal(direction: string, data: {
|
|
4514
|
+
/** @example "ABC123456" */
|
|
4515
|
+
account?: any;
|
|
4516
|
+
/** @example 100 */
|
|
4517
|
+
amount?: any;
|
|
4518
|
+
/** @example "USD" */
|
|
4519
|
+
currency?: any;
|
|
4520
|
+
originator?: {
|
|
4521
|
+
address?: {
|
|
4522
|
+
/** @example "Central City" */
|
|
4523
|
+
city?: string;
|
|
4524
|
+
/** @example "USA" */
|
|
4525
|
+
country?: string;
|
|
4526
|
+
/** @example "12345" */
|
|
4527
|
+
postalCode?: string;
|
|
4528
|
+
/** @example "NY" */
|
|
4529
|
+
stateProvince?: string;
|
|
4530
|
+
/** @example ["123 Main St"] */
|
|
4531
|
+
streetAddress?: string[];
|
|
4532
|
+
};
|
|
4533
|
+
/** @example "John" */
|
|
4534
|
+
firstName?: string;
|
|
4535
|
+
institution?: {
|
|
4536
|
+
/** @example "123456789" */
|
|
4537
|
+
accountNumber?: string;
|
|
4538
|
+
/** @example "Central City Central Bank" */
|
|
4539
|
+
name?: string;
|
|
4540
|
+
};
|
|
4541
|
+
/** @example "Smith" */
|
|
4542
|
+
lastName?: string;
|
|
4543
|
+
};
|
|
4544
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4545
|
+
/**
|
|
4546
|
+
* @tags Transfers Instant Cash Transfers
|
|
4547
|
+
* @name DepositWithdrawalV2
|
|
4548
|
+
* @summary Deposit/Withdrawal V2
|
|
4549
|
+
* @request POST:/transfer/v2/ict/${direction}
|
|
4550
|
+
* @secure
|
|
4551
|
+
*/
|
|
4552
|
+
depositWithdrawalV2(direction: string, data: {
|
|
4553
|
+
/** @example "AB123456" */
|
|
4554
|
+
account?: any;
|
|
4555
|
+
/** @example 100.32 */
|
|
4556
|
+
amount?: any;
|
|
4557
|
+
counterparty?: {
|
|
4558
|
+
address?: {
|
|
4559
|
+
/** @example "Central City" */
|
|
4560
|
+
city?: string;
|
|
4561
|
+
/** @example "12345" */
|
|
4562
|
+
postalCode?: string;
|
|
4563
|
+
/** @example "CC" */
|
|
4564
|
+
stateProvince?: string;
|
|
4565
|
+
/** @example ["225 Baker St"] */
|
|
4566
|
+
streetAddress?: string[];
|
|
4567
|
+
};
|
|
4568
|
+
/** @example "James" */
|
|
4569
|
+
firstName?: string;
|
|
4570
|
+
institution?: {
|
|
4571
|
+
/** @example "123456" */
|
|
4572
|
+
accountNumber?: string;
|
|
4573
|
+
/** @example "Royal Central Bank" */
|
|
4574
|
+
name?: string;
|
|
4575
|
+
};
|
|
4576
|
+
/** @example "Bond" */
|
|
4577
|
+
lastName?: string;
|
|
4578
|
+
};
|
|
4579
|
+
/** @example "USD" */
|
|
4580
|
+
currency?: any;
|
|
4581
|
+
/** @example "1.1.1.1" */
|
|
4582
|
+
remoteAddr?: any;
|
|
4583
|
+
/** @example "Droid Phone" */
|
|
4584
|
+
remoteDevice?: any;
|
|
4585
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4586
|
+
/**
|
|
4587
|
+
* @tags Transfers Instant Cash Transfers
|
|
4588
|
+
* @name ObtainTheReport
|
|
4589
|
+
* @summary Obtain the report
|
|
4590
|
+
* @request POST:/transfer/reports/obtain
|
|
4591
|
+
* @secure
|
|
4592
|
+
*/
|
|
4593
|
+
obtainTheReport(data: {
|
|
4594
|
+
/** @example "MM/DD/YYYY HH:MM:SS ZZZ" */
|
|
4595
|
+
date?: any;
|
|
4596
|
+
/** @example "RETAIL_BANKING" */
|
|
4597
|
+
reportType?: any;
|
|
4598
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4599
|
+
/**
|
|
4600
|
+
* @tags Transfers Instant Cash Transfers
|
|
4601
|
+
* @name ListReports
|
|
4602
|
+
* @summary List reports
|
|
4603
|
+
* @request GET:/transfer/reports
|
|
4604
|
+
* @secure
|
|
4605
|
+
*/
|
|
4606
|
+
listReports(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4607
|
+
}
|
|
4495
4608
|
export class TransfersCheques<HandleError extends boolean = boolean> {
|
|
4496
4609
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4497
4610
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4504,36 +4617,270 @@ export class TransfersCheques<HandleError extends boolean = boolean> {
|
|
|
4504
4617
|
*/
|
|
4505
4618
|
withdrawal(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4506
4619
|
}
|
|
4507
|
-
export class
|
|
4620
|
+
export class Transfers<HandleError extends boolean = boolean> {
|
|
4508
4621
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4622
|
+
relationships: TransfersRelationships<HandleError>;
|
|
4623
|
+
instantAccountVerification: TransfersInstantAccountVerification<HandleError>;
|
|
4624
|
+
ach: TransfersAch<HandleError>;
|
|
4625
|
+
acats: TransfersAcats<HandleError>;
|
|
4626
|
+
wires: TransfersWires<HandleError>;
|
|
4627
|
+
journals: TransfersJournals<HandleError>;
|
|
4628
|
+
positions: TransfersPositions<HandleError>;
|
|
4629
|
+
bank: TransfersBank<HandleError>;
|
|
4630
|
+
instantCashTransfers: TransfersInstantCashTransfers<HandleError>;
|
|
4631
|
+
cheques: TransfersCheques<HandleError>;
|
|
4509
4632
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4510
4633
|
/**
|
|
4511
|
-
* @tags
|
|
4512
|
-
* @name
|
|
4513
|
-
* @summary
|
|
4514
|
-
* @request GET:/
|
|
4634
|
+
* @tags Transfers
|
|
4635
|
+
* @name TransferDetails
|
|
4636
|
+
* @summary Transfer Details
|
|
4637
|
+
* @request GET:/transfer/details/{account}/{transferId}
|
|
4515
4638
|
* @secure
|
|
4516
4639
|
*/
|
|
4517
|
-
|
|
4518
|
-
|
|
4519
|
-
|
|
4520
|
-
|
|
4521
|
-
|
|
4522
|
-
|
|
4523
|
-
|
|
4524
|
-
|
|
4525
|
-
|
|
4526
|
-
|
|
4527
|
-
|
|
4640
|
+
transferDetails(account: string, transferId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4641
|
+
/**
|
|
4642
|
+
* @tags Transfers
|
|
4643
|
+
* @name TransferStatus
|
|
4644
|
+
* @summary Transfer Status
|
|
4645
|
+
* @request GET:/transfer/status/{account}
|
|
4646
|
+
* @secure
|
|
4647
|
+
*/
|
|
4648
|
+
transferStatus(account: string, query?: {
|
|
4649
|
+
/** INCOMING|OUTGOING */
|
|
4650
|
+
direction?: any;
|
|
4651
|
+
/** ACH|WIRE|CHECK|Bank|CustodyJournal|ALL */
|
|
4652
|
+
mechanism?: any;
|
|
4653
|
+
/** MM/DD/YYYY */
|
|
4654
|
+
dateFrom?: any;
|
|
4655
|
+
/** MM/DD/YYYY */
|
|
4656
|
+
dateTo?: any;
|
|
4657
|
+
/** Overrides `dateFrom` and `dateTo`. See description. */
|
|
4658
|
+
range?: any;
|
|
4659
|
+
start?: any;
|
|
4660
|
+
perPage?: any;
|
|
4528
4661
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4529
4662
|
/**
|
|
4530
|
-
* @tags
|
|
4531
|
-
* @name
|
|
4532
|
-
* @summary
|
|
4533
|
-
* @request GET:/
|
|
4663
|
+
* @tags Transfers
|
|
4664
|
+
* @name TransferStatusModel
|
|
4665
|
+
* @summary Transfer Status Model
|
|
4666
|
+
* @request GET:/transfer/status/model/{modelId}
|
|
4534
4667
|
* @secure
|
|
4535
4668
|
*/
|
|
4536
|
-
|
|
4669
|
+
transferStatusModel(modelId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4670
|
+
/**
|
|
4671
|
+
* @tags Transfers
|
|
4672
|
+
* @name TransferStatusBranch
|
|
4673
|
+
* @summary Transfer Status Branch
|
|
4674
|
+
* @request GET:/transfer/status/branch
|
|
4675
|
+
* @secure
|
|
4676
|
+
*/
|
|
4677
|
+
transferStatusBranch(query?: {
|
|
4678
|
+
/**
|
|
4679
|
+
* INCOMING|OUTGOING|ALL
|
|
4680
|
+
* @example "ALL"
|
|
4681
|
+
*/
|
|
4682
|
+
direction?: any;
|
|
4683
|
+
/**
|
|
4684
|
+
* ACH|WIRE|CHECK|Bank|CustodyJournal
|
|
4685
|
+
* @example "ALL"
|
|
4686
|
+
*/
|
|
4687
|
+
mechanism?: any;
|
|
4688
|
+
dateFrom?: any;
|
|
4689
|
+
dateTo?: any;
|
|
4690
|
+
/** Per regex: \d+[ymdw]$ (will override `dateFrom` and `dateTo`) */
|
|
4691
|
+
range?: any;
|
|
4692
|
+
start?: any;
|
|
4693
|
+
perPage?: any;
|
|
4694
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4695
|
+
/**
|
|
4696
|
+
* @tags Transfers
|
|
4697
|
+
* @name AmountAvailable
|
|
4698
|
+
* @summary Amount Available
|
|
4699
|
+
* @request GET:/transfer/available/{account}
|
|
4700
|
+
* @secure
|
|
4701
|
+
*/
|
|
4702
|
+
amountAvailable(account: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4703
|
+
/**
|
|
4704
|
+
* @tags Transfers
|
|
4705
|
+
* @name LegalDocumentTypes
|
|
4706
|
+
* @summary Legal document types
|
|
4707
|
+
* @request GET:/transfer/legal/types
|
|
4708
|
+
* @secure
|
|
4709
|
+
*/
|
|
4710
|
+
legalDocumentTypes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4711
|
+
/**
|
|
4712
|
+
* @tags Transfers
|
|
4713
|
+
* @name LegalDocument
|
|
4714
|
+
* @summary Legal document
|
|
4715
|
+
* @request GET:/transfer/legal/content
|
|
4716
|
+
* @secure
|
|
4717
|
+
*/
|
|
4718
|
+
legalDocument(query?: {
|
|
4719
|
+
/** Unique ID given in the types endpoint */
|
|
4720
|
+
id?: any;
|
|
4721
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4722
|
+
/**
|
|
4723
|
+
* @tags Transfers
|
|
4724
|
+
* @name Cancel
|
|
4725
|
+
* @summary Cancel
|
|
4726
|
+
* @request POST:/transfer/ach/cancel
|
|
4727
|
+
* @secure
|
|
4728
|
+
*/
|
|
4729
|
+
cancel(data: {
|
|
4730
|
+
/** @example "5VA0XXXX" */
|
|
4731
|
+
account?: any;
|
|
4732
|
+
/** @example "0.0.0.0" */
|
|
4733
|
+
remoteAddr?: any;
|
|
4734
|
+
/** @example "ultra fast browser 1.1" */
|
|
4735
|
+
remoteDevice?: any;
|
|
4736
|
+
/** @example "CC123456" */
|
|
4737
|
+
transferId?: any;
|
|
4738
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4739
|
+
/**
|
|
4740
|
+
* @tags Transfers
|
|
4741
|
+
* @name FeesAndCredits
|
|
4742
|
+
* @summary Fees and Credits
|
|
4743
|
+
* @request POST:/transfer/fees/apply
|
|
4744
|
+
* @secure
|
|
4745
|
+
*/
|
|
4746
|
+
feesAndCredits(data: {
|
|
4747
|
+
/** @example "5VA0XXXX" */
|
|
4748
|
+
account?: any;
|
|
4749
|
+
/** @example 100 */
|
|
4750
|
+
amount?: any;
|
|
4751
|
+
/** @example "FeeReversal|Promotion|WriteOff|Rebate|Courtesy|Advisory|Management|Admin|Exchange|Tech|Platform|Inactivity|MarginInterest|Custodian|CryptoGift" */
|
|
4752
|
+
classification?: any;
|
|
4753
|
+
/** @example "" */
|
|
4754
|
+
contraNote?: any;
|
|
4755
|
+
/** @example "USD" */
|
|
4756
|
+
currency?: any;
|
|
4757
|
+
/** @example "" */
|
|
4758
|
+
note?: any;
|
|
4759
|
+
/** @example 0.01 */
|
|
4760
|
+
quantity?: any;
|
|
4761
|
+
/** @example "0.0.0.0" */
|
|
4762
|
+
remoteAddr?: any;
|
|
4763
|
+
/** @example "ultra fast browser 1.1" */
|
|
4764
|
+
remoteDevice?: any;
|
|
4765
|
+
/** @example "BTC/USD" */
|
|
4766
|
+
symbol?: any;
|
|
4767
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4768
|
+
/**
|
|
4769
|
+
* @tags Transfers
|
|
4770
|
+
* @name ListFees
|
|
4771
|
+
* @summary List fees
|
|
4772
|
+
* @request GET:/transfer/fees/classifications/fees
|
|
4773
|
+
* @secure
|
|
4774
|
+
*/
|
|
4775
|
+
listFees(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4776
|
+
/**
|
|
4777
|
+
* @tags Transfers
|
|
4778
|
+
* @name ListCredits
|
|
4779
|
+
* @summary List credits
|
|
4780
|
+
* @request GET:/transfer/fees/classifications/credits
|
|
4781
|
+
* @secure
|
|
4782
|
+
*/
|
|
4783
|
+
listCredits(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4784
|
+
/**
|
|
4785
|
+
* @tags Transfers
|
|
4786
|
+
* @name CryptoDepositAddress
|
|
4787
|
+
* @summary Crypto Deposit Address
|
|
4788
|
+
* @request GET:/transfer/crypto/deposit/wallet/address
|
|
4789
|
+
* @secure
|
|
4790
|
+
*/
|
|
4791
|
+
cryptoDepositAddress(data: {
|
|
4792
|
+
/** @example "AB123456" */
|
|
4793
|
+
account?: any;
|
|
4794
|
+
/** @example "BTC" */
|
|
4795
|
+
currency?: any;
|
|
4796
|
+
/** @example "{optional}" */
|
|
4797
|
+
network?: any;
|
|
4798
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4799
|
+
/**
|
|
4800
|
+
* @tags Transfers
|
|
4801
|
+
* @name CryptoWithdrawalEstimate
|
|
4802
|
+
* @summary Crypto Withdrawal Estimate
|
|
4803
|
+
* @request POST:/transfer/crypto/withdrawal/estimate
|
|
4804
|
+
* @secure
|
|
4805
|
+
*/
|
|
4806
|
+
cryptoWithdrawalEstimate(data: {
|
|
4807
|
+
/** @example "BTC" */
|
|
4808
|
+
currency?: any;
|
|
4809
|
+
/** @example "{optional}" */
|
|
4810
|
+
network?: any;
|
|
4811
|
+
/** @example "0.1" */
|
|
4812
|
+
quantity?: any;
|
|
4813
|
+
/** @example "{optional}" */
|
|
4814
|
+
wallet?: any;
|
|
4815
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4816
|
+
/**
|
|
4817
|
+
* @tags Transfers
|
|
4818
|
+
* @name CryptoWithdrawal
|
|
4819
|
+
* @summary Crypto Withdrawal
|
|
4820
|
+
* @request POST:/transfer/crypto/withdraw
|
|
4821
|
+
* @secure
|
|
4822
|
+
*/
|
|
4823
|
+
cryptoWithdrawal(data: {
|
|
4824
|
+
/** @example "AB123456" */
|
|
4825
|
+
account?: any;
|
|
4826
|
+
/** @example "BTC" */
|
|
4827
|
+
currency?: any;
|
|
4828
|
+
/** @example "{optional}" */
|
|
4829
|
+
estimateExtension?: any;
|
|
4830
|
+
/** @example "abc123" */
|
|
4831
|
+
estimateId?: any;
|
|
4832
|
+
/** @example "{optional}" */
|
|
4833
|
+
network?: any;
|
|
4834
|
+
/** @example 0.1 */
|
|
4835
|
+
quantity?: any;
|
|
4836
|
+
/** @example "{conditional}" */
|
|
4837
|
+
recipientFirstName?: any;
|
|
4838
|
+
/** @example "{conditional}" */
|
|
4839
|
+
recipientLastName?: any;
|
|
4840
|
+
/** @example "{optional} 1.1.1.1" */
|
|
4841
|
+
remoteAddr?: any;
|
|
4842
|
+
/** @example "{optional} Some phone" */
|
|
4843
|
+
remoteDevice?: any;
|
|
4844
|
+
/** @example "{optional} true|false" */
|
|
4845
|
+
selfHosted?: any;
|
|
4846
|
+
/** @example "{optional}" */
|
|
4847
|
+
tag?: any;
|
|
4848
|
+
/** @example "{conditional}" */
|
|
4849
|
+
vaspName?: any;
|
|
4850
|
+
/** @example "wallet address" */
|
|
4851
|
+
wallet?: any;
|
|
4852
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4853
|
+
}
|
|
4854
|
+
export class Documents<HandleError extends boolean = boolean> {
|
|
4855
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4856
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4857
|
+
/**
|
|
4858
|
+
* @tags Documents
|
|
4859
|
+
* @name Confirm
|
|
4860
|
+
* @summary Confirm
|
|
4861
|
+
* @request GET:/documents/confirm
|
|
4862
|
+
* @secure
|
|
4863
|
+
*/
|
|
4864
|
+
confirm(query?: {
|
|
4865
|
+
/**
|
|
4866
|
+
* *_accountNumber_ is accepted as well*
|
|
4867
|
+
* @example "5VA0XXXX"
|
|
4868
|
+
*/
|
|
4869
|
+
account?: any;
|
|
4870
|
+
/**
|
|
4871
|
+
* Date for the confirm. The required date format is: mm/dd/yyyy.
|
|
4872
|
+
* @example "03/03/2018"
|
|
4873
|
+
*/
|
|
4874
|
+
date?: any;
|
|
4875
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4876
|
+
/**
|
|
4877
|
+
* @tags Documents
|
|
4878
|
+
* @name ListOfConfirms
|
|
4879
|
+
* @summary List of Confirms
|
|
4880
|
+
* @request GET:/documents/confirm/list
|
|
4881
|
+
* @secure
|
|
4882
|
+
*/
|
|
4883
|
+
listOfConfirms(query?: {
|
|
4537
4884
|
/**
|
|
4538
4885
|
* *_accountNumber_ is accepted as well*
|
|
4539
4886
|
* @example "5VA0XXXX"
|
|
@@ -4926,141 +5273,36 @@ export class Branch<HandleError extends boolean = boolean> {
|
|
|
4926
5273
|
maturity?: any;
|
|
4927
5274
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4928
5275
|
}
|
|
4929
|
-
export class
|
|
5276
|
+
export class LegalDocuments<HandleError extends boolean = boolean> {
|
|
4930
5277
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4931
5278
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4932
5279
|
/**
|
|
4933
|
-
* @tags
|
|
4934
|
-
* @name
|
|
4935
|
-
* @summary
|
|
4936
|
-
* @request GET:/
|
|
5280
|
+
* @tags Legal Documents
|
|
5281
|
+
* @name DocumentClassifications
|
|
5282
|
+
* @summary Document classifications
|
|
5283
|
+
* @request GET:/user/legal/classifications
|
|
4937
5284
|
* @secure
|
|
4938
5285
|
*/
|
|
4939
|
-
|
|
4940
|
-
|
|
4941
|
-
|
|
4942
|
-
|
|
4943
|
-
|
|
4944
|
-
|
|
5286
|
+
documentClassifications(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5287
|
+
/**
|
|
5288
|
+
* @tags Legal Documents
|
|
5289
|
+
* @name DocumentListing
|
|
5290
|
+
* @summary Document listing
|
|
5291
|
+
* @request GET:/user/legal/documents
|
|
5292
|
+
* @secure
|
|
5293
|
+
*/
|
|
5294
|
+
documentListing(query?: {
|
|
4945
5295
|
/**
|
|
4946
|
-
*
|
|
4947
|
-
* @example "
|
|
5296
|
+
* {optional}
|
|
5297
|
+
* @example "TermsOfUse"
|
|
4948
5298
|
*/
|
|
4949
|
-
|
|
5299
|
+
classification?: any;
|
|
4950
5300
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4951
5301
|
/**
|
|
4952
|
-
* @tags
|
|
4953
|
-
* @name
|
|
4954
|
-
* @summary
|
|
4955
|
-
* @request
|
|
4956
|
-
* @secure
|
|
4957
|
-
*/
|
|
4958
|
-
createBusiness(data: {
|
|
4959
|
-
/** @example "Gracia Marina" */
|
|
4960
|
-
business_name?: any;
|
|
4961
|
-
/** @example "Los Angeles" */
|
|
4962
|
-
city?: any;
|
|
4963
|
-
/** @example "US" */
|
|
4964
|
-
country?: any;
|
|
4965
|
-
/** @example "La Granja Del Camaron" */
|
|
4966
|
-
dba_name?: any;
|
|
4967
|
-
/** @example "" */
|
|
4968
|
-
incorporated?: any;
|
|
4969
|
-
/** @example "812748955" */
|
|
4970
|
-
number?: any;
|
|
4971
|
-
/** @example "EIN" */
|
|
4972
|
-
number_type?: any;
|
|
4973
|
-
/** @example "" */
|
|
4974
|
-
phone?: any;
|
|
4975
|
-
/** @example "CA" */
|
|
4976
|
-
state?: any;
|
|
4977
|
-
/** @example "1119 E 8th St Ste C" */
|
|
4978
|
-
street?: any;
|
|
4979
|
-
/** @example "304902" */
|
|
4980
|
-
tracking_number?: any;
|
|
4981
|
-
/** @example "90021" */
|
|
4982
|
-
zip?: any;
|
|
4983
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4984
|
-
/**
|
|
4985
|
-
* @tags Blacklist Admin Businesses
|
|
4986
|
-
* @name GetBusinessById
|
|
4987
|
-
* @summary Get Business by ID
|
|
4988
|
-
* @request GET:/v1/admin/businesses/{id}
|
|
4989
|
-
* @secure
|
|
4990
|
-
*/
|
|
4991
|
-
getBusinessById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4992
|
-
/**
|
|
4993
|
-
* @tags Blacklist Admin Businesses
|
|
4994
|
-
* @name UpdateBusiness
|
|
4995
|
-
* @summary Update Business
|
|
4996
|
-
* @request PUT:/v1/admin/businesses/{id}
|
|
4997
|
-
* @secure
|
|
4998
|
-
*/
|
|
4999
|
-
updateBusiness(id: string, data: {
|
|
5000
|
-
/** @example "Gracia Marina" */
|
|
5001
|
-
business_name?: any;
|
|
5002
|
-
/** @example "Los Angeles" */
|
|
5003
|
-
city?: any;
|
|
5004
|
-
/** @example "US" */
|
|
5005
|
-
country?: any;
|
|
5006
|
-
/** @example "La Granja Del Camaron" */
|
|
5007
|
-
dba_name?: any;
|
|
5008
|
-
/** @example "" */
|
|
5009
|
-
incorporated?: any;
|
|
5010
|
-
/** @example "812748955" */
|
|
5011
|
-
number?: any;
|
|
5012
|
-
/** @example "EIN" */
|
|
5013
|
-
number_type?: any;
|
|
5014
|
-
/** @example "" */
|
|
5015
|
-
phone?: any;
|
|
5016
|
-
/** @example "CA" */
|
|
5017
|
-
state?: any;
|
|
5018
|
-
/** @example "1119 E 8th St Ste C" */
|
|
5019
|
-
street?: any;
|
|
5020
|
-
/** @example "304902" */
|
|
5021
|
-
tracking_number?: any;
|
|
5022
|
-
/** @example "90021" */
|
|
5023
|
-
zip?: any;
|
|
5024
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5025
|
-
/**
|
|
5026
|
-
* @tags Blacklist Admin Businesses
|
|
5027
|
-
* @name DeleteBusiness
|
|
5028
|
-
* @summary Delete Business
|
|
5029
|
-
* @request DELETE:/v1/admin/businesses/{id}
|
|
5030
|
-
* @secure
|
|
5031
|
-
*/
|
|
5032
|
-
deleteBusiness(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5033
|
-
}
|
|
5034
|
-
export class LegalDocuments<HandleError extends boolean = boolean> {
|
|
5035
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5036
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5037
|
-
/**
|
|
5038
|
-
* @tags Legal Documents
|
|
5039
|
-
* @name DocumentClassifications
|
|
5040
|
-
* @summary Document classifications
|
|
5041
|
-
* @request GET:/user/legal/classifications
|
|
5042
|
-
* @secure
|
|
5043
|
-
*/
|
|
5044
|
-
documentClassifications(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5045
|
-
/**
|
|
5046
|
-
* @tags Legal Documents
|
|
5047
|
-
* @name DocumentListing
|
|
5048
|
-
* @summary Document listing
|
|
5049
|
-
* @request GET:/user/legal/documents
|
|
5050
|
-
* @secure
|
|
5051
|
-
*/
|
|
5052
|
-
documentListing(query?: {
|
|
5053
|
-
/**
|
|
5054
|
-
* {optional}
|
|
5055
|
-
* @example "TermsOfUse"
|
|
5056
|
-
*/
|
|
5057
|
-
classification?: any;
|
|
5058
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5059
|
-
/**
|
|
5060
|
-
* @tags Legal Documents
|
|
5061
|
-
* @name PolicyValues
|
|
5062
|
-
* @summary Policy values
|
|
5063
|
-
* @request GET:/user/legal/policies/listing/{type}
|
|
5302
|
+
* @tags Legal Documents
|
|
5303
|
+
* @name PolicyValues
|
|
5304
|
+
* @summary Policy values
|
|
5305
|
+
* @request GET:/user/legal/policies/listing/{type}
|
|
5064
5306
|
* @secure
|
|
5065
5307
|
*/
|
|
5066
5308
|
policyValues(type: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
@@ -5139,6 +5381,111 @@ export class LegalDocuments<HandleError extends boolean = boolean> {
|
|
|
5139
5381
|
remoteDevice?: any;
|
|
5140
5382
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5141
5383
|
}
|
|
5384
|
+
export class BlacklistAdminBusinesses<HandleError extends boolean = boolean> {
|
|
5385
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5386
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5387
|
+
/**
|
|
5388
|
+
* @tags Blacklist Admin Businesses
|
|
5389
|
+
* @name GetBusinessesList
|
|
5390
|
+
* @summary Get Businesses list
|
|
5391
|
+
* @request GET:/v1/admin/businesses
|
|
5392
|
+
* @secure
|
|
5393
|
+
*/
|
|
5394
|
+
getBusinessesList(query?: {
|
|
5395
|
+
/**
|
|
5396
|
+
* (Required) page number
|
|
5397
|
+
* @example "5567183"
|
|
5398
|
+
*/
|
|
5399
|
+
page?: any;
|
|
5400
|
+
/**
|
|
5401
|
+
* (Required) page size in records displayed
|
|
5402
|
+
* @example "5567183"
|
|
5403
|
+
*/
|
|
5404
|
+
page_size?: any;
|
|
5405
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5406
|
+
/**
|
|
5407
|
+
* @tags Blacklist Admin Businesses
|
|
5408
|
+
* @name CreateBusiness
|
|
5409
|
+
* @summary Create Business
|
|
5410
|
+
* @request POST:/v1/admin/businesses
|
|
5411
|
+
* @secure
|
|
5412
|
+
*/
|
|
5413
|
+
createBusiness(data: {
|
|
5414
|
+
/** @example "Gracia Marina" */
|
|
5415
|
+
business_name?: any;
|
|
5416
|
+
/** @example "Los Angeles" */
|
|
5417
|
+
city?: any;
|
|
5418
|
+
/** @example "US" */
|
|
5419
|
+
country?: any;
|
|
5420
|
+
/** @example "La Granja Del Camaron" */
|
|
5421
|
+
dba_name?: any;
|
|
5422
|
+
/** @example "" */
|
|
5423
|
+
incorporated?: any;
|
|
5424
|
+
/** @example "812748955" */
|
|
5425
|
+
number?: any;
|
|
5426
|
+
/** @example "EIN" */
|
|
5427
|
+
number_type?: any;
|
|
5428
|
+
/** @example "" */
|
|
5429
|
+
phone?: any;
|
|
5430
|
+
/** @example "CA" */
|
|
5431
|
+
state?: any;
|
|
5432
|
+
/** @example "1119 E 8th St Ste C" */
|
|
5433
|
+
street?: any;
|
|
5434
|
+
/** @example "304902" */
|
|
5435
|
+
tracking_number?: any;
|
|
5436
|
+
/** @example "90021" */
|
|
5437
|
+
zip?: any;
|
|
5438
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5439
|
+
/**
|
|
5440
|
+
* @tags Blacklist Admin Businesses
|
|
5441
|
+
* @name GetBusinessById
|
|
5442
|
+
* @summary Get Business by ID
|
|
5443
|
+
* @request GET:/v1/admin/businesses/{id}
|
|
5444
|
+
* @secure
|
|
5445
|
+
*/
|
|
5446
|
+
getBusinessById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5447
|
+
/**
|
|
5448
|
+
* @tags Blacklist Admin Businesses
|
|
5449
|
+
* @name UpdateBusiness
|
|
5450
|
+
* @summary Update Business
|
|
5451
|
+
* @request PUT:/v1/admin/businesses/{id}
|
|
5452
|
+
* @secure
|
|
5453
|
+
*/
|
|
5454
|
+
updateBusiness(id: string, data: {
|
|
5455
|
+
/** @example "Gracia Marina" */
|
|
5456
|
+
business_name?: any;
|
|
5457
|
+
/** @example "Los Angeles" */
|
|
5458
|
+
city?: any;
|
|
5459
|
+
/** @example "US" */
|
|
5460
|
+
country?: any;
|
|
5461
|
+
/** @example "La Granja Del Camaron" */
|
|
5462
|
+
dba_name?: any;
|
|
5463
|
+
/** @example "" */
|
|
5464
|
+
incorporated?: any;
|
|
5465
|
+
/** @example "812748955" */
|
|
5466
|
+
number?: any;
|
|
5467
|
+
/** @example "EIN" */
|
|
5468
|
+
number_type?: any;
|
|
5469
|
+
/** @example "" */
|
|
5470
|
+
phone?: any;
|
|
5471
|
+
/** @example "CA" */
|
|
5472
|
+
state?: any;
|
|
5473
|
+
/** @example "1119 E 8th St Ste C" */
|
|
5474
|
+
street?: any;
|
|
5475
|
+
/** @example "304902" */
|
|
5476
|
+
tracking_number?: any;
|
|
5477
|
+
/** @example "90021" */
|
|
5478
|
+
zip?: any;
|
|
5479
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5480
|
+
/**
|
|
5481
|
+
* @tags Blacklist Admin Businesses
|
|
5482
|
+
* @name DeleteBusiness
|
|
5483
|
+
* @summary Delete Business
|
|
5484
|
+
* @request DELETE:/v1/admin/businesses/{id}
|
|
5485
|
+
* @secure
|
|
5486
|
+
*/
|
|
5487
|
+
deleteBusiness(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5488
|
+
}
|
|
5142
5489
|
export class BlacklistAdminIndividuals<HandleError extends boolean = boolean> {
|
|
5143
5490
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5144
5491
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5268,49 +5615,6 @@ export class BlacklistAdminIndividuals<HandleError extends boolean = boolean> {
|
|
|
5268
5615
|
*/
|
|
5269
5616
|
deleteIndividual(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5270
5617
|
}
|
|
5271
|
-
export class Broker<HandleError extends boolean = boolean> {
|
|
5272
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5273
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5274
|
-
/**
|
|
5275
|
-
* @tags Broker
|
|
5276
|
-
* @name Portfolio
|
|
5277
|
-
* @summary Portfolio
|
|
5278
|
-
* @request GET:/v1/broker/portfolio
|
|
5279
|
-
* @secure
|
|
5280
|
-
*/
|
|
5281
|
-
portfolio(query?: {
|
|
5282
|
-
/**
|
|
5283
|
-
* (true or false) Allows for loading of quotes for each portfolio entry. Defaults to false.
|
|
5284
|
-
* @example "false"
|
|
5285
|
-
*/
|
|
5286
|
-
loadQuotes?: any;
|
|
5287
|
-
/** @example "false" */
|
|
5288
|
-
loadIndustries?: any;
|
|
5289
|
-
/** @example "false" */
|
|
5290
|
-
loadUpgrades?: any;
|
|
5291
|
-
/** @example "false" */
|
|
5292
|
-
loadEarnings?: any;
|
|
5293
|
-
/**
|
|
5294
|
-
* Load balances for weight
|
|
5295
|
-
* @example "false"
|
|
5296
|
-
*/
|
|
5297
|
-
loadRtb?: any;
|
|
5298
|
-
/**
|
|
5299
|
-
* Analyze market caps and get `marketCapWeights`. To be used in conjuction with `loadQuotes`
|
|
5300
|
-
* @example "false"
|
|
5301
|
-
*/
|
|
5302
|
-
marketCapBreakdown?: any;
|
|
5303
|
-
/**
|
|
5304
|
-
* Combined portfolio for the branch
|
|
5305
|
-
* @example "false"
|
|
5306
|
-
*/
|
|
5307
|
-
combined?: any;
|
|
5308
|
-
/** @example "1" */
|
|
5309
|
-
pageNum?: any;
|
|
5310
|
-
/** @example "100" */
|
|
5311
|
-
pageSize?: any;
|
|
5312
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5313
|
-
}
|
|
5314
5618
|
export class BlacklistSearch<HandleError extends boolean = boolean> {
|
|
5315
5619
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5316
5620
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5382,7 +5686,189 @@ export class Blacklist<HandleError extends boolean = boolean> {
|
|
|
5382
5686
|
*/
|
|
5383
5687
|
getHealth(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5384
5688
|
}
|
|
5385
|
-
export class
|
|
5689
|
+
export class Broker<HandleError extends boolean = boolean> {
|
|
5690
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5691
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5692
|
+
/**
|
|
5693
|
+
* @tags Broker
|
|
5694
|
+
* @name Portfolio
|
|
5695
|
+
* @summary Portfolio
|
|
5696
|
+
* @request GET:/v1/broker/portfolio
|
|
5697
|
+
* @secure
|
|
5698
|
+
*/
|
|
5699
|
+
portfolio(query?: {
|
|
5700
|
+
/**
|
|
5701
|
+
* (true or false) Allows for loading of quotes for each portfolio entry. Defaults to false.
|
|
5702
|
+
* @example "false"
|
|
5703
|
+
*/
|
|
5704
|
+
loadQuotes?: any;
|
|
5705
|
+
/** @example "false" */
|
|
5706
|
+
loadIndustries?: any;
|
|
5707
|
+
/** @example "false" */
|
|
5708
|
+
loadUpgrades?: any;
|
|
5709
|
+
/** @example "false" */
|
|
5710
|
+
loadEarnings?: any;
|
|
5711
|
+
/**
|
|
5712
|
+
* Load balances for weight
|
|
5713
|
+
* @example "false"
|
|
5714
|
+
*/
|
|
5715
|
+
loadRtb?: any;
|
|
5716
|
+
/**
|
|
5717
|
+
* Analyze market caps and get `marketCapWeights`. To be used in conjuction with `loadQuotes`
|
|
5718
|
+
* @example "false"
|
|
5719
|
+
*/
|
|
5720
|
+
marketCapBreakdown?: any;
|
|
5721
|
+
/**
|
|
5722
|
+
* Combined portfolio for the branch
|
|
5723
|
+
* @example "false"
|
|
5724
|
+
*/
|
|
5725
|
+
combined?: any;
|
|
5726
|
+
/** @example "1" */
|
|
5727
|
+
pageNum?: any;
|
|
5728
|
+
/** @example "100" */
|
|
5729
|
+
pageSize?: any;
|
|
5730
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5731
|
+
}
|
|
5732
|
+
export class WatchmenFfiUserAccountManagement<HandleError extends boolean = boolean> {
|
|
5733
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5734
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5735
|
+
/**
|
|
5736
|
+
* @tags Watchmen Ffi User Account Management
|
|
5737
|
+
* @name CreateUser
|
|
5738
|
+
* @summary Create User
|
|
5739
|
+
* @request POST:/rest/v1/uam/user/create
|
|
5740
|
+
* @secure
|
|
5741
|
+
*/
|
|
5742
|
+
createUser(data: {
|
|
5743
|
+
/** @example "{optional} enable|disable - whether or not enable user for TipRanks" */
|
|
5744
|
+
Tipranks?: any;
|
|
5745
|
+
/** @example "{optional} true|false - defaults to false" */
|
|
5746
|
+
algos?: any;
|
|
5747
|
+
/** @example "{optional} true|false - defaults to false" */
|
|
5748
|
+
allSession?: any;
|
|
5749
|
+
/** @example "{optional} Full Name" */
|
|
5750
|
+
associatedName?: any;
|
|
5751
|
+
/** @example "{optional} true|false - defaults to false" */
|
|
5752
|
+
buyWrite?: any;
|
|
5753
|
+
/** @example "{optional} e-mail address" */
|
|
5754
|
+
email?: any;
|
|
5755
|
+
/** @example "{optional} true|false - defaults to true" */
|
|
5756
|
+
isTradingEnabled?: any;
|
|
5757
|
+
/** @example "{optional} Limit On Close - true|false - defaults to false" */
|
|
5758
|
+
loc?: any;
|
|
5759
|
+
/** @example "{optional} true|false - whether user is locked" */
|
|
5760
|
+
locked?: any;
|
|
5761
|
+
/** @example "{optional} Limit On Open - true|false - defaults to false" */
|
|
5762
|
+
loo?: any;
|
|
5763
|
+
/** @example "{optional} Market On Open - true|false - defaults to false" */
|
|
5764
|
+
moc?: any;
|
|
5765
|
+
/** @example "{optional} Market On Close - true|false - defaults to false" */
|
|
5766
|
+
moo?: any;
|
|
5767
|
+
/** @example "{optional} One Cancels Other - true|false - defaults to false" */
|
|
5768
|
+
oco?: any;
|
|
5769
|
+
/** @example "{optional} true|false - defaults to false" */
|
|
5770
|
+
optionRoll?: any;
|
|
5771
|
+
/** @example "{optional} true|false - defaults to false" */
|
|
5772
|
+
options?: any;
|
|
5773
|
+
/** @example "{optional}" */
|
|
5774
|
+
password?: any;
|
|
5775
|
+
/** @example "{optional} true|false - defaults to false" */
|
|
5776
|
+
prePostTrading?: any;
|
|
5777
|
+
/** @example "{optional} 1 - delayed, 0 - realtime, 4 - CBOE1, 3 - BATS" */
|
|
5778
|
+
quoteType?: any;
|
|
5779
|
+
/** @example "{optional} true|false - defaults to false" */
|
|
5780
|
+
spreads?: any;
|
|
5781
|
+
/** @example "A - active, S - suspended == initial user status" */
|
|
5782
|
+
status?: any;
|
|
5783
|
+
/** @example "{optional} true|false - defaults to false" */
|
|
5784
|
+
trailingStops?: any;
|
|
5785
|
+
/** @example "UNIQUE_USERNAME" */
|
|
5786
|
+
username?: any;
|
|
5787
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5788
|
+
/**
|
|
5789
|
+
* @tags Watchmen Ffi User Account Management
|
|
5790
|
+
* @name CreateAccount
|
|
5791
|
+
* @summary Create Account
|
|
5792
|
+
* @request POST:/rest/v1/uam/account/create
|
|
5793
|
+
* @secure
|
|
5794
|
+
*/
|
|
5795
|
+
createAccount(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5796
|
+
/**
|
|
5797
|
+
* @tags Watchmen Ffi User Account Management
|
|
5798
|
+
* @name AccountInformation
|
|
5799
|
+
* @summary Account Information
|
|
5800
|
+
* @request GET:/rest/v1/uam/account/data
|
|
5801
|
+
* @secure
|
|
5802
|
+
*/
|
|
5803
|
+
accountInformation(query?: {
|
|
5804
|
+
/** @example "AC123456" */
|
|
5805
|
+
accountNumber?: any;
|
|
5806
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5807
|
+
/**
|
|
5808
|
+
* @tags Watchmen Ffi User Account Management
|
|
5809
|
+
* @name UserInformation
|
|
5810
|
+
* @summary User Information
|
|
5811
|
+
* @request GET:/rest/v1/uam/user/data
|
|
5812
|
+
* @secure
|
|
5813
|
+
*/
|
|
5814
|
+
userInformation(query?: {
|
|
5815
|
+
/** @example "USERNAME" */
|
|
5816
|
+
username?: any;
|
|
5817
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5818
|
+
/**
|
|
5819
|
+
* @tags Watchmen Ffi User Account Management
|
|
5820
|
+
* @name ListLinkedAccounts
|
|
5821
|
+
* @summary List Linked Accounts
|
|
5822
|
+
* @request GET:/rest/v1/linkedaccounts/listAccounts
|
|
5823
|
+
* @secure
|
|
5824
|
+
*/
|
|
5825
|
+
listLinkedAccounts(query?: {
|
|
5826
|
+
/** @example "TEST.USER" */
|
|
5827
|
+
username?: any;
|
|
5828
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5829
|
+
/**
|
|
5830
|
+
* @tags Watchmen Ffi User Account Management
|
|
5831
|
+
* @name LinkUnlinkAccount
|
|
5832
|
+
* @summary Link/Unlink Account
|
|
5833
|
+
* @request POST:/rest/v1/linkedaccounts/linkUnlinkAccount
|
|
5834
|
+
* @secure
|
|
5835
|
+
*/
|
|
5836
|
+
linkUnlinkAccount(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5837
|
+
/**
|
|
5838
|
+
* @tags Watchmen Ffi User Account Management
|
|
5839
|
+
* @name Visibility
|
|
5840
|
+
* @summary Visibility
|
|
5841
|
+
* @request POST:/rest/v1/linkedaccounts/visibility
|
|
5842
|
+
* @secure
|
|
5843
|
+
*/
|
|
5844
|
+
visibility(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5845
|
+
/**
|
|
5846
|
+
* @tags Watchmen Ffi User Account Management
|
|
5847
|
+
* @name UserAccountSearch
|
|
5848
|
+
* @summary User/Account Search
|
|
5849
|
+
* @request POST:/rest/v1/uam/user-account-search
|
|
5850
|
+
* @secure
|
|
5851
|
+
*/
|
|
5852
|
+
userAccountSearch(data: {
|
|
5853
|
+
/** @example "desired account number" */
|
|
5854
|
+
accountNumber?: any;
|
|
5855
|
+
/** @example 100 */
|
|
5856
|
+
limit?: any;
|
|
5857
|
+
/** @example 0 */
|
|
5858
|
+
lockedBit?: any;
|
|
5859
|
+
/** @example "desired username" */
|
|
5860
|
+
login?: any;
|
|
5861
|
+
/** @example false */
|
|
5862
|
+
noBrokers?: any;
|
|
5863
|
+
/** @example "" */
|
|
5864
|
+
omnibus?: any;
|
|
5865
|
+
/** @example false */
|
|
5866
|
+
onlyActiveAccount?: any;
|
|
5867
|
+
/** @example false */
|
|
5868
|
+
onlyActiveUser?: any;
|
|
5869
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5870
|
+
}
|
|
5871
|
+
export class WatchmenFfiFirmBranch<HandleError extends boolean = boolean> {
|
|
5386
5872
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5387
5873
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5388
5874
|
/**
|
|
@@ -5567,489 +6053,11 @@ export class Advisory<HandleError extends boolean = boolean> {
|
|
|
5567
6053
|
allocations: AdvisoryAllocations<HandleError>;
|
|
5568
6054
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5569
6055
|
}
|
|
5570
|
-
export class
|
|
6056
|
+
export class WatchmenFfi<HandleError extends boolean = boolean> {
|
|
5571
6057
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
6058
|
+
userAccountManagement: WatchmenFfiUserAccountManagement<HandleError>;
|
|
6059
|
+
firmBranch: WatchmenFfiFirmBranch<HandleError>;
|
|
5572
6060
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5573
|
-
/**
|
|
5574
|
-
* @tags Watchmen Ffi User Account Management
|
|
5575
|
-
* @name CreateUser
|
|
5576
|
-
* @summary Create User
|
|
5577
|
-
* @request POST:/rest/v1/uam/user/create
|
|
5578
|
-
* @secure
|
|
5579
|
-
*/
|
|
5580
|
-
createUser(data: {
|
|
5581
|
-
/** @example "{optional} enable|disable - whether or not enable user for TipRanks" */
|
|
5582
|
-
Tipranks?: any;
|
|
5583
|
-
/** @example "{optional} true|false - defaults to false" */
|
|
5584
|
-
algos?: any;
|
|
5585
|
-
/** @example "{optional} true|false - defaults to false" */
|
|
5586
|
-
allSession?: any;
|
|
5587
|
-
/** @example "{optional} Full Name" */
|
|
5588
|
-
associatedName?: any;
|
|
5589
|
-
/** @example "{optional} true|false - defaults to false" */
|
|
5590
|
-
buyWrite?: any;
|
|
5591
|
-
/** @example "{optional} e-mail address" */
|
|
5592
|
-
email?: any;
|
|
5593
|
-
/** @example "{optional} true|false - defaults to true" */
|
|
5594
|
-
isTradingEnabled?: any;
|
|
5595
|
-
/** @example "{optional} Limit On Close - true|false - defaults to false" */
|
|
5596
|
-
loc?: any;
|
|
5597
|
-
/** @example "{optional} true|false - whether user is locked" */
|
|
5598
|
-
locked?: any;
|
|
5599
|
-
/** @example "{optional} Limit On Open - true|false - defaults to false" */
|
|
5600
|
-
loo?: any;
|
|
5601
|
-
/** @example "{optional} Market On Open - true|false - defaults to false" */
|
|
5602
|
-
moc?: any;
|
|
5603
|
-
/** @example "{optional} Market On Close - true|false - defaults to false" */
|
|
5604
|
-
moo?: any;
|
|
5605
|
-
/** @example "{optional} One Cancels Other - true|false - defaults to false" */
|
|
5606
|
-
oco?: any;
|
|
5607
|
-
/** @example "{optional} true|false - defaults to false" */
|
|
5608
|
-
optionRoll?: any;
|
|
5609
|
-
/** @example "{optional} true|false - defaults to false" */
|
|
5610
|
-
options?: any;
|
|
5611
|
-
/** @example "{optional}" */
|
|
5612
|
-
password?: any;
|
|
5613
|
-
/** @example "{optional} true|false - defaults to false" */
|
|
5614
|
-
prePostTrading?: any;
|
|
5615
|
-
/** @example "{optional} 1 - delayed, 0 - realtime, 4 - CBOE1, 3 - BATS" */
|
|
5616
|
-
quoteType?: any;
|
|
5617
|
-
/** @example "{optional} true|false - defaults to false" */
|
|
5618
|
-
spreads?: any;
|
|
5619
|
-
/** @example "A - active, S - suspended == initial user status" */
|
|
5620
|
-
status?: any;
|
|
5621
|
-
/** @example "{optional} true|false - defaults to false" */
|
|
5622
|
-
trailingStops?: any;
|
|
5623
|
-
/** @example "UNIQUE_USERNAME" */
|
|
5624
|
-
username?: any;
|
|
5625
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5626
|
-
/**
|
|
5627
|
-
* @tags Watchmen Ffi User Account Management
|
|
5628
|
-
* @name CreateAccount
|
|
5629
|
-
* @summary Create Account
|
|
5630
|
-
* @request POST:/rest/v1/uam/account/create
|
|
5631
|
-
* @secure
|
|
5632
|
-
*/
|
|
5633
|
-
createAccount(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5634
|
-
/**
|
|
5635
|
-
* @tags Watchmen Ffi User Account Management
|
|
5636
|
-
* @name AccountInformation
|
|
5637
|
-
* @summary Account Information
|
|
5638
|
-
* @request GET:/rest/v1/uam/account/data
|
|
5639
|
-
* @secure
|
|
5640
|
-
*/
|
|
5641
|
-
accountInformation(query?: {
|
|
5642
|
-
/** @example "AC123456" */
|
|
5643
|
-
accountNumber?: any;
|
|
5644
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5645
|
-
/**
|
|
5646
|
-
* @tags Watchmen Ffi User Account Management
|
|
5647
|
-
* @name UserInformation
|
|
5648
|
-
* @summary User Information
|
|
5649
|
-
* @request GET:/rest/v1/uam/user/data
|
|
5650
|
-
* @secure
|
|
5651
|
-
*/
|
|
5652
|
-
userInformation(query?: {
|
|
5653
|
-
/** @example "USERNAME" */
|
|
5654
|
-
username?: any;
|
|
5655
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5656
|
-
/**
|
|
5657
|
-
* @tags Watchmen Ffi User Account Management
|
|
5658
|
-
* @name ListLinkedAccounts
|
|
5659
|
-
* @summary List Linked Accounts
|
|
5660
|
-
* @request GET:/rest/v1/linkedaccounts/listAccounts
|
|
5661
|
-
* @secure
|
|
5662
|
-
*/
|
|
5663
|
-
listLinkedAccounts(query?: {
|
|
5664
|
-
/** @example "TEST.USER" */
|
|
5665
|
-
username?: any;
|
|
5666
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5667
|
-
/**
|
|
5668
|
-
* @tags Watchmen Ffi User Account Management
|
|
5669
|
-
* @name LinkUnlinkAccount
|
|
5670
|
-
* @summary Link/Unlink Account
|
|
5671
|
-
* @request POST:/rest/v1/linkedaccounts/linkUnlinkAccount
|
|
5672
|
-
* @secure
|
|
5673
|
-
*/
|
|
5674
|
-
linkUnlinkAccount(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5675
|
-
/**
|
|
5676
|
-
* @tags Watchmen Ffi User Account Management
|
|
5677
|
-
* @name Visibility
|
|
5678
|
-
* @summary Visibility
|
|
5679
|
-
* @request POST:/rest/v1/linkedaccounts/visibility
|
|
5680
|
-
* @secure
|
|
5681
|
-
*/
|
|
5682
|
-
visibility(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5683
|
-
/**
|
|
5684
|
-
* @tags Watchmen Ffi User Account Management
|
|
5685
|
-
* @name UserAccountSearch
|
|
5686
|
-
* @summary User/Account Search
|
|
5687
|
-
* @request POST:/rest/v1/uam/user-account-search
|
|
5688
|
-
* @secure
|
|
5689
|
-
*/
|
|
5690
|
-
userAccountSearch(data: {
|
|
5691
|
-
/** @example "desired account number" */
|
|
5692
|
-
accountNumber?: any;
|
|
5693
|
-
/** @example 100 */
|
|
5694
|
-
limit?: any;
|
|
5695
|
-
/** @example 0 */
|
|
5696
|
-
lockedBit?: any;
|
|
5697
|
-
/** @example "desired username" */
|
|
5698
|
-
login?: any;
|
|
5699
|
-
/** @example false */
|
|
5700
|
-
noBrokers?: any;
|
|
5701
|
-
/** @example "" */
|
|
5702
|
-
omnibus?: any;
|
|
5703
|
-
/** @example false */
|
|
5704
|
-
onlyActiveAccount?: any;
|
|
5705
|
-
/** @example false */
|
|
5706
|
-
onlyActiveUser?: any;
|
|
5707
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5708
|
-
}
|
|
5709
|
-
export class WatchmenFfi<HandleError extends boolean = boolean> {
|
|
5710
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5711
|
-
userAccountManagement: WatchmenFfiUserAccountManagement<HandleError>;
|
|
5712
|
-
firmBranch: WatchmenFfiFirmBranch<HandleError>;
|
|
5713
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5714
|
-
}
|
|
5715
|
-
export class TransfersInstantCashTransfers<HandleError extends boolean = boolean> {
|
|
5716
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5717
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5718
|
-
/**
|
|
5719
|
-
* @tags Transfers Instant Cash Transfers
|
|
5720
|
-
* @name DepositWithdrawal
|
|
5721
|
-
* @summary Deposit/Withdrawal
|
|
5722
|
-
* @request POST:/transfer/ict/${direction}
|
|
5723
|
-
* @secure
|
|
5724
|
-
*/
|
|
5725
|
-
depositWithdrawal(direction: string, data: {
|
|
5726
|
-
/** @example "ABC123456" */
|
|
5727
|
-
account?: any;
|
|
5728
|
-
/** @example 100 */
|
|
5729
|
-
amount?: any;
|
|
5730
|
-
/** @example "USD" */
|
|
5731
|
-
currency?: any;
|
|
5732
|
-
originator?: {
|
|
5733
|
-
address?: {
|
|
5734
|
-
/** @example "Central City" */
|
|
5735
|
-
city?: string;
|
|
5736
|
-
/** @example "USA" */
|
|
5737
|
-
country?: string;
|
|
5738
|
-
/** @example "12345" */
|
|
5739
|
-
postalCode?: string;
|
|
5740
|
-
/** @example "NY" */
|
|
5741
|
-
stateProvince?: string;
|
|
5742
|
-
/** @example ["123 Main St"] */
|
|
5743
|
-
streetAddress?: string[];
|
|
5744
|
-
};
|
|
5745
|
-
/** @example "John" */
|
|
5746
|
-
firstName?: string;
|
|
5747
|
-
institution?: {
|
|
5748
|
-
/** @example "123456789" */
|
|
5749
|
-
accountNumber?: string;
|
|
5750
|
-
/** @example "Central City Central Bank" */
|
|
5751
|
-
name?: string;
|
|
5752
|
-
};
|
|
5753
|
-
/** @example "Smith" */
|
|
5754
|
-
lastName?: string;
|
|
5755
|
-
};
|
|
5756
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5757
|
-
/**
|
|
5758
|
-
* @tags Transfers Instant Cash Transfers
|
|
5759
|
-
* @name DepositWithdrawalV2
|
|
5760
|
-
* @summary Deposit/Withdrawal V2
|
|
5761
|
-
* @request POST:/transfer/v2/ict/${direction}
|
|
5762
|
-
* @secure
|
|
5763
|
-
*/
|
|
5764
|
-
depositWithdrawalV2(direction: string, data: {
|
|
5765
|
-
/** @example "AB123456" */
|
|
5766
|
-
account?: any;
|
|
5767
|
-
/** @example 100.32 */
|
|
5768
|
-
amount?: any;
|
|
5769
|
-
counterparty?: {
|
|
5770
|
-
address?: {
|
|
5771
|
-
/** @example "Central City" */
|
|
5772
|
-
city?: string;
|
|
5773
|
-
/** @example "12345" */
|
|
5774
|
-
postalCode?: string;
|
|
5775
|
-
/** @example "CC" */
|
|
5776
|
-
stateProvince?: string;
|
|
5777
|
-
/** @example ["225 Baker St"] */
|
|
5778
|
-
streetAddress?: string[];
|
|
5779
|
-
};
|
|
5780
|
-
/** @example "James" */
|
|
5781
|
-
firstName?: string;
|
|
5782
|
-
institution?: {
|
|
5783
|
-
/** @example "123456" */
|
|
5784
|
-
accountNumber?: string;
|
|
5785
|
-
/** @example "Royal Central Bank" */
|
|
5786
|
-
name?: string;
|
|
5787
|
-
};
|
|
5788
|
-
/** @example "Bond" */
|
|
5789
|
-
lastName?: string;
|
|
5790
|
-
};
|
|
5791
|
-
/** @example "USD" */
|
|
5792
|
-
currency?: any;
|
|
5793
|
-
/** @example "1.1.1.1" */
|
|
5794
|
-
remoteAddr?: any;
|
|
5795
|
-
/** @example "Droid Phone" */
|
|
5796
|
-
remoteDevice?: any;
|
|
5797
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5798
|
-
/**
|
|
5799
|
-
* @tags Transfers Instant Cash Transfers
|
|
5800
|
-
* @name ObtainTheReport
|
|
5801
|
-
* @summary Obtain the report
|
|
5802
|
-
* @request POST:/transfer/reports/obtain
|
|
5803
|
-
* @secure
|
|
5804
|
-
*/
|
|
5805
|
-
obtainTheReport(data: {
|
|
5806
|
-
/** @example "MM/DD/YYYY HH:MM:SS ZZZ" */
|
|
5807
|
-
date?: any;
|
|
5808
|
-
/** @example "RETAIL_BANKING" */
|
|
5809
|
-
reportType?: any;
|
|
5810
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5811
|
-
/**
|
|
5812
|
-
* @tags Transfers Instant Cash Transfers
|
|
5813
|
-
* @name ListReports
|
|
5814
|
-
* @summary List reports
|
|
5815
|
-
* @request GET:/transfer/reports
|
|
5816
|
-
* @secure
|
|
5817
|
-
*/
|
|
5818
|
-
listReports(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5819
|
-
}
|
|
5820
|
-
export class Transfers<HandleError extends boolean = boolean> {
|
|
5821
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5822
|
-
relationships: TransfersRelationships<HandleError>;
|
|
5823
|
-
instantAccountVerification: TransfersInstantAccountVerification<HandleError>;
|
|
5824
|
-
ach: TransfersAch<HandleError>;
|
|
5825
|
-
acats: TransfersAcats<HandleError>;
|
|
5826
|
-
wires: TransfersWires<HandleError>;
|
|
5827
|
-
journals: TransfersJournals<HandleError>;
|
|
5828
|
-
positions: TransfersPositions<HandleError>;
|
|
5829
|
-
bank: TransfersBank<HandleError>;
|
|
5830
|
-
instantCashTransfers: TransfersInstantCashTransfers<HandleError>;
|
|
5831
|
-
cheques: TransfersCheques<HandleError>;
|
|
5832
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5833
|
-
/**
|
|
5834
|
-
* @tags Transfers
|
|
5835
|
-
* @name TransferDetails
|
|
5836
|
-
* @summary Transfer Details
|
|
5837
|
-
* @request GET:/transfer/details/{account}/{transferId}
|
|
5838
|
-
* @secure
|
|
5839
|
-
*/
|
|
5840
|
-
transferDetails(account: string, transferId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5841
|
-
/**
|
|
5842
|
-
* @tags Transfers
|
|
5843
|
-
* @name TransferStatus
|
|
5844
|
-
* @summary Transfer Status
|
|
5845
|
-
* @request GET:/transfer/status/{account}
|
|
5846
|
-
* @secure
|
|
5847
|
-
*/
|
|
5848
|
-
transferStatus(account: string, query?: {
|
|
5849
|
-
/** INCOMING|OUTGOING */
|
|
5850
|
-
direction?: any;
|
|
5851
|
-
/** ACH|WIRE|CHECK|Bank|CustodyJournal|ALL */
|
|
5852
|
-
mechanism?: any;
|
|
5853
|
-
/** MM/DD/YYYY */
|
|
5854
|
-
dateFrom?: any;
|
|
5855
|
-
/** MM/DD/YYYY */
|
|
5856
|
-
dateTo?: any;
|
|
5857
|
-
/** Overrides `dateFrom` and `dateTo`. See description. */
|
|
5858
|
-
range?: any;
|
|
5859
|
-
start?: any;
|
|
5860
|
-
perPage?: any;
|
|
5861
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5862
|
-
/**
|
|
5863
|
-
* @tags Transfers
|
|
5864
|
-
* @name TransferStatusModel
|
|
5865
|
-
* @summary Transfer Status Model
|
|
5866
|
-
* @request GET:/transfer/status/model/{modelId}
|
|
5867
|
-
* @secure
|
|
5868
|
-
*/
|
|
5869
|
-
transferStatusModel(modelId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5870
|
-
/**
|
|
5871
|
-
* @tags Transfers
|
|
5872
|
-
* @name TransferStatusBranch
|
|
5873
|
-
* @summary Transfer Status Branch
|
|
5874
|
-
* @request GET:/transfer/status/branch
|
|
5875
|
-
* @secure
|
|
5876
|
-
*/
|
|
5877
|
-
transferStatusBranch(query?: {
|
|
5878
|
-
/**
|
|
5879
|
-
* INCOMING|OUTGOING|ALL
|
|
5880
|
-
* @example "ALL"
|
|
5881
|
-
*/
|
|
5882
|
-
direction?: any;
|
|
5883
|
-
/**
|
|
5884
|
-
* ACH|WIRE|CHECK|Bank|CustodyJournal
|
|
5885
|
-
* @example "ALL"
|
|
5886
|
-
*/
|
|
5887
|
-
mechanism?: any;
|
|
5888
|
-
dateFrom?: any;
|
|
5889
|
-
dateTo?: any;
|
|
5890
|
-
/** Per regex: \d+[ymdw]$ (will override `dateFrom` and `dateTo`) */
|
|
5891
|
-
range?: any;
|
|
5892
|
-
start?: any;
|
|
5893
|
-
perPage?: any;
|
|
5894
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5895
|
-
/**
|
|
5896
|
-
* @tags Transfers
|
|
5897
|
-
* @name AmountAvailable
|
|
5898
|
-
* @summary Amount Available
|
|
5899
|
-
* @request GET:/transfer/available/{account}
|
|
5900
|
-
* @secure
|
|
5901
|
-
*/
|
|
5902
|
-
amountAvailable(account: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5903
|
-
/**
|
|
5904
|
-
* @tags Transfers
|
|
5905
|
-
* @name LegalDocumentTypes
|
|
5906
|
-
* @summary Legal document types
|
|
5907
|
-
* @request GET:/transfer/legal/types
|
|
5908
|
-
* @secure
|
|
5909
|
-
*/
|
|
5910
|
-
legalDocumentTypes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5911
|
-
/**
|
|
5912
|
-
* @tags Transfers
|
|
5913
|
-
* @name LegalDocument
|
|
5914
|
-
* @summary Legal document
|
|
5915
|
-
* @request GET:/transfer/legal/content
|
|
5916
|
-
* @secure
|
|
5917
|
-
*/
|
|
5918
|
-
legalDocument(query?: {
|
|
5919
|
-
/** Unique ID given in the types endpoint */
|
|
5920
|
-
id?: any;
|
|
5921
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5922
|
-
/**
|
|
5923
|
-
* @tags Transfers
|
|
5924
|
-
* @name Cancel
|
|
5925
|
-
* @summary Cancel
|
|
5926
|
-
* @request POST:/transfer/ach/cancel
|
|
5927
|
-
* @secure
|
|
5928
|
-
*/
|
|
5929
|
-
cancel(data: {
|
|
5930
|
-
/** @example "5VA0XXXX" */
|
|
5931
|
-
account?: any;
|
|
5932
|
-
/** @example "0.0.0.0" */
|
|
5933
|
-
remoteAddr?: any;
|
|
5934
|
-
/** @example "ultra fast browser 1.1" */
|
|
5935
|
-
remoteDevice?: any;
|
|
5936
|
-
/** @example "CC123456" */
|
|
5937
|
-
transferId?: any;
|
|
5938
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5939
|
-
/**
|
|
5940
|
-
* @tags Transfers
|
|
5941
|
-
* @name FeesAndCredits
|
|
5942
|
-
* @summary Fees and Credits
|
|
5943
|
-
* @request POST:/transfer/fees/apply
|
|
5944
|
-
* @secure
|
|
5945
|
-
*/
|
|
5946
|
-
feesAndCredits(data: {
|
|
5947
|
-
/** @example "5VA0XXXX" */
|
|
5948
|
-
account?: any;
|
|
5949
|
-
/** @example 100 */
|
|
5950
|
-
amount?: any;
|
|
5951
|
-
/** @example "FeeReversal|Promotion|WriteOff|Rebate|Courtesy|Advisory|Management|Admin|Exchange|Tech|Platform|Inactivity|MarginInterest|Custodian|CryptoGift" */
|
|
5952
|
-
classification?: any;
|
|
5953
|
-
/** @example "" */
|
|
5954
|
-
contraNote?: any;
|
|
5955
|
-
/** @example "USD" */
|
|
5956
|
-
currency?: any;
|
|
5957
|
-
/** @example "" */
|
|
5958
|
-
note?: any;
|
|
5959
|
-
/** @example 0.01 */
|
|
5960
|
-
quantity?: any;
|
|
5961
|
-
/** @example "0.0.0.0" */
|
|
5962
|
-
remoteAddr?: any;
|
|
5963
|
-
/** @example "ultra fast browser 1.1" */
|
|
5964
|
-
remoteDevice?: any;
|
|
5965
|
-
/** @example "BTC/USD" */
|
|
5966
|
-
symbol?: any;
|
|
5967
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5968
|
-
/**
|
|
5969
|
-
* @tags Transfers
|
|
5970
|
-
* @name ListFees
|
|
5971
|
-
* @summary List fees
|
|
5972
|
-
* @request GET:/transfer/fees/classifications/fees
|
|
5973
|
-
* @secure
|
|
5974
|
-
*/
|
|
5975
|
-
listFees(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5976
|
-
/**
|
|
5977
|
-
* @tags Transfers
|
|
5978
|
-
* @name ListCredits
|
|
5979
|
-
* @summary List credits
|
|
5980
|
-
* @request GET:/transfer/fees/classifications/credits
|
|
5981
|
-
* @secure
|
|
5982
|
-
*/
|
|
5983
|
-
listCredits(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5984
|
-
/**
|
|
5985
|
-
* @tags Transfers
|
|
5986
|
-
* @name CryptoDepositAddress
|
|
5987
|
-
* @summary Crypto Deposit Address
|
|
5988
|
-
* @request GET:/transfer/crypto/deposit/wallet/address
|
|
5989
|
-
* @secure
|
|
5990
|
-
*/
|
|
5991
|
-
cryptoDepositAddress(data: {
|
|
5992
|
-
/** @example "AB123456" */
|
|
5993
|
-
account?: any;
|
|
5994
|
-
/** @example "BTC" */
|
|
5995
|
-
currency?: any;
|
|
5996
|
-
/** @example "{optional}" */
|
|
5997
|
-
network?: any;
|
|
5998
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5999
|
-
/**
|
|
6000
|
-
* @tags Transfers
|
|
6001
|
-
* @name CryptoWithdrawalEstimate
|
|
6002
|
-
* @summary Crypto Withdrawal Estimate
|
|
6003
|
-
* @request POST:/transfer/crypto/withdrawal/estimate
|
|
6004
|
-
* @secure
|
|
6005
|
-
*/
|
|
6006
|
-
cryptoWithdrawalEstimate(data: {
|
|
6007
|
-
/** @example "BTC" */
|
|
6008
|
-
currency?: any;
|
|
6009
|
-
/** @example "{optional}" */
|
|
6010
|
-
network?: any;
|
|
6011
|
-
/** @example "0.1" */
|
|
6012
|
-
quantity?: any;
|
|
6013
|
-
/** @example "{optional}" */
|
|
6014
|
-
wallet?: any;
|
|
6015
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
6016
|
-
/**
|
|
6017
|
-
* @tags Transfers
|
|
6018
|
-
* @name CryptoWithdrawal
|
|
6019
|
-
* @summary Crypto Withdrawal
|
|
6020
|
-
* @request POST:/transfer/crypto/withdraw
|
|
6021
|
-
* @secure
|
|
6022
|
-
*/
|
|
6023
|
-
cryptoWithdrawal(data: {
|
|
6024
|
-
/** @example "AB123456" */
|
|
6025
|
-
account?: any;
|
|
6026
|
-
/** @example "BTC" */
|
|
6027
|
-
currency?: any;
|
|
6028
|
-
/** @example "{optional}" */
|
|
6029
|
-
estimateExtension?: any;
|
|
6030
|
-
/** @example "abc123" */
|
|
6031
|
-
estimateId?: any;
|
|
6032
|
-
/** @example "{optional}" */
|
|
6033
|
-
network?: any;
|
|
6034
|
-
/** @example 0.1 */
|
|
6035
|
-
quantity?: any;
|
|
6036
|
-
/** @example "{conditional}" */
|
|
6037
|
-
recipientFirstName?: any;
|
|
6038
|
-
/** @example "{conditional}" */
|
|
6039
|
-
recipientLastName?: any;
|
|
6040
|
-
/** @example "{optional} 1.1.1.1" */
|
|
6041
|
-
remoteAddr?: any;
|
|
6042
|
-
/** @example "{optional} Some phone" */
|
|
6043
|
-
remoteDevice?: any;
|
|
6044
|
-
/** @example "{optional} true|false" */
|
|
6045
|
-
selfHosted?: any;
|
|
6046
|
-
/** @example "{optional}" */
|
|
6047
|
-
tag?: any;
|
|
6048
|
-
/** @example "{conditional}" */
|
|
6049
|
-
vaspName?: any;
|
|
6050
|
-
/** @example "wallet address" */
|
|
6051
|
-
wallet?: any;
|
|
6052
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
6053
6061
|
}
|
|
6054
6062
|
export class OrbisApi<HandleError extends boolean = false> extends BaseApi<HandleError, OrbisClient<HandleError>> {
|
|
6055
6063
|
readonly config: OrbisClientConfig<HandleError>;
|