@orbis-systems/orbis-api-clients 0.7.14 → 0.7.16
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 +197 -163
- 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 +710 -558
- 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 +410 -131
- 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 +156 -87
- 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 +911 -1067
- 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 +475 -774
- 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 +263 -245
- 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
|
@@ -229,82 +229,6 @@ declare class OrbisClient<HandleError extends boolean = boolean> extends JwtClie
|
|
|
229
229
|
protected readonly config: OrbisClientConfig<HandleError>;
|
|
230
230
|
request<Data = unknown, Body = unknown>(config: RequestConfig<Body>): Promise<OrbisClientResponse<Data, HandleError>>;
|
|
231
231
|
}
|
|
232
|
-
export class OrdersV2Equities<HandleError extends boolean = boolean> {
|
|
233
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
234
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
235
|
-
/**
|
|
236
|
-
* @tags Orders V2 Equities
|
|
237
|
-
* @name Preview
|
|
238
|
-
* @summary Preview
|
|
239
|
-
* @request POST:/orders/v2/preview/equity
|
|
240
|
-
* @secure
|
|
241
|
-
*/
|
|
242
|
-
preview(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
243
|
-
/**
|
|
244
|
-
* @tags Orders V2 Equities
|
|
245
|
-
* @name Placement
|
|
246
|
-
* @summary Placement
|
|
247
|
-
* @request POST:/orders/v2/place/equity
|
|
248
|
-
* @secure
|
|
249
|
-
*/
|
|
250
|
-
placement(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
251
|
-
/**
|
|
252
|
-
* @tags Orders V2 Equities
|
|
253
|
-
* @name AlgoPreview
|
|
254
|
-
* @summary Algo Preview
|
|
255
|
-
* @request POST:/orders/v2/algo/preview/equity
|
|
256
|
-
* @secure
|
|
257
|
-
*/
|
|
258
|
-
algoPreview(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
259
|
-
/**
|
|
260
|
-
* @tags Orders V2 Equities
|
|
261
|
-
* @name AlgoPlacement
|
|
262
|
-
* @summary Algo Placement
|
|
263
|
-
* @request POST:/orders/v2/algo/place/equity
|
|
264
|
-
* @secure
|
|
265
|
-
*/
|
|
266
|
-
algoPlacement(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
267
|
-
/**
|
|
268
|
-
* @tags Orders V2 Equities
|
|
269
|
-
* @name BasketPreview
|
|
270
|
-
* @summary Basket preview
|
|
271
|
-
* @request POST:/orders/v2/basket/preview/equity
|
|
272
|
-
* @secure
|
|
273
|
-
*/
|
|
274
|
-
basketPreview(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
275
|
-
/**
|
|
276
|
-
* @tags Orders V2 Equities
|
|
277
|
-
* @name BasketPlacement
|
|
278
|
-
* @summary Basket placement
|
|
279
|
-
* @request POST:/orders/v2/basket/place/equity
|
|
280
|
-
* @secure
|
|
281
|
-
*/
|
|
282
|
-
basketPlacement(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
283
|
-
/**
|
|
284
|
-
* @tags Orders V2 Equities
|
|
285
|
-
* @name AdvisoryPreview
|
|
286
|
-
* @summary Advisory preview
|
|
287
|
-
* @request POST:/orders/v2/advisory/equity/preview
|
|
288
|
-
* @secure
|
|
289
|
-
*/
|
|
290
|
-
advisoryPreview(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
291
|
-
/**
|
|
292
|
-
* @tags Orders V2 Equities
|
|
293
|
-
* @name AdvisoryPlacement
|
|
294
|
-
* @summary Advisory placement
|
|
295
|
-
* @request POST:/orders/v2/advisory/equity/place
|
|
296
|
-
* @secure
|
|
297
|
-
*/
|
|
298
|
-
advisoryPlacement(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
299
|
-
/**
|
|
300
|
-
* @tags Orders V2 Equities
|
|
301
|
-
* @name PreviewSnapshot
|
|
302
|
-
* @summary Preview Snapshot
|
|
303
|
-
* @request POST:/orders/v2/preview/equity/snapshot
|
|
304
|
-
* @secure
|
|
305
|
-
*/
|
|
306
|
-
previewSnapshot(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
307
|
-
}
|
|
308
232
|
export class OrdersV2Options<HandleError extends boolean = boolean> {
|
|
309
233
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
310
234
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -367,37 +291,7 @@ export class OrdersV2Options<HandleError extends boolean = boolean> {
|
|
|
367
291
|
* @request POST:/orders/v2/preview/options/multileg
|
|
368
292
|
* @secure
|
|
369
293
|
*/
|
|
370
|
-
previewMultileg(data:
|
|
371
|
-
account?: {
|
|
372
|
-
/** @example 1234 */
|
|
373
|
-
accountId?: number;
|
|
374
|
-
/** @example "TRACCOUNT" */
|
|
375
|
-
accountNumber?: string;
|
|
376
|
-
};
|
|
377
|
-
order?: {
|
|
378
|
-
/** @example [{"quantity":10,"quote":{"option":true,"symbol":"F 130927C00014500"},"transaction":"BUY_TO_OPEN|BUY_TO_CLOSE|SELL_TO_OPEN|SELL_TO_CLOSE"},{"quantity":10,"quote":{"option":true,"symbol":"F 130927C00015500"},"transaction":"BUY_TO_OPEN|BUY_TO_CLOSE|SELL_TO_OPEN|SELL_TO_CLOSE"}] */
|
|
379
|
-
legs?: {
|
|
380
|
-
/** @example 10 */
|
|
381
|
-
quantity?: number;
|
|
382
|
-
quote?: {
|
|
383
|
-
/** @example true */
|
|
384
|
-
option?: boolean;
|
|
385
|
-
/** @example "F 130927C00014500" */
|
|
386
|
-
symbol?: string;
|
|
387
|
-
};
|
|
388
|
-
/** @example "BUY_TO_OPEN|BUY_TO_CLOSE|SELL_TO_OPEN|SELL_TO_CLOSE" */
|
|
389
|
-
transaction?: string;
|
|
390
|
-
}[];
|
|
391
|
-
/** @example "MARKET|Even|Credit|Debit" */
|
|
392
|
-
orderType?: string;
|
|
393
|
-
/** @example 0 */
|
|
394
|
-
spreadPrice?: number;
|
|
395
|
-
/** @example "DAY|GTC" */
|
|
396
|
-
validity?: string;
|
|
397
|
-
};
|
|
398
|
-
/** @example false */
|
|
399
|
-
requireNbbo?: any;
|
|
400
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
294
|
+
previewMultileg(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
401
295
|
/**
|
|
402
296
|
* @tags Orders V2 Options
|
|
403
297
|
* @name PlacementMultileg
|
|
@@ -405,39 +299,7 @@ export class OrdersV2Options<HandleError extends boolean = boolean> {
|
|
|
405
299
|
* @request POST:/orders/v2/place/options/multileg
|
|
406
300
|
* @secure
|
|
407
301
|
*/
|
|
408
|
-
placementMultileg(data:
|
|
409
|
-
account?: {
|
|
410
|
-
/** @example 1234 */
|
|
411
|
-
accountId?: number;
|
|
412
|
-
/** @example "TRACCOUNT" */
|
|
413
|
-
accountNumber?: string;
|
|
414
|
-
};
|
|
415
|
-
order?: {
|
|
416
|
-
/** @example "{your own order reference number}" */
|
|
417
|
-
clientRef?: string;
|
|
418
|
-
/** @example "ABC" */
|
|
419
|
-
clientSourceId?: string;
|
|
420
|
-
/** @example [{"quantity":10,"quote":{"option":true,"symbol":"F 130927C00014500"},"transaction":"BUY_TO_OPEN|BUY_TO_CLOSE|SELL_TO_OPEN|SELL_TO_CLOSE"},{"quantity":10,"quote":{"option":true,"symbol":"F 130927C00015500"},"transaction":"BUY_TO_OPEN|BUY_TO_CLOSE|SELL_TO_OPEN|SELL_TO_CLOSE"}] */
|
|
421
|
-
legs?: {
|
|
422
|
-
/** @example 10 */
|
|
423
|
-
quantity?: number;
|
|
424
|
-
quote?: {
|
|
425
|
-
/** @example true */
|
|
426
|
-
option?: boolean;
|
|
427
|
-
/** @example "F 130927C00014500" */
|
|
428
|
-
symbol?: string;
|
|
429
|
-
};
|
|
430
|
-
/** @example "BUY_TO_OPEN|BUY_TO_CLOSE|SELL_TO_OPEN|SELL_TO_CLOSE" */
|
|
431
|
-
transaction?: string;
|
|
432
|
-
}[];
|
|
433
|
-
/** @example "MARKET|Even|Credit|Debit" */
|
|
434
|
-
orderType?: string;
|
|
435
|
-
/** @example 0 */
|
|
436
|
-
spreadPrice?: number;
|
|
437
|
-
/** @example "DAY|GTC" */
|
|
438
|
-
validity?: string;
|
|
439
|
-
};
|
|
440
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
302
|
+
placementMultileg(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
441
303
|
/**
|
|
442
304
|
* @tags Orders V2 Options
|
|
443
305
|
* @name ReplacePreviewMultileg
|
|
@@ -520,36 +382,7 @@ export class OrdersV2FixedIncome<HandleError extends boolean = boolean> {
|
|
|
520
382
|
* @request POST:/orders/v2/bonds/place
|
|
521
383
|
* @secure
|
|
522
384
|
*/
|
|
523
|
-
bondPlacement(data:
|
|
524
|
-
account?: {
|
|
525
|
-
/** @example 123 */
|
|
526
|
-
accountId?: number;
|
|
527
|
-
/** @example "AC00123" */
|
|
528
|
-
accountNumber?: string;
|
|
529
|
-
};
|
|
530
|
-
order?: {
|
|
531
|
-
/** @example "LIMIT" */
|
|
532
|
-
orderType?: string;
|
|
533
|
-
/** @example 100 */
|
|
534
|
-
price?: number;
|
|
535
|
-
/** @example "Percentage|Decimal" */
|
|
536
|
-
priceType?: string;
|
|
537
|
-
/** @example 1000 */
|
|
538
|
-
quantity?: number;
|
|
539
|
-
/** @example "Par|Unit" */
|
|
540
|
-
quantityType?: string;
|
|
541
|
-
quote?: {
|
|
542
|
-
/** @example "412001269" */
|
|
543
|
-
cusip?: string;
|
|
544
|
-
/** @example "CUSIP:ISIN" */
|
|
545
|
-
identType?: string;
|
|
546
|
-
/** @example "SK4120012691" */
|
|
547
|
-
isin?: string;
|
|
548
|
-
};
|
|
549
|
-
/** @example "BUY|SELL" */
|
|
550
|
-
transaction?: string;
|
|
551
|
-
};
|
|
552
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
385
|
+
bondPlacement(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
553
386
|
/**
|
|
554
387
|
* @tags Orders V2 Fixed Income
|
|
555
388
|
* @name BondOrderPreview
|
|
@@ -557,137 +390,130 @@ export class OrdersV2FixedIncome<HandleError extends boolean = boolean> {
|
|
|
557
390
|
* @request POST:/orders/v2/bonds/preview
|
|
558
391
|
* @secure
|
|
559
392
|
*/
|
|
560
|
-
bondOrderPreview(data:
|
|
561
|
-
account?: {
|
|
562
|
-
/** @example 123 */
|
|
563
|
-
accountId?: number;
|
|
564
|
-
/** @example "AC00123" */
|
|
565
|
-
accountNumber?: string;
|
|
566
|
-
};
|
|
567
|
-
order?: {
|
|
568
|
-
/** @example "LIMIT" */
|
|
569
|
-
orderType?: string;
|
|
570
|
-
/** @example 100 */
|
|
571
|
-
price?: number;
|
|
572
|
-
/** @example "Percentage|Decimal" */
|
|
573
|
-
priceType?: string;
|
|
574
|
-
/** @example 1000 */
|
|
575
|
-
quantity?: number;
|
|
576
|
-
/** @example "Par|Unit" */
|
|
577
|
-
quantityType?: string;
|
|
578
|
-
quote?: {
|
|
579
|
-
/** @example "412001269" */
|
|
580
|
-
cusip?: string;
|
|
581
|
-
/** @example "CUSIP:ISIN" */
|
|
582
|
-
identType?: string;
|
|
583
|
-
/** @example "SK4120012691" */
|
|
584
|
-
isin?: string;
|
|
585
|
-
};
|
|
586
|
-
/** @example "BUY|SELL" */
|
|
587
|
-
transaction?: string;
|
|
588
|
-
};
|
|
589
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
393
|
+
bondOrderPreview(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
590
394
|
}
|
|
591
|
-
export class
|
|
395
|
+
export class OrdersV2Equities<HandleError extends boolean = boolean> {
|
|
592
396
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
593
397
|
constructor(apiClient: JwtClient<HandleError>);
|
|
594
398
|
/**
|
|
595
|
-
* @tags Orders V2
|
|
596
|
-
* @name
|
|
597
|
-
* @summary
|
|
598
|
-
* @request POST:/orders/v2/
|
|
399
|
+
* @tags Orders V2 Equities
|
|
400
|
+
* @name Preview
|
|
401
|
+
* @summary Preview
|
|
402
|
+
* @request POST:/orders/v2/preview/equity
|
|
599
403
|
* @secure
|
|
600
404
|
*/
|
|
601
|
-
|
|
602
|
-
account?: {
|
|
603
|
-
/** @example "ABC123" */
|
|
604
|
-
accountNumber?: string;
|
|
605
|
-
};
|
|
606
|
-
order?: {
|
|
607
|
-
/** @example 100 */
|
|
608
|
-
expectedValue?: number;
|
|
609
|
-
/** @example 1.123 */
|
|
610
|
-
limitPx?: number;
|
|
611
|
-
/** @example "MARKET|LIMIT|STOP|STOP_LIMIG|Notional|NotionalLimit" */
|
|
612
|
-
orderType?: string;
|
|
613
|
-
/** @example 0.0123 */
|
|
614
|
-
quantity?: number;
|
|
615
|
-
quote?: {
|
|
616
|
-
/** @example "BTC/USD" */
|
|
617
|
-
symbol?: string;
|
|
618
|
-
};
|
|
619
|
-
/** @example 1.123 */
|
|
620
|
-
stopPx?: number;
|
|
621
|
-
/** @example "BUY|SELL" */
|
|
622
|
-
transaction?: string;
|
|
623
|
-
/** @example "DAY|GTC" */
|
|
624
|
-
validity?: string;
|
|
625
|
-
};
|
|
626
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
405
|
+
preview(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
627
406
|
/**
|
|
628
|
-
* @tags Orders V2
|
|
629
|
-
* @name
|
|
630
|
-
* @summary
|
|
631
|
-
* @request POST:/orders/v2/
|
|
407
|
+
* @tags Orders V2 Equities
|
|
408
|
+
* @name Placement
|
|
409
|
+
* @summary Placement
|
|
410
|
+
* @request POST:/orders/v2/place/equity
|
|
632
411
|
* @secure
|
|
633
412
|
*/
|
|
634
|
-
|
|
635
|
-
account?: {
|
|
636
|
-
/** @example "ABC123" */
|
|
637
|
-
accountNumber?: string;
|
|
638
|
-
};
|
|
639
|
-
order?: {
|
|
640
|
-
/** @example "{your own order reference number}" */
|
|
641
|
-
clientRef?: string;
|
|
642
|
-
/** @example "ABC" */
|
|
643
|
-
clientSourceId?: string;
|
|
644
|
-
/** @example 100 */
|
|
645
|
-
expectedValue?: number;
|
|
646
|
-
/** @example 1.123 */
|
|
647
|
-
limitPx?: number;
|
|
648
|
-
/** @example "MARKET|LIMIT|STOP|STOP_LIMIT|Notional|NotionalLimit" */
|
|
649
|
-
orderType?: string;
|
|
650
|
-
/** @example 0.0123 */
|
|
651
|
-
quantity?: number;
|
|
652
|
-
quote?: {
|
|
653
|
-
/** @example "BTC/USD" */
|
|
654
|
-
symbol?: string;
|
|
655
|
-
};
|
|
656
|
-
/** @example 1.123 */
|
|
657
|
-
stopPx?: number;
|
|
658
|
-
/** @example "BUY|SELL" */
|
|
659
|
-
transaction?: string;
|
|
660
|
-
/** @example "DAY|GTC" */
|
|
661
|
-
validity?: string;
|
|
662
|
-
};
|
|
663
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
664
|
-
}
|
|
665
|
-
export class OrdersV2MutualFunds<HandleError extends boolean = boolean> {
|
|
666
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
667
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
413
|
+
placement(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
668
414
|
/**
|
|
669
|
-
* @tags Orders V2
|
|
670
|
-
* @name
|
|
671
|
-
* @summary
|
|
672
|
-
* @request
|
|
415
|
+
* @tags Orders V2 Equities
|
|
416
|
+
* @name AlgoPreview
|
|
417
|
+
* @summary Algo Preview
|
|
418
|
+
* @request POST:/orders/v2/algo/preview/equity
|
|
673
419
|
* @secure
|
|
674
420
|
*/
|
|
675
|
-
|
|
421
|
+
algoPreview(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
676
422
|
/**
|
|
677
|
-
* @tags Orders V2
|
|
678
|
-
* @name
|
|
679
|
-
* @summary
|
|
680
|
-
* @request
|
|
423
|
+
* @tags Orders V2 Equities
|
|
424
|
+
* @name AlgoPlacement
|
|
425
|
+
* @summary Algo Placement
|
|
426
|
+
* @request POST:/orders/v2/algo/place/equity
|
|
681
427
|
* @secure
|
|
682
428
|
*/
|
|
683
|
-
|
|
429
|
+
algoPlacement(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
684
430
|
/**
|
|
685
|
-
* @tags Orders V2
|
|
686
|
-
* @name
|
|
687
|
-
* @summary
|
|
688
|
-
* @request
|
|
689
|
-
* @secure
|
|
690
|
-
*/
|
|
431
|
+
* @tags Orders V2 Equities
|
|
432
|
+
* @name BasketPreview
|
|
433
|
+
* @summary Basket preview
|
|
434
|
+
* @request POST:/orders/v2/basket/preview/equity
|
|
435
|
+
* @secure
|
|
436
|
+
*/
|
|
437
|
+
basketPreview(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
438
|
+
/**
|
|
439
|
+
* @tags Orders V2 Equities
|
|
440
|
+
* @name BasketPlacement
|
|
441
|
+
* @summary Basket placement
|
|
442
|
+
* @request POST:/orders/v2/basket/place/equity
|
|
443
|
+
* @secure
|
|
444
|
+
*/
|
|
445
|
+
basketPlacement(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
446
|
+
/**
|
|
447
|
+
* @tags Orders V2 Equities
|
|
448
|
+
* @name AdvisoryPreview
|
|
449
|
+
* @summary Advisory preview
|
|
450
|
+
* @request POST:/orders/v2/advisory/equity/preview
|
|
451
|
+
* @secure
|
|
452
|
+
*/
|
|
453
|
+
advisoryPreview(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
454
|
+
/**
|
|
455
|
+
* @tags Orders V2 Equities
|
|
456
|
+
* @name AdvisoryPlacement
|
|
457
|
+
* @summary Advisory placement
|
|
458
|
+
* @request POST:/orders/v2/advisory/equity/place
|
|
459
|
+
* @secure
|
|
460
|
+
*/
|
|
461
|
+
advisoryPlacement(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
462
|
+
/**
|
|
463
|
+
* @tags Orders V2 Equities
|
|
464
|
+
* @name PreviewSnapshot
|
|
465
|
+
* @summary Preview Snapshot
|
|
466
|
+
* @request POST:/orders/v2/preview/equity/snapshot
|
|
467
|
+
* @secure
|
|
468
|
+
*/
|
|
469
|
+
previewSnapshot(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
470
|
+
}
|
|
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
|
+
*/
|
|
691
517
|
checkMutualFund(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
692
518
|
/**
|
|
693
519
|
* @tags Orders V2 Mutual Funds
|
|
@@ -3560,77 +3386,6 @@ export class AdvisoryModels<HandleError extends boolean = boolean> {
|
|
|
3560
3386
|
*/
|
|
3561
3387
|
allocations(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3562
3388
|
}
|
|
3563
|
-
export class AdvisoryUserAccountManagement<HandleError extends boolean = boolean> {
|
|
3564
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
3565
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
3566
|
-
/**
|
|
3567
|
-
* @tags Advisory User Account Management
|
|
3568
|
-
* @name List
|
|
3569
|
-
* @summary /list
|
|
3570
|
-
* @request GET:/v2/advisory/users/list
|
|
3571
|
-
* @secure
|
|
3572
|
-
*/
|
|
3573
|
-
list(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3574
|
-
/**
|
|
3575
|
-
* @tags Advisory User Account Management
|
|
3576
|
-
* @name Accounts
|
|
3577
|
-
* @summary /accounts
|
|
3578
|
-
* @request GET:/v2/advisory/users/accounts
|
|
3579
|
-
* @secure
|
|
3580
|
-
*/
|
|
3581
|
-
accounts(query?: {
|
|
3582
|
-
/** @example "1234" */
|
|
3583
|
-
uid?: any;
|
|
3584
|
-
/**
|
|
3585
|
-
* true|false
|
|
3586
|
-
* @example "false"
|
|
3587
|
-
*/
|
|
3588
|
-
loadRtb?: any;
|
|
3589
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3590
|
-
/**
|
|
3591
|
-
* @tags Advisory User Account Management
|
|
3592
|
-
* @name AccountsStats
|
|
3593
|
-
* @summary /accounts/stats
|
|
3594
|
-
* @request GET:/v2/advisory/users/accounts/stats
|
|
3595
|
-
* @secure
|
|
3596
|
-
*/
|
|
3597
|
-
accountsStats(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3598
|
-
/**
|
|
3599
|
-
* @tags Advisory User Account Management
|
|
3600
|
-
* @name AccountNotes
|
|
3601
|
-
* @summary /account/notes
|
|
3602
|
-
* @request GET:/v2/advisory/users/account/notes
|
|
3603
|
-
* @secure
|
|
3604
|
-
*/
|
|
3605
|
-
accountNotes(query?: {
|
|
3606
|
-
/**
|
|
3607
|
-
* Account's ID
|
|
3608
|
-
* @example "1234"
|
|
3609
|
-
*/
|
|
3610
|
-
aid?: any;
|
|
3611
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3612
|
-
/**
|
|
3613
|
-
* @tags Advisory User Account Management
|
|
3614
|
-
* @name Notes
|
|
3615
|
-
* @summary /notes
|
|
3616
|
-
* @request GET:/v2/advisory/users/notes
|
|
3617
|
-
* @secure
|
|
3618
|
-
*/
|
|
3619
|
-
notes(query?: {
|
|
3620
|
-
/**
|
|
3621
|
-
* User's ID
|
|
3622
|
-
* @example "1234"
|
|
3623
|
-
*/
|
|
3624
|
-
uid?: any;
|
|
3625
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3626
|
-
/**
|
|
3627
|
-
* @tags Advisory User Account Management
|
|
3628
|
-
* @name NotesPost
|
|
3629
|
-
* @request POST:/v2/advisory/users/notes/{action}
|
|
3630
|
-
* @secure
|
|
3631
|
-
*/
|
|
3632
|
-
notesPost(action: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3633
|
-
}
|
|
3634
3389
|
export class AdvisoryGroups<HandleError extends boolean = boolean> {
|
|
3635
3390
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3636
3391
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4076,6 +3831,77 @@ export class TransfersRelationships<HandleError extends boolean = boolean> {
|
|
|
4076
3831
|
};
|
|
4077
3832
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4078
3833
|
}
|
|
3834
|
+
export class AdvisoryUserAccountManagement<HandleError extends boolean = boolean> {
|
|
3835
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3836
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3837
|
+
/**
|
|
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
|
|
3888
|
+
* @secure
|
|
3889
|
+
*/
|
|
3890
|
+
notes(query?: {
|
|
3891
|
+
/**
|
|
3892
|
+
* User's ID
|
|
3893
|
+
* @example "1234"
|
|
3894
|
+
*/
|
|
3895
|
+
uid?: any;
|
|
3896
|
+
}, 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
|
+
}
|
|
4079
3905
|
export class TransfersInstantAccountVerification<HandleError extends boolean = boolean> {
|
|
4080
3906
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4081
3907
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4308,36 +4134,75 @@ export class TransfersAcats<HandleError extends boolean = boolean> {
|
|
|
4308
4134
|
type?: string;
|
|
4309
4135
|
}[], config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4310
4136
|
}
|
|
4311
|
-
export class
|
|
4137
|
+
export class TransfersPositions<HandleError extends boolean = boolean> {
|
|
4312
4138
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4313
4139
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4314
4140
|
/**
|
|
4315
|
-
* @tags Transfers
|
|
4316
|
-
* @name
|
|
4317
|
-
* @summary
|
|
4318
|
-
* @request POST:/transfer/
|
|
4141
|
+
* @tags Transfers Positions
|
|
4142
|
+
* @name TransferRequest
|
|
4143
|
+
* @summary Transfer request
|
|
4144
|
+
* @request POST:/transfer/position/request
|
|
4319
4145
|
* @secure
|
|
4320
4146
|
*/
|
|
4321
|
-
|
|
4322
|
-
|
|
4323
|
-
|
|
4324
|
-
|
|
4325
|
-
|
|
4326
|
-
|
|
4327
|
-
|
|
4328
|
-
|
|
4329
|
-
/** @example
|
|
4330
|
-
|
|
4331
|
-
|
|
4332
|
-
|
|
4333
|
-
|
|
4334
|
-
|
|
4335
|
-
|
|
4336
|
-
|
|
4337
|
-
|
|
4338
|
-
|
|
4339
|
-
|
|
4340
|
-
|
|
4147
|
+
transferRequest(data: {
|
|
4148
|
+
deliverFrom?: {
|
|
4149
|
+
/** @example 124 */
|
|
4150
|
+
accountId?: number;
|
|
4151
|
+
/** @example "ABC123456" */
|
|
4152
|
+
accountNumber?: string;
|
|
4153
|
+
};
|
|
4154
|
+
deliverTo?: {
|
|
4155
|
+
/** @example 456 */
|
|
4156
|
+
accountId?: number;
|
|
4157
|
+
/** @example "DEF123456" */
|
|
4158
|
+
accountNumber?: string;
|
|
4159
|
+
};
|
|
4160
|
+
/** @example "NoPurpose|Gift" */
|
|
4161
|
+
purpose?: any;
|
|
4162
|
+
/** @example 1000 */
|
|
4163
|
+
quantity?: any;
|
|
4164
|
+
quote?: {
|
|
4165
|
+
/** @example "IBM" */
|
|
4166
|
+
symbol?: string;
|
|
4167
|
+
};
|
|
4168
|
+
/** @example "" */
|
|
4169
|
+
reason?: any;
|
|
4170
|
+
/** @example "0.0.0.0" */
|
|
4171
|
+
remoteAddr?: any;
|
|
4172
|
+
/** @example "Ultra fast proxy" */
|
|
4173
|
+
remoteDevice?: any;
|
|
4174
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4175
|
+
}
|
|
4176
|
+
export class TransfersWires<HandleError extends boolean = boolean> {
|
|
4177
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4178
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4179
|
+
/**
|
|
4180
|
+
* @tags Transfers Wires
|
|
4181
|
+
* @name Outgoing
|
|
4182
|
+
* @summary Outgoing
|
|
4183
|
+
* @request POST:/transfer/wire/outgoing
|
|
4184
|
+
* @secure
|
|
4185
|
+
*/
|
|
4186
|
+
outgoing(data: {
|
|
4187
|
+
/** @example "TRACCOUNT" */
|
|
4188
|
+
account?: any;
|
|
4189
|
+
/** @example 200 */
|
|
4190
|
+
amount?: any;
|
|
4191
|
+
beneficiary?: {
|
|
4192
|
+
/** @example "AAA012345" */
|
|
4193
|
+
account?: string;
|
|
4194
|
+
/** @example "CHECKING|SAVINGS" */
|
|
4195
|
+
accountType?: string;
|
|
4196
|
+
address?: {
|
|
4197
|
+
/** @example "Central City" */
|
|
4198
|
+
city?: string;
|
|
4199
|
+
/** @example "USA" */
|
|
4200
|
+
country?: string;
|
|
4201
|
+
/** @example "11235" */
|
|
4202
|
+
postalCode?: string;
|
|
4203
|
+
/** @example "ST" */
|
|
4204
|
+
stateProvince?: string;
|
|
4205
|
+
/** @example ["123 Main St"] */
|
|
4341
4206
|
streetAddress?: string[];
|
|
4342
4207
|
};
|
|
4343
4208
|
/** @example "John Smith" */
|
|
@@ -4349,6 +4214,24 @@ export class TransfersWires<HandleError extends boolean = boolean> {
|
|
|
4349
4214
|
disbursementType?: any;
|
|
4350
4215
|
/** @example 1234 */
|
|
4351
4216
|
entryId?: any;
|
|
4217
|
+
intermediary?: {
|
|
4218
|
+
/** @example "{account number}" */
|
|
4219
|
+
account?: string;
|
|
4220
|
+
address?: {
|
|
4221
|
+
/** @example "Central City" */
|
|
4222
|
+
city?: string;
|
|
4223
|
+
/** @example "USA" */
|
|
4224
|
+
country?: string;
|
|
4225
|
+
/** @example "11235" */
|
|
4226
|
+
postalCode?: string;
|
|
4227
|
+
/** @example "ST" */
|
|
4228
|
+
stateProvince?: string;
|
|
4229
|
+
/** @example ["123 Main St"] */
|
|
4230
|
+
streetAddress?: string[];
|
|
4231
|
+
};
|
|
4232
|
+
/** @example "{name on account}" */
|
|
4233
|
+
name?: string;
|
|
4234
|
+
};
|
|
4352
4235
|
/** @example false */
|
|
4353
4236
|
international?: any;
|
|
4354
4237
|
iraDetails?: {
|
|
@@ -4453,45 +4336,6 @@ export class TransfersJournals<HandleError extends boolean = boolean> {
|
|
|
4453
4336
|
transferId?: any;
|
|
4454
4337
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4455
4338
|
}
|
|
4456
|
-
export class TransfersPositions<HandleError extends boolean = boolean> {
|
|
4457
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4458
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4459
|
-
/**
|
|
4460
|
-
* @tags Transfers Positions
|
|
4461
|
-
* @name TransferRequest
|
|
4462
|
-
* @summary Transfer request
|
|
4463
|
-
* @request POST:/transfer/position/request
|
|
4464
|
-
* @secure
|
|
4465
|
-
*/
|
|
4466
|
-
transferRequest(data: {
|
|
4467
|
-
deliverFrom?: {
|
|
4468
|
-
/** @example 124 */
|
|
4469
|
-
accountId?: number;
|
|
4470
|
-
/** @example "ABC123456" */
|
|
4471
|
-
accountNumber?: string;
|
|
4472
|
-
};
|
|
4473
|
-
deliverTo?: {
|
|
4474
|
-
/** @example 456 */
|
|
4475
|
-
accountId?: number;
|
|
4476
|
-
/** @example "DEF123456" */
|
|
4477
|
-
accountNumber?: string;
|
|
4478
|
-
};
|
|
4479
|
-
/** @example "NoPurpose|Gift" */
|
|
4480
|
-
purpose?: any;
|
|
4481
|
-
/** @example 1000 */
|
|
4482
|
-
quantity?: any;
|
|
4483
|
-
quote?: {
|
|
4484
|
-
/** @example "IBM" */
|
|
4485
|
-
symbol?: string;
|
|
4486
|
-
};
|
|
4487
|
-
/** @example "" */
|
|
4488
|
-
reason?: any;
|
|
4489
|
-
/** @example "0.0.0.0" */
|
|
4490
|
-
remoteAddr?: any;
|
|
4491
|
-
/** @example "Ultra fast proxy" */
|
|
4492
|
-
remoteDevice?: any;
|
|
4493
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4494
|
-
}
|
|
4495
4339
|
export class TransfersBank<HandleError extends boolean = boolean> {
|
|
4496
4340
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4497
4341
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4609,103 +4453,252 @@ export class TransfersInstantCashTransfers<HandleError extends boolean = boolean
|
|
|
4609
4453
|
*/
|
|
4610
4454
|
listReports(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4611
4455
|
}
|
|
4612
|
-
export class
|
|
4613
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4614
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4615
|
-
/**
|
|
4616
|
-
* @tags Transfers Cheques
|
|
4617
|
-
* @name Withdrawal
|
|
4618
|
-
* @summary Withdrawal
|
|
4619
|
-
* @request POST:/transfer/check/outgoing
|
|
4620
|
-
* @secure
|
|
4621
|
-
*/
|
|
4622
|
-
withdrawal(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4623
|
-
}
|
|
4624
|
-
export class Transfers<HandleError extends boolean = boolean> {
|
|
4456
|
+
export class Documents<HandleError extends boolean = boolean> {
|
|
4625
4457
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4626
|
-
relationships: TransfersRelationships<HandleError>;
|
|
4627
|
-
instantAccountVerification: TransfersInstantAccountVerification<HandleError>;
|
|
4628
|
-
ach: TransfersAch<HandleError>;
|
|
4629
|
-
acats: TransfersAcats<HandleError>;
|
|
4630
|
-
wires: TransfersWires<HandleError>;
|
|
4631
|
-
journals: TransfersJournals<HandleError>;
|
|
4632
|
-
positions: TransfersPositions<HandleError>;
|
|
4633
|
-
bank: TransfersBank<HandleError>;
|
|
4634
|
-
instantCashTransfers: TransfersInstantCashTransfers<HandleError>;
|
|
4635
|
-
cheques: TransfersCheques<HandleError>;
|
|
4636
4458
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4637
4459
|
/**
|
|
4638
|
-
* @tags
|
|
4639
|
-
* @name
|
|
4640
|
-
* @summary
|
|
4641
|
-
* @request GET:/
|
|
4642
|
-
* @secure
|
|
4643
|
-
*/
|
|
4644
|
-
transferDetails(account: string, transferId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4645
|
-
/**
|
|
4646
|
-
* @tags Transfers
|
|
4647
|
-
* @name TransferStatus
|
|
4648
|
-
* @summary Transfer Status
|
|
4649
|
-
* @request GET:/transfer/status/{account}
|
|
4460
|
+
* @tags Documents
|
|
4461
|
+
* @name Confirm
|
|
4462
|
+
* @summary Confirm
|
|
4463
|
+
* @request GET:/documents/confirm
|
|
4650
4464
|
* @secure
|
|
4651
4465
|
*/
|
|
4652
|
-
|
|
4653
|
-
/**
|
|
4654
|
-
|
|
4655
|
-
|
|
4656
|
-
|
|
4657
|
-
|
|
4658
|
-
|
|
4659
|
-
|
|
4660
|
-
|
|
4661
|
-
|
|
4662
|
-
|
|
4663
|
-
start?: any;
|
|
4664
|
-
perPage?: any;
|
|
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;
|
|
4665
4477
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4666
4478
|
/**
|
|
4667
|
-
* @tags
|
|
4668
|
-
* @name
|
|
4669
|
-
* @summary
|
|
4670
|
-
* @request GET:/
|
|
4479
|
+
* @tags Documents
|
|
4480
|
+
* @name ListOfConfirms
|
|
4481
|
+
* @summary List of Confirms
|
|
4482
|
+
* @request GET:/documents/confirm/list
|
|
4671
4483
|
* @secure
|
|
4672
4484
|
*/
|
|
4673
|
-
|
|
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>>;
|
|
4674
4502
|
/**
|
|
4675
|
-
* @tags
|
|
4676
|
-
* @name
|
|
4677
|
-
* @summary
|
|
4678
|
-
* @request GET:/
|
|
4503
|
+
* @tags Documents
|
|
4504
|
+
* @name ServiceDocs
|
|
4505
|
+
* @summary Service Docs
|
|
4506
|
+
* @request GET:/documents/service
|
|
4679
4507
|
* @secure
|
|
4680
4508
|
*/
|
|
4681
|
-
|
|
4509
|
+
serviceDocs(query?: {
|
|
4510
|
+
/** @example "5VA0XXXX" */
|
|
4511
|
+
accountNumber?: any;
|
|
4512
|
+
/** See table for details. Leave blank for all document types. */
|
|
4513
|
+
docType?: any;
|
|
4682
4514
|
/**
|
|
4683
|
-
*
|
|
4684
|
-
* @example "
|
|
4515
|
+
* The beginning 2-digit month (MM) to be used as search criteria.
|
|
4516
|
+
* @example "01"
|
|
4685
4517
|
*/
|
|
4686
|
-
|
|
4518
|
+
beginMonth?: any;
|
|
4687
4519
|
/**
|
|
4688
|
-
*
|
|
4689
|
-
* @example "
|
|
4520
|
+
* The beginning 4-digit year (YYYY) to be used as search criteria.
|
|
4521
|
+
* @example "2012"
|
|
4690
4522
|
*/
|
|
4691
|
-
|
|
4692
|
-
|
|
4693
|
-
|
|
4694
|
-
|
|
4695
|
-
|
|
4696
|
-
|
|
4697
|
-
|
|
4523
|
+
beginYear?: any;
|
|
4524
|
+
/**
|
|
4525
|
+
* The ending 2-digit month (MM) to be used as search criteria.
|
|
4526
|
+
* @example "12"
|
|
4527
|
+
*/
|
|
4528
|
+
endMonth?: any;
|
|
4529
|
+
/**
|
|
4530
|
+
* The ending 4-digit year (YYYY) to be used as search criteria.
|
|
4531
|
+
* @example "2017"
|
|
4532
|
+
*/
|
|
4533
|
+
endYear?: any;
|
|
4698
4534
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4699
4535
|
/**
|
|
4700
|
-
* @tags
|
|
4701
|
-
* @name
|
|
4702
|
-
* @summary
|
|
4703
|
-
* @request GET:/
|
|
4536
|
+
* @tags Documents
|
|
4537
|
+
* @name DocumentList
|
|
4538
|
+
* @summary Document list
|
|
4539
|
+
* @request GET:/documents/list
|
|
4704
4540
|
* @secure
|
|
4705
4541
|
*/
|
|
4706
|
-
|
|
4707
|
-
|
|
4708
|
-
|
|
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>>;
|
|
4577
|
+
/**
|
|
4578
|
+
* @tags Documents
|
|
4579
|
+
* @name Download
|
|
4580
|
+
* @summary Download
|
|
4581
|
+
* @request GET:/documents/download
|
|
4582
|
+
* @secure
|
|
4583
|
+
*/
|
|
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;
|
|
4595
|
+
}, 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
|
+
}
|
|
4617
|
+
export class Transfers<HandleError extends boolean = boolean> {
|
|
4618
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4619
|
+
relationships: TransfersRelationships<HandleError>;
|
|
4620
|
+
instantAccountVerification: TransfersInstantAccountVerification<HandleError>;
|
|
4621
|
+
ach: TransfersAch<HandleError>;
|
|
4622
|
+
acats: TransfersAcats<HandleError>;
|
|
4623
|
+
wires: TransfersWires<HandleError>;
|
|
4624
|
+
journals: TransfersJournals<HandleError>;
|
|
4625
|
+
positions: TransfersPositions<HandleError>;
|
|
4626
|
+
bank: TransfersBank<HandleError>;
|
|
4627
|
+
instantCashTransfers: TransfersInstantCashTransfers<HandleError>;
|
|
4628
|
+
cheques: TransfersCheques<HandleError>;
|
|
4629
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4630
|
+
/**
|
|
4631
|
+
* @tags Transfers
|
|
4632
|
+
* @name TransferDetails
|
|
4633
|
+
* @summary Transfer Details
|
|
4634
|
+
* @request GET:/transfer/details/{account}/{transferId}
|
|
4635
|
+
* @secure
|
|
4636
|
+
*/
|
|
4637
|
+
transferDetails(account: string, transferId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4638
|
+
/**
|
|
4639
|
+
* @tags Transfers
|
|
4640
|
+
* @name TransferStatus
|
|
4641
|
+
* @summary Transfer Status
|
|
4642
|
+
* @request GET:/transfer/status/{account}
|
|
4643
|
+
* @secure
|
|
4644
|
+
*/
|
|
4645
|
+
transferStatus(account: string, query?: {
|
|
4646
|
+
/** INCOMING|OUTGOING */
|
|
4647
|
+
direction?: any;
|
|
4648
|
+
/** ACH|WIRE|CHECK|Bank|CustodyJournal|ALL */
|
|
4649
|
+
mechanism?: any;
|
|
4650
|
+
/** MM/DD/YYYY */
|
|
4651
|
+
dateFrom?: any;
|
|
4652
|
+
/** MM/DD/YYYY */
|
|
4653
|
+
dateTo?: any;
|
|
4654
|
+
/** Overrides `dateFrom` and `dateTo`. See description. */
|
|
4655
|
+
range?: any;
|
|
4656
|
+
start?: any;
|
|
4657
|
+
perPage?: any;
|
|
4658
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4659
|
+
/**
|
|
4660
|
+
* @tags Transfers
|
|
4661
|
+
* @name TransferStatusModel
|
|
4662
|
+
* @summary Transfer Status Model
|
|
4663
|
+
* @request GET:/transfer/status/model/{modelId}
|
|
4664
|
+
* @secure
|
|
4665
|
+
*/
|
|
4666
|
+
transferStatusModel(modelId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4667
|
+
/**
|
|
4668
|
+
* @tags Transfers
|
|
4669
|
+
* @name TransferStatusBranch
|
|
4670
|
+
* @summary Transfer Status Branch
|
|
4671
|
+
* @request GET:/transfer/status/branch
|
|
4672
|
+
* @secure
|
|
4673
|
+
*/
|
|
4674
|
+
transferStatusBranch(query?: {
|
|
4675
|
+
/**
|
|
4676
|
+
* INCOMING|OUTGOING|ALL
|
|
4677
|
+
* @example "ALL"
|
|
4678
|
+
*/
|
|
4679
|
+
direction?: any;
|
|
4680
|
+
/**
|
|
4681
|
+
* ACH|WIRE|CHECK|Bank|CustodyJournal
|
|
4682
|
+
* @example "ALL"
|
|
4683
|
+
*/
|
|
4684
|
+
mechanism?: any;
|
|
4685
|
+
dateFrom?: any;
|
|
4686
|
+
dateTo?: any;
|
|
4687
|
+
/** Per regex: \d+[ymdw]$ (will override `dateFrom` and `dateTo`) */
|
|
4688
|
+
range?: any;
|
|
4689
|
+
start?: any;
|
|
4690
|
+
perPage?: any;
|
|
4691
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4692
|
+
/**
|
|
4693
|
+
* @tags Transfers
|
|
4694
|
+
* @name AmountAvailable
|
|
4695
|
+
* @summary Amount Available
|
|
4696
|
+
* @request GET:/transfer/available/{account}
|
|
4697
|
+
* @secure
|
|
4698
|
+
*/
|
|
4699
|
+
amountAvailable(account: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4700
|
+
/**
|
|
4701
|
+
* @tags Transfers
|
|
4709
4702
|
* @name LegalDocumentTypes
|
|
4710
4703
|
* @summary Legal document types
|
|
4711
4704
|
* @request GET:/transfer/legal/types
|
|
@@ -4855,6 +4848,97 @@ export class Transfers<HandleError extends boolean = boolean> {
|
|
|
4855
4848
|
wallet?: any;
|
|
4856
4849
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4857
4850
|
}
|
|
4851
|
+
export class Branch<HandleError extends boolean = boolean> {
|
|
4852
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4853
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4854
|
+
/**
|
|
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
|
|
4872
|
+
* @secure
|
|
4873
|
+
*/
|
|
4874
|
+
branchInventory(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4875
|
+
/**
|
|
4876
|
+
* @tags Branch
|
|
4877
|
+
* @name BranchRtbsTotal
|
|
4878
|
+
* @request GET:/v1/branch/rtbs/total
|
|
4879
|
+
* @secure
|
|
4880
|
+
*/
|
|
4881
|
+
branchRtbsTotal(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4882
|
+
/**
|
|
4883
|
+
* @tags Branch
|
|
4884
|
+
* @name BranchPortfolio
|
|
4885
|
+
* @request GET:/v1/branch/portfolio
|
|
4886
|
+
* @secure
|
|
4887
|
+
*/
|
|
4888
|
+
branchPortfolio(query?: {
|
|
4889
|
+
/**
|
|
4890
|
+
* (true or false) Allows for loading of quotes for each portfolio entry. Defaults to false.
|
|
4891
|
+
* @example "false"
|
|
4892
|
+
*/
|
|
4893
|
+
loadQuotes?: any;
|
|
4894
|
+
/** @example "false" */
|
|
4895
|
+
loadIndustries?: any;
|
|
4896
|
+
/** @example "false" */
|
|
4897
|
+
loadUpgrades?: any;
|
|
4898
|
+
/** @example "false" */
|
|
4899
|
+
loadEarnings?: any;
|
|
4900
|
+
/**
|
|
4901
|
+
* Load balances for weight
|
|
4902
|
+
* @example "false"
|
|
4903
|
+
*/
|
|
4904
|
+
loadRtb?: any;
|
|
4905
|
+
/**
|
|
4906
|
+
* Analyze market caps and get `marketCapWeights`. To be used in conjuction with `loadQuotes`
|
|
4907
|
+
* @example "false"
|
|
4908
|
+
*/
|
|
4909
|
+
marketCapBreakdown?: any;
|
|
4910
|
+
/**
|
|
4911
|
+
* Combined portfolio for the branch
|
|
4912
|
+
* @example "false"
|
|
4913
|
+
*/
|
|
4914
|
+
combined?: any;
|
|
4915
|
+
/** @example "1" */
|
|
4916
|
+
pageNum?: any;
|
|
4917
|
+
/** @example "100" */
|
|
4918
|
+
pageSize?: any;
|
|
4919
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4920
|
+
/**
|
|
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
|
|
4933
|
+
* @secure
|
|
4934
|
+
*/
|
|
4935
|
+
optionExpirationsDetails(data: {
|
|
4936
|
+
/** @example "true|false" */
|
|
4937
|
+
loadQuotes?: any;
|
|
4938
|
+
/** @example "01/15/2021 00:00:00 EST" */
|
|
4939
|
+
maturity?: any;
|
|
4940
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4941
|
+
}
|
|
4858
4942
|
export class Miscellaneous<HandleError extends boolean = boolean> {
|
|
4859
4943
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4860
4944
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5037,110 +5121,113 @@ export class Miscellaneous<HandleError extends boolean = boolean> {
|
|
|
5037
5121
|
*/
|
|
5038
5122
|
optionStrategyClassifications(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5039
5123
|
}
|
|
5040
|
-
export class
|
|
5124
|
+
export class LegalDocuments<HandleError extends boolean = boolean> {
|
|
5041
5125
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5042
5126
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5043
5127
|
/**
|
|
5044
|
-
* @tags
|
|
5045
|
-
* @name
|
|
5046
|
-
* @summary
|
|
5047
|
-
* @request GET:/
|
|
5128
|
+
* @tags Legal Documents
|
|
5129
|
+
* @name DocumentClassifications
|
|
5130
|
+
* @summary Document classifications
|
|
5131
|
+
* @request GET:/user/legal/classifications
|
|
5048
5132
|
* @secure
|
|
5049
5133
|
*/
|
|
5050
|
-
|
|
5051
|
-
|
|
5052
|
-
|
|
5053
|
-
|
|
5054
|
-
|
|
5055
|
-
|
|
5134
|
+
documentClassifications(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5135
|
+
/**
|
|
5136
|
+
* @tags Legal Documents
|
|
5137
|
+
* @name DocumentListing
|
|
5138
|
+
* @summary Document listing
|
|
5139
|
+
* @request GET:/user/legal/documents
|
|
5140
|
+
* @secure
|
|
5141
|
+
*/
|
|
5142
|
+
documentListing(query?: {
|
|
5056
5143
|
/**
|
|
5057
|
-
*
|
|
5058
|
-
* @example "
|
|
5144
|
+
* {optional}
|
|
5145
|
+
* @example "TermsOfUse"
|
|
5059
5146
|
*/
|
|
5060
|
-
|
|
5147
|
+
classification?: any;
|
|
5061
5148
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5062
5149
|
/**
|
|
5063
|
-
* @tags
|
|
5064
|
-
* @name
|
|
5065
|
-
* @summary
|
|
5066
|
-
* @request
|
|
5150
|
+
* @tags Legal Documents
|
|
5151
|
+
* @name PolicyValues
|
|
5152
|
+
* @summary Policy values
|
|
5153
|
+
* @request GET:/user/legal/policies/listing/{type}
|
|
5067
5154
|
* @secure
|
|
5068
5155
|
*/
|
|
5069
|
-
|
|
5070
|
-
|
|
5071
|
-
|
|
5072
|
-
|
|
5073
|
-
|
|
5074
|
-
|
|
5075
|
-
|
|
5076
|
-
|
|
5077
|
-
|
|
5078
|
-
/** @example "" */
|
|
5079
|
-
|
|
5080
|
-
/** @example "812748955" */
|
|
5081
|
-
number?: any;
|
|
5082
|
-
/** @example "EIN" */
|
|
5083
|
-
number_type?: any;
|
|
5084
|
-
/** @example "" */
|
|
5085
|
-
phone?: any;
|
|
5086
|
-
/** @example "CA" */
|
|
5087
|
-
state?: any;
|
|
5088
|
-
/** @example "1119 E 8th St Ste C" */
|
|
5089
|
-
street?: any;
|
|
5090
|
-
/** @example "304902" */
|
|
5091
|
-
tracking_number?: any;
|
|
5092
|
-
/** @example "90021" */
|
|
5093
|
-
zip?: any;
|
|
5156
|
+
policyValues(type: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5157
|
+
/**
|
|
5158
|
+
* @tags Legal Documents
|
|
5159
|
+
* @name DocumentContent
|
|
5160
|
+
* @summary Document content
|
|
5161
|
+
* @request GET:/user/legal/document/content
|
|
5162
|
+
* @secure
|
|
5163
|
+
*/
|
|
5164
|
+
documentContent(query?: {
|
|
5165
|
+
/** @example "{as provided}" */
|
|
5166
|
+
id?: any;
|
|
5094
5167
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5095
5168
|
/**
|
|
5096
|
-
* @tags
|
|
5097
|
-
* @name
|
|
5098
|
-
* @summary
|
|
5099
|
-
* @request GET:/
|
|
5169
|
+
* @tags Legal Documents
|
|
5170
|
+
* @name DocumentDownload
|
|
5171
|
+
* @summary Document download
|
|
5172
|
+
* @request GET:/user/legal/document/download
|
|
5100
5173
|
* @secure
|
|
5101
5174
|
*/
|
|
5102
|
-
|
|
5175
|
+
documentDownload(query?: {
|
|
5176
|
+
/** @example "{as provided}" */
|
|
5177
|
+
id?: any;
|
|
5178
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5103
5179
|
/**
|
|
5104
|
-
* @tags
|
|
5105
|
-
* @name
|
|
5106
|
-
* @summary
|
|
5107
|
-
* @request
|
|
5180
|
+
* @tags Legal Documents
|
|
5181
|
+
* @name SignTheDocument
|
|
5182
|
+
* @summary Sign the document
|
|
5183
|
+
* @request POST:/user/legal/document/sign
|
|
5108
5184
|
* @secure
|
|
5109
5185
|
*/
|
|
5110
|
-
|
|
5111
|
-
|
|
5112
|
-
|
|
5113
|
-
|
|
5114
|
-
|
|
5115
|
-
|
|
5116
|
-
|
|
5117
|
-
|
|
5118
|
-
|
|
5119
|
-
|
|
5120
|
-
|
|
5121
|
-
/** @example "
|
|
5122
|
-
|
|
5123
|
-
/** @example
|
|
5124
|
-
|
|
5186
|
+
signTheDocument(data: {
|
|
5187
|
+
account?: {
|
|
5188
|
+
/** @example 1234 */
|
|
5189
|
+
accountId?: number;
|
|
5190
|
+
/** @example "AC123456" */
|
|
5191
|
+
accountNumber?: string;
|
|
5192
|
+
};
|
|
5193
|
+
data?: {
|
|
5194
|
+
/** @example "{conditional}" */
|
|
5195
|
+
bankAccountNumber?: string;
|
|
5196
|
+
};
|
|
5197
|
+
/** @example "{required}" */
|
|
5198
|
+
documentId?: any;
|
|
5199
|
+
/** @example true */
|
|
5200
|
+
esigned?: any;
|
|
5125
5201
|
/** @example "" */
|
|
5126
|
-
|
|
5127
|
-
/** @example "
|
|
5128
|
-
|
|
5129
|
-
/** @example "
|
|
5130
|
-
|
|
5131
|
-
/** @example "304902" */
|
|
5132
|
-
tracking_number?: any;
|
|
5133
|
-
/** @example "90021" */
|
|
5134
|
-
zip?: any;
|
|
5202
|
+
remoteAddr?: any;
|
|
5203
|
+
/** @example "{required}" */
|
|
5204
|
+
remoteDevice?: any;
|
|
5205
|
+
/** @example "{required}" */
|
|
5206
|
+
signature?: any;
|
|
5135
5207
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5136
5208
|
/**
|
|
5137
|
-
* @tags
|
|
5138
|
-
* @name
|
|
5139
|
-
* @summary
|
|
5140
|
-
* @request
|
|
5209
|
+
* @tags Legal Documents
|
|
5210
|
+
* @name UpdatesPolicyOnTheAccount
|
|
5211
|
+
* @summary Updates policy on the account
|
|
5212
|
+
* @request POST:/user/legal/policy/{type}
|
|
5141
5213
|
* @secure
|
|
5142
5214
|
*/
|
|
5143
|
-
|
|
5215
|
+
updatesPolicyOnTheAccount(type: string, data: {
|
|
5216
|
+
account?: {
|
|
5217
|
+
/** @example 0 */
|
|
5218
|
+
accountId?: number;
|
|
5219
|
+
/** @example "{optional}" */
|
|
5220
|
+
accountNumber?: string;
|
|
5221
|
+
};
|
|
5222
|
+
/** @example true */
|
|
5223
|
+
esigned?: any;
|
|
5224
|
+
/** @example "Allow" */
|
|
5225
|
+
policy?: any;
|
|
5226
|
+
/** @example "" */
|
|
5227
|
+
remoteAddr?: any;
|
|
5228
|
+
/** @example "" */
|
|
5229
|
+
remoteDevice?: any;
|
|
5230
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5144
5231
|
}
|
|
5145
5232
|
export class BlacklistAdminIndividuals<HandleError extends boolean = boolean> {
|
|
5146
5233
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -5271,204 +5358,110 @@ export class BlacklistAdminIndividuals<HandleError extends boolean = boolean> {
|
|
|
5271
5358
|
*/
|
|
5272
5359
|
deleteIndividual(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5273
5360
|
}
|
|
5274
|
-
export class
|
|
5361
|
+
export class BlacklistAdminBusinesses<HandleError extends boolean = boolean> {
|
|
5275
5362
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5276
5363
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5277
5364
|
/**
|
|
5278
|
-
* @tags
|
|
5279
|
-
* @name
|
|
5280
|
-
* @
|
|
5281
|
-
* @
|
|
5282
|
-
*/
|
|
5283
|
-
branchRtb(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5284
|
-
/**
|
|
5285
|
-
* @tags Branch
|
|
5286
|
-
* @name BranchRtbs
|
|
5287
|
-
* @request GET:/v1/branch/rtbs
|
|
5365
|
+
* @tags Blacklist Admin Businesses
|
|
5366
|
+
* @name GetBusinessesList
|
|
5367
|
+
* @summary Get Businesses list
|
|
5368
|
+
* @request GET:/v1/admin/businesses
|
|
5288
5369
|
* @secure
|
|
5289
5370
|
*/
|
|
5290
|
-
|
|
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>>;
|
|
5291
5383
|
/**
|
|
5292
|
-
* @tags
|
|
5293
|
-
* @name
|
|
5294
|
-
* @
|
|
5384
|
+
* @tags Blacklist Admin Businesses
|
|
5385
|
+
* @name CreateBusiness
|
|
5386
|
+
* @summary Create Business
|
|
5387
|
+
* @request POST:/v1/admin/businesses
|
|
5295
5388
|
* @secure
|
|
5296
5389
|
*/
|
|
5297
|
-
|
|
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>>;
|
|
5298
5416
|
/**
|
|
5299
|
-
* @tags
|
|
5300
|
-
* @name
|
|
5301
|
-
* @
|
|
5417
|
+
* @tags Blacklist Admin Businesses
|
|
5418
|
+
* @name GetBusinessById
|
|
5419
|
+
* @summary Get Business by ID
|
|
5420
|
+
* @request GET:/v1/admin/businesses/{id}
|
|
5302
5421
|
* @secure
|
|
5303
5422
|
*/
|
|
5304
|
-
|
|
5423
|
+
getBusinessById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5305
5424
|
/**
|
|
5306
|
-
* @tags
|
|
5307
|
-
* @name
|
|
5308
|
-
* @
|
|
5425
|
+
* @tags Blacklist Admin Businesses
|
|
5426
|
+
* @name UpdateBusiness
|
|
5427
|
+
* @summary Update Business
|
|
5428
|
+
* @request PUT:/v1/admin/businesses/{id}
|
|
5309
5429
|
* @secure
|
|
5310
5430
|
*/
|
|
5311
|
-
|
|
5312
|
-
/**
|
|
5313
|
-
|
|
5314
|
-
|
|
5315
|
-
|
|
5316
|
-
|
|
5317
|
-
|
|
5318
|
-
|
|
5319
|
-
|
|
5320
|
-
loadUpgrades?: any;
|
|
5321
|
-
/** @example "false" */
|
|
5322
|
-
loadEarnings?: any;
|
|
5323
|
-
/**
|
|
5324
|
-
* Load balances for weight
|
|
5325
|
-
* @example "false"
|
|
5326
|
-
*/
|
|
5327
|
-
loadRtb?: any;
|
|
5328
|
-
/**
|
|
5329
|
-
* Analyze market caps and get `marketCapWeights`. To be used in conjuction with `loadQuotes`
|
|
5330
|
-
* @example "false"
|
|
5331
|
-
*/
|
|
5332
|
-
marketCapBreakdown?: any;
|
|
5333
|
-
/**
|
|
5334
|
-
* Combined portfolio for the branch
|
|
5335
|
-
* @example "false"
|
|
5336
|
-
*/
|
|
5337
|
-
combined?: any;
|
|
5338
|
-
/** @example "1" */
|
|
5339
|
-
pageNum?: any;
|
|
5340
|
-
/** @example "100" */
|
|
5341
|
-
pageSize?: any;
|
|
5342
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5343
|
-
/**
|
|
5344
|
-
* @tags Branch
|
|
5345
|
-
* @name OptionExpirations
|
|
5346
|
-
* @summary Option expirations
|
|
5347
|
-
* @request GET:/v1/branch/portfolio/options/upcoming
|
|
5348
|
-
* @secure
|
|
5349
|
-
*/
|
|
5350
|
-
optionExpirations(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5351
|
-
/**
|
|
5352
|
-
* @tags Branch
|
|
5353
|
-
* @name OptionExpirationsDetails
|
|
5354
|
-
* @summary Option expirations details
|
|
5355
|
-
* @request POST:/v1/branch/portfolio/options/upcoming/details
|
|
5356
|
-
* @secure
|
|
5357
|
-
*/
|
|
5358
|
-
optionExpirationsDetails(data: {
|
|
5359
|
-
/** @example "true|false" */
|
|
5360
|
-
loadQuotes?: any;
|
|
5361
|
-
/** @example "01/15/2021 00:00:00 EST" */
|
|
5362
|
-
maturity?: any;
|
|
5363
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5364
|
-
}
|
|
5365
|
-
export class LegalDocuments<HandleError extends boolean = boolean> {
|
|
5366
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5367
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5368
|
-
/**
|
|
5369
|
-
* @tags Legal Documents
|
|
5370
|
-
* @name DocumentClassifications
|
|
5371
|
-
* @summary Document classifications
|
|
5372
|
-
* @request GET:/user/legal/classifications
|
|
5373
|
-
* @secure
|
|
5374
|
-
*/
|
|
5375
|
-
documentClassifications(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5376
|
-
/**
|
|
5377
|
-
* @tags Legal Documents
|
|
5378
|
-
* @name DocumentListing
|
|
5379
|
-
* @summary Document listing
|
|
5380
|
-
* @request GET:/user/legal/documents
|
|
5381
|
-
* @secure
|
|
5382
|
-
*/
|
|
5383
|
-
documentListing(query?: {
|
|
5384
|
-
/**
|
|
5385
|
-
* {optional}
|
|
5386
|
-
* @example "TermsOfUse"
|
|
5387
|
-
*/
|
|
5388
|
-
classification?: any;
|
|
5389
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5390
|
-
/**
|
|
5391
|
-
* @tags Legal Documents
|
|
5392
|
-
* @name PolicyValues
|
|
5393
|
-
* @summary Policy values
|
|
5394
|
-
* @request GET:/user/legal/policies/listing/{type}
|
|
5395
|
-
* @secure
|
|
5396
|
-
*/
|
|
5397
|
-
policyValues(type: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5398
|
-
/**
|
|
5399
|
-
* @tags Legal Documents
|
|
5400
|
-
* @name DocumentContent
|
|
5401
|
-
* @summary Document content
|
|
5402
|
-
* @request GET:/user/legal/document/content
|
|
5403
|
-
* @secure
|
|
5404
|
-
*/
|
|
5405
|
-
documentContent(query?: {
|
|
5406
|
-
/** @example "{as provided}" */
|
|
5407
|
-
id?: any;
|
|
5408
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5409
|
-
/**
|
|
5410
|
-
* @tags Legal Documents
|
|
5411
|
-
* @name DocumentDownload
|
|
5412
|
-
* @summary Document download
|
|
5413
|
-
* @request GET:/user/legal/document/download
|
|
5414
|
-
* @secure
|
|
5415
|
-
*/
|
|
5416
|
-
documentDownload(query?: {
|
|
5417
|
-
/** @example "{as provided}" */
|
|
5418
|
-
id?: any;
|
|
5419
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5420
|
-
/**
|
|
5421
|
-
* @tags Legal Documents
|
|
5422
|
-
* @name SignTheDocument
|
|
5423
|
-
* @summary Sign the document
|
|
5424
|
-
* @request POST:/user/legal/document/sign
|
|
5425
|
-
* @secure
|
|
5426
|
-
*/
|
|
5427
|
-
signTheDocument(data: {
|
|
5428
|
-
account?: {
|
|
5429
|
-
/** @example 1234 */
|
|
5430
|
-
accountId?: number;
|
|
5431
|
-
/** @example "AC123456" */
|
|
5432
|
-
accountNumber?: string;
|
|
5433
|
-
};
|
|
5434
|
-
data?: {
|
|
5435
|
-
/** @example "{conditional}" */
|
|
5436
|
-
bankAccountNumber?: string;
|
|
5437
|
-
};
|
|
5438
|
-
/** @example "{required}" */
|
|
5439
|
-
documentId?: any;
|
|
5440
|
-
/** @example true */
|
|
5441
|
-
esigned?: any;
|
|
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;
|
|
5442
5440
|
/** @example "" */
|
|
5443
|
-
|
|
5444
|
-
/** @example "
|
|
5445
|
-
|
|
5446
|
-
/** @example "
|
|
5447
|
-
|
|
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;
|
|
5448
5456
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5449
5457
|
/**
|
|
5450
|
-
* @tags
|
|
5451
|
-
* @name
|
|
5452
|
-
* @summary
|
|
5453
|
-
* @request
|
|
5458
|
+
* @tags Blacklist Admin Businesses
|
|
5459
|
+
* @name DeleteBusiness
|
|
5460
|
+
* @summary Delete Business
|
|
5461
|
+
* @request DELETE:/v1/admin/businesses/{id}
|
|
5454
5462
|
* @secure
|
|
5455
5463
|
*/
|
|
5456
|
-
|
|
5457
|
-
account?: {
|
|
5458
|
-
/** @example 0 */
|
|
5459
|
-
accountId?: number;
|
|
5460
|
-
/** @example "{optional}" */
|
|
5461
|
-
accountNumber?: string;
|
|
5462
|
-
};
|
|
5463
|
-
/** @example true */
|
|
5464
|
-
esigned?: any;
|
|
5465
|
-
/** @example "Allow" */
|
|
5466
|
-
policy?: any;
|
|
5467
|
-
/** @example "" */
|
|
5468
|
-
remoteAddr?: any;
|
|
5469
|
-
/** @example "" */
|
|
5470
|
-
remoteDevice?: any;
|
|
5471
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5464
|
+
deleteBusiness(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5472
5465
|
}
|
|
5473
5466
|
export class BlacklistSearch<HandleError extends boolean = boolean> {
|
|
5474
5467
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -5512,49 +5505,6 @@ export class BlacklistSearch<HandleError extends boolean = boolean> {
|
|
|
5512
5505
|
};
|
|
5513
5506
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5514
5507
|
}
|
|
5515
|
-
export class Broker<HandleError extends boolean = boolean> {
|
|
5516
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5517
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5518
|
-
/**
|
|
5519
|
-
* @tags Broker
|
|
5520
|
-
* @name Portfolio
|
|
5521
|
-
* @summary Portfolio
|
|
5522
|
-
* @request GET:/v1/broker/portfolio
|
|
5523
|
-
* @secure
|
|
5524
|
-
*/
|
|
5525
|
-
portfolio(query?: {
|
|
5526
|
-
/**
|
|
5527
|
-
* (true or false) Allows for loading of quotes for each portfolio entry. Defaults to false.
|
|
5528
|
-
* @example "false"
|
|
5529
|
-
*/
|
|
5530
|
-
loadQuotes?: any;
|
|
5531
|
-
/** @example "false" */
|
|
5532
|
-
loadIndustries?: any;
|
|
5533
|
-
/** @example "false" */
|
|
5534
|
-
loadUpgrades?: any;
|
|
5535
|
-
/** @example "false" */
|
|
5536
|
-
loadEarnings?: any;
|
|
5537
|
-
/**
|
|
5538
|
-
* Load balances for weight
|
|
5539
|
-
* @example "false"
|
|
5540
|
-
*/
|
|
5541
|
-
loadRtb?: any;
|
|
5542
|
-
/**
|
|
5543
|
-
* Analyze market caps and get `marketCapWeights`. To be used in conjuction with `loadQuotes`
|
|
5544
|
-
* @example "false"
|
|
5545
|
-
*/
|
|
5546
|
-
marketCapBreakdown?: any;
|
|
5547
|
-
/**
|
|
5548
|
-
* Combined portfolio for the branch
|
|
5549
|
-
* @example "false"
|
|
5550
|
-
*/
|
|
5551
|
-
combined?: any;
|
|
5552
|
-
/** @example "1" */
|
|
5553
|
-
pageNum?: any;
|
|
5554
|
-
/** @example "100" */
|
|
5555
|
-
pageSize?: any;
|
|
5556
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5557
|
-
}
|
|
5558
5508
|
export class Blacklist<HandleError extends boolean = boolean> {
|
|
5559
5509
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5560
5510
|
adminBusinesses: BlacklistAdminBusinesses<HandleError>;
|
|
@@ -5584,154 +5534,48 @@ export class Blacklist<HandleError extends boolean = boolean> {
|
|
|
5584
5534
|
*/
|
|
5585
5535
|
getHealth(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5586
5536
|
}
|
|
5587
|
-
export class
|
|
5537
|
+
export class Broker<HandleError extends boolean = boolean> {
|
|
5588
5538
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5589
5539
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5590
5540
|
/**
|
|
5591
|
-
* @tags
|
|
5592
|
-
* @name
|
|
5593
|
-
* @summary
|
|
5594
|
-
* @request
|
|
5595
|
-
* @secure
|
|
5596
|
-
*/
|
|
5597
|
-
createUser(data: {
|
|
5598
|
-
/** @example "{optional} enable|disable - whether or not enable user for TipRanks" */
|
|
5599
|
-
Tipranks?: any;
|
|
5600
|
-
/** @example "{optional} true|false - defaults to false" */
|
|
5601
|
-
algos?: any;
|
|
5602
|
-
/** @example "{optional} true|false - defaults to false" */
|
|
5603
|
-
allSession?: any;
|
|
5604
|
-
/** @example "{optional} Full Name" */
|
|
5605
|
-
associatedName?: any;
|
|
5606
|
-
/** @example "{optional} true|false - defaults to false" */
|
|
5607
|
-
buyWrite?: any;
|
|
5608
|
-
/** @example "{optional} e-mail address" */
|
|
5609
|
-
email?: any;
|
|
5610
|
-
/** @example "{optional} true|false - defaults to true" */
|
|
5611
|
-
isTradingEnabled?: any;
|
|
5612
|
-
/** @example "{optional} Limit On Close - true|false - defaults to false" */
|
|
5613
|
-
loc?: any;
|
|
5614
|
-
/** @example "{optional} true|false - whether user is locked" */
|
|
5615
|
-
locked?: any;
|
|
5616
|
-
/** @example "{optional} Limit On Open - true|false - defaults to false" */
|
|
5617
|
-
loo?: any;
|
|
5618
|
-
/** @example "{optional} Market On Open - true|false - defaults to false" */
|
|
5619
|
-
moc?: any;
|
|
5620
|
-
/** @example "{optional} Market On Close - true|false - defaults to false" */
|
|
5621
|
-
moo?: any;
|
|
5622
|
-
/** @example "{optional} One Cancels Other - true|false - defaults to false" */
|
|
5623
|
-
oco?: any;
|
|
5624
|
-
/** @example "{optional} true|false - defaults to false" */
|
|
5625
|
-
optionRoll?: any;
|
|
5626
|
-
/** @example "{optional} true|false - defaults to false" */
|
|
5627
|
-
options?: any;
|
|
5628
|
-
/** @example "{optional}" */
|
|
5629
|
-
password?: any;
|
|
5630
|
-
/** @example "{optional} true|false - defaults to false" */
|
|
5631
|
-
prePostTrading?: any;
|
|
5632
|
-
/** @example "{optional} 1 - delayed, 0 - realtime, 4 - CBOE1, 3 - BATS" */
|
|
5633
|
-
quoteType?: any;
|
|
5634
|
-
/** @example "{optional} true|false - defaults to false" */
|
|
5635
|
-
spreads?: any;
|
|
5636
|
-
/** @example "A - active, S - suspended == initial user status" */
|
|
5637
|
-
status?: any;
|
|
5638
|
-
/** @example "{optional} true|false - defaults to false" */
|
|
5639
|
-
trailingStops?: any;
|
|
5640
|
-
/** @example "UNIQUE_USERNAME" */
|
|
5641
|
-
username?: any;
|
|
5642
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5643
|
-
/**
|
|
5644
|
-
* @tags Watchmen Ffi User Account Management
|
|
5645
|
-
* @name CreateAccount
|
|
5646
|
-
* @summary Create Account
|
|
5647
|
-
* @request POST:/rest/v1/uam/account/create
|
|
5648
|
-
* @secure
|
|
5649
|
-
*/
|
|
5650
|
-
createAccount(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5651
|
-
/**
|
|
5652
|
-
* @tags Watchmen Ffi User Account Management
|
|
5653
|
-
* @name AccountInformation
|
|
5654
|
-
* @summary Account Information
|
|
5655
|
-
* @request GET:/rest/v1/uam/account/data
|
|
5656
|
-
* @secure
|
|
5657
|
-
*/
|
|
5658
|
-
accountInformation(query?: {
|
|
5659
|
-
/** @example "AC123456" */
|
|
5660
|
-
accountNumber?: any;
|
|
5661
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5662
|
-
/**
|
|
5663
|
-
* @tags Watchmen Ffi User Account Management
|
|
5664
|
-
* @name UserInformation
|
|
5665
|
-
* @summary User Information
|
|
5666
|
-
* @request GET:/rest/v1/uam/user/data
|
|
5667
|
-
* @secure
|
|
5668
|
-
*/
|
|
5669
|
-
userInformation(query?: {
|
|
5670
|
-
/** @example "USERNAME" */
|
|
5671
|
-
username?: any;
|
|
5672
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5673
|
-
/**
|
|
5674
|
-
* @tags Watchmen Ffi User Account Management
|
|
5675
|
-
* @name ListLinkedAccounts
|
|
5676
|
-
* @summary List Linked Accounts
|
|
5677
|
-
* @request GET:/rest/v1/linkedaccounts/listAccounts
|
|
5678
|
-
* @secure
|
|
5679
|
-
*/
|
|
5680
|
-
listLinkedAccounts(query?: {
|
|
5681
|
-
/** @example "TEST.USER" */
|
|
5682
|
-
username?: any;
|
|
5683
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5684
|
-
/**
|
|
5685
|
-
* @tags Watchmen Ffi User Account Management
|
|
5686
|
-
* @name LinkUnlinkAccount
|
|
5687
|
-
* @summary Link/Unlink Account
|
|
5688
|
-
* @request POST:/rest/v1/linkedaccounts/linkUnlinkAccount
|
|
5689
|
-
* @secure
|
|
5690
|
-
*/
|
|
5691
|
-
linkUnlinkAccount(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5692
|
-
/**
|
|
5693
|
-
* @tags Watchmen Ffi User Account Management
|
|
5694
|
-
* @name Visibility
|
|
5695
|
-
* @summary Visibility
|
|
5696
|
-
* @request POST:/rest/v1/linkedaccounts/visibility
|
|
5697
|
-
* @secure
|
|
5698
|
-
*/
|
|
5699
|
-
visibility(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5700
|
-
/**
|
|
5701
|
-
* @tags Watchmen Ffi User Account Management
|
|
5702
|
-
* @name UserAccountSearch
|
|
5703
|
-
* @summary User/Account Search
|
|
5704
|
-
* @request POST:/rest/v1/uam/user-account-search
|
|
5541
|
+
* @tags Broker
|
|
5542
|
+
* @name Portfolio
|
|
5543
|
+
* @summary Portfolio
|
|
5544
|
+
* @request GET:/v1/broker/portfolio
|
|
5705
5545
|
* @secure
|
|
5706
5546
|
*/
|
|
5707
|
-
|
|
5708
|
-
/**
|
|
5709
|
-
|
|
5710
|
-
|
|
5711
|
-
|
|
5712
|
-
|
|
5713
|
-
|
|
5714
|
-
|
|
5715
|
-
|
|
5716
|
-
|
|
5717
|
-
|
|
5718
|
-
|
|
5719
|
-
|
|
5720
|
-
|
|
5721
|
-
|
|
5722
|
-
|
|
5723
|
-
|
|
5724
|
-
|
|
5725
|
-
|
|
5726
|
-
|
|
5727
|
-
|
|
5728
|
-
|
|
5729
|
-
|
|
5730
|
-
|
|
5731
|
-
|
|
5732
|
-
|
|
5733
|
-
|
|
5734
|
-
|
|
5547
|
+
portfolio(query?: {
|
|
5548
|
+
/**
|
|
5549
|
+
* (true or false) Allows for loading of quotes for each portfolio entry. Defaults to false.
|
|
5550
|
+
* @example "false"
|
|
5551
|
+
*/
|
|
5552
|
+
loadQuotes?: any;
|
|
5553
|
+
/** @example "false" */
|
|
5554
|
+
loadIndustries?: any;
|
|
5555
|
+
/** @example "false" */
|
|
5556
|
+
loadUpgrades?: any;
|
|
5557
|
+
/** @example "false" */
|
|
5558
|
+
loadEarnings?: any;
|
|
5559
|
+
/**
|
|
5560
|
+
* Load balances for weight
|
|
5561
|
+
* @example "false"
|
|
5562
|
+
*/
|
|
5563
|
+
loadRtb?: any;
|
|
5564
|
+
/**
|
|
5565
|
+
* Analyze market caps and get `marketCapWeights`. To be used in conjuction with `loadQuotes`
|
|
5566
|
+
* @example "false"
|
|
5567
|
+
*/
|
|
5568
|
+
marketCapBreakdown?: any;
|
|
5569
|
+
/**
|
|
5570
|
+
* Combined portfolio for the branch
|
|
5571
|
+
* @example "false"
|
|
5572
|
+
*/
|
|
5573
|
+
combined?: any;
|
|
5574
|
+
/** @example "1" */
|
|
5575
|
+
pageNum?: any;
|
|
5576
|
+
/** @example "100" */
|
|
5577
|
+
pageSize?: any;
|
|
5578
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5735
5579
|
}
|
|
5736
5580
|
export class WatchmenFfiFirmBranch<HandleError extends boolean = boolean> {
|
|
5737
5581
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -5908,160 +5752,160 @@ export class WatchmenFfiFirmBranch<HandleError extends boolean = boolean> {
|
|
|
5908
5752
|
id?: any;
|
|
5909
5753
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5910
5754
|
}
|
|
5911
|
-
export class
|
|
5912
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5913
|
-
userAccountManagement: WatchmenFfiUserAccountManagement<HandleError>;
|
|
5914
|
-
firmBranch: WatchmenFfiFirmBranch<HandleError>;
|
|
5915
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5916
|
-
}
|
|
5917
|
-
export class Documents<HandleError extends boolean = boolean> {
|
|
5755
|
+
export class WatchmenFfiUserAccountManagement<HandleError extends boolean = boolean> {
|
|
5918
5756
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5919
5757
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5920
5758
|
/**
|
|
5921
|
-
* @tags
|
|
5922
|
-
* @name
|
|
5923
|
-
* @summary
|
|
5924
|
-
* @request
|
|
5759
|
+
* @tags Watchmen Ffi User Account Management
|
|
5760
|
+
* @name CreateUser
|
|
5761
|
+
* @summary Create User
|
|
5762
|
+
* @request POST:/rest/v1/uam/user/create
|
|
5925
5763
|
* @secure
|
|
5926
5764
|
*/
|
|
5927
|
-
|
|
5928
|
-
/**
|
|
5929
|
-
|
|
5930
|
-
|
|
5931
|
-
|
|
5932
|
-
|
|
5933
|
-
|
|
5934
|
-
|
|
5935
|
-
|
|
5936
|
-
|
|
5937
|
-
|
|
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;
|
|
5938
5810
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5939
5811
|
/**
|
|
5940
|
-
* @tags
|
|
5941
|
-
* @name
|
|
5942
|
-
* @summary
|
|
5943
|
-
* @request
|
|
5812
|
+
* @tags Watchmen Ffi User Account Management
|
|
5813
|
+
* @name CreateAccount
|
|
5814
|
+
* @summary Create Account
|
|
5815
|
+
* @request POST:/rest/v1/uam/account/create
|
|
5944
5816
|
* @secure
|
|
5945
5817
|
*/
|
|
5946
|
-
|
|
5947
|
-
/**
|
|
5948
|
-
* *_accountNumber_ is accepted as well*
|
|
5949
|
-
* @example "5VA0XXXX"
|
|
5950
|
-
*/
|
|
5951
|
-
account?: any;
|
|
5952
|
-
/**
|
|
5953
|
-
* Start date for the list of confirms. The required date format is: `mm/dd/yyyy`.
|
|
5954
|
-
* @example "01/01/2017"
|
|
5955
|
-
*/
|
|
5956
|
-
beginDate?: any;
|
|
5957
|
-
/**
|
|
5958
|
-
* End date for the list of confirms. The required date format is: `mm/dd/yyyy`.
|
|
5959
|
-
* @example "03/01/2018"
|
|
5960
|
-
*/
|
|
5961
|
-
endDate?: any;
|
|
5962
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5818
|
+
createAccount(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5963
5819
|
/**
|
|
5964
|
-
* @tags
|
|
5965
|
-
* @name
|
|
5966
|
-
* @summary
|
|
5967
|
-
* @request GET:/
|
|
5820
|
+
* @tags Watchmen Ffi User Account Management
|
|
5821
|
+
* @name AccountInformation
|
|
5822
|
+
* @summary Account Information
|
|
5823
|
+
* @request GET:/rest/v1/uam/account/data
|
|
5968
5824
|
* @secure
|
|
5969
5825
|
*/
|
|
5970
|
-
|
|
5971
|
-
/** @example "
|
|
5826
|
+
accountInformation(query?: {
|
|
5827
|
+
/** @example "AC123456" */
|
|
5972
5828
|
accountNumber?: any;
|
|
5973
|
-
/** See table for details. Leave blank for all document types. */
|
|
5974
|
-
docType?: any;
|
|
5975
|
-
/**
|
|
5976
|
-
* The beginning 2-digit month (MM) to be used as search criteria.
|
|
5977
|
-
* @example "01"
|
|
5978
|
-
*/
|
|
5979
|
-
beginMonth?: any;
|
|
5980
|
-
/**
|
|
5981
|
-
* The beginning 4-digit year (YYYY) to be used as search criteria.
|
|
5982
|
-
* @example "2012"
|
|
5983
|
-
*/
|
|
5984
|
-
beginYear?: any;
|
|
5985
|
-
/**
|
|
5986
|
-
* The ending 2-digit month (MM) to be used as search criteria.
|
|
5987
|
-
* @example "12"
|
|
5988
|
-
*/
|
|
5989
|
-
endMonth?: any;
|
|
5990
|
-
/**
|
|
5991
|
-
* The ending 4-digit year (YYYY) to be used as search criteria.
|
|
5992
|
-
* @example "2017"
|
|
5993
|
-
*/
|
|
5994
|
-
endYear?: any;
|
|
5995
5829
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5996
5830
|
/**
|
|
5997
|
-
* @tags
|
|
5998
|
-
* @name
|
|
5999
|
-
* @summary
|
|
6000
|
-
* @request GET:/
|
|
5831
|
+
* @tags Watchmen Ffi User Account Management
|
|
5832
|
+
* @name UserInformation
|
|
5833
|
+
* @summary User Information
|
|
5834
|
+
* @request GET:/rest/v1/uam/user/data
|
|
6001
5835
|
* @secure
|
|
6002
5836
|
*/
|
|
6003
|
-
|
|
6004
|
-
/** @example "
|
|
6005
|
-
|
|
6006
|
-
/**
|
|
6007
|
-
* Omit for all document types.
|
|
6008
|
-
* @example "All"
|
|
6009
|
-
*/
|
|
6010
|
-
documentType?: any;
|
|
6011
|
-
/**
|
|
6012
|
-
* Indicates start month & year (day of month is not used)
|
|
6013
|
-
* @example "1/1/2021"
|
|
6014
|
-
*/
|
|
6015
|
-
fromMonth?: any;
|
|
6016
|
-
/**
|
|
6017
|
-
* Indicates end month & year (day of month is not used)
|
|
6018
|
-
* @example "12/1/2021"
|
|
6019
|
-
*/
|
|
6020
|
-
toMonth?: any;
|
|
5837
|
+
userInformation(query?: {
|
|
5838
|
+
/** @example "USERNAME" */
|
|
5839
|
+
username?: any;
|
|
6021
5840
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
6022
5841
|
/**
|
|
6023
|
-
* @tags
|
|
6024
|
-
* @name
|
|
6025
|
-
* @summary
|
|
6026
|
-
* @request GET:/
|
|
5842
|
+
* @tags Watchmen Ffi User Account Management
|
|
5843
|
+
* @name ListLinkedAccounts
|
|
5844
|
+
* @summary List Linked Accounts
|
|
5845
|
+
* @request GET:/rest/v1/linkedaccounts/listAccounts
|
|
6027
5846
|
* @secure
|
|
6028
5847
|
*/
|
|
6029
|
-
|
|
5848
|
+
listLinkedAccounts(query?: {
|
|
5849
|
+
/** @example "TEST.USER" */
|
|
5850
|
+
username?: any;
|
|
5851
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
6030
5852
|
/**
|
|
6031
|
-
* @tags
|
|
6032
|
-
* @name
|
|
6033
|
-
* @summary
|
|
6034
|
-
* @request
|
|
5853
|
+
* @tags Watchmen Ffi User Account Management
|
|
5854
|
+
* @name LinkUnlinkAccount
|
|
5855
|
+
* @summary Link/Unlink Account
|
|
5856
|
+
* @request POST:/rest/v1/linkedaccounts/linkUnlinkAccount
|
|
6035
5857
|
* @secure
|
|
6036
5858
|
*/
|
|
6037
|
-
|
|
5859
|
+
linkUnlinkAccount(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
6038
5860
|
/**
|
|
6039
|
-
* @tags
|
|
6040
|
-
* @name
|
|
6041
|
-
* @summary
|
|
6042
|
-
* @request
|
|
5861
|
+
* @tags Watchmen Ffi User Account Management
|
|
5862
|
+
* @name Visibility
|
|
5863
|
+
* @summary Visibility
|
|
5864
|
+
* @request POST:/rest/v1/linkedaccounts/visibility
|
|
6043
5865
|
* @secure
|
|
6044
5866
|
*/
|
|
6045
|
-
|
|
6046
|
-
/**
|
|
6047
|
-
* Account Number
|
|
6048
|
-
* @example "{accountNumber}"
|
|
6049
|
-
*/
|
|
6050
|
-
account?: any;
|
|
6051
|
-
/**
|
|
6052
|
-
* UUID for finding specific document
|
|
6053
|
-
* @example "{key}"
|
|
6054
|
-
*/
|
|
6055
|
-
key?: any;
|
|
6056
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5867
|
+
visibility(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
6057
5868
|
/**
|
|
6058
|
-
* @tags
|
|
6059
|
-
* @name
|
|
6060
|
-
* @summary
|
|
6061
|
-
* @request
|
|
5869
|
+
* @tags Watchmen Ffi User Account Management
|
|
5870
|
+
* @name UserAccountSearch
|
|
5871
|
+
* @summary User/Account Search
|
|
5872
|
+
* @request POST:/rest/v1/uam/user-account-search
|
|
6062
5873
|
* @secure
|
|
6063
5874
|
*/
|
|
6064
|
-
|
|
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;
|
|
5892
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5893
|
+
}
|
|
5894
|
+
export class Advisory<HandleError extends boolean = boolean> {
|
|
5895
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5896
|
+
charges: AdvisoryCharges<HandleError>;
|
|
5897
|
+
models: AdvisoryModels<HandleError>;
|
|
5898
|
+
userAccountManagement: AdvisoryUserAccountManagement<HandleError>;
|
|
5899
|
+
groups: AdvisoryGroups<HandleError>;
|
|
5900
|
+
analytics: AdvisoryAnalytics<HandleError>;
|
|
5901
|
+
allocations: AdvisoryAllocations<HandleError>;
|
|
5902
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5903
|
+
}
|
|
5904
|
+
export class WatchmenFfi<HandleError extends boolean = boolean> {
|
|
5905
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5906
|
+
userAccountManagement: WatchmenFfiUserAccountManagement<HandleError>;
|
|
5907
|
+
firmBranch: WatchmenFfiFirmBranch<HandleError>;
|
|
5908
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
6065
5909
|
}
|
|
6066
5910
|
export class OrbisApi<HandleError extends boolean = false> extends BaseApi<HandleError, OrbisClient<HandleError>> {
|
|
6067
5911
|
readonly config: OrbisClientConfig<HandleError>;
|