@orbis-systems/orbis-api-clients 0.7.12 → 0.7.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (43) hide show
  1. package/dist/aesmidas/index.d.ts +242 -142
  2. package/dist/aesmidas/index.d.ts.map +1 -1
  3. package/dist/aesmidas/index.esm.js +1 -1
  4. package/dist/aesmidas/index.esm.js.map +1 -1
  5. package/dist/aesmidas/index.js +1 -1
  6. package/dist/aesmidas/index.js.map +1 -1
  7. package/dist/bridgewise/index.d.ts +350 -350
  8. package/dist/bridgewise/index.d.ts.map +1 -1
  9. package/dist/bridgewise/index.esm.js +1 -1
  10. package/dist/bridgewise/index.esm.js.map +1 -1
  11. package/dist/bridgewise/index.js +1 -1
  12. package/dist/bridgewise/index.js.map +1 -1
  13. package/dist/insight/index.d.ts +234 -234
  14. package/dist/insight/index.d.ts.map +1 -1
  15. package/dist/insight/index.esm.js +1 -1
  16. package/dist/insight/index.esm.js.map +1 -1
  17. package/dist/insight/index.js +1 -1
  18. package/dist/insight/index.js.map +1 -1
  19. package/dist/middleware/index.d.ts +64 -64
  20. package/dist/middleware/index.d.ts.map +1 -1
  21. package/dist/middleware/index.esm.js +1 -1
  22. package/dist/middleware/index.esm.js.map +1 -1
  23. package/dist/middleware/index.js +1 -1
  24. package/dist/middleware/index.js.map +1 -1
  25. package/dist/orbis/index.d.ts +922 -922
  26. package/dist/orbis/index.d.ts.map +1 -1
  27. package/dist/orbis/index.esm.js +1 -1
  28. package/dist/orbis/index.esm.js.map +1 -1
  29. package/dist/orbis/index.js +1 -1
  30. package/dist/orbis/index.js.map +1 -1
  31. package/dist/uma/index.d.ts +307 -307
  32. package/dist/uma/index.d.ts.map +1 -1
  33. package/dist/uma/index.esm.js +1 -1
  34. package/dist/uma/index.esm.js.map +1 -1
  35. package/dist/uma/index.js +1 -1
  36. package/dist/uma/index.js.map +1 -1
  37. package/dist/zerohash/index.d.ts +405 -405
  38. package/dist/zerohash/index.d.ts.map +1 -1
  39. package/dist/zerohash/index.esm.js +1 -1
  40. package/dist/zerohash/index.esm.js.map +1 -1
  41. package/dist/zerohash/index.js +1 -1
  42. package/dist/zerohash/index.js.map +1 -1
  43. package/package.json +1 -1
