@orbis-systems/orbis-api-clients 0.7.11 → 0.7.12
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 +103 -103
- 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 +497 -497
- 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 +659 -484
- 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 +30 -30
- 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 +1344 -1344
- 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 +288 -288
- 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 +406 -406
- 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
|
@@ -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?: (
|
|
225
|
+
onErrorTranslate?: (errorCode: string, reason?: 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,80 +588,6 @@ 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
|
-
}
|
|
665
591
|
export class OrdersV2MutualFunds<HandleError extends boolean = boolean> {
|
|
666
592
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
667
593
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -865,6 +791,80 @@ export class OrdersV2Offerings<HandleError extends boolean = boolean> {
|
|
|
865
791
|
};
|
|
866
792
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
867
793
|
}
|
|
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,43 +927,6 @@ 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
|
-
}
|
|
967
930
|
export class OrdersArchived<HandleError extends boolean = boolean> {
|
|
968
931
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
969
932
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -1045,6 +1008,43 @@ export class OrdersArchived<HandleError extends boolean = boolean> {
|
|
|
1045
1008
|
orderRef?: string;
|
|
1046
1009
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1047
1010
|
}
|
|
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>;
|
|
@@ -3631,40 +3631,117 @@ export class AdvisoryUserAccountManagement<HandleError extends boolean = boolean
|
|
|
3631
3631
|
*/
|
|
3632
3632
|
notesPost(action: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3633
3633
|
}
|
|
3634
|
-
export class
|
|
3634
|
+
export class AdvisoryGroups<HandleError extends boolean = boolean> {
|
|
3635
3635
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3636
3636
|
constructor(apiClient: JwtClient<HandleError>);
|
|
3637
3637
|
/**
|
|
3638
|
-
* @tags Advisory
|
|
3639
|
-
* @name
|
|
3640
|
-
* @
|
|
3641
|
-
* @request GET:/v2/advisory/analytics/overexposure/{type}/{scope}/{id}
|
|
3638
|
+
* @tags Advisory Groups
|
|
3639
|
+
* @name GroupsManage
|
|
3640
|
+
* @request POST:/v1/groups/manage/{action}
|
|
3642
3641
|
* @secure
|
|
3643
3642
|
*/
|
|
3644
|
-
|
|
3645
|
-
/**
|
|
3646
|
-
* Threshold of 70% or greater
|
|
3647
|
-
* @example ".7"
|
|
3648
|
-
*/
|
|
3649
|
-
threshold?: any;
|
|
3650
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3643
|
+
groupsManage(action: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3651
3644
|
/**
|
|
3652
|
-
* @tags Advisory
|
|
3653
|
-
* @name
|
|
3654
|
-
* @
|
|
3655
|
-
* @request GET:/v2/advisory/analytics/breakdown/rtbs/{modelId}
|
|
3645
|
+
* @tags Advisory Groups
|
|
3646
|
+
* @name GroupsList
|
|
3647
|
+
* @request GET:/v1/groups/list
|
|
3656
3648
|
* @secure
|
|
3657
3649
|
*/
|
|
3658
|
-
|
|
3659
|
-
/**
|
|
3660
|
-
* Bucket size
|
|
3661
|
-
* @example "10000"
|
|
3662
|
-
*/
|
|
3663
|
-
bucket?: any;
|
|
3664
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3650
|
+
groupsList(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3665
3651
|
/**
|
|
3666
|
-
* @tags Advisory
|
|
3667
|
-
* @name
|
|
3652
|
+
* @tags Advisory Groups
|
|
3653
|
+
* @name GroupAccountsStats
|
|
3654
|
+
* @request GET:/v2/advisory/group/accounts/stats/{groupsId}
|
|
3655
|
+
* @secure
|
|
3656
|
+
*/
|
|
3657
|
+
groupAccountsStats(groupsId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3658
|
+
/**
|
|
3659
|
+
* @tags Advisory Groups
|
|
3660
|
+
* @name GroupPortfolios
|
|
3661
|
+
* @request GET:/v2/advisory/group/portfolios/{groupId}
|
|
3662
|
+
* @secure
|
|
3663
|
+
*/
|
|
3664
|
+
groupPortfolios(groupId: string, query?: {
|
|
3665
|
+
/**
|
|
3666
|
+
* Should load quotes or not.
|
|
3667
|
+
* @example "false"
|
|
3668
|
+
*/
|
|
3669
|
+
loadQuotes?: any;
|
|
3670
|
+
/**
|
|
3671
|
+
* Whether to return combined portfolio (no accounts, with approximate prices)
|
|
3672
|
+
* @example "false"
|
|
3673
|
+
*/
|
|
3674
|
+
combined?: any;
|
|
3675
|
+
/** @example "false" */
|
|
3676
|
+
loadIndustries?: any;
|
|
3677
|
+
/** @example "false" */
|
|
3678
|
+
loadUpgrades?: any;
|
|
3679
|
+
/** @example "false" */
|
|
3680
|
+
loadEarnings?: any;
|
|
3681
|
+
/**
|
|
3682
|
+
* Whether or not to include orders comprising each position's cost
|
|
3683
|
+
* @example "false"
|
|
3684
|
+
*/
|
|
3685
|
+
loadCost?: any;
|
|
3686
|
+
/**
|
|
3687
|
+
* Analyze market caps and get `marketCapWeights`. To be used in conjuction with `loadQuotes`
|
|
3688
|
+
* @example "false"
|
|
3689
|
+
*/
|
|
3690
|
+
marketCapWeights?: any;
|
|
3691
|
+
/** @example "1" */
|
|
3692
|
+
pageNum?: any;
|
|
3693
|
+
/** @example "100" */
|
|
3694
|
+
pageSize?: any;
|
|
3695
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3696
|
+
/**
|
|
3697
|
+
* @tags Advisory Groups
|
|
3698
|
+
* @name GroupRtb
|
|
3699
|
+
* @request GET:/v2/advisory/group/rtb/{groupId}
|
|
3700
|
+
* @secure
|
|
3701
|
+
*/
|
|
3702
|
+
groupRtb(groupId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3703
|
+
/**
|
|
3704
|
+
* @tags Advisory Groups
|
|
3705
|
+
* @name GroupRtbs
|
|
3706
|
+
* @request GET:/v2/advisory/group/rtbs/{groupId}
|
|
3707
|
+
* @secure
|
|
3708
|
+
*/
|
|
3709
|
+
groupRtbs(groupId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3710
|
+
}
|
|
3711
|
+
export class AdvisoryAnalytics<HandleError extends boolean = boolean> {
|
|
3712
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3713
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3714
|
+
/**
|
|
3715
|
+
* @tags Advisory Analytics
|
|
3716
|
+
* @name OverexposureAnalysis
|
|
3717
|
+
* @summary Overexposure analysis
|
|
3718
|
+
* @request GET:/v2/advisory/analytics/overexposure/{type}/{scope}/{id}
|
|
3719
|
+
* @secure
|
|
3720
|
+
*/
|
|
3721
|
+
overexposureAnalysis(type: string, scope: string, id: string, query?: {
|
|
3722
|
+
/**
|
|
3723
|
+
* Threshold of 70% or greater
|
|
3724
|
+
* @example ".7"
|
|
3725
|
+
*/
|
|
3726
|
+
threshold?: any;
|
|
3727
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3728
|
+
/**
|
|
3729
|
+
* @tags Advisory Analytics
|
|
3730
|
+
* @name RealtimeBalanceBreakdown
|
|
3731
|
+
* @summary Realtime balance breakdown
|
|
3732
|
+
* @request GET:/v2/advisory/analytics/breakdown/rtbs/{modelId}
|
|
3733
|
+
* @secure
|
|
3734
|
+
*/
|
|
3735
|
+
realtimeBalanceBreakdown(modelId: string, query?: {
|
|
3736
|
+
/**
|
|
3737
|
+
* Bucket size
|
|
3738
|
+
* @example "10000"
|
|
3739
|
+
*/
|
|
3740
|
+
bucket?: any;
|
|
3741
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3742
|
+
/**
|
|
3743
|
+
* @tags Advisory Analytics
|
|
3744
|
+
* @name ModelPerformance
|
|
3668
3745
|
* @summary Model performance
|
|
3669
3746
|
* @request GET:/v2/advisory/analytics/model/performance/{modelId}/{range}
|
|
3670
3747
|
* @secure
|
|
@@ -3737,417 +3814,114 @@ export class AdvisoryAllocations<HandleError extends boolean = boolean> {
|
|
|
3737
3814
|
*/
|
|
3738
3815
|
trigger(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3739
3816
|
}
|
|
3740
|
-
export class
|
|
3817
|
+
export class Device<HandleError extends boolean = boolean> {
|
|
3741
3818
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3742
3819
|
constructor(apiClient: JwtClient<HandleError>);
|
|
3743
3820
|
/**
|
|
3744
|
-
* @tags
|
|
3745
|
-
* @name
|
|
3746
|
-
* @summary
|
|
3747
|
-
* @request
|
|
3748
|
-
* @secure
|
|
3749
|
-
*/
|
|
3750
|
-
list(account: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3751
|
-
/**
|
|
3752
|
-
* @tags Transfers Relationships
|
|
3753
|
-
* @name GetInfo
|
|
3754
|
-
* @summary Get Info
|
|
3755
|
-
* @request GET:/transfer/relationship/get
|
|
3821
|
+
* @tags Device
|
|
3822
|
+
* @name DeviceDeactivate
|
|
3823
|
+
* @summary /device/deactivate
|
|
3824
|
+
* @request POST:/device/deactivate
|
|
3756
3825
|
* @secure
|
|
3757
3826
|
*/
|
|
3758
|
-
|
|
3759
|
-
/**
|
|
3760
|
-
* Account number
|
|
3761
|
-
* @example "ABC123"
|
|
3762
|
-
*/
|
|
3763
|
-
account?: any;
|
|
3827
|
+
deviceDeactivate(data: {
|
|
3764
3828
|
/**
|
|
3765
|
-
*
|
|
3766
|
-
* @example "
|
|
3829
|
+
* Token previously registered
|
|
3830
|
+
* @example "123456789"
|
|
3767
3831
|
*/
|
|
3768
|
-
|
|
3832
|
+
Token?: string;
|
|
3769
3833
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3834
|
+
}
|
|
3835
|
+
export class TransfersInstantAccountVerification<HandleError extends boolean = boolean> {
|
|
3836
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3837
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3770
3838
|
/**
|
|
3771
|
-
* @tags Transfers
|
|
3772
|
-
* @name
|
|
3773
|
-
* @summary
|
|
3774
|
-
* @request GET:/
|
|
3839
|
+
* @tags Transfers Instant Account Verification
|
|
3840
|
+
* @name Initiate
|
|
3841
|
+
* @summary Initiate
|
|
3842
|
+
* @request GET:/iav/init
|
|
3775
3843
|
* @secure
|
|
3776
3844
|
*/
|
|
3777
|
-
|
|
3778
|
-
/** @example "IND" */
|
|
3779
|
-
country?: any;
|
|
3780
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3845
|
+
initiate(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3781
3846
|
/**
|
|
3782
|
-
* @tags Transfers
|
|
3783
|
-
* @name
|
|
3784
|
-
* @summary
|
|
3785
|
-
* @request POST:/
|
|
3847
|
+
* @tags Transfers Instant Account Verification
|
|
3848
|
+
* @name InitiatePost
|
|
3849
|
+
* @summary Initiate Post
|
|
3850
|
+
* @request POST:/iav/init
|
|
3786
3851
|
* @secure
|
|
3787
3852
|
*/
|
|
3788
|
-
|
|
3789
|
-
/** @example "
|
|
3790
|
-
|
|
3791
|
-
/** @example "IND" */
|
|
3792
|
-
country?: any;
|
|
3793
|
-
/** @example "400018" */
|
|
3794
|
-
postalCode?: any;
|
|
3795
|
-
/** @example "Maharashtra" */
|
|
3796
|
-
stateProvince?: any;
|
|
3797
|
-
/** @example ["716 /a, Poonam Chem, Dr.annie Besant Road, Opp.atre Mall, Worli"] */
|
|
3798
|
-
streetAddress?: any;
|
|
3853
|
+
initiatePost(query: object, data: {
|
|
3854
|
+
/** @example "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" */
|
|
3855
|
+
subject?: string;
|
|
3799
3856
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3800
3857
|
/**
|
|
3801
|
-
* @tags Transfers
|
|
3802
|
-
* @name
|
|
3803
|
-
* @summary
|
|
3804
|
-
* @request
|
|
3858
|
+
* @tags Transfers Instant Account Verification
|
|
3859
|
+
* @name Complete
|
|
3860
|
+
* @summary Complete
|
|
3861
|
+
* @request POST:/iav/complete
|
|
3805
3862
|
* @secure
|
|
3806
3863
|
*/
|
|
3807
|
-
|
|
3808
|
-
/** @example "IND|MEX" */
|
|
3809
|
-
country?: any;
|
|
3810
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3864
|
+
complete(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3811
3865
|
/**
|
|
3812
|
-
* @tags Transfers
|
|
3813
|
-
* @name
|
|
3814
|
-
* @summary Bank
|
|
3815
|
-
* @request POST:/
|
|
3866
|
+
* @tags Transfers Instant Account Verification
|
|
3867
|
+
* @name ListBankAccounts
|
|
3868
|
+
* @summary List Bank Accounts
|
|
3869
|
+
* @request POST:/iav/list
|
|
3816
3870
|
* @secure
|
|
3817
3871
|
*/
|
|
3818
|
-
|
|
3819
|
-
|
|
3820
|
-
|
|
3821
|
-
|
|
3822
|
-
|
|
3823
|
-
|
|
3824
|
-
|
|
3825
|
-
|
|
3826
|
-
|
|
3827
|
-
/** @example
|
|
3828
|
-
|
|
3872
|
+
listBankAccounts(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3873
|
+
/**
|
|
3874
|
+
* @tags Transfers Instant Account Verification
|
|
3875
|
+
* @name LinkBankAccount
|
|
3876
|
+
* @summary Link Bank Account
|
|
3877
|
+
* @request POST:/iav/link
|
|
3878
|
+
* @secure
|
|
3879
|
+
*/
|
|
3880
|
+
linkBankAccount(data: {
|
|
3881
|
+
/** @example "5VXXXXX" */
|
|
3882
|
+
account?: any;
|
|
3883
|
+
/** @example "XXXXXXX" */
|
|
3884
|
+
bankAccountId?: any;
|
|
3829
3885
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3830
3886
|
/**
|
|
3831
|
-
* @tags Transfers
|
|
3832
|
-
* @name
|
|
3833
|
-
* @summary
|
|
3834
|
-
* @request POST:/
|
|
3887
|
+
* @tags Transfers Instant Account Verification
|
|
3888
|
+
* @name ImportWithPlaid
|
|
3889
|
+
* @summary Import With Plaid
|
|
3890
|
+
* @request POST:/iav/import
|
|
3835
3891
|
* @secure
|
|
3836
3892
|
*/
|
|
3837
|
-
|
|
3838
|
-
/** @example "
|
|
3893
|
+
importWithPlaid(data: {
|
|
3894
|
+
/** @example "3AB123456" */
|
|
3839
3895
|
account?: any;
|
|
3840
|
-
/** @example "
|
|
3841
|
-
|
|
3842
|
-
/** @example "John
|
|
3896
|
+
/** @example "123456" */
|
|
3897
|
+
bankAccountNumber?: any;
|
|
3898
|
+
/** @example "John Smith" */
|
|
3843
3899
|
bankAccountOwnerName?: any;
|
|
3844
|
-
/** @example "
|
|
3900
|
+
/** @example "checking" */
|
|
3845
3901
|
bankAccountType?: any;
|
|
3846
|
-
/** @example "
|
|
3902
|
+
/** @example "122105155" */
|
|
3847
3903
|
bankRoutingNumber?: any;
|
|
3848
|
-
/** @example "
|
|
3904
|
+
/** @example "Checking x456" */
|
|
3849
3905
|
nickname?: any;
|
|
3906
|
+
/** @example "{optional}" */
|
|
3907
|
+
note?: any;
|
|
3908
|
+
/** @example "{optional}" */
|
|
3909
|
+
remoteAddr?: any;
|
|
3910
|
+
/** @example "{optional}" */
|
|
3911
|
+
remoteDevice?: any;
|
|
3850
3912
|
}, 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>);
|
|
3851
3917
|
/**
|
|
3852
|
-
* @tags Transfers
|
|
3853
|
-
* @name
|
|
3854
|
-
* @summary
|
|
3855
|
-
* @request POST:/transfer/
|
|
3918
|
+
* @tags Transfers Ach
|
|
3919
|
+
* @name Deposit
|
|
3920
|
+
* @summary Deposit
|
|
3921
|
+
* @request POST:/transfer/ach/deposit
|
|
3856
3922
|
* @secure
|
|
3857
3923
|
*/
|
|
3858
|
-
|
|
3859
|
-
/**
|
|
3860
|
-
* @tags Transfers Relationships
|
|
3861
|
-
* @name BankingRelationship
|
|
3862
|
-
* @summary Banking relationship
|
|
3863
|
-
* @request POST:/transfer/relationship/bank/create
|
|
3864
|
-
* @secure
|
|
3865
|
-
*/
|
|
3866
|
-
bankingRelationship(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3867
|
-
/**
|
|
3868
|
-
* @tags Transfers Relationships
|
|
3869
|
-
* @name Approve
|
|
3870
|
-
* @summary Approve
|
|
3871
|
-
* @request POST:/transfer/relationship/approve
|
|
3872
|
-
* @secure
|
|
3873
|
-
*/
|
|
3874
|
-
approve(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3875
|
-
/**
|
|
3876
|
-
* @tags Transfers Relationships
|
|
3877
|
-
* @name Cancel
|
|
3878
|
-
* @summary Cancel
|
|
3879
|
-
* @request POST:/transfer/relationship/cancel/{entryId}
|
|
3880
|
-
* @secure
|
|
3881
|
-
*/
|
|
3882
|
-
cancel(entryId: string, data: {
|
|
3883
|
-
/** @example "2QC05208" */
|
|
3884
|
-
account?: any;
|
|
3885
|
-
/** @example "USER CANCELED" */
|
|
3886
|
-
reason?: any;
|
|
3887
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3888
|
-
/**
|
|
3889
|
-
* @tags Transfers Relationships
|
|
3890
|
-
* @name Rename
|
|
3891
|
-
* @summary Rename
|
|
3892
|
-
* @request POST:/transfer/relationship/rename/{entryId}
|
|
3893
|
-
* @secure
|
|
3894
|
-
*/
|
|
3895
|
-
rename(entryId: string, data: {
|
|
3896
|
-
/** @example "Citi Checking 2" */
|
|
3897
|
-
nickname?: any;
|
|
3898
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3899
|
-
/**
|
|
3900
|
-
* @tags Transfers Relationships
|
|
3901
|
-
* @name AdvisorPolicyUpdate
|
|
3902
|
-
* @summary Advisor Policy Update
|
|
3903
|
-
* @request POST:/transfer/relationship/policy
|
|
3904
|
-
* @secure
|
|
3905
|
-
*/
|
|
3906
|
-
advisorPolicyUpdate(data: {
|
|
3907
|
-
account?: {
|
|
3908
|
-
/** @example 0 */
|
|
3909
|
-
accountId?: number;
|
|
3910
|
-
/** @example "{optional}" */
|
|
3911
|
-
accountNumber?: string;
|
|
3912
|
-
};
|
|
3913
|
-
/** @example 123 */
|
|
3914
|
-
entryId?: any;
|
|
3915
|
-
/** @example true */
|
|
3916
|
-
esigned?: any;
|
|
3917
|
-
/** @example "AllowWithdrawal|Disallow" */
|
|
3918
|
-
policy?: any;
|
|
3919
|
-
/** @example "" */
|
|
3920
|
-
remoteAddr?: any;
|
|
3921
|
-
/** @example "" */
|
|
3922
|
-
remoteDevice?: any;
|
|
3923
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3924
|
-
/**
|
|
3925
|
-
* @tags Transfers Relationships
|
|
3926
|
-
* @name DocumentUpload
|
|
3927
|
-
* @summary Document upload
|
|
3928
|
-
* @request POST:/transfer/relationship/wire/upload
|
|
3929
|
-
* @secure
|
|
3930
|
-
*/
|
|
3931
|
-
documentUpload(data: {
|
|
3932
|
-
/**
|
|
3933
|
-
* Wire relationship ID
|
|
3934
|
-
* @example ""
|
|
3935
|
-
*/
|
|
3936
|
-
entryId?: string;
|
|
3937
|
-
/**
|
|
3938
|
-
* Document file
|
|
3939
|
-
* @format binary
|
|
3940
|
-
*/
|
|
3941
|
-
file?: File;
|
|
3942
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3943
|
-
/**
|
|
3944
|
-
* @tags Transfers Relationships
|
|
3945
|
-
* @name MfaReInitiation
|
|
3946
|
-
* @summary 2FA re-initiation
|
|
3947
|
-
* @request POST:/transfer/relationship/wire/2fa/reinitiate
|
|
3948
|
-
* @secure
|
|
3949
|
-
*/
|
|
3950
|
-
mfaReInitiation(data: {
|
|
3951
|
-
/** @example 123 */
|
|
3952
|
-
entryId?: any;
|
|
3953
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3954
|
-
/**
|
|
3955
|
-
* @tags Transfers Relationships
|
|
3956
|
-
* @name SupplementWire
|
|
3957
|
-
* @summary Supplement wire
|
|
3958
|
-
* @request POST:/transfer/relationship/wire/supplement
|
|
3959
|
-
* @secure
|
|
3960
|
-
*/
|
|
3961
|
-
supplementWire(data: {
|
|
3962
|
-
/** @example 123456 */
|
|
3963
|
-
entryId?: any;
|
|
3964
|
-
recipientBank?: {
|
|
3965
|
-
/** @example "Capital City" */
|
|
3966
|
-
city?: string;
|
|
3967
|
-
identifier?: {
|
|
3968
|
-
/** @example "AAA-123-2587964" */
|
|
3969
|
-
id?: string;
|
|
3970
|
-
/** @example "BIC" */
|
|
3971
|
-
type?: string;
|
|
3972
|
-
};
|
|
3973
|
-
/** @example "ABC 123" */
|
|
3974
|
-
postalCode?: string;
|
|
3975
|
-
/** @example "NJ" */
|
|
3976
|
-
stateProvince?: string;
|
|
3977
|
-
};
|
|
3978
|
-
userAccount?: {
|
|
3979
|
-
/** @example "AB12345" */
|
|
3980
|
-
accountNumber?: string;
|
|
3981
|
-
};
|
|
3982
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3983
|
-
}
|
|
3984
|
-
export class AdvisoryGroups<HandleError extends boolean = boolean> {
|
|
3985
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
3986
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
3987
|
-
/**
|
|
3988
|
-
* @tags Advisory Groups
|
|
3989
|
-
* @name GroupsManage
|
|
3990
|
-
* @request POST:/v1/groups/manage/{action}
|
|
3991
|
-
* @secure
|
|
3992
|
-
*/
|
|
3993
|
-
groupsManage(action: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3994
|
-
/**
|
|
3995
|
-
* @tags Advisory Groups
|
|
3996
|
-
* @name GroupsList
|
|
3997
|
-
* @request GET:/v1/groups/list
|
|
3998
|
-
* @secure
|
|
3999
|
-
*/
|
|
4000
|
-
groupsList(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4001
|
-
/**
|
|
4002
|
-
* @tags Advisory Groups
|
|
4003
|
-
* @name GroupAccountsStats
|
|
4004
|
-
* @request GET:/v2/advisory/group/accounts/stats/{groupsId}
|
|
4005
|
-
* @secure
|
|
4006
|
-
*/
|
|
4007
|
-
groupAccountsStats(groupsId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4008
|
-
/**
|
|
4009
|
-
* @tags Advisory Groups
|
|
4010
|
-
* @name GroupPortfolios
|
|
4011
|
-
* @request GET:/v2/advisory/group/portfolios/{groupId}
|
|
4012
|
-
* @secure
|
|
4013
|
-
*/
|
|
4014
|
-
groupPortfolios(groupId: string, query?: {
|
|
4015
|
-
/**
|
|
4016
|
-
* Should load quotes or not.
|
|
4017
|
-
* @example "false"
|
|
4018
|
-
*/
|
|
4019
|
-
loadQuotes?: any;
|
|
4020
|
-
/**
|
|
4021
|
-
* Whether to return combined portfolio (no accounts, with approximate prices)
|
|
4022
|
-
* @example "false"
|
|
4023
|
-
*/
|
|
4024
|
-
combined?: any;
|
|
4025
|
-
/** @example "false" */
|
|
4026
|
-
loadIndustries?: any;
|
|
4027
|
-
/** @example "false" */
|
|
4028
|
-
loadUpgrades?: any;
|
|
4029
|
-
/** @example "false" */
|
|
4030
|
-
loadEarnings?: any;
|
|
4031
|
-
/**
|
|
4032
|
-
* Whether or not to include orders comprising each position's cost
|
|
4033
|
-
* @example "false"
|
|
4034
|
-
*/
|
|
4035
|
-
loadCost?: any;
|
|
4036
|
-
/**
|
|
4037
|
-
* Analyze market caps and get `marketCapWeights`. To be used in conjuction with `loadQuotes`
|
|
4038
|
-
* @example "false"
|
|
4039
|
-
*/
|
|
4040
|
-
marketCapWeights?: any;
|
|
4041
|
-
/** @example "1" */
|
|
4042
|
-
pageNum?: any;
|
|
4043
|
-
/** @example "100" */
|
|
4044
|
-
pageSize?: any;
|
|
4045
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4046
|
-
/**
|
|
4047
|
-
* @tags Advisory Groups
|
|
4048
|
-
* @name GroupRtb
|
|
4049
|
-
* @request GET:/v2/advisory/group/rtb/{groupId}
|
|
4050
|
-
* @secure
|
|
4051
|
-
*/
|
|
4052
|
-
groupRtb(groupId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4053
|
-
/**
|
|
4054
|
-
* @tags Advisory Groups
|
|
4055
|
-
* @name GroupRtbs
|
|
4056
|
-
* @request GET:/v2/advisory/group/rtbs/{groupId}
|
|
4057
|
-
* @secure
|
|
4058
|
-
*/
|
|
4059
|
-
groupRtbs(groupId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4060
|
-
}
|
|
4061
|
-
export class TransfersInstantAccountVerification<HandleError extends boolean = boolean> {
|
|
4062
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4063
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4064
|
-
/**
|
|
4065
|
-
* @tags Transfers Instant Account Verification
|
|
4066
|
-
* @name Initiate
|
|
4067
|
-
* @summary Initiate
|
|
4068
|
-
* @request GET:/iav/init
|
|
4069
|
-
* @secure
|
|
4070
|
-
*/
|
|
4071
|
-
initiate(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4072
|
-
/**
|
|
4073
|
-
* @tags Transfers Instant Account Verification
|
|
4074
|
-
* @name InitiatePost
|
|
4075
|
-
* @summary Initiate Post
|
|
4076
|
-
* @request POST:/iav/init
|
|
4077
|
-
* @secure
|
|
4078
|
-
*/
|
|
4079
|
-
initiatePost(query: object, data: {
|
|
4080
|
-
/** @example "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" */
|
|
4081
|
-
subject?: string;
|
|
4082
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4083
|
-
/**
|
|
4084
|
-
* @tags Transfers Instant Account Verification
|
|
4085
|
-
* @name Complete
|
|
4086
|
-
* @summary Complete
|
|
4087
|
-
* @request POST:/iav/complete
|
|
4088
|
-
* @secure
|
|
4089
|
-
*/
|
|
4090
|
-
complete(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4091
|
-
/**
|
|
4092
|
-
* @tags Transfers Instant Account Verification
|
|
4093
|
-
* @name ListBankAccounts
|
|
4094
|
-
* @summary List Bank Accounts
|
|
4095
|
-
* @request POST:/iav/list
|
|
4096
|
-
* @secure
|
|
4097
|
-
*/
|
|
4098
|
-
listBankAccounts(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4099
|
-
/**
|
|
4100
|
-
* @tags Transfers Instant Account Verification
|
|
4101
|
-
* @name LinkBankAccount
|
|
4102
|
-
* @summary Link Bank Account
|
|
4103
|
-
* @request POST:/iav/link
|
|
4104
|
-
* @secure
|
|
4105
|
-
*/
|
|
4106
|
-
linkBankAccount(data: {
|
|
4107
|
-
/** @example "5VXXXXX" */
|
|
4108
|
-
account?: any;
|
|
4109
|
-
/** @example "XXXXXXX" */
|
|
4110
|
-
bankAccountId?: any;
|
|
4111
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4112
|
-
/**
|
|
4113
|
-
* @tags Transfers Instant Account Verification
|
|
4114
|
-
* @name ImportWithPlaid
|
|
4115
|
-
* @summary Import With Plaid
|
|
4116
|
-
* @request POST:/iav/import
|
|
4117
|
-
* @secure
|
|
4118
|
-
*/
|
|
4119
|
-
importWithPlaid(data: {
|
|
4120
|
-
/** @example "3AB123456" */
|
|
4121
|
-
account?: any;
|
|
4122
|
-
/** @example "123456" */
|
|
4123
|
-
bankAccountNumber?: any;
|
|
4124
|
-
/** @example "John Smith" */
|
|
4125
|
-
bankAccountOwnerName?: any;
|
|
4126
|
-
/** @example "checking" */
|
|
4127
|
-
bankAccountType?: any;
|
|
4128
|
-
/** @example "122105155" */
|
|
4129
|
-
bankRoutingNumber?: any;
|
|
4130
|
-
/** @example "Checking x456" */
|
|
4131
|
-
nickname?: any;
|
|
4132
|
-
/** @example "{optional}" */
|
|
4133
|
-
note?: any;
|
|
4134
|
-
/** @example "{optional}" */
|
|
4135
|
-
remoteAddr?: any;
|
|
4136
|
-
/** @example "{optional}" */
|
|
4137
|
-
remoteDevice?: any;
|
|
4138
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4139
|
-
}
|
|
4140
|
-
export class TransfersAch<HandleError extends boolean = boolean> {
|
|
4141
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4142
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4143
|
-
/**
|
|
4144
|
-
* @tags Transfers Ach
|
|
4145
|
-
* @name Deposit
|
|
4146
|
-
* @summary Deposit
|
|
4147
|
-
* @request POST:/transfer/ach/deposit
|
|
4148
|
-
* @secure
|
|
4149
|
-
*/
|
|
4150
|
-
deposit(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3924
|
+
deposit(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4151
3925
|
/**
|
|
4152
3926
|
* @tags Transfers Ach
|
|
4153
3927
|
* @name Withdraw
|
|
@@ -4157,24 +3931,6 @@ export class TransfersAch<HandleError extends boolean = boolean> {
|
|
|
4157
3931
|
*/
|
|
4158
3932
|
withdraw(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4159
3933
|
}
|
|
4160
|
-
export class Device<HandleError extends boolean = boolean> {
|
|
4161
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4162
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4163
|
-
/**
|
|
4164
|
-
* @tags Device
|
|
4165
|
-
* @name DeviceDeactivate
|
|
4166
|
-
* @summary /device/deactivate
|
|
4167
|
-
* @request POST:/device/deactivate
|
|
4168
|
-
* @secure
|
|
4169
|
-
*/
|
|
4170
|
-
deviceDeactivate(data: {
|
|
4171
|
-
/**
|
|
4172
|
-
* Token previously registered
|
|
4173
|
-
* @example "123456789"
|
|
4174
|
-
*/
|
|
4175
|
-
Token?: string;
|
|
4176
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4177
|
-
}
|
|
4178
3934
|
export class TransfersAcats<HandleError extends boolean = boolean> {
|
|
4179
3935
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4180
3936
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4383,17 +4139,19 @@ export class TransfersWires<HandleError extends boolean = boolean> {
|
|
|
4383
4139
|
remoteDevice?: any;
|
|
4384
4140
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4385
4141
|
}
|
|
4386
|
-
export class
|
|
4142
|
+
export class TransfersJournals<HandleError extends boolean = boolean> {
|
|
4387
4143
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4388
4144
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4389
4145
|
/**
|
|
4390
|
-
* @tags Transfers
|
|
4391
|
-
* @name
|
|
4392
|
-
* @summary
|
|
4393
|
-
* @request POST:/transfer/
|
|
4146
|
+
* @tags Transfers Journals
|
|
4147
|
+
* @name JournalRequest
|
|
4148
|
+
* @summary Journal request
|
|
4149
|
+
* @request POST:/transfer/journal/request
|
|
4394
4150
|
* @secure
|
|
4395
4151
|
*/
|
|
4396
|
-
|
|
4152
|
+
journalRequest(data: {
|
|
4153
|
+
/** @example 1000 */
|
|
4154
|
+
amount?: any;
|
|
4397
4155
|
deliverFrom?: {
|
|
4398
4156
|
/** @example 124 */
|
|
4399
4157
|
accountId?: number;
|
|
@@ -4406,47 +4164,62 @@ export class TransfersPositions<HandleError extends boolean = boolean> {
|
|
|
4406
4164
|
/** @example "DEF123456" */
|
|
4407
4165
|
accountNumber?: string;
|
|
4408
4166
|
};
|
|
4409
|
-
/** @example "
|
|
4410
|
-
|
|
4411
|
-
|
|
4412
|
-
|
|
4413
|
-
|
|
4414
|
-
/** @example "
|
|
4415
|
-
|
|
4167
|
+
/** @example "MM/dd/yyyy HH:mm:ss z" */
|
|
4168
|
+
deliveryDate?: any;
|
|
4169
|
+
loa?: {
|
|
4170
|
+
/** @example "" */
|
|
4171
|
+
fullName?: string;
|
|
4172
|
+
/** @example "" */
|
|
4173
|
+
remoteAddr?: string;
|
|
4174
|
+
/** @example "" */
|
|
4175
|
+
remoteDevice?: string;
|
|
4176
|
+
/** @example "" */
|
|
4177
|
+
signature?: string;
|
|
4178
|
+
/** @example "MM/dd/yyyy HH:mm:ss z" */
|
|
4179
|
+
timestamp?: string;
|
|
4416
4180
|
};
|
|
4181
|
+
/** @example "NoPurpose|Gift|StockGift" */
|
|
4182
|
+
purpose?: any;
|
|
4417
4183
|
/** @example "" */
|
|
4418
4184
|
reason?: any;
|
|
4419
4185
|
/** @example "0.0.0.0" */
|
|
4420
4186
|
remoteAddr?: any;
|
|
4421
4187
|
/** @example "Ultra fast proxy" */
|
|
4422
4188
|
remoteDevice?: any;
|
|
4189
|
+
/** @example "required for StockGift" */
|
|
4190
|
+
symbol?: any;
|
|
4423
4191
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4424
|
-
}
|
|
4425
|
-
export class TransfersBank<HandleError extends boolean = boolean> {
|
|
4426
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4427
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4428
4192
|
/**
|
|
4429
|
-
* @tags Transfers
|
|
4430
|
-
* @name
|
|
4431
|
-
* @summary
|
|
4432
|
-
* @request POST:/transfer/
|
|
4193
|
+
* @tags Transfers Journals
|
|
4194
|
+
* @name Search
|
|
4195
|
+
* @summary Search
|
|
4196
|
+
* @request POST:/transfer/journal/search
|
|
4433
4197
|
* @secure
|
|
4434
4198
|
*/
|
|
4435
|
-
|
|
4199
|
+
search(data: {
|
|
4200
|
+
account?: {
|
|
4201
|
+
/** @example 0 */
|
|
4202
|
+
accountId?: number;
|
|
4203
|
+
/** @example "ABC123456" */
|
|
4204
|
+
accountNumber?: string;
|
|
4205
|
+
};
|
|
4206
|
+
/** @example "PLACED|SENT|..." */
|
|
4207
|
+
status?: any;
|
|
4208
|
+
/** @example "AB123456" */
|
|
4209
|
+
transferId?: any;
|
|
4210
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4436
4211
|
}
|
|
4437
|
-
export class
|
|
4212
|
+
export class TransfersPositions<HandleError extends boolean = boolean> {
|
|
4438
4213
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4439
4214
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4440
4215
|
/**
|
|
4441
|
-
* @tags Transfers
|
|
4442
|
-
* @name
|
|
4443
|
-
* @summary
|
|
4444
|
-
* @request POST:/transfer/
|
|
4216
|
+
* @tags Transfers Positions
|
|
4217
|
+
* @name TransferRequest
|
|
4218
|
+
* @summary Transfer request
|
|
4219
|
+
* @request POST:/transfer/position/request
|
|
4445
4220
|
* @secure
|
|
4446
4221
|
*/
|
|
4447
|
-
|
|
4448
|
-
/** @example 1000 */
|
|
4449
|
-
amount?: any;
|
|
4222
|
+
transferRequest(data: {
|
|
4450
4223
|
deliverFrom?: {
|
|
4451
4224
|
/** @example 124 */
|
|
4452
4225
|
accountId?: number;
|
|
@@ -4459,50 +4232,33 @@ export class TransfersJournals<HandleError extends boolean = boolean> {
|
|
|
4459
4232
|
/** @example "DEF123456" */
|
|
4460
4233
|
accountNumber?: string;
|
|
4461
4234
|
};
|
|
4462
|
-
/** @example "
|
|
4463
|
-
deliveryDate?: any;
|
|
4464
|
-
loa?: {
|
|
4465
|
-
/** @example "" */
|
|
4466
|
-
fullName?: string;
|
|
4467
|
-
/** @example "" */
|
|
4468
|
-
remoteAddr?: string;
|
|
4469
|
-
/** @example "" */
|
|
4470
|
-
remoteDevice?: string;
|
|
4471
|
-
/** @example "" */
|
|
4472
|
-
signature?: string;
|
|
4473
|
-
/** @example "MM/dd/yyyy HH:mm:ss z" */
|
|
4474
|
-
timestamp?: string;
|
|
4475
|
-
};
|
|
4476
|
-
/** @example "NoPurpose|Gift|StockGift" */
|
|
4235
|
+
/** @example "NoPurpose|Gift" */
|
|
4477
4236
|
purpose?: any;
|
|
4237
|
+
/** @example 1000 */
|
|
4238
|
+
quantity?: any;
|
|
4239
|
+
quote?: {
|
|
4240
|
+
/** @example "IBM" */
|
|
4241
|
+
symbol?: string;
|
|
4242
|
+
};
|
|
4478
4243
|
/** @example "" */
|
|
4479
4244
|
reason?: any;
|
|
4480
4245
|
/** @example "0.0.0.0" */
|
|
4481
4246
|
remoteAddr?: any;
|
|
4482
4247
|
/** @example "Ultra fast proxy" */
|
|
4483
4248
|
remoteDevice?: any;
|
|
4484
|
-
/** @example "required for StockGift" */
|
|
4485
|
-
symbol?: any;
|
|
4486
4249
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4250
|
+
}
|
|
4251
|
+
export class TransfersBank<HandleError extends boolean = boolean> {
|
|
4252
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4253
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4487
4254
|
/**
|
|
4488
|
-
* @tags Transfers
|
|
4489
|
-
* @name
|
|
4490
|
-
* @summary
|
|
4491
|
-
* @request POST:/transfer/
|
|
4255
|
+
* @tags Transfers Bank
|
|
4256
|
+
* @name FundTransfer
|
|
4257
|
+
* @summary Fund transfer
|
|
4258
|
+
* @request POST:/transfer/bank/{direction}
|
|
4492
4259
|
* @secure
|
|
4493
4260
|
*/
|
|
4494
|
-
|
|
4495
|
-
account?: {
|
|
4496
|
-
/** @example 0 */
|
|
4497
|
-
accountId?: number;
|
|
4498
|
-
/** @example "ABC123456" */
|
|
4499
|
-
accountNumber?: string;
|
|
4500
|
-
};
|
|
4501
|
-
/** @example "PLACED|SENT|..." */
|
|
4502
|
-
status?: any;
|
|
4503
|
-
/** @example "AB123456" */
|
|
4504
|
-
transferId?: any;
|
|
4505
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4261
|
+
fundTransfer(direction: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4506
4262
|
}
|
|
4507
4263
|
export class TransfersInstantCashTransfers<HandleError extends boolean = boolean> {
|
|
4508
4264
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -4588,26 +4344,270 @@ export class TransfersInstantCashTransfers<HandleError extends boolean = boolean
|
|
|
4588
4344
|
remoteDevice?: any;
|
|
4589
4345
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4590
4346
|
/**
|
|
4591
|
-
* @tags Transfers Instant Cash Transfers
|
|
4592
|
-
* @name ObtainTheReport
|
|
4593
|
-
* @summary Obtain the report
|
|
4594
|
-
* @request POST:/transfer/reports/obtain
|
|
4347
|
+
* @tags Transfers Instant Cash Transfers
|
|
4348
|
+
* @name ObtainTheReport
|
|
4349
|
+
* @summary Obtain the report
|
|
4350
|
+
* @request POST:/transfer/reports/obtain
|
|
4351
|
+
* @secure
|
|
4352
|
+
*/
|
|
4353
|
+
obtainTheReport(data: {
|
|
4354
|
+
/** @example "MM/DD/YYYY HH:MM:SS ZZZ" */
|
|
4355
|
+
date?: any;
|
|
4356
|
+
/** @example "RETAIL_BANKING" */
|
|
4357
|
+
reportType?: any;
|
|
4358
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4359
|
+
/**
|
|
4360
|
+
* @tags Transfers Instant Cash Transfers
|
|
4361
|
+
* @name ListReports
|
|
4362
|
+
* @summary List reports
|
|
4363
|
+
* @request GET:/transfer/reports
|
|
4364
|
+
* @secure
|
|
4365
|
+
*/
|
|
4366
|
+
listReports(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4367
|
+
}
|
|
4368
|
+
export class TransfersRelationships<HandleError extends boolean = boolean> {
|
|
4369
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4370
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4371
|
+
/**
|
|
4372
|
+
* @tags Transfers Relationships
|
|
4373
|
+
* @name List
|
|
4374
|
+
* @summary List
|
|
4375
|
+
* @request GET:/transfer/relationship/list/{account}
|
|
4376
|
+
* @secure
|
|
4377
|
+
*/
|
|
4378
|
+
list(account: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4379
|
+
/**
|
|
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
|
|
4595
4557
|
* @secure
|
|
4596
4558
|
*/
|
|
4597
|
-
|
|
4598
|
-
/**
|
|
4599
|
-
|
|
4600
|
-
|
|
4601
|
-
|
|
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;
|
|
4602
4570
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4603
4571
|
/**
|
|
4604
|
-
* @tags Transfers
|
|
4605
|
-
* @name
|
|
4606
|
-
* @summary
|
|
4607
|
-
* @request
|
|
4572
|
+
* @tags Transfers Relationships
|
|
4573
|
+
* @name MfaReInitiation
|
|
4574
|
+
* @summary 2FA re-initiation
|
|
4575
|
+
* @request POST:/transfer/relationship/wire/2fa/reinitiate
|
|
4608
4576
|
* @secure
|
|
4609
4577
|
*/
|
|
4610
|
-
|
|
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
4611
|
}
|
|
4612
4612
|
export class TransfersCheques<HandleError extends boolean = boolean> {
|
|
4613
4613
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -4776,84 +4776,233 @@ export class Transfers<HandleError extends boolean = boolean> {
|
|
|
4776
4776
|
* @request GET:/transfer/fees/classifications/fees
|
|
4777
4777
|
* @secure
|
|
4778
4778
|
*/
|
|
4779
|
-
listFees(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4779
|
+
listFees(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4780
|
+
/**
|
|
4781
|
+
* @tags Transfers
|
|
4782
|
+
* @name ListCredits
|
|
4783
|
+
* @summary List credits
|
|
4784
|
+
* @request GET:/transfer/fees/classifications/credits
|
|
4785
|
+
* @secure
|
|
4786
|
+
*/
|
|
4787
|
+
listCredits(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4788
|
+
/**
|
|
4789
|
+
* @tags Transfers
|
|
4790
|
+
* @name CryptoDepositAddress
|
|
4791
|
+
* @summary Crypto Deposit Address
|
|
4792
|
+
* @request GET:/transfer/crypto/deposit/wallet/address
|
|
4793
|
+
* @secure
|
|
4794
|
+
*/
|
|
4795
|
+
cryptoDepositAddress(data: {
|
|
4796
|
+
/** @example "AB123456" */
|
|
4797
|
+
account?: any;
|
|
4798
|
+
/** @example "BTC" */
|
|
4799
|
+
currency?: any;
|
|
4800
|
+
/** @example "{optional}" */
|
|
4801
|
+
network?: any;
|
|
4802
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
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;
|
|
4819
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4820
|
+
/**
|
|
4821
|
+
* @tags Transfers
|
|
4822
|
+
* @name CryptoWithdrawal
|
|
4823
|
+
* @summary Crypto Withdrawal
|
|
4824
|
+
* @request POST:/transfer/crypto/withdraw
|
|
4825
|
+
* @secure
|
|
4826
|
+
*/
|
|
4827
|
+
cryptoWithdrawal(data: {
|
|
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>>;
|
|
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>>;
|
|
4780
4971
|
/**
|
|
4781
|
-
* @tags
|
|
4782
|
-
* @name
|
|
4783
|
-
* @summary
|
|
4784
|
-
* @request GET:/
|
|
4972
|
+
* @tags Documents
|
|
4973
|
+
* @name AvailableDocumentTypesAndCodes
|
|
4974
|
+
* @summary Available document types and codes
|
|
4975
|
+
* @request GET:/documents/typesAndCodes
|
|
4785
4976
|
* @secure
|
|
4786
4977
|
*/
|
|
4787
|
-
|
|
4978
|
+
availableDocumentTypesAndCodes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4788
4979
|
/**
|
|
4789
|
-
* @tags
|
|
4790
|
-
* @name
|
|
4791
|
-
* @summary
|
|
4792
|
-
* @request GET:/
|
|
4980
|
+
* @tags Documents
|
|
4981
|
+
* @name Download
|
|
4982
|
+
* @summary Download
|
|
4983
|
+
* @request GET:/documents/download
|
|
4793
4984
|
* @secure
|
|
4794
4985
|
*/
|
|
4795
|
-
|
|
4796
|
-
/**
|
|
4986
|
+
download(query?: {
|
|
4987
|
+
/**
|
|
4988
|
+
* Account Number
|
|
4989
|
+
* @example "{accountNumber}"
|
|
4990
|
+
*/
|
|
4797
4991
|
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;
|
|
4992
|
+
/**
|
|
4993
|
+
* UUID for finding specific document
|
|
4994
|
+
* @example "{key}"
|
|
4995
|
+
*/
|
|
4996
|
+
key?: any;
|
|
4819
4997
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4820
4998
|
/**
|
|
4821
|
-
* @tags
|
|
4822
|
-
* @name
|
|
4823
|
-
* @summary
|
|
4824
|
-
* @request
|
|
4999
|
+
* @tags Documents
|
|
5000
|
+
* @name GetAllBranchDocuments
|
|
5001
|
+
* @summary Get all Branch Documents
|
|
5002
|
+
* @request GET:/documents/branch/list
|
|
4825
5003
|
* @secure
|
|
4826
5004
|
*/
|
|
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>>;
|
|
5005
|
+
getAllBranchDocuments(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4857
5006
|
}
|
|
4858
5007
|
export class Miscellaneous<HandleError extends boolean = boolean> {
|
|
4859
5008
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -4968,223 +5117,74 @@ export class Miscellaneous<HandleError extends boolean = boolean> {
|
|
|
4968
5117
|
* @name FilesList
|
|
4969
5118
|
* @request GET:/v1/files/list
|
|
4970
5119
|
* @secure
|
|
4971
|
-
*/
|
|
4972
|
-
filesList(query?: {
|
|
4973
|
-
/**
|
|
4974
|
-
* Optional. Allows filtering for tags
|
|
4975
|
-
* @example "document*"
|
|
4976
|
-
*/
|
|
4977
|
-
tag?: any;
|
|
4978
|
-
/**
|
|
4979
|
-
* Optional. Allows filtering for filenames
|
|
4980
|
-
* @example "application*"
|
|
4981
|
-
*/
|
|
4982
|
-
filename?: any;
|
|
4983
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4984
|
-
/**
|
|
4985
|
-
* @tags Miscellaneous
|
|
4986
|
-
* @name FilesAllowedExts
|
|
4987
|
-
* @request GET:/v1/files/allowed/exts
|
|
4988
|
-
* @secure
|
|
4989
|
-
*/
|
|
4990
|
-
filesAllowedExts(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4991
|
-
/**
|
|
4992
|
-
* @tags Miscellaneous
|
|
4993
|
-
* @name ErrorCodeListing
|
|
4994
|
-
* @summary Error code listing
|
|
4995
|
-
* @request GET:/general/errors
|
|
4996
|
-
* @secure
|
|
4997
|
-
*/
|
|
4998
|
-
errorCodeListing(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4999
|
-
/**
|
|
5000
|
-
* @tags Miscellaneous
|
|
5001
|
-
* @name Ping
|
|
5002
|
-
* @summary Ping
|
|
5003
|
-
* @request GET:/general/ping
|
|
5004
|
-
* @secure
|
|
5005
|
-
*/
|
|
5006
|
-
ping(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5007
|
-
/**
|
|
5008
|
-
* @tags Miscellaneous
|
|
5009
|
-
* @name CurrencyList
|
|
5010
|
-
* @summary Currency list
|
|
5011
|
-
* @request GET:/general/available-currencies
|
|
5012
|
-
* @secure
|
|
5013
|
-
*/
|
|
5014
|
-
currencyList(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5015
|
-
/**
|
|
5016
|
-
* @tags Miscellaneous
|
|
5017
|
-
* @name TradableCurrencyList
|
|
5018
|
-
* @summary Tradable currency list
|
|
5019
|
-
* @request GET:/general/tradable-currencies
|
|
5020
|
-
* @secure
|
|
5021
|
-
*/
|
|
5022
|
-
tradableCurrencyList(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5023
|
-
/**
|
|
5024
|
-
* @tags Miscellaneous
|
|
5025
|
-
* @name OptionStrategyTypes
|
|
5026
|
-
* @summary Option Strategy Types
|
|
5027
|
-
* @request GET:/general/options/strategyTypes
|
|
5028
|
-
* @secure
|
|
5029
|
-
*/
|
|
5030
|
-
optionStrategyTypes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5031
|
-
/**
|
|
5032
|
-
* @tags Miscellaneous
|
|
5033
|
-
* @name OptionStrategyClassifications
|
|
5034
|
-
* @summary Option Strategy Classifications
|
|
5035
|
-
* @request GET:/general/options/strategyClassifications
|
|
5036
|
-
* @secure
|
|
5037
|
-
*/
|
|
5038
|
-
optionStrategyClassifications(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5039
|
-
}
|
|
5040
|
-
export class Documents<HandleError extends boolean = boolean> {
|
|
5041
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5042
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5043
|
-
/**
|
|
5044
|
-
* @tags Documents
|
|
5045
|
-
* @name Confirm
|
|
5046
|
-
* @summary Confirm
|
|
5047
|
-
* @request GET:/documents/confirm
|
|
5048
|
-
* @secure
|
|
5049
|
-
*/
|
|
5050
|
-
confirm(query?: {
|
|
5051
|
-
/**
|
|
5052
|
-
* *_accountNumber_ is accepted as well*
|
|
5053
|
-
* @example "5VA0XXXX"
|
|
5054
|
-
*/
|
|
5055
|
-
account?: any;
|
|
5056
|
-
/**
|
|
5057
|
-
* Date for the confirm. The required date format is: mm/dd/yyyy.
|
|
5058
|
-
* @example "03/03/2018"
|
|
5059
|
-
*/
|
|
5060
|
-
date?: any;
|
|
5061
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5062
|
-
/**
|
|
5063
|
-
* @tags Documents
|
|
5064
|
-
* @name ListOfConfirms
|
|
5065
|
-
* @summary List of Confirms
|
|
5066
|
-
* @request GET:/documents/confirm/list
|
|
5067
|
-
* @secure
|
|
5068
|
-
*/
|
|
5069
|
-
listOfConfirms(query?: {
|
|
5070
|
-
/**
|
|
5071
|
-
* *_accountNumber_ is accepted as well*
|
|
5072
|
-
* @example "5VA0XXXX"
|
|
5073
|
-
*/
|
|
5074
|
-
account?: any;
|
|
5075
|
-
/**
|
|
5076
|
-
* Start date for the list of confirms. The required date format is: `mm/dd/yyyy`.
|
|
5077
|
-
* @example "01/01/2017"
|
|
5078
|
-
*/
|
|
5079
|
-
beginDate?: any;
|
|
5080
|
-
/**
|
|
5081
|
-
* End date for the list of confirms. The required date format is: `mm/dd/yyyy`.
|
|
5082
|
-
* @example "03/01/2018"
|
|
5083
|
-
*/
|
|
5084
|
-
endDate?: any;
|
|
5085
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5086
|
-
/**
|
|
5087
|
-
* @tags Documents
|
|
5088
|
-
* @name ServiceDocs
|
|
5089
|
-
* @summary Service Docs
|
|
5090
|
-
* @request GET:/documents/service
|
|
5091
|
-
* @secure
|
|
5092
|
-
*/
|
|
5093
|
-
serviceDocs(query?: {
|
|
5094
|
-
/** @example "5VA0XXXX" */
|
|
5095
|
-
accountNumber?: any;
|
|
5096
|
-
/** See table for details. Leave blank for all document types. */
|
|
5097
|
-
docType?: any;
|
|
5098
|
-
/**
|
|
5099
|
-
* The beginning 2-digit month (MM) to be used as search criteria.
|
|
5100
|
-
* @example "01"
|
|
5101
|
-
*/
|
|
5102
|
-
beginMonth?: any;
|
|
5103
|
-
/**
|
|
5104
|
-
* The beginning 4-digit year (YYYY) to be used as search criteria.
|
|
5105
|
-
* @example "2012"
|
|
5106
|
-
*/
|
|
5107
|
-
beginYear?: any;
|
|
5108
|
-
/**
|
|
5109
|
-
* The ending 2-digit month (MM) to be used as search criteria.
|
|
5110
|
-
* @example "12"
|
|
5111
|
-
*/
|
|
5112
|
-
endMonth?: any;
|
|
5113
|
-
/**
|
|
5114
|
-
* The ending 4-digit year (YYYY) to be used as search criteria.
|
|
5115
|
-
* @example "2017"
|
|
5116
|
-
*/
|
|
5117
|
-
endYear?: any;
|
|
5118
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5119
|
-
/**
|
|
5120
|
-
* @tags Documents
|
|
5121
|
-
* @name DocumentList
|
|
5122
|
-
* @summary Document list
|
|
5123
|
-
* @request GET:/documents/list
|
|
5124
|
-
* @secure
|
|
5125
|
-
*/
|
|
5126
|
-
documentList(query?: {
|
|
5127
|
-
/** @example "5VA0XXXX" */
|
|
5128
|
-
account?: any;
|
|
5129
|
-
/**
|
|
5130
|
-
* Omit for all document types.
|
|
5131
|
-
* @example "All"
|
|
5132
|
-
*/
|
|
5133
|
-
documentType?: any;
|
|
5120
|
+
*/
|
|
5121
|
+
filesList(query?: {
|
|
5134
5122
|
/**
|
|
5135
|
-
*
|
|
5136
|
-
* @example "
|
|
5123
|
+
* Optional. Allows filtering for tags
|
|
5124
|
+
* @example "document*"
|
|
5137
5125
|
*/
|
|
5138
|
-
|
|
5126
|
+
tag?: any;
|
|
5139
5127
|
/**
|
|
5140
|
-
*
|
|
5141
|
-
* @example "
|
|
5128
|
+
* Optional. Allows filtering for filenames
|
|
5129
|
+
* @example "application*"
|
|
5142
5130
|
*/
|
|
5143
|
-
|
|
5131
|
+
filename?: any;
|
|
5144
5132
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5145
5133
|
/**
|
|
5146
|
-
* @tags
|
|
5147
|
-
* @name
|
|
5148
|
-
* @
|
|
5149
|
-
* @request GET:/documents/types
|
|
5134
|
+
* @tags Miscellaneous
|
|
5135
|
+
* @name FilesAllowedExts
|
|
5136
|
+
* @request GET:/v1/files/allowed/exts
|
|
5150
5137
|
* @secure
|
|
5151
5138
|
*/
|
|
5152
|
-
|
|
5139
|
+
filesAllowedExts(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5153
5140
|
/**
|
|
5154
|
-
* @tags
|
|
5155
|
-
* @name
|
|
5156
|
-
* @summary
|
|
5157
|
-
* @request GET:/
|
|
5141
|
+
* @tags Miscellaneous
|
|
5142
|
+
* @name ErrorCodeListing
|
|
5143
|
+
* @summary Error code listing
|
|
5144
|
+
* @request GET:/general/errors
|
|
5158
5145
|
* @secure
|
|
5159
5146
|
*/
|
|
5160
|
-
|
|
5147
|
+
errorCodeListing(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5161
5148
|
/**
|
|
5162
|
-
* @tags
|
|
5163
|
-
* @name
|
|
5164
|
-
* @summary
|
|
5165
|
-
* @request GET:/
|
|
5149
|
+
* @tags Miscellaneous
|
|
5150
|
+
* @name Ping
|
|
5151
|
+
* @summary Ping
|
|
5152
|
+
* @request GET:/general/ping
|
|
5166
5153
|
* @secure
|
|
5167
5154
|
*/
|
|
5168
|
-
|
|
5169
|
-
/**
|
|
5170
|
-
* Account Number
|
|
5171
|
-
* @example "{accountNumber}"
|
|
5172
|
-
*/
|
|
5173
|
-
account?: any;
|
|
5174
|
-
/**
|
|
5175
|
-
* UUID for finding specific document
|
|
5176
|
-
* @example "{key}"
|
|
5177
|
-
*/
|
|
5178
|
-
key?: any;
|
|
5179
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5155
|
+
ping(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5180
5156
|
/**
|
|
5181
|
-
* @tags
|
|
5182
|
-
* @name
|
|
5183
|
-
* @summary
|
|
5184
|
-
* @request GET:/
|
|
5157
|
+
* @tags Miscellaneous
|
|
5158
|
+
* @name CurrencyList
|
|
5159
|
+
* @summary Currency list
|
|
5160
|
+
* @request GET:/general/available-currencies
|
|
5185
5161
|
* @secure
|
|
5186
5162
|
*/
|
|
5187
|
-
|
|
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
5188
|
}
|
|
5189
5189
|
export class Branch<HandleError extends boolean = boolean> {
|
|
5190
5190
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -5218,64 +5218,277 @@ export class Branch<HandleError extends boolean = boolean> {
|
|
|
5218
5218
|
*/
|
|
5219
5219
|
branchRtbsTotal(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5220
5220
|
/**
|
|
5221
|
-
* @tags Branch
|
|
5222
|
-
* @name BranchPortfolio
|
|
5223
|
-
* @request GET:/v1/branch/portfolio
|
|
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
|
|
5318
|
+
* @secure
|
|
5319
|
+
*/
|
|
5320
|
+
documentContent(query?: {
|
|
5321
|
+
/** @example "{as provided}" */
|
|
5322
|
+
id?: any;
|
|
5323
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5324
|
+
/**
|
|
5325
|
+
* @tags Legal Documents
|
|
5326
|
+
* @name DocumentDownload
|
|
5327
|
+
* @summary Document download
|
|
5328
|
+
* @request GET:/user/legal/document/download
|
|
5329
|
+
* @secure
|
|
5330
|
+
*/
|
|
5331
|
+
documentDownload(query?: {
|
|
5332
|
+
/** @example "{as provided}" */
|
|
5333
|
+
id?: any;
|
|
5334
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5335
|
+
/**
|
|
5336
|
+
* @tags Legal Documents
|
|
5337
|
+
* @name SignTheDocument
|
|
5338
|
+
* @summary Sign the document
|
|
5339
|
+
* @request POST:/user/legal/document/sign
|
|
5340
|
+
* @secure
|
|
5341
|
+
*/
|
|
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>>;
|
|
5364
|
+
/**
|
|
5365
|
+
* @tags Legal Documents
|
|
5366
|
+
* @name UpdatesPolicyOnTheAccount
|
|
5367
|
+
* @summary Updates policy on the account
|
|
5368
|
+
* @request POST:/user/legal/policy/{type}
|
|
5369
|
+
* @secure
|
|
5370
|
+
*/
|
|
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>>;
|
|
5387
|
+
}
|
|
5388
|
+
export class BlacklistAdminBusinesses<HandleError extends boolean = boolean> {
|
|
5389
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5390
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5391
|
+
/**
|
|
5392
|
+
* @tags Blacklist Admin Businesses
|
|
5393
|
+
* @name GetBusinessesList
|
|
5394
|
+
* @summary Get Businesses list
|
|
5395
|
+
* @request GET:/v1/admin/businesses
|
|
5224
5396
|
* @secure
|
|
5225
5397
|
*/
|
|
5226
|
-
|
|
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;
|
|
5398
|
+
getBusinessesList(query?: {
|
|
5243
5399
|
/**
|
|
5244
|
-
*
|
|
5245
|
-
* @example "
|
|
5400
|
+
* (Required) page number
|
|
5401
|
+
* @example "5567183"
|
|
5246
5402
|
*/
|
|
5247
|
-
|
|
5403
|
+
page?: any;
|
|
5248
5404
|
/**
|
|
5249
|
-
*
|
|
5250
|
-
* @example "
|
|
5405
|
+
* (Required) page size in records displayed
|
|
5406
|
+
* @example "5567183"
|
|
5251
5407
|
*/
|
|
5252
|
-
|
|
5253
|
-
/** @example "1" */
|
|
5254
|
-
pageNum?: any;
|
|
5255
|
-
/** @example "100" */
|
|
5256
|
-
pageSize?: any;
|
|
5408
|
+
page_size?: any;
|
|
5257
5409
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5258
5410
|
/**
|
|
5259
|
-
* @tags
|
|
5260
|
-
* @name
|
|
5261
|
-
* @summary
|
|
5262
|
-
* @request
|
|
5411
|
+
* @tags Blacklist Admin Businesses
|
|
5412
|
+
* @name CreateBusiness
|
|
5413
|
+
* @summary Create Business
|
|
5414
|
+
* @request POST:/v1/admin/businesses
|
|
5263
5415
|
* @secure
|
|
5264
5416
|
*/
|
|
5265
|
-
|
|
5417
|
+
createBusiness(data: {
|
|
5418
|
+
/** @example "Gracia Marina" */
|
|
5419
|
+
business_name?: any;
|
|
5420
|
+
/** @example "Los Angeles" */
|
|
5421
|
+
city?: any;
|
|
5422
|
+
/** @example "US" */
|
|
5423
|
+
country?: any;
|
|
5424
|
+
/** @example "La Granja Del Camaron" */
|
|
5425
|
+
dba_name?: any;
|
|
5426
|
+
/** @example "" */
|
|
5427
|
+
incorporated?: any;
|
|
5428
|
+
/** @example "812748955" */
|
|
5429
|
+
number?: any;
|
|
5430
|
+
/** @example "EIN" */
|
|
5431
|
+
number_type?: any;
|
|
5432
|
+
/** @example "" */
|
|
5433
|
+
phone?: any;
|
|
5434
|
+
/** @example "CA" */
|
|
5435
|
+
state?: any;
|
|
5436
|
+
/** @example "1119 E 8th St Ste C" */
|
|
5437
|
+
street?: any;
|
|
5438
|
+
/** @example "304902" */
|
|
5439
|
+
tracking_number?: any;
|
|
5440
|
+
/** @example "90021" */
|
|
5441
|
+
zip?: any;
|
|
5442
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5266
5443
|
/**
|
|
5267
|
-
* @tags
|
|
5268
|
-
* @name
|
|
5269
|
-
* @summary
|
|
5270
|
-
* @request
|
|
5444
|
+
* @tags Blacklist Admin Businesses
|
|
5445
|
+
* @name GetBusinessById
|
|
5446
|
+
* @summary Get Business by ID
|
|
5447
|
+
* @request GET:/v1/admin/businesses/{id}
|
|
5271
5448
|
* @secure
|
|
5272
5449
|
*/
|
|
5273
|
-
|
|
5274
|
-
|
|
5275
|
-
|
|
5276
|
-
|
|
5277
|
-
|
|
5450
|
+
getBusinessById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5451
|
+
/**
|
|
5452
|
+
* @tags Blacklist Admin Businesses
|
|
5453
|
+
* @name UpdateBusiness
|
|
5454
|
+
* @summary Update Business
|
|
5455
|
+
* @request PUT:/v1/admin/businesses/{id}
|
|
5456
|
+
* @secure
|
|
5457
|
+
*/
|
|
5458
|
+
updateBusiness(id: string, data: {
|
|
5459
|
+
/** @example "Gracia Marina" */
|
|
5460
|
+
business_name?: any;
|
|
5461
|
+
/** @example "Los Angeles" */
|
|
5462
|
+
city?: any;
|
|
5463
|
+
/** @example "US" */
|
|
5464
|
+
country?: any;
|
|
5465
|
+
/** @example "La Granja Del Camaron" */
|
|
5466
|
+
dba_name?: any;
|
|
5467
|
+
/** @example "" */
|
|
5468
|
+
incorporated?: any;
|
|
5469
|
+
/** @example "812748955" */
|
|
5470
|
+
number?: any;
|
|
5471
|
+
/** @example "EIN" */
|
|
5472
|
+
number_type?: any;
|
|
5473
|
+
/** @example "" */
|
|
5474
|
+
phone?: any;
|
|
5475
|
+
/** @example "CA" */
|
|
5476
|
+
state?: any;
|
|
5477
|
+
/** @example "1119 E 8th St Ste C" */
|
|
5478
|
+
street?: any;
|
|
5479
|
+
/** @example "304902" */
|
|
5480
|
+
tracking_number?: any;
|
|
5481
|
+
/** @example "90021" */
|
|
5482
|
+
zip?: any;
|
|
5278
5483
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5484
|
+
/**
|
|
5485
|
+
* @tags Blacklist Admin Businesses
|
|
5486
|
+
* @name DeleteBusiness
|
|
5487
|
+
* @summary Delete Business
|
|
5488
|
+
* @request DELETE:/v1/admin/businesses/{id}
|
|
5489
|
+
* @secure
|
|
5490
|
+
*/
|
|
5491
|
+
deleteBusiness(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5279
5492
|
}
|
|
5280
5493
|
export class BlacklistAdminIndividuals<HandleError extends boolean = boolean> {
|
|
5281
5494
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -5357,159 +5570,54 @@ export class BlacklistAdminIndividuals<HandleError extends boolean = boolean> {
|
|
|
5357
5570
|
* @name UpdateIndividual
|
|
5358
5571
|
* @summary Update Individual
|
|
5359
5572
|
* @request PUT:/v1/admin/individuals/{id}
|
|
5360
|
-
* @secure
|
|
5361
|
-
*/
|
|
5362
|
-
updateIndividual(id: string, data: {
|
|
5363
|
-
/** @example "Martin" */
|
|
5364
|
-
alias_first_name?: any;
|
|
5365
|
-
/** @example "Ahn" */
|
|
5366
|
-
alias_last_name?: any;
|
|
5367
|
-
/** @example "Hyodon" */
|
|
5368
|
-
alias_middle_name?: any;
|
|
5369
|
-
/** @example "Mr." */
|
|
5370
|
-
alias_suffix?: any;
|
|
5371
|
-
/** @example "Flushing" */
|
|
5372
|
-
city?: any;
|
|
5373
|
-
/** @example "US" */
|
|
5374
|
-
country?: any;
|
|
5375
|
-
/** @example "5/11/1989" */
|
|
5376
|
-
dob?: any;
|
|
5377
|
-
/** @example "Hyodon" */
|
|
5378
|
-
first_name?: any;
|
|
5379
|
-
/** @example "Ahn" */
|
|
5380
|
-
last_name?: any;
|
|
5381
|
-
/** @example "" */
|
|
5382
|
-
middle_name?: any;
|
|
5383
|
-
/** @example "89884722" */
|
|
5384
|
-
number?: any;
|
|
5385
|
-
/** @example "SSN/ITIN" */
|
|
5386
|
-
number_type?: any;
|
|
5387
|
-
/** @example "" */
|
|
5388
|
-
phone?: any;
|
|
5389
|
-
/** @example "NY" */
|
|
5390
|
-
state?: any;
|
|
5391
|
-
/** @example "4505 162nd St" */
|
|
5392
|
-
street?: any;
|
|
5393
|
-
/** @example "Mr." */
|
|
5394
|
-
suffix?: any;
|
|
5395
|
-
/** @example "305178" */
|
|
5396
|
-
tracking_number?: any;
|
|
5397
|
-
/** @example "11358" */
|
|
5398
|
-
zip?: any;
|
|
5399
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5400
|
-
/**
|
|
5401
|
-
* @tags Blacklist Admin Individuals
|
|
5402
|
-
* @name DeleteIndividual
|
|
5403
|
-
* @summary Delete Individual
|
|
5404
|
-
* @request DELETE:/v1/admin/individuals/{id}
|
|
5405
|
-
* @secure
|
|
5406
|
-
*/
|
|
5407
|
-
deleteIndividual(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5408
|
-
}
|
|
5409
|
-
export class BlacklistAdminBusinesses<HandleError extends boolean = boolean> {
|
|
5410
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5411
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5412
|
-
/**
|
|
5413
|
-
* @tags Blacklist Admin Businesses
|
|
5414
|
-
* @name GetBusinessesList
|
|
5415
|
-
* @summary Get Businesses list
|
|
5416
|
-
* @request GET:/v1/admin/businesses
|
|
5417
|
-
* @secure
|
|
5418
|
-
*/
|
|
5419
|
-
getBusinessesList(query?: {
|
|
5420
|
-
/**
|
|
5421
|
-
* (Required) page number
|
|
5422
|
-
* @example "5567183"
|
|
5423
|
-
*/
|
|
5424
|
-
page?: any;
|
|
5425
|
-
/**
|
|
5426
|
-
* (Required) page size in records displayed
|
|
5427
|
-
* @example "5567183"
|
|
5428
|
-
*/
|
|
5429
|
-
page_size?: any;
|
|
5430
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5431
|
-
/**
|
|
5432
|
-
* @tags Blacklist Admin Businesses
|
|
5433
|
-
* @name CreateBusiness
|
|
5434
|
-
* @summary Create Business
|
|
5435
|
-
* @request POST:/v1/admin/businesses
|
|
5436
|
-
* @secure
|
|
5437
|
-
*/
|
|
5438
|
-
createBusiness(data: {
|
|
5439
|
-
/** @example "Gracia Marina" */
|
|
5440
|
-
business_name?: any;
|
|
5441
|
-
/** @example "Los Angeles" */
|
|
5442
|
-
city?: any;
|
|
5443
|
-
/** @example "US" */
|
|
5444
|
-
country?: any;
|
|
5445
|
-
/** @example "La Granja Del Camaron" */
|
|
5446
|
-
dba_name?: any;
|
|
5447
|
-
/** @example "" */
|
|
5448
|
-
incorporated?: any;
|
|
5449
|
-
/** @example "812748955" */
|
|
5450
|
-
number?: any;
|
|
5451
|
-
/** @example "EIN" */
|
|
5452
|
-
number_type?: any;
|
|
5453
|
-
/** @example "" */
|
|
5454
|
-
phone?: any;
|
|
5455
|
-
/** @example "CA" */
|
|
5456
|
-
state?: any;
|
|
5457
|
-
/** @example "1119 E 8th St Ste C" */
|
|
5458
|
-
street?: any;
|
|
5459
|
-
/** @example "304902" */
|
|
5460
|
-
tracking_number?: any;
|
|
5461
|
-
/** @example "90021" */
|
|
5462
|
-
zip?: any;
|
|
5463
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5464
|
-
/**
|
|
5465
|
-
* @tags Blacklist Admin Businesses
|
|
5466
|
-
* @name GetBusinessById
|
|
5467
|
-
* @summary Get Business by ID
|
|
5468
|
-
* @request GET:/v1/admin/businesses/{id}
|
|
5469
|
-
* @secure
|
|
5470
|
-
*/
|
|
5471
|
-
getBusinessById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5472
|
-
/**
|
|
5473
|
-
* @tags Blacklist Admin Businesses
|
|
5474
|
-
* @name UpdateBusiness
|
|
5475
|
-
* @summary Update Business
|
|
5476
|
-
* @request PUT:/v1/admin/businesses/{id}
|
|
5477
|
-
* @secure
|
|
5478
|
-
*/
|
|
5479
|
-
updateBusiness(id: string, data: {
|
|
5480
|
-
/** @example "Gracia Marina" */
|
|
5481
|
-
business_name?: any;
|
|
5482
|
-
/** @example "Los Angeles" */
|
|
5573
|
+
* @secure
|
|
5574
|
+
*/
|
|
5575
|
+
updateIndividual(id: string, data: {
|
|
5576
|
+
/** @example "Martin" */
|
|
5577
|
+
alias_first_name?: any;
|
|
5578
|
+
/** @example "Ahn" */
|
|
5579
|
+
alias_last_name?: any;
|
|
5580
|
+
/** @example "Hyodon" */
|
|
5581
|
+
alias_middle_name?: any;
|
|
5582
|
+
/** @example "Mr." */
|
|
5583
|
+
alias_suffix?: any;
|
|
5584
|
+
/** @example "Flushing" */
|
|
5483
5585
|
city?: any;
|
|
5484
5586
|
/** @example "US" */
|
|
5485
5587
|
country?: any;
|
|
5486
|
-
/** @example "
|
|
5487
|
-
|
|
5588
|
+
/** @example "5/11/1989" */
|
|
5589
|
+
dob?: any;
|
|
5590
|
+
/** @example "Hyodon" */
|
|
5591
|
+
first_name?: any;
|
|
5592
|
+
/** @example "Ahn" */
|
|
5593
|
+
last_name?: any;
|
|
5488
5594
|
/** @example "" */
|
|
5489
|
-
|
|
5490
|
-
/** @example "
|
|
5595
|
+
middle_name?: any;
|
|
5596
|
+
/** @example "89884722" */
|
|
5491
5597
|
number?: any;
|
|
5492
|
-
/** @example "
|
|
5598
|
+
/** @example "SSN/ITIN" */
|
|
5493
5599
|
number_type?: any;
|
|
5494
5600
|
/** @example "" */
|
|
5495
5601
|
phone?: any;
|
|
5496
|
-
/** @example "
|
|
5602
|
+
/** @example "NY" */
|
|
5497
5603
|
state?: any;
|
|
5498
|
-
/** @example "
|
|
5604
|
+
/** @example "4505 162nd St" */
|
|
5499
5605
|
street?: any;
|
|
5500
|
-
/** @example "
|
|
5606
|
+
/** @example "Mr." */
|
|
5607
|
+
suffix?: any;
|
|
5608
|
+
/** @example "305178" */
|
|
5501
5609
|
tracking_number?: any;
|
|
5502
|
-
/** @example "
|
|
5610
|
+
/** @example "11358" */
|
|
5503
5611
|
zip?: any;
|
|
5504
5612
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5505
5613
|
/**
|
|
5506
|
-
* @tags Blacklist Admin
|
|
5507
|
-
* @name
|
|
5508
|
-
* @summary Delete
|
|
5509
|
-
* @request DELETE:/v1/admin/
|
|
5614
|
+
* @tags Blacklist Admin Individuals
|
|
5615
|
+
* @name DeleteIndividual
|
|
5616
|
+
* @summary Delete Individual
|
|
5617
|
+
* @request DELETE:/v1/admin/individuals/{id}
|
|
5510
5618
|
* @secure
|
|
5511
5619
|
*/
|
|
5512
|
-
|
|
5620
|
+
deleteIndividual(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5513
5621
|
}
|
|
5514
5622
|
export class BlacklistSearch<HandleError extends boolean = boolean> {
|
|
5515
5623
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -5553,196 +5661,217 @@ export class BlacklistSearch<HandleError extends boolean = boolean> {
|
|
|
5553
5661
|
};
|
|
5554
5662
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5555
5663
|
}
|
|
5556
|
-
export class
|
|
5664
|
+
export class Blacklist<HandleError extends boolean = boolean> {
|
|
5557
5665
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5666
|
+
adminBusinesses: BlacklistAdminBusinesses<HandleError>;
|
|
5667
|
+
adminIndividuals: BlacklistAdminIndividuals<HandleError>;
|
|
5668
|
+
search: BlacklistSearch<HandleError>;
|
|
5558
5669
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5559
5670
|
/**
|
|
5560
|
-
* @tags
|
|
5561
|
-
* @name
|
|
5562
|
-
* @summary
|
|
5563
|
-
* @request
|
|
5564
|
-
* @secure
|
|
5565
|
-
*/
|
|
5566
|
-
documentClassifications(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5567
|
-
/**
|
|
5568
|
-
* @tags Legal Documents
|
|
5569
|
-
* @name DocumentListing
|
|
5570
|
-
* @summary Document listing
|
|
5571
|
-
* @request GET:/user/legal/documents
|
|
5671
|
+
* @tags Blacklist
|
|
5672
|
+
* @name UploadBlacklistCsv
|
|
5673
|
+
* @summary Upload Blacklist CSV
|
|
5674
|
+
* @request POST:/v1/csv/upload
|
|
5572
5675
|
* @secure
|
|
5573
5676
|
*/
|
|
5574
|
-
|
|
5677
|
+
uploadBlacklistCsv(data: {
|
|
5575
5678
|
/**
|
|
5576
|
-
*
|
|
5577
|
-
* @
|
|
5679
|
+
* (Required) file with info to upload
|
|
5680
|
+
* @format binary
|
|
5578
5681
|
*/
|
|
5579
|
-
|
|
5682
|
+
file_field?: File;
|
|
5580
5683
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5581
5684
|
/**
|
|
5582
|
-
* @tags
|
|
5583
|
-
* @name
|
|
5584
|
-
* @summary
|
|
5585
|
-
* @request GET:/
|
|
5685
|
+
* @tags Blacklist
|
|
5686
|
+
* @name GetHealth
|
|
5687
|
+
* @summary Get Health
|
|
5688
|
+
* @request GET:/v1/healthz
|
|
5586
5689
|
* @secure
|
|
5587
5690
|
*/
|
|
5588
|
-
|
|
5691
|
+
getHealth(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5692
|
+
}
|
|
5693
|
+
export class Broker<HandleError extends boolean = boolean> {
|
|
5694
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5695
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5589
5696
|
/**
|
|
5590
|
-
* @tags
|
|
5591
|
-
* @name
|
|
5592
|
-
* @summary
|
|
5593
|
-
* @request GET:/
|
|
5697
|
+
* @tags Broker
|
|
5698
|
+
* @name Portfolio
|
|
5699
|
+
* @summary Portfolio
|
|
5700
|
+
* @request GET:/v1/broker/portfolio
|
|
5594
5701
|
* @secure
|
|
5595
5702
|
*/
|
|
5596
|
-
|
|
5597
|
-
/**
|
|
5598
|
-
|
|
5703
|
+
portfolio(query?: {
|
|
5704
|
+
/**
|
|
5705
|
+
* (true or false) Allows for loading of quotes for each portfolio entry. Defaults to false.
|
|
5706
|
+
* @example "false"
|
|
5707
|
+
*/
|
|
5708
|
+
loadQuotes?: any;
|
|
5709
|
+
/** @example "false" */
|
|
5710
|
+
loadIndustries?: any;
|
|
5711
|
+
/** @example "false" */
|
|
5712
|
+
loadUpgrades?: any;
|
|
5713
|
+
/** @example "false" */
|
|
5714
|
+
loadEarnings?: any;
|
|
5715
|
+
/**
|
|
5716
|
+
* Load balances for weight
|
|
5717
|
+
* @example "false"
|
|
5718
|
+
*/
|
|
5719
|
+
loadRtb?: any;
|
|
5720
|
+
/**
|
|
5721
|
+
* Analyze market caps and get `marketCapWeights`. To be used in conjuction with `loadQuotes`
|
|
5722
|
+
* @example "false"
|
|
5723
|
+
*/
|
|
5724
|
+
marketCapBreakdown?: any;
|
|
5725
|
+
/**
|
|
5726
|
+
* Combined portfolio for the branch
|
|
5727
|
+
* @example "false"
|
|
5728
|
+
*/
|
|
5729
|
+
combined?: any;
|
|
5730
|
+
/** @example "1" */
|
|
5731
|
+
pageNum?: any;
|
|
5732
|
+
/** @example "100" */
|
|
5733
|
+
pageSize?: any;
|
|
5599
5734
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5735
|
+
}
|
|
5736
|
+
export class WatchmenFfiUserAccountManagement<HandleError extends boolean = boolean> {
|
|
5737
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5738
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5600
5739
|
/**
|
|
5601
|
-
* @tags
|
|
5602
|
-
* @name
|
|
5603
|
-
* @summary
|
|
5604
|
-
* @request
|
|
5740
|
+
* @tags Watchmen Ffi User Account Management
|
|
5741
|
+
* @name CreateUser
|
|
5742
|
+
* @summary Create User
|
|
5743
|
+
* @request POST:/rest/v1/uam/user/create
|
|
5605
5744
|
* @secure
|
|
5606
5745
|
*/
|
|
5607
|
-
|
|
5608
|
-
/** @example "{
|
|
5609
|
-
|
|
5746
|
+
createUser(data: {
|
|
5747
|
+
/** @example "{optional} enable|disable - whether or not enable user for TipRanks" */
|
|
5748
|
+
Tipranks?: any;
|
|
5749
|
+
/** @example "{optional} true|false - defaults to false" */
|
|
5750
|
+
algos?: any;
|
|
5751
|
+
/** @example "{optional} true|false - defaults to false" */
|
|
5752
|
+
allSession?: any;
|
|
5753
|
+
/** @example "{optional} Full Name" */
|
|
5754
|
+
associatedName?: any;
|
|
5755
|
+
/** @example "{optional} true|false - defaults to false" */
|
|
5756
|
+
buyWrite?: any;
|
|
5757
|
+
/** @example "{optional} e-mail address" */
|
|
5758
|
+
email?: any;
|
|
5759
|
+
/** @example "{optional} true|false - defaults to true" */
|
|
5760
|
+
isTradingEnabled?: any;
|
|
5761
|
+
/** @example "{optional} Limit On Close - true|false - defaults to false" */
|
|
5762
|
+
loc?: any;
|
|
5763
|
+
/** @example "{optional} true|false - whether user is locked" */
|
|
5764
|
+
locked?: any;
|
|
5765
|
+
/** @example "{optional} Limit On Open - true|false - defaults to false" */
|
|
5766
|
+
loo?: any;
|
|
5767
|
+
/** @example "{optional} Market On Open - true|false - defaults to false" */
|
|
5768
|
+
moc?: any;
|
|
5769
|
+
/** @example "{optional} Market On Close - true|false - defaults to false" */
|
|
5770
|
+
moo?: any;
|
|
5771
|
+
/** @example "{optional} One Cancels Other - true|false - defaults to false" */
|
|
5772
|
+
oco?: any;
|
|
5773
|
+
/** @example "{optional} true|false - defaults to false" */
|
|
5774
|
+
optionRoll?: any;
|
|
5775
|
+
/** @example "{optional} true|false - defaults to false" */
|
|
5776
|
+
options?: any;
|
|
5777
|
+
/** @example "{optional}" */
|
|
5778
|
+
password?: any;
|
|
5779
|
+
/** @example "{optional} true|false - defaults to false" */
|
|
5780
|
+
prePostTrading?: any;
|
|
5781
|
+
/** @example "{optional} 1 - delayed, 0 - realtime, 4 - CBOE1, 3 - BATS" */
|
|
5782
|
+
quoteType?: any;
|
|
5783
|
+
/** @example "{optional} true|false - defaults to false" */
|
|
5784
|
+
spreads?: any;
|
|
5785
|
+
/** @example "A - active, S - suspended == initial user status" */
|
|
5786
|
+
status?: any;
|
|
5787
|
+
/** @example "{optional} true|false - defaults to false" */
|
|
5788
|
+
trailingStops?: any;
|
|
5789
|
+
/** @example "UNIQUE_USERNAME" */
|
|
5790
|
+
username?: any;
|
|
5610
5791
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5611
5792
|
/**
|
|
5612
|
-
* @tags
|
|
5613
|
-
* @name
|
|
5614
|
-
* @summary
|
|
5615
|
-
* @request POST:/
|
|
5793
|
+
* @tags Watchmen Ffi User Account Management
|
|
5794
|
+
* @name CreateAccount
|
|
5795
|
+
* @summary Create Account
|
|
5796
|
+
* @request POST:/rest/v1/uam/account/create
|
|
5616
5797
|
* @secure
|
|
5617
5798
|
*/
|
|
5618
|
-
|
|
5619
|
-
|
|
5620
|
-
|
|
5621
|
-
|
|
5622
|
-
|
|
5623
|
-
|
|
5624
|
-
|
|
5625
|
-
|
|
5626
|
-
|
|
5627
|
-
|
|
5628
|
-
|
|
5629
|
-
/** @example "{required}" */
|
|
5630
|
-
documentId?: any;
|
|
5631
|
-
/** @example true */
|
|
5632
|
-
esigned?: any;
|
|
5633
|
-
/** @example "" */
|
|
5634
|
-
remoteAddr?: any;
|
|
5635
|
-
/** @example "{required}" */
|
|
5636
|
-
remoteDevice?: any;
|
|
5637
|
-
/** @example "{required}" */
|
|
5638
|
-
signature?: any;
|
|
5799
|
+
createAccount(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5800
|
+
/**
|
|
5801
|
+
* @tags Watchmen Ffi User Account Management
|
|
5802
|
+
* @name AccountInformation
|
|
5803
|
+
* @summary Account Information
|
|
5804
|
+
* @request GET:/rest/v1/uam/account/data
|
|
5805
|
+
* @secure
|
|
5806
|
+
*/
|
|
5807
|
+
accountInformation(query?: {
|
|
5808
|
+
/** @example "AC123456" */
|
|
5809
|
+
accountNumber?: any;
|
|
5639
5810
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5640
5811
|
/**
|
|
5641
|
-
* @tags
|
|
5642
|
-
* @name
|
|
5643
|
-
* @summary
|
|
5644
|
-
* @request
|
|
5812
|
+
* @tags Watchmen Ffi User Account Management
|
|
5813
|
+
* @name UserInformation
|
|
5814
|
+
* @summary User Information
|
|
5815
|
+
* @request GET:/rest/v1/uam/user/data
|
|
5645
5816
|
* @secure
|
|
5646
5817
|
*/
|
|
5647
|
-
|
|
5648
|
-
|
|
5649
|
-
|
|
5650
|
-
accountId?: number;
|
|
5651
|
-
/** @example "{optional}" */
|
|
5652
|
-
accountNumber?: string;
|
|
5653
|
-
};
|
|
5654
|
-
/** @example true */
|
|
5655
|
-
esigned?: any;
|
|
5656
|
-
/** @example "Allow" */
|
|
5657
|
-
policy?: any;
|
|
5658
|
-
/** @example "" */
|
|
5659
|
-
remoteAddr?: any;
|
|
5660
|
-
/** @example "" */
|
|
5661
|
-
remoteDevice?: any;
|
|
5818
|
+
userInformation(query?: {
|
|
5819
|
+
/** @example "USERNAME" */
|
|
5820
|
+
username?: any;
|
|
5662
5821
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5663
|
-
}
|
|
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
5822
|
/**
|
|
5671
|
-
* @tags
|
|
5672
|
-
* @name
|
|
5673
|
-
* @summary
|
|
5674
|
-
* @request
|
|
5823
|
+
* @tags Watchmen Ffi User Account Management
|
|
5824
|
+
* @name ListLinkedAccounts
|
|
5825
|
+
* @summary List Linked Accounts
|
|
5826
|
+
* @request GET:/rest/v1/linkedaccounts/listAccounts
|
|
5675
5827
|
* @secure
|
|
5676
5828
|
*/
|
|
5677
|
-
|
|
5678
|
-
/**
|
|
5679
|
-
|
|
5680
|
-
* @format binary
|
|
5681
|
-
*/
|
|
5682
|
-
file_field?: File;
|
|
5829
|
+
listLinkedAccounts(query?: {
|
|
5830
|
+
/** @example "TEST.USER" */
|
|
5831
|
+
username?: any;
|
|
5683
5832
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5684
5833
|
/**
|
|
5685
|
-
* @tags
|
|
5686
|
-
* @name
|
|
5687
|
-
* @summary
|
|
5688
|
-
* @request
|
|
5834
|
+
* @tags Watchmen Ffi User Account Management
|
|
5835
|
+
* @name LinkUnlinkAccount
|
|
5836
|
+
* @summary Link/Unlink Account
|
|
5837
|
+
* @request POST:/rest/v1/linkedaccounts/linkUnlinkAccount
|
|
5689
5838
|
* @secure
|
|
5690
5839
|
*/
|
|
5691
|
-
|
|
5692
|
-
}
|
|
5693
|
-
export class Broker<HandleError extends boolean = boolean> {
|
|
5694
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5695
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5840
|
+
linkUnlinkAccount(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5696
5841
|
/**
|
|
5697
|
-
* @tags
|
|
5698
|
-
* @name
|
|
5699
|
-
* @summary
|
|
5700
|
-
* @request
|
|
5842
|
+
* @tags Watchmen Ffi User Account Management
|
|
5843
|
+
* @name Visibility
|
|
5844
|
+
* @summary Visibility
|
|
5845
|
+
* @request POST:/rest/v1/linkedaccounts/visibility
|
|
5701
5846
|
* @secure
|
|
5702
5847
|
*/
|
|
5703
|
-
|
|
5704
|
-
|
|
5705
|
-
|
|
5706
|
-
|
|
5707
|
-
|
|
5708
|
-
|
|
5709
|
-
|
|
5710
|
-
|
|
5711
|
-
|
|
5712
|
-
|
|
5713
|
-
|
|
5714
|
-
|
|
5715
|
-
|
|
5716
|
-
|
|
5717
|
-
|
|
5718
|
-
|
|
5719
|
-
|
|
5720
|
-
/**
|
|
5721
|
-
|
|
5722
|
-
|
|
5723
|
-
|
|
5724
|
-
|
|
5725
|
-
|
|
5726
|
-
|
|
5727
|
-
|
|
5728
|
-
*/
|
|
5729
|
-
combined?: any;
|
|
5730
|
-
/** @example "1" */
|
|
5731
|
-
pageNum?: any;
|
|
5732
|
-
/** @example "100" */
|
|
5733
|
-
pageSize?: any;
|
|
5848
|
+
visibility(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5849
|
+
/**
|
|
5850
|
+
* @tags Watchmen Ffi User Account Management
|
|
5851
|
+
* @name UserAccountSearch
|
|
5852
|
+
* @summary User/Account Search
|
|
5853
|
+
* @request POST:/rest/v1/uam/user-account-search
|
|
5854
|
+
* @secure
|
|
5855
|
+
*/
|
|
5856
|
+
userAccountSearch(data: {
|
|
5857
|
+
/** @example "desired account number" */
|
|
5858
|
+
accountNumber?: any;
|
|
5859
|
+
/** @example 100 */
|
|
5860
|
+
limit?: any;
|
|
5861
|
+
/** @example 0 */
|
|
5862
|
+
lockedBit?: any;
|
|
5863
|
+
/** @example "desired username" */
|
|
5864
|
+
login?: any;
|
|
5865
|
+
/** @example false */
|
|
5866
|
+
noBrokers?: any;
|
|
5867
|
+
/** @example "" */
|
|
5868
|
+
omnibus?: any;
|
|
5869
|
+
/** @example false */
|
|
5870
|
+
onlyActiveAccount?: any;
|
|
5871
|
+
/** @example false */
|
|
5872
|
+
onlyActiveUser?: any;
|
|
5734
5873
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5735
5874
|
}
|
|
5736
|
-
export class Advisory<HandleError extends boolean = boolean> {
|
|
5737
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5738
|
-
charges: AdvisoryCharges<HandleError>;
|
|
5739
|
-
models: AdvisoryModels<HandleError>;
|
|
5740
|
-
userAccountManagement: AdvisoryUserAccountManagement<HandleError>;
|
|
5741
|
-
groups: AdvisoryGroups<HandleError>;
|
|
5742
|
-
analytics: AdvisoryAnalytics<HandleError>;
|
|
5743
|
-
allocations: AdvisoryAllocations<HandleError>;
|
|
5744
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5745
|
-
}
|
|
5746
5875
|
export class WatchmenFfiFirmBranch<HandleError extends boolean = boolean> {
|
|
5747
5876
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5748
5877
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5918,144 +6047,15 @@ export class WatchmenFfiFirmBranch<HandleError extends boolean = boolean> {
|
|
|
5918
6047
|
id?: any;
|
|
5919
6048
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5920
6049
|
}
|
|
5921
|
-
export class
|
|
6050
|
+
export class Advisory<HandleError extends boolean = boolean> {
|
|
5922
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>;
|
|
5923
6058
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5924
|
-
/**
|
|
5925
|
-
* @tags Watchmen Ffi User Account Management
|
|
5926
|
-
* @name CreateUser
|
|
5927
|
-
* @summary Create User
|
|
5928
|
-
* @request POST:/rest/v1/uam/user/create
|
|
5929
|
-
* @secure
|
|
5930
|
-
*/
|
|
5931
|
-
createUser(data: {
|
|
5932
|
-
/** @example "{optional} enable|disable - whether or not enable user for TipRanks" */
|
|
5933
|
-
Tipranks?: any;
|
|
5934
|
-
/** @example "{optional} true|false - defaults to false" */
|
|
5935
|
-
algos?: any;
|
|
5936
|
-
/** @example "{optional} true|false - defaults to false" */
|
|
5937
|
-
allSession?: any;
|
|
5938
|
-
/** @example "{optional} Full Name" */
|
|
5939
|
-
associatedName?: any;
|
|
5940
|
-
/** @example "{optional} true|false - defaults to false" */
|
|
5941
|
-
buyWrite?: any;
|
|
5942
|
-
/** @example "{optional} e-mail address" */
|
|
5943
|
-
email?: any;
|
|
5944
|
-
/** @example "{optional} true|false - defaults to true" */
|
|
5945
|
-
isTradingEnabled?: any;
|
|
5946
|
-
/** @example "{optional} Limit On Close - true|false - defaults to false" */
|
|
5947
|
-
loc?: any;
|
|
5948
|
-
/** @example "{optional} true|false - whether user is locked" */
|
|
5949
|
-
locked?: any;
|
|
5950
|
-
/** @example "{optional} Limit On Open - true|false - defaults to false" */
|
|
5951
|
-
loo?: any;
|
|
5952
|
-
/** @example "{optional} Market On Open - true|false - defaults to false" */
|
|
5953
|
-
moc?: any;
|
|
5954
|
-
/** @example "{optional} Market On Close - true|false - defaults to false" */
|
|
5955
|
-
moo?: any;
|
|
5956
|
-
/** @example "{optional} One Cancels Other - true|false - defaults to false" */
|
|
5957
|
-
oco?: any;
|
|
5958
|
-
/** @example "{optional} true|false - defaults to false" */
|
|
5959
|
-
optionRoll?: any;
|
|
5960
|
-
/** @example "{optional} true|false - defaults to false" */
|
|
5961
|
-
options?: any;
|
|
5962
|
-
/** @example "{optional}" */
|
|
5963
|
-
password?: any;
|
|
5964
|
-
/** @example "{optional} true|false - defaults to false" */
|
|
5965
|
-
prePostTrading?: any;
|
|
5966
|
-
/** @example "{optional} 1 - delayed, 0 - realtime, 4 - CBOE1, 3 - BATS" */
|
|
5967
|
-
quoteType?: any;
|
|
5968
|
-
/** @example "{optional} true|false - defaults to false" */
|
|
5969
|
-
spreads?: any;
|
|
5970
|
-
/** @example "A - active, S - suspended == initial user status" */
|
|
5971
|
-
status?: any;
|
|
5972
|
-
/** @example "{optional} true|false - defaults to false" */
|
|
5973
|
-
trailingStops?: any;
|
|
5974
|
-
/** @example "UNIQUE_USERNAME" */
|
|
5975
|
-
username?: any;
|
|
5976
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5977
|
-
/**
|
|
5978
|
-
* @tags Watchmen Ffi User Account Management
|
|
5979
|
-
* @name CreateAccount
|
|
5980
|
-
* @summary Create Account
|
|
5981
|
-
* @request POST:/rest/v1/uam/account/create
|
|
5982
|
-
* @secure
|
|
5983
|
-
*/
|
|
5984
|
-
createAccount(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5985
|
-
/**
|
|
5986
|
-
* @tags Watchmen Ffi User Account Management
|
|
5987
|
-
* @name AccountInformation
|
|
5988
|
-
* @summary Account Information
|
|
5989
|
-
* @request GET:/rest/v1/uam/account/data
|
|
5990
|
-
* @secure
|
|
5991
|
-
*/
|
|
5992
|
-
accountInformation(query?: {
|
|
5993
|
-
/** @example "AC123456" */
|
|
5994
|
-
accountNumber?: any;
|
|
5995
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5996
|
-
/**
|
|
5997
|
-
* @tags Watchmen Ffi User Account Management
|
|
5998
|
-
* @name UserInformation
|
|
5999
|
-
* @summary User Information
|
|
6000
|
-
* @request GET:/rest/v1/uam/user/data
|
|
6001
|
-
* @secure
|
|
6002
|
-
*/
|
|
6003
|
-
userInformation(query?: {
|
|
6004
|
-
/** @example "USERNAME" */
|
|
6005
|
-
username?: any;
|
|
6006
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
6007
|
-
/**
|
|
6008
|
-
* @tags Watchmen Ffi User Account Management
|
|
6009
|
-
* @name ListLinkedAccounts
|
|
6010
|
-
* @summary List Linked Accounts
|
|
6011
|
-
* @request GET:/rest/v1/linkedaccounts/listAccounts
|
|
6012
|
-
* @secure
|
|
6013
|
-
*/
|
|
6014
|
-
listLinkedAccounts(query?: {
|
|
6015
|
-
/** @example "TEST.USER" */
|
|
6016
|
-
username?: any;
|
|
6017
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
6018
|
-
/**
|
|
6019
|
-
* @tags Watchmen Ffi User Account Management
|
|
6020
|
-
* @name LinkUnlinkAccount
|
|
6021
|
-
* @summary Link/Unlink Account
|
|
6022
|
-
* @request POST:/rest/v1/linkedaccounts/linkUnlinkAccount
|
|
6023
|
-
* @secure
|
|
6024
|
-
*/
|
|
6025
|
-
linkUnlinkAccount(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
6026
|
-
/**
|
|
6027
|
-
* @tags Watchmen Ffi User Account Management
|
|
6028
|
-
* @name Visibility
|
|
6029
|
-
* @summary Visibility
|
|
6030
|
-
* @request POST:/rest/v1/linkedaccounts/visibility
|
|
6031
|
-
* @secure
|
|
6032
|
-
*/
|
|
6033
|
-
visibility(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
6034
|
-
/**
|
|
6035
|
-
* @tags Watchmen Ffi User Account Management
|
|
6036
|
-
* @name UserAccountSearch
|
|
6037
|
-
* @summary User/Account Search
|
|
6038
|
-
* @request POST:/rest/v1/uam/user-account-search
|
|
6039
|
-
* @secure
|
|
6040
|
-
*/
|
|
6041
|
-
userAccountSearch(data: {
|
|
6042
|
-
/** @example "desired account number" */
|
|
6043
|
-
accountNumber?: any;
|
|
6044
|
-
/** @example 100 */
|
|
6045
|
-
limit?: any;
|
|
6046
|
-
/** @example 0 */
|
|
6047
|
-
lockedBit?: any;
|
|
6048
|
-
/** @example "desired username" */
|
|
6049
|
-
login?: any;
|
|
6050
|
-
/** @example false */
|
|
6051
|
-
noBrokers?: any;
|
|
6052
|
-
/** @example "" */
|
|
6053
|
-
omnibus?: any;
|
|
6054
|
-
/** @example false */
|
|
6055
|
-
onlyActiveAccount?: any;
|
|
6056
|
-
/** @example false */
|
|
6057
|
-
onlyActiveUser?: any;
|
|
6058
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
6059
6059
|
}
|
|
6060
6060
|
export class WatchmenFfi<HandleError extends boolean = boolean> {
|
|
6061
6061
|
protected readonly apiClient: JwtClient<HandleError>;
|