@orbis-systems/orbis-api-clients 0.7.14 → 0.7.15
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 +295 -261
- 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 +603 -451
- 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 +394 -124
- 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 +123 -54
- 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 +699 -855
- 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 +449 -753
- 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 +168 -150
- 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
|
|
@@ -510,6 +372,82 @@ export class OrdersV2Options<HandleError extends boolean = boolean> {
|
|
|
510
372
|
};
|
|
511
373
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
512
374
|
}
|
|
375
|
+
export class OrdersV2Equities<HandleError extends boolean = boolean> {
|
|
376
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
377
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
378
|
+
/**
|
|
379
|
+
* @tags Orders V2 Equities
|
|
380
|
+
* @name Preview
|
|
381
|
+
* @summary Preview
|
|
382
|
+
* @request POST:/orders/v2/preview/equity
|
|
383
|
+
* @secure
|
|
384
|
+
*/
|
|
385
|
+
preview(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
386
|
+
/**
|
|
387
|
+
* @tags Orders V2 Equities
|
|
388
|
+
* @name Placement
|
|
389
|
+
* @summary Placement
|
|
390
|
+
* @request POST:/orders/v2/place/equity
|
|
391
|
+
* @secure
|
|
392
|
+
*/
|
|
393
|
+
placement(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
394
|
+
/**
|
|
395
|
+
* @tags Orders V2 Equities
|
|
396
|
+
* @name AlgoPreview
|
|
397
|
+
* @summary Algo Preview
|
|
398
|
+
* @request POST:/orders/v2/algo/preview/equity
|
|
399
|
+
* @secure
|
|
400
|
+
*/
|
|
401
|
+
algoPreview(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
402
|
+
/**
|
|
403
|
+
* @tags Orders V2 Equities
|
|
404
|
+
* @name AlgoPlacement
|
|
405
|
+
* @summary Algo Placement
|
|
406
|
+
* @request POST:/orders/v2/algo/place/equity
|
|
407
|
+
* @secure
|
|
408
|
+
*/
|
|
409
|
+
algoPlacement(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
410
|
+
/**
|
|
411
|
+
* @tags Orders V2 Equities
|
|
412
|
+
* @name BasketPreview
|
|
413
|
+
* @summary Basket preview
|
|
414
|
+
* @request POST:/orders/v2/basket/preview/equity
|
|
415
|
+
* @secure
|
|
416
|
+
*/
|
|
417
|
+
basketPreview(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
418
|
+
/**
|
|
419
|
+
* @tags Orders V2 Equities
|
|
420
|
+
* @name BasketPlacement
|
|
421
|
+
* @summary Basket placement
|
|
422
|
+
* @request POST:/orders/v2/basket/place/equity
|
|
423
|
+
* @secure
|
|
424
|
+
*/
|
|
425
|
+
basketPlacement(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
426
|
+
/**
|
|
427
|
+
* @tags Orders V2 Equities
|
|
428
|
+
* @name AdvisoryPreview
|
|
429
|
+
* @summary Advisory preview
|
|
430
|
+
* @request POST:/orders/v2/advisory/equity/preview
|
|
431
|
+
* @secure
|
|
432
|
+
*/
|
|
433
|
+
advisoryPreview(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
434
|
+
/**
|
|
435
|
+
* @tags Orders V2 Equities
|
|
436
|
+
* @name AdvisoryPlacement
|
|
437
|
+
* @summary Advisory placement
|
|
438
|
+
* @request POST:/orders/v2/advisory/equity/place
|
|
439
|
+
* @secure
|
|
440
|
+
*/
|
|
441
|
+
advisoryPlacement(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
442
|
+
/**
|
|
443
|
+
* @tags Orders V2 Equities
|
|
444
|
+
* @name PreviewSnapshot
|
|
445
|
+
* @summary Preview Snapshot
|
|
446
|
+
* @request POST:/orders/v2/preview/equity/snapshot
|
|
447
|
+
* @secure
|
|
448
|
+
*/
|
|
449
|
+
previewSnapshot(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
450
|
+
}
|
|
513
451
|
export class OrdersV2FixedIncome<HandleError extends boolean = boolean> {
|
|
514
452
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
515
453
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -520,36 +458,7 @@ export class OrdersV2FixedIncome<HandleError extends boolean = boolean> {
|
|
|
520
458
|
* @request POST:/orders/v2/bonds/place
|
|
521
459
|
* @secure
|
|
522
460
|
*/
|
|
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>>;
|
|
461
|
+
bondPlacement(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
553
462
|
/**
|
|
554
463
|
* @tags Orders V2 Fixed Income
|
|
555
464
|
* @name BondOrderPreview
|
|
@@ -557,36 +466,7 @@ export class OrdersV2FixedIncome<HandleError extends boolean = boolean> {
|
|
|
557
466
|
* @request POST:/orders/v2/bonds/preview
|
|
558
467
|
* @secure
|
|
559
468
|
*/
|
|
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>>;
|
|
469
|
+
bondOrderPreview(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
590
470
|
}
|
|
591
471
|
export class OrdersV2Crypto<HandleError extends boolean = boolean> {
|
|
592
472
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -598,32 +478,7 @@ export class OrdersV2Crypto<HandleError extends boolean = boolean> {
|
|
|
598
478
|
* @request POST:/orders/v2/crypto/preview
|
|
599
479
|
* @secure
|
|
600
480
|
*/
|
|
601
|
-
orderPreview(data:
|
|
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>>;
|
|
481
|
+
orderPreview(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
627
482
|
/**
|
|
628
483
|
* @tags Orders V2 Crypto
|
|
629
484
|
* @name OrderPlace
|
|
@@ -631,36 +486,7 @@ export class OrdersV2Crypto<HandleError extends boolean = boolean> {
|
|
|
631
486
|
* @request POST:/orders/v2/crypto/place
|
|
632
487
|
* @secure
|
|
633
488
|
*/
|
|
634
|
-
orderPlace(data:
|
|
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>>;
|
|
489
|
+
orderPlace(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
664
490
|
}
|
|
665
491
|
export class OrdersV2MutualFunds<HandleError extends boolean = boolean> {
|
|
666
492
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -2343,6 +2169,96 @@ export class Research<HandleError extends boolean = boolean> {
|
|
|
2343
2169
|
dates?: any;
|
|
2344
2170
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2345
2171
|
}
|
|
2172
|
+
export class UserWatchlists<HandleError extends boolean = boolean> {
|
|
2173
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2174
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2175
|
+
/**
|
|
2176
|
+
* @tags User Watchlists
|
|
2177
|
+
* @name CreateWatchlist
|
|
2178
|
+
* @summary Create Watchlist
|
|
2179
|
+
* @request POST:/user/v2/watchlist/create
|
|
2180
|
+
* @secure
|
|
2181
|
+
*/
|
|
2182
|
+
createWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2183
|
+
/**
|
|
2184
|
+
* @tags User Watchlists
|
|
2185
|
+
* @name RenameWatchlist
|
|
2186
|
+
* @summary Rename Watchlist
|
|
2187
|
+
* @request POST:/user/v2/watchlist/rename
|
|
2188
|
+
* @secure
|
|
2189
|
+
*/
|
|
2190
|
+
renameWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2191
|
+
/**
|
|
2192
|
+
* @tags User Watchlists
|
|
2193
|
+
* @name DeleteWatchlist
|
|
2194
|
+
* @summary Delete Watchlist
|
|
2195
|
+
* @request POST:/user/v2/watchlist/delete
|
|
2196
|
+
* @secure
|
|
2197
|
+
*/
|
|
2198
|
+
deleteWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2199
|
+
/**
|
|
2200
|
+
* @tags User Watchlists
|
|
2201
|
+
* @name AddToWatchlist
|
|
2202
|
+
* @summary Add to Watchlist
|
|
2203
|
+
* @request POST:/user/v2/watchlist/addEntry
|
|
2204
|
+
* @secure
|
|
2205
|
+
*/
|
|
2206
|
+
addToWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2207
|
+
/**
|
|
2208
|
+
* @tags User Watchlists
|
|
2209
|
+
* @name RemoveFromWatchlist
|
|
2210
|
+
* @summary Remove from Watchlist
|
|
2211
|
+
* @request POST:/user/v2/watchlist/removeEntry
|
|
2212
|
+
* @secure
|
|
2213
|
+
*/
|
|
2214
|
+
removeFromWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2215
|
+
}
|
|
2216
|
+
export class UserDevice<HandleError extends boolean = boolean> {
|
|
2217
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2218
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2219
|
+
/**
|
|
2220
|
+
* @tags User Device
|
|
2221
|
+
* @name Register
|
|
2222
|
+
* @summary Register
|
|
2223
|
+
* @request GET:/user/device/register
|
|
2224
|
+
* @secure
|
|
2225
|
+
*/
|
|
2226
|
+
register(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2227
|
+
/**
|
|
2228
|
+
* @tags User Device
|
|
2229
|
+
* @name Deregister
|
|
2230
|
+
* @summary Deregister
|
|
2231
|
+
* @request GET:/user/device/deregister
|
|
2232
|
+
* @secure
|
|
2233
|
+
*/
|
|
2234
|
+
deregister(query?: {
|
|
2235
|
+
token?: any;
|
|
2236
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2237
|
+
/**
|
|
2238
|
+
* @tags User Device
|
|
2239
|
+
* @name FirebaseRegistration
|
|
2240
|
+
* @summary Firebase - registration
|
|
2241
|
+
* @request POST:/user/device/firebase/register
|
|
2242
|
+
* @secure
|
|
2243
|
+
*/
|
|
2244
|
+
firebaseRegistration(data: {
|
|
2245
|
+
/** @example "{predfined scope name}" */
|
|
2246
|
+
scope?: any;
|
|
2247
|
+
/** @example "a1s2d3f4g5h6" */
|
|
2248
|
+
token?: any;
|
|
2249
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2250
|
+
/**
|
|
2251
|
+
* @tags User Device
|
|
2252
|
+
* @name FirebaseRemoval
|
|
2253
|
+
* @summary Firebase - removal
|
|
2254
|
+
* @request POST:/user/device/firebase/deregister
|
|
2255
|
+
* @secure
|
|
2256
|
+
*/
|
|
2257
|
+
firebaseRemoval(data: {
|
|
2258
|
+
/** @example "a1s2d3f4g5h6" */
|
|
2259
|
+
token?: any;
|
|
2260
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2261
|
+
}
|
|
2346
2262
|
export class UserAgreements<HandleError extends boolean = boolean> {
|
|
2347
2263
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2348
2264
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -2461,138 +2377,48 @@ export class UserAttachedBanks<HandleError extends boolean = boolean> {
|
|
|
2461
2377
|
* Brokerage account number
|
|
2462
2378
|
* @example "AC123456"
|
|
2463
2379
|
*/
|
|
2464
|
-
account?: any;
|
|
2465
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2466
|
-
}
|
|
2467
|
-
export class UserProfitLoss<HandleError extends boolean = boolean> {
|
|
2468
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
2469
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
2470
|
-
/**
|
|
2471
|
-
* @tags User Profit Loss
|
|
2472
|
-
* @name ReportRequest
|
|
2473
|
-
* @summary Report Request
|
|
2474
|
-
* @request POST:/user/pal/submit
|
|
2475
|
-
* @secure
|
|
2476
|
-
*/
|
|
2477
|
-
reportRequest(data: {
|
|
2478
|
-
/** @example "{account number}" */
|
|
2479
|
-
account?: any;
|
|
2480
|
-
/** @example "{timestamp}" */
|
|
2481
|
-
from?: any;
|
|
2482
|
-
/** @example "{timestamp}" */
|
|
2483
|
-
until?: any;
|
|
2484
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2485
|
-
/**
|
|
2486
|
-
* @tags User Profit Loss
|
|
2487
|
-
* @name StatusCheck
|
|
2488
|
-
* @summary Status check
|
|
2489
|
-
* @request GET:/user/pal/status
|
|
2490
|
-
* @secure
|
|
2491
|
-
*/
|
|
2492
|
-
statusCheck(query?: {
|
|
2493
|
-
/** @example "643eaa24e00691406cbaa72f" */
|
|
2494
|
-
requestId?: any;
|
|
2495
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2496
|
-
/**
|
|
2497
|
-
* @tags User Profit Loss
|
|
2498
|
-
* @name Report
|
|
2499
|
-
* @summary Report
|
|
2500
|
-
* @request GET:/user/pal/report
|
|
2501
|
-
* @secure
|
|
2502
|
-
*/
|
|
2503
|
-
report(query?: {
|
|
2504
|
-
/** @example "643eaa24e00691406cbaa72f" */
|
|
2505
|
-
requestId?: any;
|
|
2506
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2507
|
-
}
|
|
2508
|
-
export class UserWatchlists<HandleError extends boolean = boolean> {
|
|
2509
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
2510
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
2511
|
-
/**
|
|
2512
|
-
* @tags User Watchlists
|
|
2513
|
-
* @name CreateWatchlist
|
|
2514
|
-
* @summary Create Watchlist
|
|
2515
|
-
* @request POST:/user/v2/watchlist/create
|
|
2516
|
-
* @secure
|
|
2517
|
-
*/
|
|
2518
|
-
createWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2519
|
-
/**
|
|
2520
|
-
* @tags User Watchlists
|
|
2521
|
-
* @name RenameWatchlist
|
|
2522
|
-
* @summary Rename Watchlist
|
|
2523
|
-
* @request POST:/user/v2/watchlist/rename
|
|
2524
|
-
* @secure
|
|
2525
|
-
*/
|
|
2526
|
-
renameWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2527
|
-
/**
|
|
2528
|
-
* @tags User Watchlists
|
|
2529
|
-
* @name DeleteWatchlist
|
|
2530
|
-
* @summary Delete Watchlist
|
|
2531
|
-
* @request POST:/user/v2/watchlist/delete
|
|
2532
|
-
* @secure
|
|
2533
|
-
*/
|
|
2534
|
-
deleteWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2535
|
-
/**
|
|
2536
|
-
* @tags User Watchlists
|
|
2537
|
-
* @name AddToWatchlist
|
|
2538
|
-
* @summary Add to Watchlist
|
|
2539
|
-
* @request POST:/user/v2/watchlist/addEntry
|
|
2540
|
-
* @secure
|
|
2541
|
-
*/
|
|
2542
|
-
addToWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2543
|
-
/**
|
|
2544
|
-
* @tags User Watchlists
|
|
2545
|
-
* @name RemoveFromWatchlist
|
|
2546
|
-
* @summary Remove from Watchlist
|
|
2547
|
-
* @request POST:/user/v2/watchlist/removeEntry
|
|
2548
|
-
* @secure
|
|
2549
|
-
*/
|
|
2550
|
-
removeFromWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2551
|
-
}
|
|
2552
|
-
export class UserDevice<HandleError extends boolean = boolean> {
|
|
2553
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
2554
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
2555
|
-
/**
|
|
2556
|
-
* @tags User Device
|
|
2557
|
-
* @name Register
|
|
2558
|
-
* @summary Register
|
|
2559
|
-
* @request GET:/user/device/register
|
|
2560
|
-
* @secure
|
|
2561
|
-
*/
|
|
2562
|
-
register(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2380
|
+
account?: any;
|
|
2381
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2382
|
+
}
|
|
2383
|
+
export class UserProfitLoss<HandleError extends boolean = boolean> {
|
|
2384
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2385
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2563
2386
|
/**
|
|
2564
|
-
* @tags User
|
|
2565
|
-
* @name
|
|
2566
|
-
* @summary
|
|
2567
|
-
* @request
|
|
2387
|
+
* @tags User Profit Loss
|
|
2388
|
+
* @name ReportRequest
|
|
2389
|
+
* @summary Report Request
|
|
2390
|
+
* @request POST:/user/pal/submit
|
|
2568
2391
|
* @secure
|
|
2569
2392
|
*/
|
|
2570
|
-
|
|
2571
|
-
|
|
2393
|
+
reportRequest(data: {
|
|
2394
|
+
/** @example "{account number}" */
|
|
2395
|
+
account?: any;
|
|
2396
|
+
/** @example "{timestamp}" */
|
|
2397
|
+
from?: any;
|
|
2398
|
+
/** @example "{timestamp}" */
|
|
2399
|
+
until?: any;
|
|
2572
2400
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2573
2401
|
/**
|
|
2574
|
-
* @tags User
|
|
2575
|
-
* @name
|
|
2576
|
-
* @summary
|
|
2577
|
-
* @request
|
|
2402
|
+
* @tags User Profit Loss
|
|
2403
|
+
* @name StatusCheck
|
|
2404
|
+
* @summary Status check
|
|
2405
|
+
* @request GET:/user/pal/status
|
|
2578
2406
|
* @secure
|
|
2579
2407
|
*/
|
|
2580
|
-
|
|
2581
|
-
/** @example "
|
|
2582
|
-
|
|
2583
|
-
/** @example "a1s2d3f4g5h6" */
|
|
2584
|
-
token?: any;
|
|
2408
|
+
statusCheck(query?: {
|
|
2409
|
+
/** @example "643eaa24e00691406cbaa72f" */
|
|
2410
|
+
requestId?: any;
|
|
2585
2411
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2586
2412
|
/**
|
|
2587
|
-
* @tags User
|
|
2588
|
-
* @name
|
|
2589
|
-
* @summary
|
|
2590
|
-
* @request
|
|
2413
|
+
* @tags User Profit Loss
|
|
2414
|
+
* @name Report
|
|
2415
|
+
* @summary Report
|
|
2416
|
+
* @request GET:/user/pal/report
|
|
2591
2417
|
* @secure
|
|
2592
2418
|
*/
|
|
2593
|
-
|
|
2594
|
-
/** @example "
|
|
2595
|
-
|
|
2419
|
+
report(query?: {
|
|
2420
|
+
/** @example "643eaa24e00691406cbaa72f" */
|
|
2421
|
+
requestId?: any;
|
|
2596
2422
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2597
2423
|
}
|
|
2598
2424
|
export class User<HandleError extends boolean = boolean> {
|
|
@@ -4349,6 +4175,24 @@ export class TransfersWires<HandleError extends boolean = boolean> {
|
|
|
4349
4175
|
disbursementType?: any;
|
|
4350
4176
|
/** @example 1234 */
|
|
4351
4177
|
entryId?: any;
|
|
4178
|
+
intermediary?: {
|
|
4179
|
+
/** @example "{account number}" */
|
|
4180
|
+
account?: string;
|
|
4181
|
+
address?: {
|
|
4182
|
+
/** @example "Central City" */
|
|
4183
|
+
city?: string;
|
|
4184
|
+
/** @example "USA" */
|
|
4185
|
+
country?: string;
|
|
4186
|
+
/** @example "11235" */
|
|
4187
|
+
postalCode?: string;
|
|
4188
|
+
/** @example "ST" */
|
|
4189
|
+
stateProvince?: string;
|
|
4190
|
+
/** @example ["123 Main St"] */
|
|
4191
|
+
streetAddress?: string[];
|
|
4192
|
+
};
|
|
4193
|
+
/** @example "{name on account}" */
|
|
4194
|
+
name?: string;
|
|
4195
|
+
};
|
|
4352
4196
|
/** @example false */
|
|
4353
4197
|
international?: any;
|
|
4354
4198
|
iraDetails?: {
|
|
@@ -4770,90 +4614,239 @@ export class Transfers<HandleError extends boolean = boolean> {
|
|
|
4770
4614
|
symbol?: any;
|
|
4771
4615
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4772
4616
|
/**
|
|
4773
|
-
* @tags Transfers
|
|
4774
|
-
* @name ListFees
|
|
4775
|
-
* @summary List fees
|
|
4776
|
-
* @request GET:/transfer/fees/classifications/fees
|
|
4617
|
+
* @tags Transfers
|
|
4618
|
+
* @name ListFees
|
|
4619
|
+
* @summary List fees
|
|
4620
|
+
* @request GET:/transfer/fees/classifications/fees
|
|
4621
|
+
* @secure
|
|
4622
|
+
*/
|
|
4623
|
+
listFees(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4624
|
+
/**
|
|
4625
|
+
* @tags Transfers
|
|
4626
|
+
* @name ListCredits
|
|
4627
|
+
* @summary List credits
|
|
4628
|
+
* @request GET:/transfer/fees/classifications/credits
|
|
4629
|
+
* @secure
|
|
4630
|
+
*/
|
|
4631
|
+
listCredits(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4632
|
+
/**
|
|
4633
|
+
* @tags Transfers
|
|
4634
|
+
* @name CryptoDepositAddress
|
|
4635
|
+
* @summary Crypto Deposit Address
|
|
4636
|
+
* @request GET:/transfer/crypto/deposit/wallet/address
|
|
4637
|
+
* @secure
|
|
4638
|
+
*/
|
|
4639
|
+
cryptoDepositAddress(data: {
|
|
4640
|
+
/** @example "AB123456" */
|
|
4641
|
+
account?: any;
|
|
4642
|
+
/** @example "BTC" */
|
|
4643
|
+
currency?: any;
|
|
4644
|
+
/** @example "{optional}" */
|
|
4645
|
+
network?: any;
|
|
4646
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4647
|
+
/**
|
|
4648
|
+
* @tags Transfers
|
|
4649
|
+
* @name CryptoWithdrawalEstimate
|
|
4650
|
+
* @summary Crypto Withdrawal Estimate
|
|
4651
|
+
* @request POST:/transfer/crypto/withdrawal/estimate
|
|
4652
|
+
* @secure
|
|
4653
|
+
*/
|
|
4654
|
+
cryptoWithdrawalEstimate(data: {
|
|
4655
|
+
/** @example "BTC" */
|
|
4656
|
+
currency?: any;
|
|
4657
|
+
/** @example "{optional}" */
|
|
4658
|
+
network?: any;
|
|
4659
|
+
/** @example "0.1" */
|
|
4660
|
+
quantity?: any;
|
|
4661
|
+
/** @example "{optional}" */
|
|
4662
|
+
wallet?: any;
|
|
4663
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4664
|
+
/**
|
|
4665
|
+
* @tags Transfers
|
|
4666
|
+
* @name CryptoWithdrawal
|
|
4667
|
+
* @summary Crypto Withdrawal
|
|
4668
|
+
* @request POST:/transfer/crypto/withdraw
|
|
4669
|
+
* @secure
|
|
4670
|
+
*/
|
|
4671
|
+
cryptoWithdrawal(data: {
|
|
4672
|
+
/** @example "AB123456" */
|
|
4673
|
+
account?: any;
|
|
4674
|
+
/** @example "BTC" */
|
|
4675
|
+
currency?: any;
|
|
4676
|
+
/** @example "{optional}" */
|
|
4677
|
+
estimateExtension?: any;
|
|
4678
|
+
/** @example "abc123" */
|
|
4679
|
+
estimateId?: any;
|
|
4680
|
+
/** @example "{optional}" */
|
|
4681
|
+
network?: any;
|
|
4682
|
+
/** @example 0.1 */
|
|
4683
|
+
quantity?: any;
|
|
4684
|
+
/** @example "{conditional}" */
|
|
4685
|
+
recipientFirstName?: any;
|
|
4686
|
+
/** @example "{conditional}" */
|
|
4687
|
+
recipientLastName?: any;
|
|
4688
|
+
/** @example "{optional} 1.1.1.1" */
|
|
4689
|
+
remoteAddr?: any;
|
|
4690
|
+
/** @example "{optional} Some phone" */
|
|
4691
|
+
remoteDevice?: any;
|
|
4692
|
+
/** @example "{optional} true|false" */
|
|
4693
|
+
selfHosted?: any;
|
|
4694
|
+
/** @example "{optional}" */
|
|
4695
|
+
tag?: any;
|
|
4696
|
+
/** @example "{conditional}" */
|
|
4697
|
+
vaspName?: any;
|
|
4698
|
+
/** @example "wallet address" */
|
|
4699
|
+
wallet?: any;
|
|
4700
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4701
|
+
}
|
|
4702
|
+
export class Documents<HandleError extends boolean = boolean> {
|
|
4703
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4704
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4705
|
+
/**
|
|
4706
|
+
* @tags Documents
|
|
4707
|
+
* @name Confirm
|
|
4708
|
+
* @summary Confirm
|
|
4709
|
+
* @request GET:/documents/confirm
|
|
4710
|
+
* @secure
|
|
4711
|
+
*/
|
|
4712
|
+
confirm(query?: {
|
|
4713
|
+
/**
|
|
4714
|
+
* *_accountNumber_ is accepted as well*
|
|
4715
|
+
* @example "5VA0XXXX"
|
|
4716
|
+
*/
|
|
4717
|
+
account?: any;
|
|
4718
|
+
/**
|
|
4719
|
+
* Date for the confirm. The required date format is: mm/dd/yyyy.
|
|
4720
|
+
* @example "03/03/2018"
|
|
4721
|
+
*/
|
|
4722
|
+
date?: any;
|
|
4723
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4724
|
+
/**
|
|
4725
|
+
* @tags Documents
|
|
4726
|
+
* @name ListOfConfirms
|
|
4727
|
+
* @summary List of Confirms
|
|
4728
|
+
* @request GET:/documents/confirm/list
|
|
4729
|
+
* @secure
|
|
4730
|
+
*/
|
|
4731
|
+
listOfConfirms(query?: {
|
|
4732
|
+
/**
|
|
4733
|
+
* *_accountNumber_ is accepted as well*
|
|
4734
|
+
* @example "5VA0XXXX"
|
|
4735
|
+
*/
|
|
4736
|
+
account?: any;
|
|
4737
|
+
/**
|
|
4738
|
+
* Start date for the list of confirms. The required date format is: `mm/dd/yyyy`.
|
|
4739
|
+
* @example "01/01/2017"
|
|
4740
|
+
*/
|
|
4741
|
+
beginDate?: any;
|
|
4742
|
+
/**
|
|
4743
|
+
* End date for the list of confirms. The required date format is: `mm/dd/yyyy`.
|
|
4744
|
+
* @example "03/01/2018"
|
|
4745
|
+
*/
|
|
4746
|
+
endDate?: any;
|
|
4747
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4748
|
+
/**
|
|
4749
|
+
* @tags Documents
|
|
4750
|
+
* @name ServiceDocs
|
|
4751
|
+
* @summary Service Docs
|
|
4752
|
+
* @request GET:/documents/service
|
|
4753
|
+
* @secure
|
|
4754
|
+
*/
|
|
4755
|
+
serviceDocs(query?: {
|
|
4756
|
+
/** @example "5VA0XXXX" */
|
|
4757
|
+
accountNumber?: any;
|
|
4758
|
+
/** See table for details. Leave blank for all document types. */
|
|
4759
|
+
docType?: any;
|
|
4760
|
+
/**
|
|
4761
|
+
* The beginning 2-digit month (MM) to be used as search criteria.
|
|
4762
|
+
* @example "01"
|
|
4763
|
+
*/
|
|
4764
|
+
beginMonth?: any;
|
|
4765
|
+
/**
|
|
4766
|
+
* The beginning 4-digit year (YYYY) to be used as search criteria.
|
|
4767
|
+
* @example "2012"
|
|
4768
|
+
*/
|
|
4769
|
+
beginYear?: any;
|
|
4770
|
+
/**
|
|
4771
|
+
* The ending 2-digit month (MM) to be used as search criteria.
|
|
4772
|
+
* @example "12"
|
|
4773
|
+
*/
|
|
4774
|
+
endMonth?: any;
|
|
4775
|
+
/**
|
|
4776
|
+
* The ending 4-digit year (YYYY) to be used as search criteria.
|
|
4777
|
+
* @example "2017"
|
|
4778
|
+
*/
|
|
4779
|
+
endYear?: any;
|
|
4780
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4781
|
+
/**
|
|
4782
|
+
* @tags Documents
|
|
4783
|
+
* @name DocumentList
|
|
4784
|
+
* @summary Document list
|
|
4785
|
+
* @request GET:/documents/list
|
|
4786
|
+
* @secure
|
|
4787
|
+
*/
|
|
4788
|
+
documentList(query?: {
|
|
4789
|
+
/** @example "5VA0XXXX" */
|
|
4790
|
+
account?: any;
|
|
4791
|
+
/**
|
|
4792
|
+
* Omit for all document types.
|
|
4793
|
+
* @example "All"
|
|
4794
|
+
*/
|
|
4795
|
+
documentType?: any;
|
|
4796
|
+
/**
|
|
4797
|
+
* Indicates start month & year (day of month is not used)
|
|
4798
|
+
* @example "1/1/2021"
|
|
4799
|
+
*/
|
|
4800
|
+
fromMonth?: any;
|
|
4801
|
+
/**
|
|
4802
|
+
* Indicates end month & year (day of month is not used)
|
|
4803
|
+
* @example "12/1/2021"
|
|
4804
|
+
*/
|
|
4805
|
+
toMonth?: any;
|
|
4806
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4807
|
+
/**
|
|
4808
|
+
* @tags Documents
|
|
4809
|
+
* @name AvailableDocumentTypes
|
|
4810
|
+
* @summary Available document types
|
|
4811
|
+
* @request GET:/documents/types
|
|
4777
4812
|
* @secure
|
|
4778
4813
|
*/
|
|
4779
|
-
|
|
4814
|
+
availableDocumentTypes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4780
4815
|
/**
|
|
4781
|
-
* @tags
|
|
4782
|
-
* @name
|
|
4783
|
-
* @summary
|
|
4784
|
-
* @request GET:/
|
|
4816
|
+
* @tags Documents
|
|
4817
|
+
* @name AvailableDocumentTypesAndCodes
|
|
4818
|
+
* @summary Available document types and codes
|
|
4819
|
+
* @request GET:/documents/typesAndCodes
|
|
4785
4820
|
* @secure
|
|
4786
4821
|
*/
|
|
4787
|
-
|
|
4822
|
+
availableDocumentTypesAndCodes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4788
4823
|
/**
|
|
4789
|
-
* @tags
|
|
4790
|
-
* @name
|
|
4791
|
-
* @summary
|
|
4792
|
-
* @request GET:/
|
|
4824
|
+
* @tags Documents
|
|
4825
|
+
* @name Download
|
|
4826
|
+
* @summary Download
|
|
4827
|
+
* @request GET:/documents/download
|
|
4793
4828
|
* @secure
|
|
4794
4829
|
*/
|
|
4795
|
-
|
|
4796
|
-
/**
|
|
4830
|
+
download(query?: {
|
|
4831
|
+
/**
|
|
4832
|
+
* Account Number
|
|
4833
|
+
* @example "{accountNumber}"
|
|
4834
|
+
*/
|
|
4797
4835
|
account?: any;
|
|
4798
|
-
/**
|
|
4799
|
-
|
|
4800
|
-
|
|
4801
|
-
|
|
4802
|
-
|
|
4803
|
-
/**
|
|
4804
|
-
* @tags Transfers
|
|
4805
|
-
* @name CryptoWithdrawalEstimate
|
|
4806
|
-
* @summary Crypto Withdrawal Estimate
|
|
4807
|
-
* @request POST:/transfer/crypto/withdrawal/estimate
|
|
4808
|
-
* @secure
|
|
4809
|
-
*/
|
|
4810
|
-
cryptoWithdrawalEstimate(data: {
|
|
4811
|
-
/** @example "BTC" */
|
|
4812
|
-
currency?: any;
|
|
4813
|
-
/** @example "{optional}" */
|
|
4814
|
-
network?: any;
|
|
4815
|
-
/** @example "0.1" */
|
|
4816
|
-
quantity?: any;
|
|
4817
|
-
/** @example "{optional}" */
|
|
4818
|
-
wallet?: any;
|
|
4836
|
+
/**
|
|
4837
|
+
* UUID for finding specific document
|
|
4838
|
+
* @example "{key}"
|
|
4839
|
+
*/
|
|
4840
|
+
key?: any;
|
|
4819
4841
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4820
4842
|
/**
|
|
4821
|
-
* @tags
|
|
4822
|
-
* @name
|
|
4823
|
-
* @summary
|
|
4824
|
-
* @request
|
|
4843
|
+
* @tags Documents
|
|
4844
|
+
* @name GetAllBranchDocuments
|
|
4845
|
+
* @summary Get all Branch Documents
|
|
4846
|
+
* @request GET:/documents/branch/list
|
|
4825
4847
|
* @secure
|
|
4826
4848
|
*/
|
|
4827
|
-
|
|
4828
|
-
/** @example "AB123456" */
|
|
4829
|
-
account?: any;
|
|
4830
|
-
/** @example "BTC" */
|
|
4831
|
-
currency?: any;
|
|
4832
|
-
/** @example "{optional}" */
|
|
4833
|
-
estimateExtension?: any;
|
|
4834
|
-
/** @example "abc123" */
|
|
4835
|
-
estimateId?: any;
|
|
4836
|
-
/** @example "{optional}" */
|
|
4837
|
-
network?: any;
|
|
4838
|
-
/** @example 0.1 */
|
|
4839
|
-
quantity?: any;
|
|
4840
|
-
/** @example "{conditional}" */
|
|
4841
|
-
recipientFirstName?: any;
|
|
4842
|
-
/** @example "{conditional}" */
|
|
4843
|
-
recipientLastName?: any;
|
|
4844
|
-
/** @example "{optional} 1.1.1.1" */
|
|
4845
|
-
remoteAddr?: any;
|
|
4846
|
-
/** @example "{optional} Some phone" */
|
|
4847
|
-
remoteDevice?: any;
|
|
4848
|
-
/** @example "{optional} true|false" */
|
|
4849
|
-
selfHosted?: any;
|
|
4850
|
-
/** @example "{optional}" */
|
|
4851
|
-
tag?: any;
|
|
4852
|
-
/** @example "{conditional}" */
|
|
4853
|
-
vaspName?: any;
|
|
4854
|
-
/** @example "wallet address" */
|
|
4855
|
-
wallet?: any;
|
|
4856
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4849
|
+
getAllBranchDocuments(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4857
4850
|
}
|
|
4858
4851
|
export class Miscellaneous<HandleError extends boolean = boolean> {
|
|
4859
4852
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -5019,23 +5012,222 @@ export class Miscellaneous<HandleError extends boolean = boolean> {
|
|
|
5019
5012
|
* @request GET:/general/tradable-currencies
|
|
5020
5013
|
* @secure
|
|
5021
5014
|
*/
|
|
5022
|
-
tradableCurrencyList(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5015
|
+
tradableCurrencyList(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5016
|
+
/**
|
|
5017
|
+
* @tags Miscellaneous
|
|
5018
|
+
* @name OptionStrategyTypes
|
|
5019
|
+
* @summary Option Strategy Types
|
|
5020
|
+
* @request GET:/general/options/strategyTypes
|
|
5021
|
+
* @secure
|
|
5022
|
+
*/
|
|
5023
|
+
optionStrategyTypes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5024
|
+
/**
|
|
5025
|
+
* @tags Miscellaneous
|
|
5026
|
+
* @name OptionStrategyClassifications
|
|
5027
|
+
* @summary Option Strategy Classifications
|
|
5028
|
+
* @request GET:/general/options/strategyClassifications
|
|
5029
|
+
* @secure
|
|
5030
|
+
*/
|
|
5031
|
+
optionStrategyClassifications(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5032
|
+
}
|
|
5033
|
+
export class Branch<HandleError extends boolean = boolean> {
|
|
5034
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5035
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5036
|
+
/**
|
|
5037
|
+
* @tags Branch
|
|
5038
|
+
* @name BranchRtb
|
|
5039
|
+
* @request GET:/v1/branch/rtb
|
|
5040
|
+
* @secure
|
|
5041
|
+
*/
|
|
5042
|
+
branchRtb(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5043
|
+
/**
|
|
5044
|
+
* @tags Branch
|
|
5045
|
+
* @name BranchRtbs
|
|
5046
|
+
* @request GET:/v1/branch/rtbs
|
|
5047
|
+
* @secure
|
|
5048
|
+
*/
|
|
5049
|
+
branchRtbs(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5050
|
+
/**
|
|
5051
|
+
* @tags Branch
|
|
5052
|
+
* @name BranchInventory
|
|
5053
|
+
* @request GET:/v1/branch/inventory
|
|
5054
|
+
* @secure
|
|
5055
|
+
*/
|
|
5056
|
+
branchInventory(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5057
|
+
/**
|
|
5058
|
+
* @tags Branch
|
|
5059
|
+
* @name BranchRtbsTotal
|
|
5060
|
+
* @request GET:/v1/branch/rtbs/total
|
|
5061
|
+
* @secure
|
|
5062
|
+
*/
|
|
5063
|
+
branchRtbsTotal(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5064
|
+
/**
|
|
5065
|
+
* @tags Branch
|
|
5066
|
+
* @name BranchPortfolio
|
|
5067
|
+
* @request GET:/v1/branch/portfolio
|
|
5068
|
+
* @secure
|
|
5069
|
+
*/
|
|
5070
|
+
branchPortfolio(query?: {
|
|
5071
|
+
/**
|
|
5072
|
+
* (true or false) Allows for loading of quotes for each portfolio entry. Defaults to false.
|
|
5073
|
+
* @example "false"
|
|
5074
|
+
*/
|
|
5075
|
+
loadQuotes?: any;
|
|
5076
|
+
/** @example "false" */
|
|
5077
|
+
loadIndustries?: any;
|
|
5078
|
+
/** @example "false" */
|
|
5079
|
+
loadUpgrades?: any;
|
|
5080
|
+
/** @example "false" */
|
|
5081
|
+
loadEarnings?: any;
|
|
5082
|
+
/**
|
|
5083
|
+
* Load balances for weight
|
|
5084
|
+
* @example "false"
|
|
5085
|
+
*/
|
|
5086
|
+
loadRtb?: any;
|
|
5087
|
+
/**
|
|
5088
|
+
* Analyze market caps and get `marketCapWeights`. To be used in conjuction with `loadQuotes`
|
|
5089
|
+
* @example "false"
|
|
5090
|
+
*/
|
|
5091
|
+
marketCapBreakdown?: any;
|
|
5092
|
+
/**
|
|
5093
|
+
* Combined portfolio for the branch
|
|
5094
|
+
* @example "false"
|
|
5095
|
+
*/
|
|
5096
|
+
combined?: any;
|
|
5097
|
+
/** @example "1" */
|
|
5098
|
+
pageNum?: any;
|
|
5099
|
+
/** @example "100" */
|
|
5100
|
+
pageSize?: any;
|
|
5101
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5102
|
+
/**
|
|
5103
|
+
* @tags Branch
|
|
5104
|
+
* @name OptionExpirations
|
|
5105
|
+
* @summary Option expirations
|
|
5106
|
+
* @request GET:/v1/branch/portfolio/options/upcoming
|
|
5107
|
+
* @secure
|
|
5108
|
+
*/
|
|
5109
|
+
optionExpirations(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5110
|
+
/**
|
|
5111
|
+
* @tags Branch
|
|
5112
|
+
* @name OptionExpirationsDetails
|
|
5113
|
+
* @summary Option expirations details
|
|
5114
|
+
* @request POST:/v1/branch/portfolio/options/upcoming/details
|
|
5115
|
+
* @secure
|
|
5116
|
+
*/
|
|
5117
|
+
optionExpirationsDetails(data: {
|
|
5118
|
+
/** @example "true|false" */
|
|
5119
|
+
loadQuotes?: any;
|
|
5120
|
+
/** @example "01/15/2021 00:00:00 EST" */
|
|
5121
|
+
maturity?: any;
|
|
5122
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5123
|
+
}
|
|
5124
|
+
export class LegalDocuments<HandleError extends boolean = boolean> {
|
|
5125
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5126
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5127
|
+
/**
|
|
5128
|
+
* @tags Legal Documents
|
|
5129
|
+
* @name DocumentClassifications
|
|
5130
|
+
* @summary Document classifications
|
|
5131
|
+
* @request GET:/user/legal/classifications
|
|
5132
|
+
* @secure
|
|
5133
|
+
*/
|
|
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?: {
|
|
5143
|
+
/**
|
|
5144
|
+
* {optional}
|
|
5145
|
+
* @example "TermsOfUse"
|
|
5146
|
+
*/
|
|
5147
|
+
classification?: any;
|
|
5148
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5149
|
+
/**
|
|
5150
|
+
* @tags Legal Documents
|
|
5151
|
+
* @name PolicyValues
|
|
5152
|
+
* @summary Policy values
|
|
5153
|
+
* @request GET:/user/legal/policies/listing/{type}
|
|
5154
|
+
* @secure
|
|
5155
|
+
*/
|
|
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;
|
|
5167
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5168
|
+
/**
|
|
5169
|
+
* @tags Legal Documents
|
|
5170
|
+
* @name DocumentDownload
|
|
5171
|
+
* @summary Document download
|
|
5172
|
+
* @request GET:/user/legal/document/download
|
|
5173
|
+
* @secure
|
|
5174
|
+
*/
|
|
5175
|
+
documentDownload(query?: {
|
|
5176
|
+
/** @example "{as provided}" */
|
|
5177
|
+
id?: any;
|
|
5178
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5023
5179
|
/**
|
|
5024
|
-
* @tags
|
|
5025
|
-
* @name
|
|
5026
|
-
* @summary
|
|
5027
|
-
* @request
|
|
5180
|
+
* @tags Legal Documents
|
|
5181
|
+
* @name SignTheDocument
|
|
5182
|
+
* @summary Sign the document
|
|
5183
|
+
* @request POST:/user/legal/document/sign
|
|
5028
5184
|
* @secure
|
|
5029
5185
|
*/
|
|
5030
|
-
|
|
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;
|
|
5201
|
+
/** @example "" */
|
|
5202
|
+
remoteAddr?: any;
|
|
5203
|
+
/** @example "{required}" */
|
|
5204
|
+
remoteDevice?: any;
|
|
5205
|
+
/** @example "{required}" */
|
|
5206
|
+
signature?: any;
|
|
5207
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5031
5208
|
/**
|
|
5032
|
-
* @tags
|
|
5033
|
-
* @name
|
|
5034
|
-
* @summary
|
|
5035
|
-
* @request
|
|
5209
|
+
* @tags Legal Documents
|
|
5210
|
+
* @name UpdatesPolicyOnTheAccount
|
|
5211
|
+
* @summary Updates policy on the account
|
|
5212
|
+
* @request POST:/user/legal/policy/{type}
|
|
5036
5213
|
* @secure
|
|
5037
5214
|
*/
|
|
5038
|
-
|
|
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>>;
|
|
5039
5231
|
}
|
|
5040
5232
|
export class BlacklistAdminBusinesses<HandleError extends boolean = boolean> {
|
|
5041
5233
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -5257,218 +5449,19 @@ export class BlacklistAdminIndividuals<HandleError extends boolean = boolean> {
|
|
|
5257
5449
|
street?: any;
|
|
5258
5450
|
/** @example "Mr." */
|
|
5259
5451
|
suffix?: any;
|
|
5260
|
-
/** @example "305178" */
|
|
5261
|
-
tracking_number?: any;
|
|
5262
|
-
/** @example "11358" */
|
|
5263
|
-
zip?: any;
|
|
5264
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5265
|
-
/**
|
|
5266
|
-
* @tags Blacklist Admin Individuals
|
|
5267
|
-
* @name DeleteIndividual
|
|
5268
|
-
* @summary Delete Individual
|
|
5269
|
-
* @request DELETE:/v1/admin/individuals/{id}
|
|
5270
|
-
* @secure
|
|
5271
|
-
*/
|
|
5272
|
-
deleteIndividual(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5273
|
-
}
|
|
5274
|
-
export class Branch<HandleError extends boolean = boolean> {
|
|
5275
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5276
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5277
|
-
/**
|
|
5278
|
-
* @tags Branch
|
|
5279
|
-
* @name BranchRtb
|
|
5280
|
-
* @request GET:/v1/branch/rtb
|
|
5281
|
-
* @secure
|
|
5282
|
-
*/
|
|
5283
|
-
branchRtb(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5284
|
-
/**
|
|
5285
|
-
* @tags Branch
|
|
5286
|
-
* @name BranchRtbs
|
|
5287
|
-
* @request GET:/v1/branch/rtbs
|
|
5288
|
-
* @secure
|
|
5289
|
-
*/
|
|
5290
|
-
branchRtbs(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5291
|
-
/**
|
|
5292
|
-
* @tags Branch
|
|
5293
|
-
* @name BranchInventory
|
|
5294
|
-
* @request GET:/v1/branch/inventory
|
|
5295
|
-
* @secure
|
|
5296
|
-
*/
|
|
5297
|
-
branchInventory(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5298
|
-
/**
|
|
5299
|
-
* @tags Branch
|
|
5300
|
-
* @name BranchRtbsTotal
|
|
5301
|
-
* @request GET:/v1/branch/rtbs/total
|
|
5302
|
-
* @secure
|
|
5303
|
-
*/
|
|
5304
|
-
branchRtbsTotal(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5305
|
-
/**
|
|
5306
|
-
* @tags Branch
|
|
5307
|
-
* @name BranchPortfolio
|
|
5308
|
-
* @request GET:/v1/branch/portfolio
|
|
5309
|
-
* @secure
|
|
5310
|
-
*/
|
|
5311
|
-
branchPortfolio(query?: {
|
|
5312
|
-
/**
|
|
5313
|
-
* (true or false) Allows for loading of quotes for each portfolio entry. Defaults to false.
|
|
5314
|
-
* @example "false"
|
|
5315
|
-
*/
|
|
5316
|
-
loadQuotes?: any;
|
|
5317
|
-
/** @example "false" */
|
|
5318
|
-
loadIndustries?: any;
|
|
5319
|
-
/** @example "false" */
|
|
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;
|
|
5442
|
-
/** @example "" */
|
|
5443
|
-
remoteAddr?: any;
|
|
5444
|
-
/** @example "{required}" */
|
|
5445
|
-
remoteDevice?: any;
|
|
5446
|
-
/** @example "{required}" */
|
|
5447
|
-
signature?: any;
|
|
5452
|
+
/** @example "305178" */
|
|
5453
|
+
tracking_number?: any;
|
|
5454
|
+
/** @example "11358" */
|
|
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 Individuals
|
|
5459
|
+
* @name DeleteIndividual
|
|
5460
|
+
* @summary Delete Individual
|
|
5461
|
+
* @request DELETE:/v1/admin/individuals/{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
|
+
deleteIndividual(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,6 +5505,35 @@ export class BlacklistSearch<HandleError extends boolean = boolean> {
|
|
|
5512
5505
|
};
|
|
5513
5506
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5514
5507
|
}
|
|
5508
|
+
export class Blacklist<HandleError extends boolean = boolean> {
|
|
5509
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5510
|
+
adminBusinesses: BlacklistAdminBusinesses<HandleError>;
|
|
5511
|
+
adminIndividuals: BlacklistAdminIndividuals<HandleError>;
|
|
5512
|
+
search: BlacklistSearch<HandleError>;
|
|
5513
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5514
|
+
/**
|
|
5515
|
+
* @tags Blacklist
|
|
5516
|
+
* @name UploadBlacklistCsv
|
|
5517
|
+
* @summary Upload Blacklist CSV
|
|
5518
|
+
* @request POST:/v1/csv/upload
|
|
5519
|
+
* @secure
|
|
5520
|
+
*/
|
|
5521
|
+
uploadBlacklistCsv(data: {
|
|
5522
|
+
/**
|
|
5523
|
+
* (Required) file with info to upload
|
|
5524
|
+
* @format binary
|
|
5525
|
+
*/
|
|
5526
|
+
file_field?: File;
|
|
5527
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5528
|
+
/**
|
|
5529
|
+
* @tags Blacklist
|
|
5530
|
+
* @name GetHealth
|
|
5531
|
+
* @summary Get Health
|
|
5532
|
+
* @request GET:/v1/healthz
|
|
5533
|
+
* @secure
|
|
5534
|
+
*/
|
|
5535
|
+
getHealth(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5536
|
+
}
|
|
5515
5537
|
export class Broker<HandleError extends boolean = boolean> {
|
|
5516
5538
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5517
5539
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5555,35 +5577,6 @@ export class Broker<HandleError extends boolean = boolean> {
|
|
|
5555
5577
|
pageSize?: any;
|
|
5556
5578
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5557
5579
|
}
|
|
5558
|
-
export class Blacklist<HandleError extends boolean = boolean> {
|
|
5559
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5560
|
-
adminBusinesses: BlacklistAdminBusinesses<HandleError>;
|
|
5561
|
-
adminIndividuals: BlacklistAdminIndividuals<HandleError>;
|
|
5562
|
-
search: BlacklistSearch<HandleError>;
|
|
5563
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5564
|
-
/**
|
|
5565
|
-
* @tags Blacklist
|
|
5566
|
-
* @name UploadBlacklistCsv
|
|
5567
|
-
* @summary Upload Blacklist CSV
|
|
5568
|
-
* @request POST:/v1/csv/upload
|
|
5569
|
-
* @secure
|
|
5570
|
-
*/
|
|
5571
|
-
uploadBlacklistCsv(data: {
|
|
5572
|
-
/**
|
|
5573
|
-
* (Required) file with info to upload
|
|
5574
|
-
* @format binary
|
|
5575
|
-
*/
|
|
5576
|
-
file_field?: File;
|
|
5577
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5578
|
-
/**
|
|
5579
|
-
* @tags Blacklist
|
|
5580
|
-
* @name GetHealth
|
|
5581
|
-
* @summary Get Health
|
|
5582
|
-
* @request GET:/v1/healthz
|
|
5583
|
-
* @secure
|
|
5584
|
-
*/
|
|
5585
|
-
getHealth(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5586
|
-
}
|
|
5587
5580
|
export class WatchmenFfiUserAccountManagement<HandleError extends boolean = boolean> {
|
|
5588
5581
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5589
5582
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5723,16 +5716,6 @@ export class WatchmenFfiUserAccountManagement<HandleError extends boolean = bool
|
|
|
5723
5716
|
onlyActiveUser?: any;
|
|
5724
5717
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5725
5718
|
}
|
|
5726
|
-
export class Advisory<HandleError extends boolean = boolean> {
|
|
5727
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5728
|
-
charges: AdvisoryCharges<HandleError>;
|
|
5729
|
-
models: AdvisoryModels<HandleError>;
|
|
5730
|
-
userAccountManagement: AdvisoryUserAccountManagement<HandleError>;
|
|
5731
|
-
groups: AdvisoryGroups<HandleError>;
|
|
5732
|
-
analytics: AdvisoryAnalytics<HandleError>;
|
|
5733
|
-
allocations: AdvisoryAllocations<HandleError>;
|
|
5734
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5735
|
-
}
|
|
5736
5719
|
export class WatchmenFfiFirmBranch<HandleError extends boolean = boolean> {
|
|
5737
5720
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5738
5721
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5908,160 +5891,21 @@ export class WatchmenFfiFirmBranch<HandleError extends boolean = boolean> {
|
|
|
5908
5891
|
id?: any;
|
|
5909
5892
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5910
5893
|
}
|
|
5911
|
-
export class
|
|
5894
|
+
export class Advisory<HandleError extends boolean = boolean> {
|
|
5912
5895
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5913
|
-
|
|
5914
|
-
|
|
5896
|
+
charges: AdvisoryCharges<HandleError>;
|
|
5897
|
+
models: AdvisoryModels<HandleError>;
|
|
5898
|
+
userAccountManagement: AdvisoryUserAccountManagement<HandleError>;
|
|
5899
|
+
groups: AdvisoryGroups<HandleError>;
|
|
5900
|
+
analytics: AdvisoryAnalytics<HandleError>;
|
|
5901
|
+
allocations: AdvisoryAllocations<HandleError>;
|
|
5915
5902
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5916
5903
|
}
|
|
5917
|
-
export class
|
|
5904
|
+
export class WatchmenFfi<HandleError extends boolean = boolean> {
|
|
5918
5905
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5906
|
+
userAccountManagement: WatchmenFfiUserAccountManagement<HandleError>;
|
|
5907
|
+
firmBranch: WatchmenFfiFirmBranch<HandleError>;
|
|
5919
5908
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5920
|
-
/**
|
|
5921
|
-
* @tags Documents
|
|
5922
|
-
* @name Confirm
|
|
5923
|
-
* @summary Confirm
|
|
5924
|
-
* @request GET:/documents/confirm
|
|
5925
|
-
* @secure
|
|
5926
|
-
*/
|
|
5927
|
-
confirm(query?: {
|
|
5928
|
-
/**
|
|
5929
|
-
* *_accountNumber_ is accepted as well*
|
|
5930
|
-
* @example "5VA0XXXX"
|
|
5931
|
-
*/
|
|
5932
|
-
account?: any;
|
|
5933
|
-
/**
|
|
5934
|
-
* Date for the confirm. The required date format is: mm/dd/yyyy.
|
|
5935
|
-
* @example "03/03/2018"
|
|
5936
|
-
*/
|
|
5937
|
-
date?: any;
|
|
5938
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5939
|
-
/**
|
|
5940
|
-
* @tags Documents
|
|
5941
|
-
* @name ListOfConfirms
|
|
5942
|
-
* @summary List of Confirms
|
|
5943
|
-
* @request GET:/documents/confirm/list
|
|
5944
|
-
* @secure
|
|
5945
|
-
*/
|
|
5946
|
-
listOfConfirms(query?: {
|
|
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>>;
|
|
5963
|
-
/**
|
|
5964
|
-
* @tags Documents
|
|
5965
|
-
* @name ServiceDocs
|
|
5966
|
-
* @summary Service Docs
|
|
5967
|
-
* @request GET:/documents/service
|
|
5968
|
-
* @secure
|
|
5969
|
-
*/
|
|
5970
|
-
serviceDocs(query?: {
|
|
5971
|
-
/** @example "5VA0XXXX" */
|
|
5972
|
-
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
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5996
|
-
/**
|
|
5997
|
-
* @tags Documents
|
|
5998
|
-
* @name DocumentList
|
|
5999
|
-
* @summary Document list
|
|
6000
|
-
* @request GET:/documents/list
|
|
6001
|
-
* @secure
|
|
6002
|
-
*/
|
|
6003
|
-
documentList(query?: {
|
|
6004
|
-
/** @example "5VA0XXXX" */
|
|
6005
|
-
account?: any;
|
|
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;
|
|
6021
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
6022
|
-
/**
|
|
6023
|
-
* @tags Documents
|
|
6024
|
-
* @name AvailableDocumentTypes
|
|
6025
|
-
* @summary Available document types
|
|
6026
|
-
* @request GET:/documents/types
|
|
6027
|
-
* @secure
|
|
6028
|
-
*/
|
|
6029
|
-
availableDocumentTypes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
6030
|
-
/**
|
|
6031
|
-
* @tags Documents
|
|
6032
|
-
* @name AvailableDocumentTypesAndCodes
|
|
6033
|
-
* @summary Available document types and codes
|
|
6034
|
-
* @request GET:/documents/typesAndCodes
|
|
6035
|
-
* @secure
|
|
6036
|
-
*/
|
|
6037
|
-
availableDocumentTypesAndCodes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
6038
|
-
/**
|
|
6039
|
-
* @tags Documents
|
|
6040
|
-
* @name Download
|
|
6041
|
-
* @summary Download
|
|
6042
|
-
* @request GET:/documents/download
|
|
6043
|
-
* @secure
|
|
6044
|
-
*/
|
|
6045
|
-
download(query?: {
|
|
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>>;
|
|
6057
|
-
/**
|
|
6058
|
-
* @tags Documents
|
|
6059
|
-
* @name GetAllBranchDocuments
|
|
6060
|
-
* @summary Get all Branch Documents
|
|
6061
|
-
* @request GET:/documents/branch/list
|
|
6062
|
-
* @secure
|
|
6063
|
-
*/
|
|
6064
|
-
getAllBranchDocuments(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
6065
5909
|
}
|
|
6066
5910
|
export class OrbisApi<HandleError extends boolean = false> extends BaseApi<HandleError, OrbisClient<HandleError>> {
|
|
6067
5911
|
readonly config: OrbisClientConfig<HandleError>;
|