@@ -222,7 +222,7 @@ interface OrbisErrorData {
222
222
  interface OrbisClientConfig<HandleError extends boolean = boolean> extends JwtClientConfig<HandleError> {
223
223
  onLoginTimeout?: VoidFunction;
224
224
  onUnauthorized?: VoidFunction;
225
- onErrorTranslate?: (errorCode: string, reason?: string) => string;
225
+ onErrorTranslate?: (code: string) => string;
226
226
  }
227
227
  type OrbisClientResponse<Data = unknown, HandleError extends boolean = boolean> = OrbisErrorData & ClientResponse<Data, HandleError>;
228
228
  declare class OrbisClient<HandleError extends boolean = boolean> extends JwtClient<HandleError> {
@@ -588,6 +588,80 @@ export class OrdersV2FixedIncome<HandleError extends boolean = boolean> {
588
588
  };
589
589
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
590
590
  }
591
+ export class OrdersV2Crypto<HandleError extends boolean = boolean> {
592
+ protected readonly apiClient: JwtClient<HandleError>;
593
+ constructor(apiClient: JwtClient<HandleError>);
594
+ /**
595
+ * @tags Orders V2 Crypto
596
+ * @name OrderPreview
597
+ * @summary Order Preview
598
+ * @request POST:/orders/v2/crypto/preview
599
+ * @secure
600
+ */
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>>;
627
+ /**
628
+ * @tags Orders V2 Crypto
629
+ * @name OrderPlace
630
+ * @summary Order Place
631
+ * @request POST:/orders/v2/crypto/place
632
+ * @secure
633
+ */
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>>;
664
+ }
591
665
  export class OrdersV2MutualFunds<HandleError extends boolean = boolean> {
592
666
  protected readonly apiClient: JwtClient<HandleError>;
593
667
  constructor(apiClient: JwtClient<HandleError>);
@@ -791,80 +865,6 @@ export class OrdersV2Offerings<HandleError extends boolean = boolean> {
791
865
  };
792
866
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
793
867
  }
794
- export class OrdersV2Crypto<HandleError extends boolean = boolean> {
795
- protected readonly apiClient: JwtClient<HandleError>;
796
- constructor(apiClient: JwtClient<HandleError>);
797
- /**
798
- * @tags Orders V2 Crypto
799
- * @name OrderPreview
800
- * @summary Order Preview
801
- * @request POST:/orders/v2/crypto/preview
802
- * @secure
803
- */
804
- orderPreview(data: {
805
- account?: {
806
- /** @example "ABC123" */
807
- accountNumber?: string;
808
- };
809
- order?: {
810
- /** @example 100 */
811
- expectedValue?: number;
812
- /** @example 1.123 */
813
- limitPx?: number;
814
- /** @example "MARKET|LIMIT|STOP|STOP_LIMIG|Notional|NotionalLimit" */
815
- orderType?: string;
816
- /** @example 0.0123 */
817
- quantity?: number;
818
- quote?: {
819
- /** @example "BTC/USD" */
820
- symbol?: string;
821
- };
822
- /** @example 1.123 */
823
- stopPx?: number;
824
- /** @example "BUY|SELL" */
825
- transaction?: string;
826
- /** @example "DAY|GTC" */
827
- validity?: string;
828
- };
829
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
830
- /**
831
- * @tags Orders V2 Crypto
832
- * @name OrderPlace
833
- * @summary Order Place
834
- * @request POST:/orders/v2/crypto/place
835
- * @secure
836
- */
837
- orderPlace(data: {
838
- account?: {
839
- /** @example "ABC123" */
840
- accountNumber?: string;
841
- };
842
- order?: {
843
- /** @example "{your own order reference number}" */
844
- clientRef?: string;
845
- /** @example "ABC" */
846
- clientSourceId?: string;
847
- /** @example 100 */
848
- expectedValue?: number;
849
- /** @example 1.123 */
850
- limitPx?: number;
851
- /** @example "MARKET|LIMIT|STOP|STOP_LIMIT|Notional|NotionalLimit" */
852
- orderType?: string;
853
- /** @example 0.0123 */
854
- quantity?: number;
855
- quote?: {
856
- /** @example "BTC/USD" */
857
- symbol?: string;
858
- };
859
- /** @example 1.123 */
860
- stopPx?: number;
861
- /** @example "BUY|SELL" */
862
- transaction?: string;
863
- /** @example "DAY|GTC" */
864
- validity?: string;
865
- };
866
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
867
- }
868
868
  export class OrdersV2<HandleError extends boolean = boolean> {
869
869
  protected readonly apiClient: JwtClient<HandleError>;
870
870
  equities: OrdersV2Equities<HandleError>;
@@ -927,6 +927,43 @@ export class OrdersV2<HandleError extends boolean = boolean> {
927
927
  };
928
928
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
929
929
  }
930
+ export class OrdersViolationManagement<HandleError extends boolean = boolean> {
931
+ protected readonly apiClient: JwtClient<HandleError>;
932
+ constructor(apiClient: JwtClient<HandleError>);
933
+ /**
934
+ * @tags Orders Violation Management
935
+ * @name GfvEquities
936
+ * @summary GFV (equities)
937
+ * @request POST:/trading/violations/gfv/equity
938
+ * @secure
939
+ */
940
+ gfvEquities(data: {
941
+ account?: {
942
+ /** @example "optional" */
943
+ accountNumber?: string;
944
+ };
945
+ order?: {
946
+ /** @example 101.5 */
947
+ expectedValue?: number;
948
+ /** @example 123.45 */
949
+ limitPrice?: number;
950
+ /** @example "PRE_MARKET|CORE_MARKET|POST_MARKET|ALL_MARKET|PRE_CORE|POST_CORE" */
951
+ marketTime?: string;
952
+ /** @example "MARKET|LIMIT|STOP|STOP_LIMIT|TRAILING_STOP|Notional|NotionalLimit" */
953
+ orderType?: string;
954
+ /** @example 123.45 */
955
+ quantity?: number;
956
+ quote?: {
957
+ /** @example "ZVZZT" */
958
+ symbol?: string;
959
+ };
960
+ /** @example 123.45 */
961
+ stopPrice?: number;
962
+ /** @example "BUY|SELL|SHORT_SELL|BUY_TO_COVER|Liquidate" */
963
+ transaction?: string;
964
+ };
965
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
966
+ }
930
967
  export class OrdersArchived<HandleError extends boolean = boolean> {
931
968
  protected readonly apiClient: JwtClient<HandleError>;
932
969
  constructor(apiClient: JwtClient<HandleError>);
@@ -1008,43 +1045,6 @@ export class OrdersArchived<HandleError extends boolean = boolean> {
1008
1045
  orderRef?: string;
1009
1046
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1010
1047
  }
1011
- export class OrdersViolationManagement<HandleError extends boolean = boolean> {
1012
- protected readonly apiClient: JwtClient<HandleError>;
1013
- constructor(apiClient: JwtClient<HandleError>);
1014
- /**
1015
- * @tags Orders Violation Management
1016
- * @name GfvEquities
1017
- * @summary GFV (equities)
1018
- * @request POST:/trading/violations/gfv/equity
1019
- * @secure
1020
- */
1021
- gfvEquities(data: {
1022
- account?: {
1023
- /** @example "optional" */
1024
- accountNumber?: string;
1025
- };
1026
- order?: {
1027
- /** @example 101.5 */
1028
- expectedValue?: number;
1029
- /** @example 123.45 */
1030
- limitPrice?: number;
1031
- /** @example "PRE_MARKET|CORE_MARKET|POST_MARKET|ALL_MARKET|PRE_CORE|POST_CORE" */
1032
- marketTime?: string;
1033
- /** @example "MARKET|LIMIT|STOP|STOP_LIMIT|TRAILING_STOP|Notional|NotionalLimit" */
1034
- orderType?: string;
1035
- /** @example 123.45 */
1036
- quantity?: number;
1037
- quote?: {
1038
- /** @example "ZVZZT" */
1039
- symbol?: string;
1040
- };
1041
- /** @example 123.45 */
1042
- stopPrice?: number;
1043
- /** @example "BUY|SELL|SHORT_SELL|BUY_TO_COVER|Liquidate" */
1044
- transaction?: string;
1045
- };
1046
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1047
- }
1048
1048
  export class Orders<HandleError extends boolean = boolean> {
1049
1049
  protected readonly apiClient: JwtClient<HandleError>;
1050
1050
  violationManagement: OrdersViolationManagement<HandleError>;
@@ -2343,51 +2343,65 @@ export class Research<HandleError extends boolean = boolean> {
2343
2343
  dates?: any;
2344
2344
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2345
2345
  }
2346
- export class UserDevice<HandleError extends boolean = boolean> {
2346
+ export class UserAgreements<HandleError extends boolean = boolean> {
2347
2347
  protected readonly apiClient: JwtClient<HandleError>;
2348
2348
  constructor(apiClient: JwtClient<HandleError>);
2349
2349
  /**
2350
- * @tags User Device
2351
- * @name Register
2352
- * @summary Register
2353
- * @request GET:/user/device/register
2350
+ * @tags User Agreements
2351
+ * @name Available
2352
+ * @summary Available
2353
+ * @request GET:/user/agreements/all/active
2354
2354
  * @secure
2355
2355
  */
2356
- register(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2356
+ available(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2357
2357
  /**
2358
- * @tags User Device
2359
- * @name Deregister
2360
- * @summary Deregister
2361
- * @request GET:/user/device/deregister
2358
+ * @tags User Agreements
2359
+ * @name Agreement
2360
+ * @summary Agreement
2361
+ * @request GET:/user/agreements/contents/{version}/{code}/body.html
2362
2362
  * @secure
2363
2363
  */
2364
- deregister(query?: {
2365
- token?: any;
2366
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2364
+ agreement(version: string, code: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2367
2365
  /**
2368
- * @tags User Device
2369
- * @name FirebaseRegistration
2370
- * @summary Firebase - registration
2371
- * @request POST:/user/device/firebase/register
2366
+ * @tags User Agreements
2367
+ * @name Unsigned
2368
+ * @summary Unsigned
2369
+ * @request GET:/user/agreements/unsigned
2372
2370
  * @secure
2373
2371
  */
2374
- firebaseRegistration(data: {
2375
- /** @example "{predfined scope name}" */
2376
- scope?: any;
2377
- /** @example "a1s2d3f4g5h6" */
2378
- token?: any;
2379
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2372
+ unsigned(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2380
2373
  /**
2381
- * @tags User Device
2382
- * @name FirebaseRemoval
2383
- * @summary Firebase - removal
2384
- * @request POST:/user/device/firebase/deregister
2374
+ * @tags User Agreements
2375
+ * @name AttestStatus
2376
+ * @summary Attest status
2377
+ * @request POST:/user/professional/attest
2385
2378
  * @secure
2386
2379
  */
2387
- firebaseRemoval(data: {
2388
- /** @example "a1s2d3f4g5h6" */
2389
- token?: any;
2390
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2380
+ attestStatus(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2381
+ /**
2382
+ * @tags User Agreements
2383
+ * @name Sign
2384
+ * @summary Sign
2385
+ * @request POST:/user/agreements/sign
2386
+ * @secure
2387
+ */
2388
+ sign(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2389
+ /**
2390
+ * @tags User Agreements
2391
+ * @name CryptoAgreement
2392
+ * @summary Crypto Agreement
2393
+ * @request GET:/user/agreements/crypto/Agreement
2394
+ * @secure
2395
+ */
2396
+ cryptoAgreement(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2397
+ /**
2398
+ * @tags User Agreements
2399
+ * @name CryptoSign
2400
+ * @summary Crypto Sign
2401
+ * @request POST:/user/agreements/crypto/sign
2402
+ * @secure
2403
+ */
2404
+ cryptoSign(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2391
2405
  }
2392
2406
  export class UserTradingLimitManagement<HandleError extends boolean = boolean> {
2393
2407
  protected readonly apiClient: JwtClient<HandleError>;
@@ -2535,65 +2549,51 @@ export class UserWatchlists<HandleError extends boolean = boolean> {
2535
2549
  */
2536
2550
  removeFromWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2537
2551
  }
2538
- export class UserAgreements<HandleError extends boolean = boolean> {
2552
+ export class UserDevice<HandleError extends boolean = boolean> {
2539
2553
  protected readonly apiClient: JwtClient<HandleError>;
2540
2554
  constructor(apiClient: JwtClient<HandleError>);
2541
2555
  /**
2542
- * @tags User Agreements
2543
- * @name Available
2544
- * @summary Available
2545
- * @request GET:/user/agreements/all/active
2546
- * @secure
2547
- */
2548
- available(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2549
- /**
2550
- * @tags User Agreements
2551
- * @name Agreement
2552
- * @summary Agreement
2553
- * @request GET:/user/agreements/contents/{version}/{code}/body.html
2554
- * @secure
2555
- */
2556
- agreement(version: string, code: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2557
- /**
2558
- * @tags User Agreements
2559
- * @name Unsigned
2560
- * @summary Unsigned
2561
- * @request GET:/user/agreements/unsigned
2562
- * @secure
2563
- */
2564
- unsigned(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2565
- /**
2566
- * @tags User Agreements
2567
- * @name AttestStatus
2568
- * @summary Attest status
2569
- * @request POST:/user/professional/attest
2556
+ * @tags User Device
2557
+ * @name Register
2558
+ * @summary Register
2559
+ * @request GET:/user/device/register
2570
2560
  * @secure
2571
2561
  */
2572
- attestStatus(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2562
+ register(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2573
2563
  /**
2574
- * @tags User Agreements
2575
- * @name Sign
2576
- * @summary Sign
2577
- * @request POST:/user/agreements/sign
2564
+ * @tags User Device
2565
+ * @name Deregister
2566
+ * @summary Deregister
2567
+ * @request GET:/user/device/deregister
2578
2568
  * @secure
2579
2569
  */
2580
- sign(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2570
+ deregister(query?: {
2571
+ token?: any;
2572
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2581
2573
  /**
2582
- * @tags User Agreements
2583
- * @name CryptoAgreement
2584
- * @summary Crypto Agreement
2585
- * @request GET:/user/agreements/crypto/Agreement
2574
+ * @tags User Device
2575
+ * @name FirebaseRegistration
2576
+ * @summary Firebase - registration
2577
+ * @request POST:/user/device/firebase/register
2586
2578
  * @secure
2587
2579
  */
2588
- cryptoAgreement(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2580
+ firebaseRegistration(data: {
2581
+ /** @example "{predfined scope name}" */
2582
+ scope?: any;
2583
+ /** @example "a1s2d3f4g5h6" */
2584
+ token?: any;
2585
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2589
2586
  /**
2590
- * @tags User Agreements
2591
- * @name CryptoSign
2592
- * @summary Crypto Sign
2593
- * @request POST:/user/agreements/crypto/sign
2587
+ * @tags User Device
2588
+ * @name FirebaseRemoval
2589
+ * @summary Firebase - removal
2590
+ * @request POST:/user/device/firebase/deregister
2594
2591
  * @secure
2595
2592
  */
2596
- cryptoSign(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2593
+ firebaseRemoval(data: {
2594
+ /** @example "a1s2d3f4g5h6" */
2595
+ token?: any;
2596
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2597
2597
  }
2598
2598
  export class User<HandleError extends boolean = boolean> {
2599
2599
  protected readonly apiClient: JwtClient<HandleError>;
@@ -3832,90 +3832,334 @@ export class Device<HandleError extends boolean = boolean> {
3832
3832
  Token?: string;
3833
3833
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3834
3834
  }
3835
- export class TransfersInstantAccountVerification<HandleError extends boolean = boolean> {
3835
+ export class TransfersRelationships<HandleError extends boolean = boolean> {
3836
3836
  protected readonly apiClient: JwtClient<HandleError>;
3837
3837
  constructor(apiClient: JwtClient<HandleError>);
3838
3838
  /**
3839
- * @tags Transfers Instant Account Verification
3840
- * @name Initiate
3841
- * @summary Initiate
3842
- * @request GET:/iav/init
3839
+ * @tags Transfers Relationships
3840
+ * @name List
3841
+ * @summary List
3842
+ * @request GET:/transfer/relationship/list/{account}
3843
3843
  * @secure
3844
3844
  */
3845
- initiate(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3845
+ list(account: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3846
3846
  /**
3847
- * @tags Transfers Instant Account Verification
3848
- * @name InitiatePost
3849
- * @summary Initiate Post
3850
- * @request POST:/iav/init
3847
+ * @tags Transfers Relationships
3848
+ * @name GetInfo
3849
+ * @summary Get Info
3850
+ * @request GET:/transfer/relationship/get
3851
3851
  * @secure
3852
3852
  */
3853
- initiatePost(query: object, data: {
3854
- /** @example "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" */
3855
- subject?: string;
3853
+ getInfo(query?: {
3854
+ /**
3855
+ * Account number
3856
+ * @example "ABC123"
3857
+ */
3858
+ account?: any;
3859
+ /**
3860
+ * Desired entry ID
3861
+ * @example "123"
3862
+ */
3863
+ entryId?: any;
3856
3864
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3857
3865
  /**
3858
- * @tags Transfers Instant Account Verification
3859
- * @name Complete
3860
- * @summary Complete
3861
- * @request POST:/iav/complete
3866
+ * @tags Transfers Relationships
3867
+ * @name PaymentMethods
3868
+ * @summary Payment methods
3869
+ * @request GET:/transfer/bank/paymentMethods
3862
3870
  * @secure
3863
3871
  */
3864
- complete(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3872
+ paymentMethods(query?: {
3873
+ /** @example "IND" */
3874
+ country?: any;
3875
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3865
3876
  /**
3866
- * @tags Transfers Instant Account Verification
3867
- * @name ListBankAccounts
3868
- * @summary List Bank Accounts
3869
- * @request POST:/iav/list
3877
+ * @tags Transfers Relationships
3878
+ * @name PaymentMethodsViaAddress
3879
+ * @summary Payment methods (via address)
3880
+ * @request POST:/transfer/bank/paymentMethods
3870
3881
  * @secure
3871
3882
  */
3872
- listBankAccounts(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3883
+ paymentMethodsViaAddress(data: {
3884
+ /** @example "Mumbai" */
3885
+ city?: any;
3886
+ /** @example "IND" */
3887
+ country?: any;
3888
+ /** @example "400018" */
3889
+ postalCode?: any;
3890
+ /** @example "Maharashtra" */
3891
+ stateProvince?: any;
3892
+ /** @example ["716 /a, Poonam Chem, Dr.annie Besant Road, Opp.atre Mall, Worli"] */
3893
+ streetAddress?: any;
3894
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3873
3895
  /**
3874
- * @tags Transfers Instant Account Verification
3875
- * @name LinkBankAccount
3876
- * @summary Link Bank Account
3877
- * @request POST:/iav/link
3896
+ * @tags Transfers Relationships
3897
+ * @name BankCodes
3898
+ * @summary Bank Codes
3899
+ * @request GET:/transfer/bank/bankCodes
3878
3900
  * @secure
3879
3901
  */
3880
- linkBankAccount(data: {
3881
- /** @example "5VXXXXX" */
3882
- account?: any;
3883
- /** @example "XXXXXXX" */
3884
- bankAccountId?: any;
3902
+ bankCodes(query?: {
3903
+ /** @example "IND|MEX" */
3904
+ country?: any;
3885
3905
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3886
3906
  /**
3887
- * @tags Transfers Instant Account Verification
3888
- * @name ImportWithPlaid
3889
- * @summary Import With Plaid
3890
- * @request POST:/iav/import
3907
+ * @tags Transfers Relationships
3908
+ * @name BankCodesViaAddress
3909
+ * @summary Bank Codes (via address)
3910
+ * @request POST:/transfer/bank/bankCodes
3891
3911
  * @secure
3892
3912
  */
3893
- importWithPlaid(data: {
3894
- /** @example "3AB123456" */
3913
+ bankCodesViaAddress(data: {
3914
+ /** @example "Mumbai" */
3915
+ city?: any;
3916
+ /** @example "IND" */
3917
+ country?: any;
3918
+ /** @example "400018" */
3919
+ postalCode?: any;
3920
+ /** @example "Maharashtra" */
3921
+ stateProvince?: any;
3922
+ /** @example ["716 /a, Poonam Chem, Dr.annie Besant Road, Opp.atre Mall, Worli"] */
3923
+ streetAddress?: any;
3924
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3925
+ /**
3926
+ * @tags Transfers Relationships
3927
+ * @name Create
3928
+ * @summary Create
3929
+ * @request POST:/transfer/relationship/create
3930
+ * @secure
3931
+ */
3932
+ create(data: {
3933
+ /** @example "5VA0XXXX" */
3895
3934
  account?: any;
3896
- /** @example "123456" */
3897
- bankAccountNumber?: any;
3898
- /** @example "John Smith" */
3935
+ /** @example "111111" */
3936
+ bankAccount?: any;
3937
+ /** @example "John Doe" */
3899
3938
  bankAccountOwnerName?: any;
3900
- /** @example "checking" */
3939
+ /** @example "CHECKING" */
3901
3940
  bankAccountType?: any;
3902
- /** @example "122105155" */
3941
+ /** @example "010101010" */
3903
3942
  bankRoutingNumber?: any;
3904
- /** @example "Checking x456" */
3943
+ /** @example "Test" */
3905
3944
  nickname?: any;
3906
- /** @example "{optional}" */
3907
- note?: any;
3908
- /** @example "{optional}" */
3909
- remoteAddr?: any;
3910
- /** @example "{optional}" */
3911
- remoteDevice?: any;
3912
3945
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3913
- }
3914
- export class TransfersAch<HandleError extends boolean = boolean> {
3915
- protected readonly apiClient: JwtClient<HandleError>;
3916
- constructor(apiClient: JwtClient<HandleError>);
3917
3946
  /**
3918
- * @tags Transfers Ach
3947
+ * @tags Transfers Relationships
3948
+ * @name WireInformation
3949
+ * @summary Wire information
3950
+ * @request POST:/transfer/relationship/wire/create
3951
+ * @secure
3952
+ */
3953
+ wireInformation(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3954
+ /**
3955
+ * @tags Transfers Relationships
3956
+ * @name BankingRelationship
3957
+ * @summary Banking relationship
3958
+ * @request POST:/transfer/relationship/bank/create
3959
+ * @secure
3960
+ */
3961
+ bankingRelationship(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3962
+ /**
3963
+ * @tags Transfers Relationships
3964
+ * @name Approve
3965
+ * @summary Approve
3966
+ * @request POST:/transfer/relationship/approve
3967
+ * @secure
3968
+ */
3969
+ approve(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3970
+ /**
3971
+ * @tags Transfers Relationships
3972
+ * @name Cancel
3973
+ * @summary Cancel
3974
+ * @request POST:/transfer/relationship/cancel/{entryId}
3975
+ * @secure
3976
+ */
3977
+ cancel(entryId: string, data: {
3978
+ /** @example "2QC05208" */
3979
+ account?: any;
3980
+ /** @example "USER CANCELED" */
3981
+ reason?: any;
3982
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3983
+ /**
3984
+ * @tags Transfers Relationships
3985
+ * @name Rename
3986
+ * @summary Rename
3987
+ * @request POST:/transfer/relationship/rename/{entryId}
3988
+ * @secure
3989
+ */
3990
+ rename(entryId: string, data: {
3991
+ /** @example "Citi Checking 2" */
3992
+ nickname?: any;
3993
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3994
+ /**
3995
+ * @tags Transfers Relationships
3996
+ * @name AdvisorPolicyUpdate
3997
+ * @summary Advisor Policy Update
3998
+ * @request POST:/transfer/relationship/policy
3999
+ * @secure
4000
+ */
4001
+ advisorPolicyUpdate(data: {
4002
+ account?: {
4003
+ /** @example 0 */
4004
+ accountId?: number;
4005
+ /** @example "{optional}" */
4006
+ accountNumber?: string;
4007
+ };
4008
+ /** @example 123 */
4009
+ entryId?: any;
4010
+ /** @example true */
4011
+ esigned?: any;
4012
+ /** @example "AllowWithdrawal|Disallow" */
4013
+ policy?: any;
4014
+ /** @example "" */
4015
+ remoteAddr?: any;
4016
+ /** @example "" */
4017
+ remoteDevice?: any;
4018
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4019
+ /**
4020
+ * @tags Transfers Relationships
4021
+ * @name DocumentUpload
4022
+ * @summary Document upload
4023
+ * @request POST:/transfer/relationship/wire/upload
4024
+ * @secure
4025
+ */
4026
+ documentUpload(data: {
4027
+ /**
4028
+ * Wire relationship ID
4029
+ * @example ""
4030
+ */
4031
+ entryId?: string;
4032
+ /**
4033
+ * Document file
4034
+ * @format binary
4035
+ */
4036
+ file?: File;
4037
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4038
+ /**
4039
+ * @tags Transfers Relationships
4040
+ * @name MfaReInitiation
4041
+ * @summary 2FA re-initiation
4042
+ * @request POST:/transfer/relationship/wire/2fa/reinitiate
4043
+ * @secure
4044
+ */
4045
+ mfaReInitiation(data: {
4046
+ /** @example 123 */
4047
+ entryId?: any;
4048
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4049
+ /**
4050
+ * @tags Transfers Relationships
4051
+ * @name SupplementWire
4052
+ * @summary Supplement wire
4053
+ * @request POST:/transfer/relationship/wire/supplement
4054
+ * @secure
4055
+ */
4056
+ supplementWire(data: {
4057
+ /** @example 123456 */
4058
+ entryId?: any;
4059
+ recipientBank?: {
4060
+ /** @example "Capital City" */
4061
+ city?: string;
4062
+ identifier?: {
4063
+ /** @example "AAA-123-2587964" */
4064
+ id?: string;
4065
+ /** @example "BIC" */
4066
+ type?: string;
4067
+ };
4068
+ /** @example "ABC 123" */
4069
+ postalCode?: string;
4070
+ /** @example "NJ" */
4071
+ stateProvince?: string;
4072
+ };
4073
+ userAccount?: {
4074
+ /** @example "AB12345" */
4075
+ accountNumber?: string;
4076
+ };
4077
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4078
+ }
4079
+ export class TransfersInstantAccountVerification<HandleError extends boolean = boolean> {
4080
+ protected readonly apiClient: JwtClient<HandleError>;
4081
+ constructor(apiClient: JwtClient<HandleError>);
4082
+ /**
4083
+ * @tags Transfers Instant Account Verification
4084
+ * @name Initiate
4085
+ * @summary Initiate
4086
+ * @request GET:/iav/init
4087
+ * @secure
4088
+ */
4089
+ initiate(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4090
+ /**
4091
+ * @tags Transfers Instant Account Verification
4092
+ * @name InitiatePost
4093
+ * @summary Initiate Post
4094
+ * @request POST:/iav/init
4095
+ * @secure
4096
+ */
4097
+ initiatePost(query: object, data: {
4098
+ /** @example "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" */
4099
+ subject?: string;
4100
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4101
+ /**
4102
+ * @tags Transfers Instant Account Verification
4103
+ * @name Complete
4104
+ * @summary Complete
4105
+ * @request POST:/iav/complete
4106
+ * @secure
4107
+ */
4108
+ complete(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4109
+ /**
4110
+ * @tags Transfers Instant Account Verification
4111
+ * @name ListBankAccounts
4112
+ * @summary List Bank Accounts
4113
+ * @request POST:/iav/list
4114
+ * @secure
4115
+ */
4116
+ listBankAccounts(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4117
+ /**
4118
+ * @tags Transfers Instant Account Verification
4119
+ * @name LinkBankAccount
4120
+ * @summary Link Bank Account
4121
+ * @request POST:/iav/link
4122
+ * @secure
4123
+ */
4124
+ linkBankAccount(data: {
4125
+ /** @example "5VXXXXX" */
4126
+ account?: any;
4127
+ /** @example "XXXXXXX" */
4128
+ bankAccountId?: any;
4129
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4130
+ /**
4131
+ * @tags Transfers Instant Account Verification
4132
+ * @name ImportWithPlaid
4133
+ * @summary Import With Plaid
4134
+ * @request POST:/iav/import
4135
+ * @secure
4136
+ */
4137
+ importWithPlaid(data: {
4138
+ /** @example "3AB123456" */
4139
+ account?: any;
4140
+ /** @example "123456" */
4141
+ bankAccountNumber?: any;
4142
+ /** @example "John Smith" */
4143
+ bankAccountOwnerName?: any;
4144
+ /** @example "checking" */
4145
+ bankAccountType?: any;
4146
+ /** @example "122105155" */
4147
+ bankRoutingNumber?: any;
4148
+ /** @example "Checking x456" */
4149
+ nickname?: any;
4150
+ /** @example "{optional}" */
4151
+ note?: any;
4152
+ /** @example "{optional}" */
4153
+ remoteAddr?: any;
4154
+ /** @example "{optional}" */
4155
+ remoteDevice?: any;
4156
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4157
+ }
4158
+ export class TransfersAch<HandleError extends boolean = boolean> {
4159
+ protected readonly apiClient: JwtClient<HandleError>;
4160
+ constructor(apiClient: JwtClient<HandleError>);
4161
+ /**
4162
+ * @tags Transfers Ach
3919
4163
  * @name Deposit
3920
4164
  * @summary Deposit
3921
4165
  * @request POST:/transfer/ach/deposit
@@ -4365,280 +4609,36 @@ export class TransfersInstantCashTransfers<HandleError extends boolean = boolean
4365
4609
  */
4366
4610
  listReports(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4367
4611
  }
4368
- export class TransfersRelationships<HandleError extends boolean = boolean> {
4612
+ export class TransfersCheques<HandleError extends boolean = boolean> {
4369
4613
  protected readonly apiClient: JwtClient<HandleError>;
4370
4614
  constructor(apiClient: JwtClient<HandleError>);
4371
4615
  /**
4372
- * @tags Transfers Relationships
4373
- * @name List
4374
- * @summary List
4375
- * @request GET:/transfer/relationship/list/{account}
4616
+ * @tags Transfers Cheques
4617
+ * @name Withdrawal
4618
+ * @summary Withdrawal
4619
+ * @request POST:/transfer/check/outgoing
4376
4620
  * @secure
4377
4621
  */
4378
- list(account: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4622
+ withdrawal(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4623
+ }
4624
+ export class Transfers<HandleError extends boolean = boolean> {
4625
+ 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
+ constructor(apiClient: JwtClient<HandleError>);
4379
4637
  /**
4380
- * @tags Transfers Relationships
4381
- * @name GetInfo
4382
- * @summary Get Info
4383
- * @request GET:/transfer/relationship/get
4384
- * @secure
4385
- */
4386
- getInfo(query?: {
4387
- /**
4388
- * Account number
4389
- * @example "ABC123"
4390
- */
4391
- account?: any;
4392
- /**
4393
- * Desired entry ID
4394
- * @example "123"
4395
- */
4396
- entryId?: any;
4397
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4398
- /**
4399
- * @tags Transfers Relationships
4400
- * @name PaymentMethods
4401
- * @summary Payment methods
4402
- * @request GET:/transfer/bank/paymentMethods
4403
- * @secure
4404
- */
4405
- paymentMethods(query?: {
4406
- /** @example "IND" */
4407
- country?: any;
4408
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4409
- /**
4410
- * @tags Transfers Relationships
4411
- * @name PaymentMethodsViaAddress
4412
- * @summary Payment methods (via address)
4413
- * @request POST:/transfer/bank/paymentMethods
4414
- * @secure
4415
- */
4416
- paymentMethodsViaAddress(data: {
4417
- /** @example "Mumbai" */
4418
- city?: any;
4419
- /** @example "IND" */
4420
- country?: any;
4421
- /** @example "400018" */
4422
- postalCode?: any;
4423
- /** @example "Maharashtra" */
4424
- stateProvince?: any;
4425
- /** @example ["716 /a, Poonam Chem, Dr.annie Besant Road, Opp.atre Mall, Worli"] */
4426
- streetAddress?: any;
4427
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4428
- /**
4429
- * @tags Transfers Relationships
4430
- * @name BankCodes
4431
- * @summary Bank Codes
4432
- * @request GET:/transfer/bank/bankCodes
4433
- * @secure
4434
- */
4435
- bankCodes(query?: {
4436
- /** @example "IND|MEX" */
4437
- country?: any;
4438
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4439
- /**
4440
- * @tags Transfers Relationships
4441
- * @name BankCodesViaAddress
4442
- * @summary Bank Codes (via address)
4443
- * @request POST:/transfer/bank/bankCodes
4444
- * @secure
4445
- */
4446
- bankCodesViaAddress(data: {
4447
- /** @example "Mumbai" */
4448
- city?: any;
4449
- /** @example "IND" */
4450
- country?: any;
4451
- /** @example "400018" */
4452
- postalCode?: any;
4453
- /** @example "Maharashtra" */
4454
- stateProvince?: any;
4455
- /** @example ["716 /a, Poonam Chem, Dr.annie Besant Road, Opp.atre Mall, Worli"] */
4456
- streetAddress?: any;
4457
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4458
- /**
4459
- * @tags Transfers Relationships
4460
- * @name Create
4461
- * @summary Create
4462
- * @request POST:/transfer/relationship/create
4463
- * @secure
4464
- */
4465
- create(data: {
4466
- /** @example "5VA0XXXX" */
4467
- account?: any;
4468
- /** @example "111111" */
4469
- bankAccount?: any;
4470
- /** @example "John Doe" */
4471
- bankAccountOwnerName?: any;
4472
- /** @example "CHECKING" */
4473
- bankAccountType?: any;
4474
- /** @example "010101010" */
4475
- bankRoutingNumber?: any;
4476
- /** @example "Test" */
4477
- nickname?: any;
4478
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4479
- /**
4480
- * @tags Transfers Relationships
4481
- * @name WireInformation
4482
- * @summary Wire information
4483
- * @request POST:/transfer/relationship/wire/create
4484
- * @secure
4485
- */
4486
- wireInformation(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4487
- /**
4488
- * @tags Transfers Relationships
4489
- * @name BankingRelationship
4490
- * @summary Banking relationship
4491
- * @request POST:/transfer/relationship/bank/create
4492
- * @secure
4493
- */
4494
- bankingRelationship(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4495
- /**
4496
- * @tags Transfers Relationships
4497
- * @name Approve
4498
- * @summary Approve
4499
- * @request POST:/transfer/relationship/approve
4500
- * @secure
4501
- */
4502
- approve(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4503
- /**
4504
- * @tags Transfers Relationships
4505
- * @name Cancel
4506
- * @summary Cancel
4507
- * @request POST:/transfer/relationship/cancel/{entryId}
4508
- * @secure
4509
- */
4510
- cancel(entryId: string, data: {
4511
- /** @example "2QC05208" */
4512
- account?: any;
4513
- /** @example "USER CANCELED" */
4514
- reason?: any;
4515
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4516
- /**
4517
- * @tags Transfers Relationships
4518
- * @name Rename
4519
- * @summary Rename
4520
- * @request POST:/transfer/relationship/rename/{entryId}
4521
- * @secure
4522
- */
4523
- rename(entryId: string, data: {
4524
- /** @example "Citi Checking 2" */
4525
- nickname?: any;
4526
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4527
- /**
4528
- * @tags Transfers Relationships
4529
- * @name AdvisorPolicyUpdate
4530
- * @summary Advisor Policy Update
4531
- * @request POST:/transfer/relationship/policy
4532
- * @secure
4533
- */
4534
- advisorPolicyUpdate(data: {
4535
- account?: {
4536
- /** @example 0 */
4537
- accountId?: number;
4538
- /** @example "{optional}" */
4539
- accountNumber?: string;
4540
- };
4541
- /** @example 123 */
4542
- entryId?: any;
4543
- /** @example true */
4544
- esigned?: any;
4545
- /** @example "AllowWithdrawal|Disallow" */
4546
- policy?: any;
4547
- /** @example "" */
4548
- remoteAddr?: any;
4549
- /** @example "" */
4550
- remoteDevice?: any;
4551
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4552
- /**
4553
- * @tags Transfers Relationships
4554
- * @name DocumentUpload
4555
- * @summary Document upload
4556
- * @request POST:/transfer/relationship/wire/upload
4557
- * @secure
4558
- */
4559
- documentUpload(data: {
4560
- /**
4561
- * Wire relationship ID
4562
- * @example ""
4563
- */
4564
- entryId?: string;
4565
- /**
4566
- * Document file
4567
- * @format binary
4568
- */
4569
- file?: File;
4570
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4571
- /**
4572
- * @tags Transfers Relationships
4573
- * @name MfaReInitiation
4574
- * @summary 2FA re-initiation
4575
- * @request POST:/transfer/relationship/wire/2fa/reinitiate
4576
- * @secure
4577
- */
4578
- mfaReInitiation(data: {
4579
- /** @example 123 */
4580
- entryId?: any;
4581
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4582
- /**
4583
- * @tags Transfers Relationships
4584
- * @name SupplementWire
4585
- * @summary Supplement wire
4586
- * @request POST:/transfer/relationship/wire/supplement
4587
- * @secure
4588
- */
4589
- supplementWire(data: {
4590
- /** @example 123456 */
4591
- entryId?: any;
4592
- recipientBank?: {
4593
- /** @example "Capital City" */
4594
- city?: string;
4595
- identifier?: {
4596
- /** @example "AAA-123-2587964" */
4597
- id?: string;
4598
- /** @example "BIC" */
4599
- type?: string;
4600
- };
4601
- /** @example "ABC 123" */
4602
- postalCode?: string;
4603
- /** @example "NJ" */
4604
- stateProvince?: string;
4605
- };
4606
- userAccount?: {
4607
- /** @example "AB12345" */
4608
- accountNumber?: string;
4609
- };
4610
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4611
- }
4612
- export class TransfersCheques<HandleError extends boolean = boolean> {
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> {
4625
- 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
- constructor(apiClient: JwtClient<HandleError>);
4637
- /**
4638
- * @tags Transfers
4639
- * @name TransferDetails
4640
- * @summary Transfer Details
4641
- * @request GET:/transfer/details/{account}/{transferId}
4638
+ * @tags Transfers
4639
+ * @name TransferDetails
4640
+ * @summary Transfer Details
4641
+ * @request GET:/transfer/details/{account}/{transferId}
4642
4642
  * @secure
4643
4643
  */
4644
4644
  transferDetails(account: string, transferId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
@@ -4855,156 +4855,7 @@ export class Transfers<HandleError extends boolean = boolean> {
4855
4855
  wallet?: any;
4856
4856
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4857
4857
  }
4858
- export class Documents<HandleError extends boolean = boolean> {
4859
- protected readonly apiClient: JwtClient<HandleError>;
4860
- constructor(apiClient: JwtClient<HandleError>);
4861
- /**
4862
- * @tags Documents
4863
- * @name Confirm
4864
- * @summary Confirm
4865
- * @request GET:/documents/confirm
4866
- * @secure
4867
- */
4868
- confirm(query?: {
4869
- /**
4870
- * *_accountNumber_ is accepted as well*
4871
- * @example "5VA0XXXX"
4872
- */
4873
- account?: any;
4874
- /**
4875
- * Date for the confirm. The required date format is: mm/dd/yyyy.
4876
- * @example "03/03/2018"
4877
- */
4878
- date?: any;
4879
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4880
- /**
4881
- * @tags Documents
4882
- * @name ListOfConfirms
4883
- * @summary List of Confirms
4884
- * @request GET:/documents/confirm/list
4885
- * @secure
4886
- */
4887
- listOfConfirms(query?: {
4888
- /**
4889
- * *_accountNumber_ is accepted as well*
4890
- * @example "5VA0XXXX"
4891
- */
4892
- account?: any;
4893
- /**
4894
- * Start date for the list of confirms. The required date format is: `mm/dd/yyyy`.
4895
- * @example "01/01/2017"
4896
- */
4897
- beginDate?: any;
4898
- /**
4899
- * End date for the list of confirms. The required date format is: `mm/dd/yyyy`.
4900
- * @example "03/01/2018"
4901
- */
4902
- endDate?: any;
4903
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4904
- /**
4905
- * @tags Documents
4906
- * @name ServiceDocs
4907
- * @summary Service Docs
4908
- * @request GET:/documents/service
4909
- * @secure
4910
- */
4911
- serviceDocs(query?: {
4912
- /** @example "5VA0XXXX" */
4913
- accountNumber?: any;
4914
- /** See table for details. Leave blank for all document types. */
4915
- docType?: any;
4916
- /**
4917
- * The beginning 2-digit month (MM) to be used as search criteria.
4918
- * @example "01"
4919
- */
4920
- beginMonth?: any;
4921
- /**
4922
- * The beginning 4-digit year (YYYY) to be used as search criteria.
4923
- * @example "2012"
4924
- */
4925
- beginYear?: any;
4926
- /**
4927
- * The ending 2-digit month (MM) to be used as search criteria.
4928
- * @example "12"
4929
- */
4930
- endMonth?: any;
4931
- /**
4932
- * The ending 4-digit year (YYYY) to be used as search criteria.
4933
- * @example "2017"
4934
- */
4935
- endYear?: any;
4936
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4937
- /**
4938
- * @tags Documents
4939
- * @name DocumentList
4940
- * @summary Document list
4941
- * @request GET:/documents/list
4942
- * @secure
4943
- */
4944
- documentList(query?: {
4945
- /** @example "5VA0XXXX" */
4946
- account?: any;
4947
- /**
4948
- * Omit for all document types.
4949
- * @example "All"
4950
- */
4951
- documentType?: any;
4952
- /**
4953
- * Indicates start month & year (day of month is not used)
4954
- * @example "1/1/2021"
4955
- */
4956
- fromMonth?: any;
4957
- /**
4958
- * Indicates end month & year (day of month is not used)
4959
- * @example "12/1/2021"
4960
- */
4961
- toMonth?: any;
4962
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4963
- /**
4964
- * @tags Documents
4965
- * @name AvailableDocumentTypes
4966
- * @summary Available document types
4967
- * @request GET:/documents/types
4968
- * @secure
4969
- */
4970
- availableDocumentTypes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4971
- /**
4972
- * @tags Documents
4973
- * @name AvailableDocumentTypesAndCodes
4974
- * @summary Available document types and codes
4975
- * @request GET:/documents/typesAndCodes
4976
- * @secure
4977
- */
4978
- availableDocumentTypesAndCodes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4979
- /**
4980
- * @tags Documents
4981
- * @name Download
4982
- * @summary Download
4983
- * @request GET:/documents/download
4984
- * @secure
4985
- */
4986
- download(query?: {
4987
- /**
4988
- * Account Number
4989
- * @example "{accountNumber}"
4990
- */
4991
- account?: any;
4992
- /**
4993
- * UUID for finding specific document
4994
- * @example "{key}"
4995
- */
4996
- key?: any;
4997
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4998
- /**
4999
- * @tags Documents
5000
- * @name GetAllBranchDocuments
5001
- * @summary Get all Branch Documents
5002
- * @request GET:/documents/branch/list
5003
- * @secure
5004
- */
5005
- getAllBranchDocuments(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5006
- }
5007
- export class Miscellaneous<HandleError extends boolean = boolean> {
4858
+ export class Miscellaneous<HandleError extends boolean = boolean> {
5008
4859
  protected readonly apiClient: JwtClient<HandleError>;
5009
4860
  constructor(apiClient: JwtClient<HandleError>);
5010
4861
  /**
@@ -5156,234 +5007,35 @@ export class Miscellaneous<HandleError extends boolean = boolean> {
5156
5007
  /**
5157
5008
  * @tags Miscellaneous
5158
5009
  * @name CurrencyList
5159
- * @summary Currency list
5160
- * @request GET:/general/available-currencies
5161
- * @secure
5162
- */
5163
- currencyList(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5164
- /**
5165
- * @tags Miscellaneous
5166
- * @name TradableCurrencyList
5167
- * @summary Tradable currency list
5168
- * @request GET:/general/tradable-currencies
5169
- * @secure
5170
- */
5171
- tradableCurrencyList(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5172
- /**
5173
- * @tags Miscellaneous
5174
- * @name OptionStrategyTypes
5175
- * @summary Option Strategy Types
5176
- * @request GET:/general/options/strategyTypes
5177
- * @secure
5178
- */
5179
- optionStrategyTypes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5180
- /**
5181
- * @tags Miscellaneous
5182
- * @name OptionStrategyClassifications
5183
- * @summary Option Strategy Classifications
5184
- * @request GET:/general/options/strategyClassifications
5185
- * @secure
5186
- */
5187
- optionStrategyClassifications(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5188
- }
5189
- export class Branch<HandleError extends boolean = boolean> {
5190
- protected readonly apiClient: JwtClient<HandleError>;
5191
- constructor(apiClient: JwtClient<HandleError>);
5192
- /**
5193
- * @tags Branch
5194
- * @name BranchRtb
5195
- * @request GET:/v1/branch/rtb
5196
- * @secure
5197
- */
5198
- branchRtb(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5199
- /**
5200
- * @tags Branch
5201
- * @name BranchRtbs
5202
- * @request GET:/v1/branch/rtbs
5203
- * @secure
5204
- */
5205
- branchRtbs(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5206
- /**
5207
- * @tags Branch
5208
- * @name BranchInventory
5209
- * @request GET:/v1/branch/inventory
5210
- * @secure
5211
- */
5212
- branchInventory(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5213
- /**
5214
- * @tags Branch
5215
- * @name BranchRtbsTotal
5216
- * @request GET:/v1/branch/rtbs/total
5217
- * @secure
5218
- */
5219
- branchRtbsTotal(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5220
- /**
5221
- * @tags Branch
5222
- * @name BranchPortfolio
5223
- * @request GET:/v1/branch/portfolio
5224
- * @secure
5225
- */
5226
- branchPortfolio(query?: {
5227
- /**
5228
- * (true or false) Allows for loading of quotes for each portfolio entry. Defaults to false.
5229
- * @example "false"
5230
- */
5231
- loadQuotes?: any;
5232
- /** @example "false" */
5233
- loadIndustries?: any;
5234
- /** @example "false" */
5235
- loadUpgrades?: any;
5236
- /** @example "false" */
5237
- loadEarnings?: any;
5238
- /**
5239
- * Load balances for weight
5240
- * @example "false"
5241
- */
5242
- loadRtb?: any;
5243
- /**
5244
- * Analyze market caps and get `marketCapWeights`. To be used in conjuction with `loadQuotes`
5245
- * @example "false"
5246
- */
5247
- marketCapBreakdown?: any;
5248
- /**
5249
- * Combined portfolio for the branch
5250
- * @example "false"
5251
- */
5252
- combined?: any;
5253
- /** @example "1" */
5254
- pageNum?: any;
5255
- /** @example "100" */
5256
- pageSize?: any;
5257
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5258
- /**
5259
- * @tags Branch
5260
- * @name OptionExpirations
5261
- * @summary Option expirations
5262
- * @request GET:/v1/branch/portfolio/options/upcoming
5263
- * @secure
5264
- */
5265
- optionExpirations(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5266
- /**
5267
- * @tags Branch
5268
- * @name OptionExpirationsDetails
5269
- * @summary Option expirations details
5270
- * @request POST:/v1/branch/portfolio/options/upcoming/details
5271
- * @secure
5272
- */
5273
- optionExpirationsDetails(data: {
5274
- /** @example "true|false" */
5275
- loadQuotes?: any;
5276
- /** @example "01/15/2021 00:00:00 EST" */
5277
- maturity?: any;
5278
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5279
- }
5280
- export class LegalDocuments<HandleError extends boolean = boolean> {
5281
- protected readonly apiClient: JwtClient<HandleError>;
5282
- constructor(apiClient: JwtClient<HandleError>);
5283
- /**
5284
- * @tags Legal Documents
5285
- * @name DocumentClassifications
5286
- * @summary Document classifications
5287
- * @request GET:/user/legal/classifications
5288
- * @secure
5289
- */
5290
- documentClassifications(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5291
- /**
5292
- * @tags Legal Documents
5293
- * @name DocumentListing
5294
- * @summary Document listing
5295
- * @request GET:/user/legal/documents
5296
- * @secure
5297
- */
5298
- documentListing(query?: {
5299
- /**
5300
- * {optional}
5301
- * @example "TermsOfUse"
5302
- */
5303
- classification?: any;
5304
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5305
- /**
5306
- * @tags Legal Documents
5307
- * @name PolicyValues
5308
- * @summary Policy values
5309
- * @request GET:/user/legal/policies/listing/{type}
5310
- * @secure
5311
- */
5312
- policyValues(type: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5313
- /**
5314
- * @tags Legal Documents
5315
- * @name DocumentContent
5316
- * @summary Document content
5317
- * @request GET:/user/legal/document/content
5010
+ * @summary Currency list
5011
+ * @request GET:/general/available-currencies
5318
5012
  * @secure
5319
5013
  */
5320
- documentContent(query?: {
5321
- /** @example "{as provided}" */
5322
- id?: any;
5323
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5014
+ currencyList(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5324
5015
  /**
5325
- * @tags Legal Documents
5326
- * @name DocumentDownload
5327
- * @summary Document download
5328
- * @request GET:/user/legal/document/download
5016
+ * @tags Miscellaneous
5017
+ * @name TradableCurrencyList
5018
+ * @summary Tradable currency list
5019
+ * @request GET:/general/tradable-currencies
5329
5020
  * @secure
5330
5021
  */
5331
- documentDownload(query?: {
5332
- /** @example "{as provided}" */
5333
- id?: any;
5334
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5022
+ tradableCurrencyList(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5335
5023
  /**
5336
- * @tags Legal Documents
5337
- * @name SignTheDocument
5338
- * @summary Sign the document
5339
- * @request POST:/user/legal/document/sign
5024
+ * @tags Miscellaneous
5025
+ * @name OptionStrategyTypes
5026
+ * @summary Option Strategy Types
5027
+ * @request GET:/general/options/strategyTypes
5340
5028
  * @secure
5341
5029
  */
5342
- signTheDocument(data: {
5343
- account?: {
5344
- /** @example 1234 */
5345
- accountId?: number;
5346
- /** @example "AC123456" */
5347
- accountNumber?: string;
5348
- };
5349
- data?: {
5350
- /** @example "{conditional}" */
5351
- bankAccountNumber?: string;
5352
- };
5353
- /** @example "{required}" */
5354
- documentId?: any;
5355
- /** @example true */
5356
- esigned?: any;
5357
- /** @example "" */
5358
- remoteAddr?: any;
5359
- /** @example "{required}" */
5360
- remoteDevice?: any;
5361
- /** @example "{required}" */
5362
- signature?: any;
5363
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5030
+ optionStrategyTypes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5364
5031
  /**
5365
- * @tags Legal Documents
5366
- * @name UpdatesPolicyOnTheAccount
5367
- * @summary Updates policy on the account
5368
- * @request POST:/user/legal/policy/{type}
5032
+ * @tags Miscellaneous
5033
+ * @name OptionStrategyClassifications
5034
+ * @summary Option Strategy Classifications
5035
+ * @request GET:/general/options/strategyClassifications
5369
5036
  * @secure
5370
5037
  */
5371
- updatesPolicyOnTheAccount(type: string, data: {
5372
- account?: {
5373
- /** @example 0 */
5374
- accountId?: number;
5375
- /** @example "{optional}" */
5376
- accountNumber?: string;
5377
- };
5378
- /** @example true */
5379
- esigned?: any;
5380
- /** @example "Allow" */
5381
- policy?: any;
5382
- /** @example "" */
5383
- remoteAddr?: any;
5384
- /** @example "" */
5385
- remoteDevice?: any;
5386
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5038
+ optionStrategyClassifications(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5387
5039
  }
5388
5040
  export class BlacklistAdminBusinesses<HandleError extends boolean = boolean> {
5389
5041
  protected readonly apiClient: JwtClient<HandleError>;
@@ -5611,13 +5263,212 @@ export class BlacklistAdminIndividuals<HandleError extends boolean = boolean> {
5611
5263
  zip?: any;
5612
5264
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5613
5265
  /**
5614
- * @tags Blacklist Admin Individuals
5615
- * @name DeleteIndividual
5616
- * @summary Delete Individual
5617
- * @request DELETE:/v1/admin/individuals/{id}
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;
5448
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5449
+ /**
5450
+ * @tags Legal Documents
5451
+ * @name UpdatesPolicyOnTheAccount
5452
+ * @summary Updates policy on the account
5453
+ * @request POST:/user/legal/policy/{type}
5618
5454
  * @secure
5619
5455
  */
5620
- deleteIndividual(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5456
+ updatesPolicyOnTheAccount(type: string, data: {
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>>;
5621
5472
  }
5622
5473
  export class BlacklistSearch<HandleError extends boolean = boolean> {
5623
5474
  protected readonly apiClient: JwtClient<HandleError>;
@@ -5661,35 +5512,6 @@ export class BlacklistSearch<HandleError extends boolean = boolean> {
5661
5512
  };
5662
5513
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5663
5514
  }
5664
- export class Blacklist<HandleError extends boolean = boolean> {
5665
- protected readonly apiClient: JwtClient<HandleError>;
5666
- adminBusinesses: BlacklistAdminBusinesses<HandleError>;
5667
- adminIndividuals: BlacklistAdminIndividuals<HandleError>;
5668
- search: BlacklistSearch<HandleError>;
5669
- constructor(apiClient: JwtClient<HandleError>);
5670
- /**
5671
- * @tags Blacklist
5672
- * @name UploadBlacklistCsv
5673
- * @summary Upload Blacklist CSV
5674
- * @request POST:/v1/csv/upload
5675
- * @secure
5676
- */
5677
- uploadBlacklistCsv(data: {
5678
- /**
5679
- * (Required) file with info to upload
5680
- * @format binary
5681
- */
5682
- file_field?: File;
5683
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5684
- /**
5685
- * @tags Blacklist
5686
- * @name GetHealth
5687
- * @summary Get Health
5688
- * @request GET:/v1/healthz
5689
- * @secure
5690
- */
5691
- getHealth(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5692
- }
5693
5515
  export class Broker<HandleError extends boolean = boolean> {
5694
5516
  protected readonly apiClient: JwtClient<HandleError>;
5695
5517
  constructor(apiClient: JwtClient<HandleError>);
@@ -5733,6 +5555,35 @@ export class Broker<HandleError extends boolean = boolean> {
5733
5555
  pageSize?: any;
5734
5556
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5735
5557
  }
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
+ }
5736
5587
  export class WatchmenFfiUserAccountManagement<HandleError extends boolean = boolean> {
5737
5588
  protected readonly apiClient: JwtClient<HandleError>;
5738
5589
  constructor(apiClient: JwtClient<HandleError>);
@@ -5872,6 +5723,16 @@ export class WatchmenFfiUserAccountManagement<HandleError extends boolean = bool
5872
5723
  onlyActiveUser?: any;
5873
5724
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5874
5725
  }
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
+ }
5875
5736
  export class WatchmenFfiFirmBranch<HandleError extends boolean = boolean> {
5876
5737
  protected readonly apiClient: JwtClient<HandleError>;
5877
5738
  constructor(apiClient: JwtClient<HandleError>);
@@ -6047,22 +5908,161 @@ export class WatchmenFfiFirmBranch<HandleError extends boolean = boolean> {
6047
5908
  id?: any;
6048
5909
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
6049
5910
  }
6050
- export class Advisory<HandleError extends boolean = boolean> {
6051
- protected readonly apiClient: JwtClient<HandleError>;
6052
- charges: AdvisoryCharges<HandleError>;
6053
- models: AdvisoryModels<HandleError>;
6054
- userAccountManagement: AdvisoryUserAccountManagement<HandleError>;
6055
- groups: AdvisoryGroups<HandleError>;
6056
- analytics: AdvisoryAnalytics<HandleError>;
6057
- allocations: AdvisoryAllocations<HandleError>;
6058
- constructor(apiClient: JwtClient<HandleError>);
6059
- }
6060
5911
  export class WatchmenFfi<HandleError extends boolean = boolean> {
6061
5912
  protected readonly apiClient: JwtClient<HandleError>;
6062
5913
  userAccountManagement: WatchmenFfiUserAccountManagement<HandleError>;
6063
5914
  firmBranch: WatchmenFfiFirmBranch<HandleError>;
6064
5915
  constructor(apiClient: JwtClient<HandleError>);
6065
5916
  }
5917
+ export class Documents<HandleError extends boolean = boolean> {
5918
+ protected readonly apiClient: JwtClient<HandleError>;
5919
+ 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
+ }
6066
6066
  export class OrbisApi<HandleError extends boolean = false> extends BaseApi<HandleError, OrbisClient<HandleError>> {
6067
6067
  readonly config: OrbisClientConfig<HandleError>;
6068
6068
  advisory: Advisory<HandleError>;