@orbis-systems/orbis-api-clients 0.8.9 → 0.8.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. package/dist/aesmidas/index.d.ts +504 -486
  2. package/dist/aesmidas/index.d.ts.map +1 -1
  3. package/dist/aesmidas/index.esm.js +1 -1
  4. package/dist/aesmidas/index.esm.js.map +1 -1
  5. package/dist/aesmidas/index.js +1 -1
  6. package/dist/aesmidas/index.js.map +1 -1
  7. package/dist/bridgewise/index.d.ts +1169 -742
  8. package/dist/bridgewise/index.d.ts.map +1 -1
  9. package/dist/bridgewise/index.esm.js +1 -1
  10. package/dist/bridgewise/index.esm.js.map +1 -1
  11. package/dist/bridgewise/index.js +1 -1
  12. package/dist/bridgewise/index.js.map +1 -1
  13. package/dist/insight/index.d.ts +127 -127
  14. package/dist/insight/index.d.ts.map +1 -1
  15. package/dist/insight/index.esm.js +1 -1
  16. package/dist/insight/index.esm.js.map +1 -1
  17. package/dist/insight/index.js +1 -1
  18. package/dist/insight/index.js.map +1 -1
  19. package/dist/middleware/index.d.ts +83 -83
  20. package/dist/middleware/index.d.ts.map +1 -1
  21. package/dist/middleware/index.esm.js +1 -1
  22. package/dist/middleware/index.esm.js.map +1 -1
  23. package/dist/middleware/index.js +1 -1
  24. package/dist/middleware/index.js.map +1 -1
  25. package/dist/orbis/index.d.ts +1718 -1689
  26. package/dist/orbis/index.d.ts.map +1 -1
  27. package/dist/orbis/index.esm.js +1 -1
  28. package/dist/orbis/index.esm.js.map +1 -1
  29. package/dist/orbis/index.js +1 -1
  30. package/dist/orbis/index.js.map +1 -1
  31. package/dist/uma/index.d.ts +781 -659
  32. package/dist/uma/index.d.ts.map +1 -1
  33. package/dist/uma/index.esm.js +1 -1
  34. package/dist/uma/index.esm.js.map +1 -1
  35. package/dist/uma/index.js +1 -1
  36. package/dist/uma/index.js.map +1 -1
  37. package/package.json +1 -1
@@ -306,26 +306,6 @@ export class OrdersV2Equities<HandleError extends boolean = boolean> {
306
306
  */
307
307
  previewSnapshot(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
308
308
  }
309
- export class OrdersV2FixedIncome<HandleError extends boolean = boolean> {
310
- protected readonly apiClient: JwtClient<HandleError>;
311
- constructor(apiClient: JwtClient<HandleError>);
312
- /**
313
- * @tags Orders V2 Fixed Income
314
- * @name BondPlacement
315
- * @summary Bond placement
316
- * @request POST:/orders/v2/bonds/place
317
- * @secure
318
- */
319
- bondPlacement(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
320
- /**
321
- * @tags Orders V2 Fixed Income
322
- * @name BondOrderPreview
323
- * @summary Bond order preview
324
- * @request POST:/orders/v2/bonds/preview
325
- * @secure
326
- */
327
- bondOrderPreview(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
328
- }
329
309
  export class OrdersV2Options<HandleError extends boolean = boolean> {
330
310
  protected readonly apiClient: JwtClient<HandleError>;
331
311
  constructor(apiClient: JwtClient<HandleError>);
@@ -469,6 +449,26 @@ export class OrdersV2Options<HandleError extends boolean = boolean> {
469
449
  };
470
450
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
471
451
  }
452
+ export class OrdersV2FixedIncome<HandleError extends boolean = boolean> {
453
+ protected readonly apiClient: JwtClient<HandleError>;
454
+ constructor(apiClient: JwtClient<HandleError>);
455
+ /**
456
+ * @tags Orders V2 Fixed Income
457
+ * @name BondPlacement
458
+ * @summary Bond placement
459
+ * @request POST:/orders/v2/bonds/place
460
+ * @secure
461
+ */
462
+ bondPlacement(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
463
+ /**
464
+ * @tags Orders V2 Fixed Income
465
+ * @name BondOrderPreview
466
+ * @summary Bond order preview
467
+ * @request POST:/orders/v2/bonds/preview
468
+ * @secure
469
+ */
470
+ bondOrderPreview(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
471
+ }
472
472
  export class OrdersV2Crypto<HandleError extends boolean = boolean> {
473
473
  protected readonly apiClient: JwtClient<HandleError>;
474
474
  constructor(apiClient: JwtClient<HandleError>);
@@ -754,6 +754,43 @@ export class OrdersV2<HandleError extends boolean = boolean> {
754
754
  };
755
755
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
756
756
  }
757
+ export class OrdersViolationManagement<HandleError extends boolean = boolean> {
758
+ protected readonly apiClient: JwtClient<HandleError>;
759
+ constructor(apiClient: JwtClient<HandleError>);
760
+ /**
761
+ * @tags Orders Violation Management
762
+ * @name GfvEquities
763
+ * @summary GFV (equities)
764
+ * @request POST:/trading/violations/gfv/equity
765
+ * @secure
766
+ */
767
+ gfvEquities(data: {
768
+ account?: {
769
+ /** @example "optional" */
770
+ accountNumber?: string;
771
+ };
772
+ order?: {
773
+ /** @example 101.5 */
774
+ expectedValue?: number;
775
+ /** @example 123.45 */
776
+ limitPrice?: number;
777
+ /** @example "PRE_MARKET|CORE_MARKET|POST_MARKET|ALL_MARKET|PRE_CORE|POST_CORE" */
778
+ marketTime?: string;
779
+ /** @example "MARKET|LIMIT|STOP|STOP_LIMIT|TRAILING_STOP|Notional|NotionalLimit" */
780
+ orderType?: string;
781
+ /** @example 123.45 */
782
+ quantity?: number;
783
+ quote?: {
784
+ /** @example "ZVZZT" */
785
+ symbol?: string;
786
+ };
787
+ /** @example 123.45 */
788
+ stopPrice?: number;
789
+ /** @example "BUY|SELL|SHORT_SELL|BUY_TO_COVER|Liquidate" */
790
+ transaction?: string;
791
+ };
792
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
793
+ }
757
794
  export class OrdersArchived<HandleError extends boolean = boolean> {
758
795
  protected readonly apiClient: JwtClient<HandleError>;
759
796
  constructor(apiClient: JwtClient<HandleError>);
@@ -835,169 +872,6 @@ export class OrdersArchived<HandleError extends boolean = boolean> {
835
872
  orderRef?: string;
836
873
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
837
874
  }
838
- export class OrdersViolationManagement<HandleError extends boolean = boolean> {
839
- protected readonly apiClient: JwtClient<HandleError>;
840
- constructor(apiClient: JwtClient<HandleError>);
841
- /**
842
- * @tags Orders Violation Management
843
- * @name GfvEquities
844
- * @summary GFV (equities)
845
- * @request POST:/trading/violations/gfv/equity
846
- * @secure
847
- */
848
- gfvEquities(data: {
849
- account?: {
850
- /** @example "optional" */
851
- accountNumber?: string;
852
- };
853
- order?: {
854
- /** @example 101.5 */
855
- expectedValue?: number;
856
- /** @example 123.45 */
857
- limitPrice?: number;
858
- /** @example "PRE_MARKET|CORE_MARKET|POST_MARKET|ALL_MARKET|PRE_CORE|POST_CORE" */
859
- marketTime?: string;
860
- /** @example "MARKET|LIMIT|STOP|STOP_LIMIT|TRAILING_STOP|Notional|NotionalLimit" */
861
- orderType?: string;
862
- /** @example 123.45 */
863
- quantity?: number;
864
- quote?: {
865
- /** @example "ZVZZT" */
866
- symbol?: string;
867
- };
868
- /** @example 123.45 */
869
- stopPrice?: number;
870
- /** @example "BUY|SELL|SHORT_SELL|BUY_TO_COVER|Liquidate" */
871
- transaction?: string;
872
- };
873
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
874
- }
875
- export class Orders<HandleError extends boolean = boolean> {
876
- protected readonly apiClient: JwtClient<HandleError>;
877
- violationManagement: OrdersViolationManagement<HandleError>;
878
- archived: OrdersArchived<HandleError>;
879
- v2: OrdersV2<HandleError>;
880
- constructor(apiClient: JwtClient<HandleError>);
881
- /**
882
- * @tags Orders
883
- * @name Listing
884
- * @summary Listing
885
- * @request GET:/orders/{type}
886
- * @secure
887
- */
888
- listing(type: string, query?: {
889
- /**
890
- * `true|false` (optional)
891
- * @example "false"
892
- */
893
- loadQuotes?: any;
894
- /** Account ID (optional) */
895
- accountId?: any;
896
- /** Account number (optional) */
897
- account?: any;
898
- /** Ticker symbol (optional) */
899
- symbol?: any;
900
- /**
901
- * Return bond pricing type in `Percentage|Decimal` (optional)
902
- * @example "Decimal"
903
- */
904
- bondPriceType?: any;
905
- /**
906
- * Return bond quantity in `Par|Unit` (optional)
907
- * @example "Par"
908
- */
909
- bondQuantityType?: any;
910
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
911
- /**
912
- * @tags Orders
913
- * @name ListingForModel
914
- * @summary Listing for model
915
- * @request GET:/orders/model/{modelId}/{type}
916
- * @secure
917
- */
918
- listingForModel(modelId: string, type: string, query?: {
919
- /**
920
- * true|false
921
- * @example "false"
922
- */
923
- loadQuotes?: any;
924
- /**
925
- * Return bond pricing type in `Percentage|Decimal` (optional)
926
- * @example "Decimal"
927
- */
928
- bondPriceType?: any;
929
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
930
- /**
931
- * @tags Orders
932
- * @name ListingForBranch
933
- * @summary Listing for branch
934
- * @request GET:/orders/branch/{type}
935
- * @secure
936
- */
937
- listingForBranch(type: string, query?: {
938
- /** Return bond pricing type in `Percentage|Decimal` (optional) */
939
- bondPriceType?: any;
940
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
941
- /**
942
- * @tags Orders
943
- * @name Status
944
- * @summary Status
945
- * @request GET:/orders/status/{orderRef}
946
- * @secure
947
- */
948
- status(orderRef: string, query?: {
949
- /** [optional] `true` or `false` to load quotes */
950
- loadQuotes?: any;
951
- /** [optional] Account number order belongs to */
952
- account?: any;
953
- /** [optional] AccountId as known in the system */
954
- accountId?: any;
955
- /**
956
- * Return bond quantity in `Par|Unit` (optional)
957
- * @example "Decimal"
958
- */
959
- bondPriceType?: any;
960
- /**
961
- * Return bond quantity in `Par|Unit` (optional)
962
- * @example "Par"
963
- */
964
- bondQuantityType?: any;
965
- /**
966
- * [optional] Specifies market code for the order
967
- * @example "U"
968
- */
969
- market?: any;
970
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
971
- /**
972
- * @tags Orders
973
- * @name OrderLookup
974
- * @summary Order lookup
975
- * @request GET:/orders/lookup
976
- * @secure
977
- */
978
- orderLookup(query?: {
979
- /**
980
- * Required
981
- * @example "{your order reference}"
982
- */
983
- clientRef?: any;
984
- /**
985
- * `true|false` (optional)
986
- * @example "false"
987
- */
988
- loadQuotes?: any;
989
- /**
990
- * Return bond pricing type in `Percentage|Decimal` (optional)
991
- * @example "Decimal"
992
- */
993
- bondPriceType?: any;
994
- /**
995
- * Return bond quantity in `Par|Unit` (optional)
996
- * @example "Par"
997
- */
998
- bondQuantityType?: any;
999
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1000
- }
1001
875
  export class Quotes<HandleError extends boolean = boolean> {
1002
876
  protected readonly apiClient: JwtClient<HandleError>;
1003
877
  constructor(apiClient: JwtClient<HandleError>);
@@ -1285,19 +1159,145 @@ export class Quotes<HandleError extends boolean = boolean> {
1285
1159
  symbols?: any;
1286
1160
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1287
1161
  }
1288
- export class ResearchTipranks<HandleError extends boolean = boolean> {
1162
+ export class Orders<HandleError extends boolean = boolean> {
1289
1163
  protected readonly apiClient: JwtClient<HandleError>;
1164
+ violationManagement: OrdersViolationManagement<HandleError>;
1165
+ archived: OrdersArchived<HandleError>;
1166
+ v2: OrdersV2<HandleError>;
1290
1167
  constructor(apiClient: JwtClient<HandleError>);
1291
1168
  /**
1292
- * @tags Research Tipranks
1293
- * @name Livefeed
1294
- * @summary Livefeed
1295
- * @request GET:/research/tipranks/livefeed
1169
+ * @tags Orders
1170
+ * @name Listing
1171
+ * @summary Listing
1172
+ * @request GET:/orders/{type}
1296
1173
  * @secure
1297
1174
  */
1298
- livefeed(query?: {
1175
+ listing(type: string, query?: {
1299
1176
  /**
1300
- * Amount to include. Defaults to 20.
1177
+ * `true|false` (optional)
1178
+ * @example "false"
1179
+ */
1180
+ loadQuotes?: any;
1181
+ /** Account ID (optional) */
1182
+ accountId?: any;
1183
+ /** Account number (optional) */
1184
+ account?: any;
1185
+ /** Ticker symbol (optional) */
1186
+ symbol?: any;
1187
+ /**
1188
+ * Return bond pricing type in `Percentage|Decimal` (optional)
1189
+ * @example "Decimal"
1190
+ */
1191
+ bondPriceType?: any;
1192
+ /**
1193
+ * Return bond quantity in `Par|Unit` (optional)
1194
+ * @example "Par"
1195
+ */
1196
+ bondQuantityType?: any;
1197
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1198
+ /**
1199
+ * @tags Orders
1200
+ * @name ListingForModel
1201
+ * @summary Listing for model
1202
+ * @request GET:/orders/model/{modelId}/{type}
1203
+ * @secure
1204
+ */
1205
+ listingForModel(modelId: string, type: string, query?: {
1206
+ /**
1207
+ * true|false
1208
+ * @example "false"
1209
+ */
1210
+ loadQuotes?: any;
1211
+ /**
1212
+ * Return bond pricing type in `Percentage|Decimal` (optional)
1213
+ * @example "Decimal"
1214
+ */
1215
+ bondPriceType?: any;
1216
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1217
+ /**
1218
+ * @tags Orders
1219
+ * @name ListingForBranch
1220
+ * @summary Listing for branch
1221
+ * @request GET:/orders/branch/{type}
1222
+ * @secure
1223
+ */
1224
+ listingForBranch(type: string, query?: {
1225
+ /** Return bond pricing type in `Percentage|Decimal` (optional) */
1226
+ bondPriceType?: any;
1227
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1228
+ /**
1229
+ * @tags Orders
1230
+ * @name Status
1231
+ * @summary Status
1232
+ * @request GET:/orders/status/{orderRef}
1233
+ * @secure
1234
+ */
1235
+ status(orderRef: string, query?: {
1236
+ /** [optional] `true` or `false` to load quotes */
1237
+ loadQuotes?: any;
1238
+ /** [optional] Account number order belongs to */
1239
+ account?: any;
1240
+ /** [optional] AccountId as known in the system */
1241
+ accountId?: any;
1242
+ /**
1243
+ * Return bond quantity in `Par|Unit` (optional)
1244
+ * @example "Decimal"
1245
+ */
1246
+ bondPriceType?: any;
1247
+ /**
1248
+ * Return bond quantity in `Par|Unit` (optional)
1249
+ * @example "Par"
1250
+ */
1251
+ bondQuantityType?: any;
1252
+ /**
1253
+ * [optional] Specifies market code for the order
1254
+ * @example "U"
1255
+ */
1256
+ market?: any;
1257
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1258
+ /**
1259
+ * @tags Orders
1260
+ * @name OrderLookup
1261
+ * @summary Order lookup
1262
+ * @request GET:/orders/lookup
1263
+ * @secure
1264
+ */
1265
+ orderLookup(query?: {
1266
+ /**
1267
+ * Required
1268
+ * @example "{your order reference}"
1269
+ */
1270
+ clientRef?: any;
1271
+ /**
1272
+ * `true|false` (optional)
1273
+ * @example "false"
1274
+ */
1275
+ loadQuotes?: any;
1276
+ /**
1277
+ * Return bond pricing type in `Percentage|Decimal` (optional)
1278
+ * @example "Decimal"
1279
+ */
1280
+ bondPriceType?: any;
1281
+ /**
1282
+ * Return bond quantity in `Par|Unit` (optional)
1283
+ * @example "Par"
1284
+ */
1285
+ bondQuantityType?: any;
1286
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1287
+ }
1288
+ export class ResearchTipranks<HandleError extends boolean = boolean> {
1289
+ protected readonly apiClient: JwtClient<HandleError>;
1290
+ constructor(apiClient: JwtClient<HandleError>);
1291
+ /**
1292
+ * @tags Research Tipranks
1293
+ * @name Livefeed
1294
+ * @summary Livefeed
1295
+ * @request GET:/research/tipranks/livefeed
1296
+ * @secure
1297
+ */
1298
+ livefeed(query?: {
1299
+ /**
1300
+ * Amount to include. Defaults to 20.
1301
1301
  * @example "20"
1302
1302
  */
1303
1303
  count?: any;
@@ -2214,6 +2214,108 @@ export class UserWatchlists<HandleError extends boolean = boolean> {
2214
2214
  */
2215
2215
  removeFromWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2216
2216
  }
2217
+ export class UserAttachedBanks<HandleError extends boolean = boolean> {
2218
+ protected readonly apiClient: JwtClient<HandleError>;
2219
+ constructor(apiClient: JwtClient<HandleError>);
2220
+ /**
2221
+ * @tags User Attached Banks
2222
+ * @name Accounts
2223
+ * @summary Accounts
2224
+ * @request GET:/user/bank/accounts
2225
+ * @secure
2226
+ */
2227
+ accounts(query?: {
2228
+ /**
2229
+ * Brokerage account number
2230
+ * @example "AC123456"
2231
+ */
2232
+ account?: any;
2233
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2234
+ /**
2235
+ * @tags User Attached Banks
2236
+ * @name Balances
2237
+ * @summary Balances
2238
+ * @request GET:/user/bank/balances
2239
+ * @secure
2240
+ */
2241
+ balances(query?: {
2242
+ /**
2243
+ * Brokerage account number
2244
+ * @example "AC123456"
2245
+ */
2246
+ account?: any;
2247
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2248
+ }
2249
+ export class UserTradingLimitManagement<HandleError extends boolean = boolean> {
2250
+ protected readonly apiClient: JwtClient<HandleError>;
2251
+ constructor(apiClient: JwtClient<HandleError>);
2252
+ /**
2253
+ * @tags User Trading Limit Management
2254
+ * @name Update
2255
+ * @summary Update
2256
+ * @request POST:/user/balance/adjust
2257
+ * @secure
2258
+ */
2259
+ update(data: {
2260
+ account?: {
2261
+ /** @example "AB123456" */
2262
+ accountNumber?: string;
2263
+ };
2264
+ /** @example 100 */
2265
+ adjustment?: any;
2266
+ /** @example "USD" */
2267
+ currency?: any;
2268
+ /** @example "something nice" */
2269
+ note?: any;
2270
+ /** @example "tbd" */
2271
+ reason?: any;
2272
+ /** @example "" */
2273
+ referenceNo?: any;
2274
+ /** @example "Delta|Absolute" */
2275
+ type?: any;
2276
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2277
+ }
2278
+ export class UserProfitLoss<HandleError extends boolean = boolean> {
2279
+ protected readonly apiClient: JwtClient<HandleError>;
2280
+ constructor(apiClient: JwtClient<HandleError>);
2281
+ /**
2282
+ * @tags User Profit Loss
2283
+ * @name ReportRequest
2284
+ * @summary Report Request
2285
+ * @request POST:/user/pal/submit
2286
+ * @secure
2287
+ */
2288
+ reportRequest(data: {
2289
+ /** @example "{account number}" */
2290
+ account?: any;
2291
+ /** @example "{timestamp}" */
2292
+ from?: any;
2293
+ /** @example "{timestamp}" */
2294
+ until?: any;
2295
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2296
+ /**
2297
+ * @tags User Profit Loss
2298
+ * @name StatusCheck
2299
+ * @summary Status check
2300
+ * @request GET:/user/pal/status
2301
+ * @secure
2302
+ */
2303
+ statusCheck(query?: {
2304
+ /** @example "643eaa24e00691406cbaa72f" */
2305
+ requestId?: any;
2306
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2307
+ /**
2308
+ * @tags User Profit Loss
2309
+ * @name Report
2310
+ * @summary Report
2311
+ * @request GET:/user/pal/report
2312
+ * @secure
2313
+ */
2314
+ report(query?: {
2315
+ /** @example "643eaa24e00691406cbaa72f" */
2316
+ requestId?: any;
2317
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2318
+ }
2217
2319
  export class UserDevice<HandleError extends boolean = boolean> {
2218
2320
  protected readonly apiClient: JwtClient<HandleError>;
2219
2321
  constructor(apiClient: JwtClient<HandleError>);
@@ -2320,122 +2422,20 @@ export class UserAgreements<HandleError extends boolean = boolean> {
2320
2422
  */
2321
2423
  cryptoSign(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2322
2424
  }
2323
- export class UserTradingLimitManagement<HandleError extends boolean = boolean> {
2425
+ export class User<HandleError extends boolean = boolean> {
2324
2426
  protected readonly apiClient: JwtClient<HandleError>;
2427
+ watchlists: UserWatchlists<HandleError>;
2428
+ device: UserDevice<HandleError>;
2429
+ agreements: UserAgreements<HandleError>;
2430
+ tradingLimitManagement: UserTradingLimitManagement<HandleError>;
2431
+ attachedBanks: UserAttachedBanks<HandleError>;
2432
+ profitLoss: UserProfitLoss<HandleError>;
2325
2433
  constructor(apiClient: JwtClient<HandleError>);
2326
2434
  /**
2327
- * @tags User Trading Limit Management
2328
- * @name Update
2329
- * @summary Update
2330
- * @request POST:/user/balance/adjust
2331
- * @secure
2332
- */
2333
- update(data: {
2334
- account?: {
2335
- /** @example "AB123456" */
2336
- accountNumber?: string;
2337
- };
2338
- /** @example 100 */
2339
- adjustment?: any;
2340
- /** @example "USD" */
2341
- currency?: any;
2342
- /** @example "something nice" */
2343
- note?: any;
2344
- /** @example "tbd" */
2345
- reason?: any;
2346
- /** @example "" */
2347
- referenceNo?: any;
2348
- /** @example "Delta|Absolute" */
2349
- type?: any;
2350
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2351
- }
2352
- export class UserAttachedBanks<HandleError extends boolean = boolean> {
2353
- protected readonly apiClient: JwtClient<HandleError>;
2354
- constructor(apiClient: JwtClient<HandleError>);
2355
- /**
2356
- * @tags User Attached Banks
2357
- * @name Accounts
2358
- * @summary Accounts
2359
- * @request GET:/user/bank/accounts
2360
- * @secure
2361
- */
2362
- accounts(query?: {
2363
- /**
2364
- * Brokerage account number
2365
- * @example "AC123456"
2366
- */
2367
- account?: any;
2368
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2369
- /**
2370
- * @tags User Attached Banks
2371
- * @name Balances
2372
- * @summary Balances
2373
- * @request GET:/user/bank/balances
2374
- * @secure
2375
- */
2376
- balances(query?: {
2377
- /**
2378
- * Brokerage account number
2379
- * @example "AC123456"
2380
- */
2381
- account?: any;
2382
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2383
- }
2384
- export class UserProfitLoss<HandleError extends boolean = boolean> {
2385
- protected readonly apiClient: JwtClient<HandleError>;
2386
- constructor(apiClient: JwtClient<HandleError>);
2387
- /**
2388
- * @tags User Profit Loss
2389
- * @name ReportRequest
2390
- * @summary Report Request
2391
- * @request POST:/user/pal/submit
2392
- * @secure
2393
- */
2394
- reportRequest(data: {
2395
- /** @example "{account number}" */
2396
- account?: any;
2397
- /** @example "{timestamp}" */
2398
- from?: any;
2399
- /** @example "{timestamp}" */
2400
- until?: any;
2401
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2402
- /**
2403
- * @tags User Profit Loss
2404
- * @name StatusCheck
2405
- * @summary Status check
2406
- * @request GET:/user/pal/status
2407
- * @secure
2408
- */
2409
- statusCheck(query?: {
2410
- /** @example "643eaa24e00691406cbaa72f" */
2411
- requestId?: any;
2412
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2413
- /**
2414
- * @tags User Profit Loss
2415
- * @name Report
2416
- * @summary Report
2417
- * @request GET:/user/pal/report
2418
- * @secure
2419
- */
2420
- report(query?: {
2421
- /** @example "643eaa24e00691406cbaa72f" */
2422
- requestId?: any;
2423
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2424
- }
2425
- export class User<HandleError extends boolean = boolean> {
2426
- protected readonly apiClient: JwtClient<HandleError>;
2427
- watchlists: UserWatchlists<HandleError>;
2428
- device: UserDevice<HandleError>;
2429
- agreements: UserAgreements<HandleError>;
2430
- tradingLimitManagement: UserTradingLimitManagement<HandleError>;
2431
- attachedBanks: UserAttachedBanks<HandleError>;
2432
- profitLoss: UserProfitLoss<HandleError>;
2433
- constructor(apiClient: JwtClient<HandleError>);
2434
- /**
2435
- * @tags User
2436
- * @name UserInformation
2437
- * @summary User information
2438
- * @request GET:/user/info
2435
+ * @tags User
2436
+ * @name UserInformation
2437
+ * @summary User information
2438
+ * @request GET:/user/info
2439
2439
  * @secure
2440
2440
  */
2441
2441
  userInformation(query?: {
@@ -3112,122 +3112,526 @@ export class AdvisoryCharges<HandleError extends boolean = boolean> {
3112
3112
  */
3113
3113
  cancel(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3114
3114
  }
3115
- export class AdvisoryAnalytics<HandleError extends boolean = boolean> {
3115
+ export class AdvisoryModels<HandleError extends boolean = boolean> {
3116
3116
  protected readonly apiClient: JwtClient<HandleError>;
3117
3117
  constructor(apiClient: JwtClient<HandleError>);
3118
3118
  /**
3119
- * @tags Advisory Analytics
3120
- * @name OverexposureAnalysis
3121
- * @summary Overexposure analysis
3122
- * @request GET:/v2/advisory/analytics/overexposure/{type}/{scope}/{id}
3119
+ * @tags Advisory Models
3120
+ * @name Listing
3121
+ * @summary Listing
3122
+ * @request GET:/v2/advisory/models
3123
3123
  * @secure
3124
3124
  */
3125
- overexposureAnalysis(type: string, scope: string, id: string, query?: {
3125
+ listing(query?: {
3126
3126
  /**
3127
- * Threshold of 70% or greater
3128
- * @example ".7"
3127
+ * true|false
3128
+ * @example "false"
3129
3129
  */
3130
- threshold?: any;
3130
+ loadQuotes?: any;
3131
+ /**
3132
+ * true|false
3133
+ * @example "false"
3134
+ */
3135
+ loadAccounts?: any;
3131
3136
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3132
3137
  /**
3133
- * @tags Advisory Analytics
3134
- * @name RealtimeBalanceBreakdown
3135
- * @summary Realtime balance breakdown
3136
- * @request GET:/v2/advisory/analytics/breakdown/rtbs/{modelId}
3138
+ * @tags Advisory Models
3139
+ * @name ModelsByAccount
3140
+ * @summary Models by account
3141
+ * @request GET:/v2/advisory/modelsOfAccount
3137
3142
  * @secure
3138
3143
  */
3139
- realtimeBalanceBreakdown(modelId: string, query?: {
3140
- /**
3141
- * Bucket size
3142
- * @example "10000"
3143
- */
3144
- bucket?: any;
3144
+ modelsByAccount(query?: {
3145
+ /** @example "" */
3146
+ accountId?: any;
3147
+ /** @example "" */
3148
+ account?: any;
3145
3149
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3146
3150
  /**
3147
- * @tags Advisory Analytics
3148
- * @name ModelPerformance
3149
- * @summary Model performance
3150
- * @request GET:/v2/advisory/analytics/model/performance/{modelId}/{range}
3151
+ * @tags Advisory Models
3152
+ * @name ComponentTags
3153
+ * @summary Component tags
3154
+ * @request GET:/v2/advisory/models/components/tags
3151
3155
  * @secure
3152
3156
  */
3153
- modelPerformance(modelId: string, range: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3157
+ componentTags(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3154
3158
  /**
3155
- * @tags Advisory Analytics
3156
- * @name ModelDriftReport
3157
- * @summary Model drift report
3158
- * @request GET:/v2/advisory/analytics/model/drift/{modelId}
3159
+ * @tags Advisory Models
3160
+ * @name BuyingPower
3161
+ * @summary Buying power
3162
+ * @request GET:/v2/advisory/model/balance/{currency}/{modelId}
3159
3163
  * @secure
3160
3164
  */
3161
- modelDriftReport(modelId: string, query?: {
3162
- /**
3163
- * `optional` - specifies threshold (10% default)
3164
- * @example ".1"
3165
- */
3166
- threshold?: any;
3165
+ buyingPower(currency: string, modelId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3166
+ /**
3167
+ * @tags Advisory Models
3168
+ * @name RealtimeBalance
3169
+ * @summary Realtime balance
3170
+ * @request GET:/v2/advisory/model/rtb/{modelId}
3171
+ * @secure
3172
+ */
3173
+ realtimeBalance(modelId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3174
+ /**
3175
+ * @tags Advisory Models
3176
+ * @name RealtimeBalanceHistory
3177
+ * @summary Realtime balance history
3178
+ * @request GET:/v2/advisory/model/rtb/history/{modelId}
3179
+ * @secure
3180
+ */
3181
+ realtimeBalanceHistory(modelId: string, query?: {
3182
+ /** First page is 0 */
3183
+ page?: any;
3184
+ /** Number of entries per page. Defaults to 1,000 */
3185
+ count?: any;
3186
+ dateFrom?: any;
3187
+ dateTo?: any;
3167
3188
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3168
- }
3169
- export class Device<HandleError extends boolean = boolean> {
3170
- protected readonly apiClient: JwtClient<HandleError>;
3171
- constructor(apiClient: JwtClient<HandleError>);
3172
3189
  /**
3173
- * @tags Device
3174
- * @name DeviceDeactivate
3175
- * @summary /device/deactivate
3176
- * @request POST:/device/deactivate
3190
+ * @tags Advisory Models
3191
+ * @name Adjustments
3192
+ * @summary Adjustments
3193
+ * @request GET:/v2/advisory/model/adjustments/{modelId}
3177
3194
  * @secure
3178
3195
  */
3179
- deviceDeactivate(data: {
3196
+ adjustments(modelId: string, query?: {
3180
3197
  /**
3181
- * Token previously registered
3182
- * @example "123456789"
3198
+ * true|false
3199
+ * @example "false"
3183
3200
  */
3184
- Token?: string;
3201
+ loadQuotes?: any;
3202
+ /** Pending, Active, Complete, Rejected, Cancelled */
3203
+ status?: any;
3185
3204
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3186
- }
3187
- export class TransfersRelationships<HandleError extends boolean = boolean> {
3188
- protected readonly apiClient: JwtClient<HandleError>;
3189
- constructor(apiClient: JwtClient<HandleError>);
3190
3205
  /**
3191
- * @tags Transfers Relationships
3192
- * @name List
3193
- * @summary List
3194
- * @request GET:/transfer/relationship/list/{account}
3206
+ * @tags Advisory Models
3207
+ * @name AdjustmentPreview
3208
+ * @summary Adjustment preview
3209
+ * @request GET:/v2/advisory/model/adjustments/preview/{adjustmentId}
3195
3210
  * @secure
3196
3211
  */
3197
- list(account: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3212
+ adjustmentPreview(adjustmentId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3198
3213
  /**
3199
- * @tags Transfers Relationships
3200
- * @name GetInfo
3201
- * @summary Get Info
3202
- * @request GET:/transfer/relationship/get
3214
+ * @tags Advisory Models
3215
+ * @name MemberAccounts
3216
+ * @summary Member accounts
3217
+ * @request GET:/v2/advisory/model/accounts/{modelId}
3203
3218
  * @secure
3204
3219
  */
3205
- getInfo(query?: {
3220
+ memberAccounts(modelId: string, query?: {
3206
3221
  /**
3207
- * Account number
3208
- * @example "ABC123"
3222
+ * `true`|`false` - whether or not to load account's realtime balance
3223
+ * @example "false"
3209
3224
  */
3210
- account?: any;
3225
+ loadRtb?: any;
3211
3226
  /**
3212
- * Desired entry ID
3213
- * @example "123"
3227
+ * `true`|`false` - whether or not to load account's 3 months of balance history
3228
+ * @example "false"
3214
3229
  */
3215
- entryId?: any;
3230
+ loadRtbHistory?: any;
3216
3231
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3217
3232
  /**
3218
- * @tags Transfers Relationships
3219
- * @name PaymentMethods
3220
- * @summary Payment methods
3221
- * @request GET:/transfer/bank/paymentMethods
3233
+ * @tags Advisory Models
3234
+ * @name OrphanedAccounts
3235
+ * @summary Orphaned accounts
3236
+ * @request GET:/v2/advisory/model/accounts/orphaned
3222
3237
  * @secure
3223
3238
  */
3224
- paymentMethods(query?: {
3225
- /** @example "IND" */
3226
- country?: any;
3227
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3239
+ orphanedAccounts(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3228
3240
  /**
3229
- * @tags Transfers Relationships
3230
- * @name PaymentMethodsViaAddress
3241
+ * @tags Advisory Models
3242
+ * @name MemberAccountStatistics
3243
+ * @summary Member account statistics
3244
+ * @request GET:/v2/advisory/model/accounts/stats/{modelId}
3245
+ * @secure
3246
+ */
3247
+ memberAccountStatistics(modelId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3248
+ /**
3249
+ * @tags Advisory Models
3250
+ * @name MemberRealtimeBalances
3251
+ * @summary Member realtime balances
3252
+ * @request GET:/v2/advisory/model/rtbs/{modelId}
3253
+ * @secure
3254
+ */
3255
+ memberRealtimeBalances(modelId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3256
+ /**
3257
+ * @tags Advisory Models
3258
+ * @name Portfolio
3259
+ * @summary Portfolio
3260
+ * @request GET:/v2/advisory/model/portfolios/{modelId}
3261
+ * @secure
3262
+ */
3263
+ portfolio(modelId: string, query?: {
3264
+ /**
3265
+ * Should load quotes or not.
3266
+ * @example "false"
3267
+ */
3268
+ loadQuotes?: any;
3269
+ /**
3270
+ * Whether to return combined portfolio (no accounts, with approximate prices)
3271
+ * @example "false"
3272
+ */
3273
+ combined?: any;
3274
+ /** @example "false" */
3275
+ loadIndustries?: any;
3276
+ /** @example "false" */
3277
+ loadUpgrades?: any;
3278
+ /** @example "false" */
3279
+ loadEarnings?: any;
3280
+ /**
3281
+ * Whether or not to include orders comprising each position's cost
3282
+ * @example "false"
3283
+ */
3284
+ loadCost?: any;
3285
+ /**
3286
+ * Analyze market caps and get `marketCapWeights`. To be used in conjuction with `loadQuotes`
3287
+ * @example "false"
3288
+ */
3289
+ marketCapWeights?: any;
3290
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3291
+ /**
3292
+ * @tags Advisory Models
3293
+ * @name AllModelBuyingPower
3294
+ * @summary All model buying power
3295
+ * @request GET:/v2/advisory/model/balances/{currency}
3296
+ * @secure
3297
+ */
3298
+ allModelBuyingPower(currency: string, query?: {
3299
+ /**
3300
+ * [optional] when omitted defaults to system's setting.
3301
+ * @example "USD"
3302
+ */
3303
+ currency?: any;
3304
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3305
+ /**
3306
+ * @tags Advisory Models
3307
+ * @name PositionLookup
3308
+ * @summary Position lookup
3309
+ * @request GET:/v2/advisory/model/position/equity/{modelId}
3310
+ * @secure
3311
+ */
3312
+ positionLookup(modelId: string, query?: {
3313
+ symbol?: any;
3314
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3315
+ /**
3316
+ * @tags Advisory Models
3317
+ * @name PositionLookupOptions
3318
+ * @summary Position lookup (options)
3319
+ * @request GET:/v2/advisory/model/position/option/{modelId}
3320
+ * @secure
3321
+ */
3322
+ positionLookupOptions(modelId: string, query?: {
3323
+ symbol?: any;
3324
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3325
+ /**
3326
+ * @tags Advisory Models
3327
+ * @name AdjustmentUpdates
3328
+ * @summary Adjustment updates
3329
+ * @request POST:/v2/advisory/model/adjustments/modify/{action}
3330
+ * @secure
3331
+ */
3332
+ adjustmentUpdates(action: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3333
+ /**
3334
+ * @tags Advisory Models
3335
+ * @name Creation
3336
+ * @summary Creation
3337
+ * @request POST:/v2/advisory/model/create
3338
+ * @secure
3339
+ */
3340
+ creation(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3341
+ /**
3342
+ * @tags Advisory Models
3343
+ * @name Update
3344
+ * @summary Update
3345
+ * @request POST:/v2/advisory/model/update
3346
+ * @secure
3347
+ */
3348
+ update(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3349
+ /**
3350
+ * @tags Advisory Models
3351
+ * @name Deletion
3352
+ * @summary Deletion
3353
+ * @request POST:/v2/advisory/model/delete
3354
+ * @secure
3355
+ */
3356
+ deletion(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3357
+ /**
3358
+ * @tags Advisory Models
3359
+ * @name ComponentUpdate
3360
+ * @summary Component update
3361
+ * @request POST:/v2/advisory/model/component/update
3362
+ * @secure
3363
+ */
3364
+ componentUpdate(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3365
+ /**
3366
+ * @tags Advisory Models
3367
+ * @name LinkOfMemberAccounts
3368
+ * @summary Link of member accounts
3369
+ * @request POST:/v2/advisory/model/account/link
3370
+ * @secure
3371
+ */
3372
+ linkOfMemberAccounts(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3373
+ /**
3374
+ * @tags Advisory Models
3375
+ * @name UnlinkMemberAccount
3376
+ * @summary Unlink member account
3377
+ * @request POST:/v2/advisory/model/account/unlink
3378
+ * @secure
3379
+ */
3380
+ unlinkMemberAccount(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3381
+ /**
3382
+ * @tags Advisory Models
3383
+ * @name Allocations
3384
+ * @summary Allocations
3385
+ * @request POST:/v2/advisory/model/orders/allocate
3386
+ * @secure
3387
+ */
3388
+ allocations(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3389
+ }
3390
+ export class AdvisoryGroups<HandleError extends boolean = boolean> {
3391
+ protected readonly apiClient: JwtClient<HandleError>;
3392
+ constructor(apiClient: JwtClient<HandleError>);
3393
+ /**
3394
+ * @tags Advisory Groups
3395
+ * @name GroupsManage
3396
+ * @request POST:/v1/groups/manage/{action}
3397
+ * @secure
3398
+ */
3399
+ groupsManage(action: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3400
+ /**
3401
+ * @tags Advisory Groups
3402
+ * @name GroupsList
3403
+ * @request GET:/v1/groups/list
3404
+ * @secure
3405
+ */
3406
+ groupsList(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3407
+ /**
3408
+ * @tags Advisory Groups
3409
+ * @name GroupAccountsStats
3410
+ * @request GET:/v2/advisory/group/accounts/stats/{groupsId}
3411
+ * @secure
3412
+ */
3413
+ groupAccountsStats(groupsId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3414
+ /**
3415
+ * @tags Advisory Groups
3416
+ * @name GroupPortfolios
3417
+ * @request GET:/v2/advisory/group/portfolios/{groupId}
3418
+ * @secure
3419
+ */
3420
+ groupPortfolios(groupId: string, query?: {
3421
+ /**
3422
+ * Should load quotes or not.
3423
+ * @example "false"
3424
+ */
3425
+ loadQuotes?: any;
3426
+ /**
3427
+ * Whether to return combined portfolio (no accounts, with approximate prices)
3428
+ * @example "false"
3429
+ */
3430
+ combined?: any;
3431
+ /** @example "false" */
3432
+ loadIndustries?: any;
3433
+ /** @example "false" */
3434
+ loadUpgrades?: any;
3435
+ /** @example "false" */
3436
+ loadEarnings?: any;
3437
+ /**
3438
+ * Whether or not to include orders comprising each position's cost
3439
+ * @example "false"
3440
+ */
3441
+ loadCost?: any;
3442
+ /**
3443
+ * Analyze market caps and get `marketCapWeights`. To be used in conjuction with `loadQuotes`
3444
+ * @example "false"
3445
+ */
3446
+ marketCapWeights?: any;
3447
+ /** @example "1" */
3448
+ pageNum?: any;
3449
+ /** @example "100" */
3450
+ pageSize?: any;
3451
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3452
+ /**
3453
+ * @tags Advisory Groups
3454
+ * @name GroupRtb
3455
+ * @request GET:/v2/advisory/group/rtb/{groupId}
3456
+ * @secure
3457
+ */
3458
+ groupRtb(groupId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3459
+ /**
3460
+ * @tags Advisory Groups
3461
+ * @name GroupRtbs
3462
+ * @request GET:/v2/advisory/group/rtbs/{groupId}
3463
+ * @secure
3464
+ */
3465
+ groupRtbs(groupId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3466
+ }
3467
+ export class AdvisoryAnalytics<HandleError extends boolean = boolean> {
3468
+ protected readonly apiClient: JwtClient<HandleError>;
3469
+ constructor(apiClient: JwtClient<HandleError>);
3470
+ /**
3471
+ * @tags Advisory Analytics
3472
+ * @name OverexposureAnalysis
3473
+ * @summary Overexposure analysis
3474
+ * @request GET:/v2/advisory/analytics/overexposure/{type}/{scope}/{id}
3475
+ * @secure
3476
+ */
3477
+ overexposureAnalysis(type: string, scope: string, id: string, query?: {
3478
+ /**
3479
+ * Threshold of 70% or greater
3480
+ * @example ".7"
3481
+ */
3482
+ threshold?: any;
3483
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3484
+ /**
3485
+ * @tags Advisory Analytics
3486
+ * @name RealtimeBalanceBreakdown
3487
+ * @summary Realtime balance breakdown
3488
+ * @request GET:/v2/advisory/analytics/breakdown/rtbs/{modelId}
3489
+ * @secure
3490
+ */
3491
+ realtimeBalanceBreakdown(modelId: string, query?: {
3492
+ /**
3493
+ * Bucket size
3494
+ * @example "10000"
3495
+ */
3496
+ bucket?: any;
3497
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3498
+ /**
3499
+ * @tags Advisory Analytics
3500
+ * @name ModelPerformance
3501
+ * @summary Model performance
3502
+ * @request GET:/v2/advisory/analytics/model/performance/{modelId}/{range}
3503
+ * @secure
3504
+ */
3505
+ modelPerformance(modelId: string, range: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3506
+ /**
3507
+ * @tags Advisory Analytics
3508
+ * @name ModelDriftReport
3509
+ * @summary Model drift report
3510
+ * @request GET:/v2/advisory/analytics/model/drift/{modelId}
3511
+ * @secure
3512
+ */
3513
+ modelDriftReport(modelId: string, query?: {
3514
+ /**
3515
+ * `optional` - specifies threshold (10% default)
3516
+ * @example ".1"
3517
+ */
3518
+ threshold?: any;
3519
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3520
+ }
3521
+ export class AdvisoryAllocations<HandleError extends boolean = boolean> {
3522
+ protected readonly apiClient: JwtClient<HandleError>;
3523
+ constructor(apiClient: JwtClient<HandleError>);
3524
+ /**
3525
+ * @tags Advisory Allocations
3526
+ * @name SearchNa
3527
+ * @summary Search (n/a)
3528
+ * @request GET:/v2/allocations/search
3529
+ * @secure
3530
+ */
3531
+ searchNa(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3532
+ /**
3533
+ * @tags Advisory Allocations
3534
+ * @name Details
3535
+ * @summary Details
3536
+ * @request GET:/v2/allocations/details/{allocationRef}
3537
+ * @secure
3538
+ */
3539
+ details(allocationRef: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3540
+ /**
3541
+ * @tags Advisory Allocations
3542
+ * @name Cancel
3543
+ * @summary Cancel
3544
+ * @request POST:/v2/allocations/cancel
3545
+ * @secure
3546
+ */
3547
+ cancel(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3548
+ /**
3549
+ * @tags Advisory Allocations
3550
+ * @name Validation
3551
+ * @summary Validation
3552
+ * @request POST:/v2/allocations/validate
3553
+ * @secure
3554
+ */
3555
+ validation(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3556
+ /**
3557
+ * @tags Advisory Allocations
3558
+ * @name Scheduling
3559
+ * @summary Scheduling
3560
+ * @request POST:/v2/allocations/preallocate
3561
+ * @secure
3562
+ */
3563
+ scheduling(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3564
+ /**
3565
+ * @tags Advisory Allocations
3566
+ * @name Trigger
3567
+ * @summary Trigger
3568
+ * @request POST:/v2/allocations/trigger
3569
+ * @secure
3570
+ */
3571
+ trigger(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3572
+ }
3573
+ export class Device<HandleError extends boolean = boolean> {
3574
+ protected readonly apiClient: JwtClient<HandleError>;
3575
+ constructor(apiClient: JwtClient<HandleError>);
3576
+ /**
3577
+ * @tags Device
3578
+ * @name DeviceDeactivate
3579
+ * @summary /device/deactivate
3580
+ * @request POST:/device/deactivate
3581
+ * @secure
3582
+ */
3583
+ deviceDeactivate(data: {
3584
+ /**
3585
+ * Token previously registered
3586
+ * @example "123456789"
3587
+ */
3588
+ Token?: string;
3589
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3590
+ }
3591
+ export class TransfersRelationships<HandleError extends boolean = boolean> {
3592
+ protected readonly apiClient: JwtClient<HandleError>;
3593
+ constructor(apiClient: JwtClient<HandleError>);
3594
+ /**
3595
+ * @tags Transfers Relationships
3596
+ * @name List
3597
+ * @summary List
3598
+ * @request GET:/transfer/relationship/list/{account}
3599
+ * @secure
3600
+ */
3601
+ list(account: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3602
+ /**
3603
+ * @tags Transfers Relationships
3604
+ * @name GetInfo
3605
+ * @summary Get Info
3606
+ * @request GET:/transfer/relationship/get
3607
+ * @secure
3608
+ */
3609
+ getInfo(query?: {
3610
+ /**
3611
+ * Account number
3612
+ * @example "ABC123"
3613
+ */
3614
+ account?: any;
3615
+ /**
3616
+ * Desired entry ID
3617
+ * @example "123"
3618
+ */
3619
+ entryId?: any;
3620
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3621
+ /**
3622
+ * @tags Transfers Relationships
3623
+ * @name PaymentMethods
3624
+ * @summary Payment methods
3625
+ * @request GET:/transfer/bank/paymentMethods
3626
+ * @secure
3627
+ */
3628
+ paymentMethods(query?: {
3629
+ /** @example "IND" */
3630
+ country?: any;
3631
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3632
+ /**
3633
+ * @tags Transfers Relationships
3634
+ * @name PaymentMethodsViaAddress
3231
3635
  * @summary Payment methods (via address)
3232
3636
  * @request POST:/transfer/bank/paymentMethods
3233
3637
  * @secure
@@ -3507,6 +3911,77 @@ export class TransfersInstantAccountVerification<HandleError extends boolean = b
3507
3911
  remoteDevice?: any;
3508
3912
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3509
3913
  }
3914
+ export class AdvisoryUserAccountManagement<HandleError extends boolean = boolean> {
3915
+ protected readonly apiClient: JwtClient<HandleError>;
3916
+ constructor(apiClient: JwtClient<HandleError>);
3917
+ /**
3918
+ * @tags Advisory User Account Management
3919
+ * @name List
3920
+ * @summary /list
3921
+ * @request GET:/v2/advisory/users/list
3922
+ * @secure
3923
+ */
3924
+ list(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3925
+ /**
3926
+ * @tags Advisory User Account Management
3927
+ * @name Accounts
3928
+ * @summary /accounts
3929
+ * @request GET:/v2/advisory/users/accounts
3930
+ * @secure
3931
+ */
3932
+ accounts(query?: {
3933
+ /** @example "1234" */
3934
+ uid?: any;
3935
+ /**
3936
+ * true|false
3937
+ * @example "false"
3938
+ */
3939
+ loadRtb?: any;
3940
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3941
+ /**
3942
+ * @tags Advisory User Account Management
3943
+ * @name AccountsStats
3944
+ * @summary /accounts/stats
3945
+ * @request GET:/v2/advisory/users/accounts/stats
3946
+ * @secure
3947
+ */
3948
+ accountsStats(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3949
+ /**
3950
+ * @tags Advisory User Account Management
3951
+ * @name AccountNotes
3952
+ * @summary /account/notes
3953
+ * @request GET:/v2/advisory/users/account/notes
3954
+ * @secure
3955
+ */
3956
+ accountNotes(query?: {
3957
+ /**
3958
+ * Account's ID
3959
+ * @example "1234"
3960
+ */
3961
+ aid?: any;
3962
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3963
+ /**
3964
+ * @tags Advisory User Account Management
3965
+ * @name Notes
3966
+ * @summary /notes
3967
+ * @request GET:/v2/advisory/users/notes
3968
+ * @secure
3969
+ */
3970
+ notes(query?: {
3971
+ /**
3972
+ * User's ID
3973
+ * @example "1234"
3974
+ */
3975
+ uid?: any;
3976
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3977
+ /**
3978
+ * @tags Advisory User Account Management
3979
+ * @name NotesPost
3980
+ * @request POST:/v2/advisory/users/notes/{action}
3981
+ * @secure
3982
+ */
3983
+ notesPost(action: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3984
+ }
3510
3985
  export class TransfersAch<HandleError extends boolean = boolean> {
3511
3986
  protected readonly apiClient: JwtClient<HandleError>;
3512
3987
  constructor(apiClient: JwtClient<HandleError>);
@@ -3637,125 +4112,66 @@ export class TransfersAcats<HandleError extends boolean = boolean> {
3637
4112
  account?: {
3638
4113
  /** @example 0 */
3639
4114
  accountId?: number;
3640
- /** @example "AC123" */
3641
- accountNumber?: string;
3642
- };
3643
- /** @example [{"currency":"{optional, only for CASH} ","isShort":"{optional if asset is shortable then set to 1}","optionFlag":"{optional if asset is options then set to 1}","quantity":1000,"quote":{"cusip":"0A1B2C","symbol":"AAPL"},"type":"Security | Cash"}] */
3644
- assets?: {
3645
- /** @example "{optional, only for CASH} " */
3646
- currency?: string;
3647
- /** @example "{optional if asset is shortable then set to 1}" */
3648
- isShort?: string;
3649
- /** @example "{optional if asset is options then set to 1}" */
3650
- optionFlag?: string;
3651
- /** @example 1000 */
3652
- quantity?: number;
3653
- quote?: {
3654
- /** @example "0A1B2C" */
3655
- cusip?: string;
3656
- /** @example "AAPL" */
3657
- symbol?: string;
3658
- };
3659
- /** @example "Security | Cash" */
3660
- type?: string;
3661
- }[];
3662
- /** @example "{batchId} (Only Required for Schedule/Trigger)" */
3663
- batchId?: string;
3664
- /** @example "Something for the record" */
3665
- comment?: string;
3666
- /** @example "" */
3667
- contraAccount?: string;
3668
- /** @example "COLLEGE_TAX_ADVANTAGE_529|PENSION_PLAN_401K|TAX_SHELTERED_ANNUITY_403B|AGENCY|BANK_CUSTODY|BENEFICIARY|BENEFICIARY_ROTH_IRA|CORPORATE|CO_TRUSTEE|CUSTODIAN_UGMA|DIRECT_ROLLOVER|COVERDELL_IRA|ESTATE|HEALTH_SAVINGS_ACCOUNT|IRA|JOINT|MEDICAL_SAVINGS_ACCOUNT|OTHER|QUALIFIED_PROFIT_SHARING_PENSION|ROTH_IRA|SIMPLE_IRA|SARSEP|SINGLE|TRUST" */
3669
- contraAccountType?: string;
3670
- /** @example "" */
3671
- contraNumber?: string;
3672
- /** @example "" */
3673
- contraTitle?: string;
3674
- /** @example "" */
3675
- participantNumber?: string;
3676
- /** @example "" */
3677
- primaryTaxId?: string;
3678
- /** @example "{optional}" */
3679
- remoteDevice?: string;
3680
- /** @example "{optional}" */
3681
- remoteIp?: string;
3682
- /** @example "" */
3683
- secondaryTaxId?: string;
3684
- /** @example "{optional} (Leave blank to send out ACAT immediately)|RequestPlaced (Trigger Scheduled Acat Request)|Scheduled" */
3685
- status?: string;
3686
- /** @example "Full|Partial" */
3687
- type?: string;
3688
- }[], config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3689
- }
3690
- export class TransfersJournals<HandleError extends boolean = boolean> {
3691
- protected readonly apiClient: JwtClient<HandleError>;
3692
- constructor(apiClient: JwtClient<HandleError>);
3693
- /**
3694
- * @tags Transfers Journals
3695
- * @name JournalRequest
3696
- * @summary Journal request
3697
- * @request POST:/transfer/journal/request
3698
- * @secure
3699
- */
3700
- journalRequest(data: {
3701
- /** @example 1000 */
3702
- amount?: any;
3703
- deliverFrom?: {
3704
- /** @example 124 */
3705
- accountId?: number;
3706
- /** @example "ABC123456" */
3707
- accountNumber?: string;
3708
- };
3709
- deliverTo?: {
3710
- /** @example 456 */
3711
- accountId?: number;
3712
- /** @example "DEF123456" */
3713
- accountNumber?: string;
3714
- };
3715
- /** @example "MM/dd/yyyy HH:mm:ss z" */
3716
- deliveryDate?: any;
3717
- loa?: {
3718
- /** @example "" */
3719
- fullName?: string;
3720
- /** @example "" */
3721
- remoteAddr?: string;
3722
- /** @example "" */
3723
- remoteDevice?: string;
3724
- /** @example "" */
3725
- signature?: string;
3726
- /** @example "MM/dd/yyyy HH:mm:ss z" */
3727
- timestamp?: string;
3728
- };
3729
- /** @example "NoPurpose|Gift|StockGift" */
3730
- purpose?: any;
3731
- /** @example "" */
3732
- reason?: any;
3733
- /** @example "0.0.0.0" */
3734
- remoteAddr?: any;
3735
- /** @example "Ultra fast proxy" */
3736
- remoteDevice?: any;
3737
- /** @example "required for StockGift" */
3738
- symbol?: any;
3739
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3740
- /**
3741
- * @tags Transfers Journals
3742
- * @name Search
3743
- * @summary Search
3744
- * @request POST:/transfer/journal/search
3745
- * @secure
3746
- */
3747
- search(data: {
3748
- account?: {
3749
- /** @example 0 */
3750
- accountId?: number;
3751
- /** @example "ABC123456" */
4115
+ /** @example "AC123" */
3752
4116
  accountNumber?: string;
3753
4117
  };
3754
- /** @example "PLACED|SENT|..." */
3755
- status?: any;
3756
- /** @example "AB123456" */
3757
- transferId?: any;
3758
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4118
+ /** @example [{"currency":"{optional, only for CASH} ","isShort":"{optional if asset is shortable then set to 1}","optionFlag":"{optional if asset is options then set to 1}","quantity":1000,"quote":{"cusip":"0A1B2C","symbol":"AAPL"},"type":"Security | Cash"}] */
4119
+ assets?: {
4120
+ /** @example "{optional, only for CASH} " */
4121
+ currency?: string;
4122
+ /** @example "{optional if asset is shortable then set to 1}" */
4123
+ isShort?: string;
4124
+ /** @example "{optional if asset is options then set to 1}" */
4125
+ optionFlag?: string;
4126
+ /** @example 1000 */
4127
+ quantity?: number;
4128
+ quote?: {
4129
+ /** @example "0A1B2C" */
4130
+ cusip?: string;
4131
+ /** @example "AAPL" */
4132
+ symbol?: string;
4133
+ };
4134
+ /** @example "Security | Cash" */
4135
+ type?: string;
4136
+ }[];
4137
+ /** @example "{batchId} (Only Required for Schedule/Trigger)" */
4138
+ batchId?: string;
4139
+ /** @example "Something for the record" */
4140
+ comment?: string;
4141
+ /** @example "" */
4142
+ contraAccount?: string;
4143
+ /**
4144
+ * @example "COLLEGE_TAX_ADVANTAGE_529|PENSION_PLAN_401K
4145
+ * |TAX_SHELTERED_ANNUITY_403B|AGENCY|BANK_CUSTODY|BENEFICIARY
4146
+ * |BENEFICIARY_ROTH_IRA|CORPORATE|CO_TRUSTEE|CUSTODIAN_UGMA|DIRECT_ROLLOVER|COVERDELL_IRA
4147
+ * |ESTATE|HEALTH_SAVINGS_ACCOUNT|IRA|JOINT|MEDICAL_SAVINGS_ACCOUNT|OTHER
4148
+ * |QUALIFIED_PROFIT_SHARING_PENSION|ROTH_IRA|SIMPLE_IRA|SARSEP|SINGLE|TRUST"
4149
+ */
4150
+ contraAccountType?: string;
4151
+ /** @example "" */
4152
+ contraNumber?: string;
4153
+ /** @example "" */
4154
+ contraTitle?: string;
4155
+ /** @example "" */
4156
+ participantNumber?: string;
4157
+ /** @example "" */
4158
+ primaryTaxId?: string;
4159
+ /** @example "{optional}" */
4160
+ remoteDevice?: string;
4161
+ /** @example "{optional}" */
4162
+ remoteIp?: string;
4163
+ /** @example "" */
4164
+ secondaryTaxId?: string;
4165
+ /**
4166
+ * @example "{optional}
4167
+ * (Leave blank to send out ACAT immediately)|
4168
+ * RequestPlaced (Trigger Scheduled Acat Request)
4169
+ * |Scheduled"
4170
+ */
4171
+ status?: string;
4172
+ /** @example "Full|Partial" */
4173
+ type?: string;
4174
+ }[], config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3759
4175
  }
3760
4176
  export class TransfersWires<HandleError extends boolean = boolean> {
3761
4177
  protected readonly apiClient: JwtClient<HandleError>;
@@ -3850,292 +4266,114 @@ export class TransfersWires<HandleError extends boolean = boolean> {
3850
4266
  remoteDevice?: any;
3851
4267
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3852
4268
  }
3853
- export class AdvisoryModels<HandleError extends boolean = boolean> {
3854
- protected readonly apiClient: JwtClient<HandleError>;
3855
- constructor(apiClient: JwtClient<HandleError>);
3856
- /**
3857
- * @tags Advisory Models
3858
- * @name Listing
3859
- * @summary Listing
3860
- * @request GET:/v2/advisory/models
3861
- * @secure
3862
- */
3863
- listing(query?: {
3864
- /**
3865
- * true|false
3866
- * @example "false"
3867
- */
3868
- loadQuotes?: any;
3869
- /**
3870
- * true|false
3871
- * @example "false"
3872
- */
3873
- loadAccounts?: any;
3874
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3875
- /**
3876
- * @tags Advisory Models
3877
- * @name ModelsByAccount
3878
- * @summary Models by account
3879
- * @request GET:/v2/advisory/modelsOfAccount
3880
- * @secure
3881
- */
3882
- modelsByAccount(query?: {
3883
- /** @example "" */
3884
- accountId?: any;
3885
- /** @example "" */
3886
- account?: any;
3887
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3888
- /**
3889
- * @tags Advisory Models
3890
- * @name ComponentTags
3891
- * @summary Component tags
3892
- * @request GET:/v2/advisory/models/components/tags
3893
- * @secure
3894
- */
3895
- componentTags(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3896
- /**
3897
- * @tags Advisory Models
3898
- * @name BuyingPower
3899
- * @summary Buying power
3900
- * @request GET:/v2/advisory/model/balance/{currency}/{modelId}
3901
- * @secure
3902
- */
3903
- buyingPower(currency: string, modelId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3904
- /**
3905
- * @tags Advisory Models
3906
- * @name RealtimeBalance
3907
- * @summary Realtime balance
3908
- * @request GET:/v2/advisory/model/rtb/{modelId}
3909
- * @secure
3910
- */
3911
- realtimeBalance(modelId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3912
- /**
3913
- * @tags Advisory Models
3914
- * @name RealtimeBalanceHistory
3915
- * @summary Realtime balance history
3916
- * @request GET:/v2/advisory/model/rtb/history/{modelId}
3917
- * @secure
3918
- */
3919
- realtimeBalanceHistory(modelId: string, query?: {
3920
- /** First page is 0 */
3921
- page?: any;
3922
- /** Number of entries per page. Defaults to 1,000 */
3923
- count?: any;
3924
- dateFrom?: any;
3925
- dateTo?: any;
3926
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3927
- /**
3928
- * @tags Advisory Models
3929
- * @name Adjustments
3930
- * @summary Adjustments
3931
- * @request GET:/v2/advisory/model/adjustments/{modelId}
3932
- * @secure
3933
- */
3934
- adjustments(modelId: string, query?: {
3935
- /**
3936
- * true|false
3937
- * @example "false"
3938
- */
3939
- loadQuotes?: any;
3940
- /** Pending, Active, Complete, Rejected, Cancelled */
3941
- status?: any;
3942
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3943
- /**
3944
- * @tags Advisory Models
3945
- * @name AdjustmentPreview
3946
- * @summary Adjustment preview
3947
- * @request GET:/v2/advisory/model/adjustments/preview/{adjustmentId}
3948
- * @secure
3949
- */
3950
- adjustmentPreview(adjustmentId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3951
- /**
3952
- * @tags Advisory Models
3953
- * @name MemberAccounts
3954
- * @summary Member accounts
3955
- * @request GET:/v2/advisory/model/accounts/{modelId}
3956
- * @secure
3957
- */
3958
- memberAccounts(modelId: string, query?: {
3959
- /**
3960
- * `true`|`false` - whether or not to load account's realtime balance
3961
- * @example "false"
3962
- */
3963
- loadRtb?: any;
3964
- /**
3965
- * `true`|`false` - whether or not to load account's 3 months of balance history
3966
- * @example "false"
3967
- */
3968
- loadRtbHistory?: any;
3969
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3970
- /**
3971
- * @tags Advisory Models
3972
- * @name OrphanedAccounts
3973
- * @summary Orphaned accounts
3974
- * @request GET:/v2/advisory/model/accounts/orphaned
3975
- * @secure
3976
- */
3977
- orphanedAccounts(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3978
- /**
3979
- * @tags Advisory Models
3980
- * @name MemberAccountStatistics
3981
- * @summary Member account statistics
3982
- * @request GET:/v2/advisory/model/accounts/stats/{modelId}
3983
- * @secure
3984
- */
3985
- memberAccountStatistics(modelId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3986
- /**
3987
- * @tags Advisory Models
3988
- * @name MemberRealtimeBalances
3989
- * @summary Member realtime balances
3990
- * @request GET:/v2/advisory/model/rtbs/{modelId}
3991
- * @secure
3992
- */
3993
- memberRealtimeBalances(modelId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3994
- /**
3995
- * @tags Advisory Models
3996
- * @name Portfolio
3997
- * @summary Portfolio
3998
- * @request GET:/v2/advisory/model/portfolios/{modelId}
3999
- * @secure
4000
- */
4001
- portfolio(modelId: string, query?: {
4002
- /**
4003
- * Should load quotes or not.
4004
- * @example "false"
4005
- */
4006
- loadQuotes?: any;
4007
- /**
4008
- * Whether to return combined portfolio (no accounts, with approximate prices)
4009
- * @example "false"
4010
- */
4011
- combined?: any;
4012
- /** @example "false" */
4013
- loadIndustries?: any;
4014
- /** @example "false" */
4015
- loadUpgrades?: any;
4016
- /** @example "false" */
4017
- loadEarnings?: any;
4018
- /**
4019
- * Whether or not to include orders comprising each position's cost
4020
- * @example "false"
4021
- */
4022
- loadCost?: any;
4023
- /**
4024
- * Analyze market caps and get `marketCapWeights`. To be used in conjuction with `loadQuotes`
4025
- * @example "false"
4026
- */
4027
- marketCapWeights?: any;
4028
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4029
- /**
4030
- * @tags Advisory Models
4031
- * @name AllModelBuyingPower
4032
- * @summary All model buying power
4033
- * @request GET:/v2/advisory/model/balances/{currency}
4034
- * @secure
4035
- */
4036
- allModelBuyingPower(currency: string, query?: {
4037
- /**
4038
- * [optional] when omitted defaults to system's setting.
4039
- * @example "USD"
4040
- */
4041
- currency?: any;
4042
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4043
- /**
4044
- * @tags Advisory Models
4045
- * @name PositionLookup
4046
- * @summary Position lookup
4047
- * @request GET:/v2/advisory/model/position/equity/{modelId}
4048
- * @secure
4049
- */
4050
- positionLookup(modelId: string, query?: {
4051
- symbol?: any;
4052
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4269
+ export class TransfersJournals<HandleError extends boolean = boolean> {
4270
+ protected readonly apiClient: JwtClient<HandleError>;
4271
+ constructor(apiClient: JwtClient<HandleError>);
4053
4272
  /**
4054
- * @tags Advisory Models
4055
- * @name PositionLookupOptions
4056
- * @summary Position lookup (options)
4057
- * @request GET:/v2/advisory/model/position/option/{modelId}
4273
+ * @tags Transfers Journals
4274
+ * @name JournalRequest
4275
+ * @summary Journal request
4276
+ * @request POST:/transfer/journal/request
4058
4277
  * @secure
4059
4278
  */
4060
- positionLookupOptions(modelId: string, query?: {
4279
+ journalRequest(data: {
4280
+ /** @example 1000 */
4281
+ amount?: any;
4282
+ deliverFrom?: {
4283
+ /** @example 124 */
4284
+ accountId?: number;
4285
+ /** @example "ABC123456" */
4286
+ accountNumber?: string;
4287
+ };
4288
+ deliverTo?: {
4289
+ /** @example 456 */
4290
+ accountId?: number;
4291
+ /** @example "DEF123456" */
4292
+ accountNumber?: string;
4293
+ };
4294
+ /** @example "MM/dd/yyyy HH:mm:ss z" */
4295
+ deliveryDate?: any;
4296
+ loa?: {
4297
+ /** @example "" */
4298
+ fullName?: string;
4299
+ /** @example "" */
4300
+ remoteAddr?: string;
4301
+ /** @example "" */
4302
+ remoteDevice?: string;
4303
+ /** @example "" */
4304
+ signature?: string;
4305
+ /** @example "MM/dd/yyyy HH:mm:ss z" */
4306
+ timestamp?: string;
4307
+ };
4308
+ /** @example "NoPurpose|Gift|StockGift" */
4309
+ purpose?: any;
4310
+ /** @example "" */
4311
+ reason?: any;
4312
+ /** @example "0.0.0.0" */
4313
+ remoteAddr?: any;
4314
+ /** @example "Ultra fast proxy" */
4315
+ remoteDevice?: any;
4316
+ /** @example "required for StockGift" */
4061
4317
  symbol?: any;
4062
4318
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4063
4319
  /**
4064
- * @tags Advisory Models
4065
- * @name AdjustmentUpdates
4066
- * @summary Adjustment updates
4067
- * @request POST:/v2/advisory/model/adjustments/modify/{action}
4068
- * @secure
4069
- */
4070
- adjustmentUpdates(action: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4071
- /**
4072
- * @tags Advisory Models
4073
- * @name Creation
4074
- * @summary Creation
4075
- * @request POST:/v2/advisory/model/create
4076
- * @secure
4077
- */
4078
- creation(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4079
- /**
4080
- * @tags Advisory Models
4081
- * @name Update
4082
- * @summary Update
4083
- * @request POST:/v2/advisory/model/update
4084
- * @secure
4085
- */
4086
- update(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4087
- /**
4088
- * @tags Advisory Models
4089
- * @name Deletion
4090
- * @summary Deletion
4091
- * @request POST:/v2/advisory/model/delete
4092
- * @secure
4093
- */
4094
- deletion(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4095
- /**
4096
- * @tags Advisory Models
4097
- * @name ComponentUpdate
4098
- * @summary Component update
4099
- * @request POST:/v2/advisory/model/component/update
4100
- * @secure
4101
- */
4102
- componentUpdate(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4103
- /**
4104
- * @tags Advisory Models
4105
- * @name LinkOfMemberAccounts
4106
- * @summary Link of member accounts
4107
- * @request POST:/v2/advisory/model/account/link
4108
- * @secure
4109
- */
4110
- linkOfMemberAccounts(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4111
- /**
4112
- * @tags Advisory Models
4113
- * @name UnlinkMemberAccount
4114
- * @summary Unlink member account
4115
- * @request POST:/v2/advisory/model/account/unlink
4116
- * @secure
4117
- */
4118
- unlinkMemberAccount(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4119
- /**
4120
- * @tags Advisory Models
4121
- * @name Allocations
4122
- * @summary Allocations
4123
- * @request POST:/v2/advisory/model/orders/allocate
4320
+ * @tags Transfers Journals
4321
+ * @name Search
4322
+ * @summary Search
4323
+ * @request POST:/transfer/journal/search
4124
4324
  * @secure
4125
4325
  */
4126
- allocations(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4326
+ search(data: {
4327
+ account?: {
4328
+ /** @example 0 */
4329
+ accountId?: number;
4330
+ /** @example "ABC123456" */
4331
+ accountNumber?: string;
4332
+ };
4333
+ /** @example "PLACED|SENT|..." */
4334
+ status?: any;
4335
+ /** @example "AB123456" */
4336
+ transferId?: any;
4337
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4127
4338
  }
4128
- export class TransfersBank<HandleError extends boolean = boolean> {
4339
+ export class TransfersPositions<HandleError extends boolean = boolean> {
4129
4340
  protected readonly apiClient: JwtClient<HandleError>;
4130
4341
  constructor(apiClient: JwtClient<HandleError>);
4131
4342
  /**
4132
- * @tags Transfers Bank
4133
- * @name FundTransfer
4134
- * @summary Fund transfer
4135
- * @request POST:/transfer/bank/{direction}
4343
+ * @tags Transfers Positions
4344
+ * @name TransferRequest
4345
+ * @summary Transfer request
4346
+ * @request POST:/transfer/position/request
4136
4347
  * @secure
4137
4348
  */
4138
- fundTransfer(direction: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4349
+ transferRequest(data: {
4350
+ deliverFrom?: {
4351
+ /** @example 124 */
4352
+ accountId?: number;
4353
+ /** @example "ABC123456" */
4354
+ accountNumber?: string;
4355
+ };
4356
+ deliverTo?: {
4357
+ /** @example 456 */
4358
+ accountId?: number;
4359
+ /** @example "DEF123456" */
4360
+ accountNumber?: string;
4361
+ };
4362
+ /** @example "NoPurpose|Gift" */
4363
+ purpose?: any;
4364
+ /** @example 1000 */
4365
+ quantity?: any;
4366
+ quote?: {
4367
+ /** @example "IBM" */
4368
+ symbol?: string;
4369
+ };
4370
+ /** @example "" */
4371
+ reason?: any;
4372
+ /** @example "0.0.0.0" */
4373
+ remoteAddr?: any;
4374
+ /** @example "Ultra fast proxy" */
4375
+ remoteDevice?: any;
4376
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4139
4377
  }
4140
4378
  export class TransfersInstantCashTransfers<HandleError extends boolean = boolean> {
4141
4379
  protected readonly apiClient: JwtClient<HandleError>;
@@ -4242,58 +4480,6 @@ export class TransfersInstantCashTransfers<HandleError extends boolean = boolean
4242
4480
  */
4243
4481
  listReports(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4244
4482
  }
4245
- export class AdvisoryAllocations<HandleError extends boolean = boolean> {
4246
- protected readonly apiClient: JwtClient<HandleError>;
4247
- constructor(apiClient: JwtClient<HandleError>);
4248
- /**
4249
- * @tags Advisory Allocations
4250
- * @name SearchNa
4251
- * @summary Search (n/a)
4252
- * @request GET:/v2/allocations/search
4253
- * @secure
4254
- */
4255
- searchNa(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4256
- /**
4257
- * @tags Advisory Allocations
4258
- * @name Details
4259
- * @summary Details
4260
- * @request GET:/v2/allocations/details/{allocationRef}
4261
- * @secure
4262
- */
4263
- details(allocationRef: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4264
- /**
4265
- * @tags Advisory Allocations
4266
- * @name Cancel
4267
- * @summary Cancel
4268
- * @request POST:/v2/allocations/cancel
4269
- * @secure
4270
- */
4271
- cancel(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4272
- /**
4273
- * @tags Advisory Allocations
4274
- * @name Validation
4275
- * @summary Validation
4276
- * @request POST:/v2/allocations/validate
4277
- * @secure
4278
- */
4279
- validation(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4280
- /**
4281
- * @tags Advisory Allocations
4282
- * @name Scheduling
4283
- * @summary Scheduling
4284
- * @request POST:/v2/allocations/preallocate
4285
- * @secure
4286
- */
4287
- scheduling(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4288
- /**
4289
- * @tags Advisory Allocations
4290
- * @name Trigger
4291
- * @summary Trigger
4292
- * @request POST:/v2/allocations/trigger
4293
- * @secure
4294
- */
4295
- trigger(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4296
- }
4297
4483
  export class TransfersCheques<HandleError extends boolean = boolean> {
4298
4484
  protected readonly apiClient: JwtClient<HandleError>;
4299
4485
  constructor(apiClient: JwtClient<HandleError>);
@@ -4306,44 +4492,17 @@ export class TransfersCheques<HandleError extends boolean = boolean> {
4306
4492
  */
4307
4493
  withdrawal(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4308
4494
  }
4309
- export class TransfersPositions<HandleError extends boolean = boolean> {
4495
+ export class TransfersBank<HandleError extends boolean = boolean> {
4310
4496
  protected readonly apiClient: JwtClient<HandleError>;
4311
4497
  constructor(apiClient: JwtClient<HandleError>);
4312
4498
  /**
4313
- * @tags Transfers Positions
4314
- * @name TransferRequest
4315
- * @summary Transfer request
4316
- * @request POST:/transfer/position/request
4499
+ * @tags Transfers Bank
4500
+ * @name FundTransfer
4501
+ * @summary Fund transfer
4502
+ * @request POST:/transfer/bank/{direction}
4317
4503
  * @secure
4318
- */
4319
- transferRequest(data: {
4320
- deliverFrom?: {
4321
- /** @example 124 */
4322
- accountId?: number;
4323
- /** @example "ABC123456" */
4324
- accountNumber?: string;
4325
- };
4326
- deliverTo?: {
4327
- /** @example 456 */
4328
- accountId?: number;
4329
- /** @example "DEF123456" */
4330
- accountNumber?: string;
4331
- };
4332
- /** @example "NoPurpose|Gift" */
4333
- purpose?: any;
4334
- /** @example 1000 */
4335
- quantity?: any;
4336
- quote?: {
4337
- /** @example "IBM" */
4338
- symbol?: string;
4339
- };
4340
- /** @example "" */
4341
- reason?: any;
4342
- /** @example "0.0.0.0" */
4343
- remoteAddr?: any;
4344
- /** @example "Ultra fast proxy" */
4345
- remoteDevice?: any;
4346
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4504
+ */
4505
+ fundTransfer(direction: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4347
4506
  }
4348
4507
  export class Transfers<HandleError extends boolean = boolean> {
4349
4508
  protected readonly apiClient: JwtClient<HandleError>;
@@ -4437,329 +4596,147 @@ export class Transfers<HandleError extends boolean = boolean> {
4437
4596
  */
4438
4597
  legalDocumentTypes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4439
4598
  /**
4440
- * @tags Transfers
4441
- * @name LegalDocument
4442
- * @summary Legal document
4443
- * @request GET:/transfer/legal/content
4444
- * @secure
4445
- */
4446
- legalDocument(query?: {
4447
- /** Unique ID given in the types endpoint */
4448
- id?: any;
4449
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4450
- /**
4451
- * @tags Transfers
4452
- * @name Cancel
4453
- * @summary Cancel
4454
- * @request POST:/transfer/ach/cancel
4455
- * @secure
4456
- */
4457
- cancel(data: {
4458
- /** @example "5VA0XXXX" */
4459
- account?: any;
4460
- /** @example "0.0.0.0" */
4461
- remoteAddr?: any;
4462
- /** @example "ultra fast browser 1.1" */
4463
- remoteDevice?: any;
4464
- /** @example "CC123456" */
4465
- transferId?: any;
4466
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4467
- /**
4468
- * @tags Transfers
4469
- * @name FeesAndCredits
4470
- * @summary Fees and Credits
4471
- * @request POST:/transfer/fees/apply
4472
- * @secure
4473
- */
4474
- feesAndCredits(data: {
4475
- /** @example "5VA0XXXX" */
4476
- account?: any;
4477
- /** @example 100 */
4478
- amount?: any;
4479
- /** @example "FeeReversal|Promotion|WriteOff|Rebate|Courtesy|Advisory|Management|Admin|Exchange|Tech|Platform|Inactivity|MarginInterest|Custodian|CryptoGift" */
4480
- classification?: any;
4481
- /** @example "" */
4482
- contraNote?: any;
4483
- /** @example "USD" */
4484
- currency?: any;
4485
- /** @example "" */
4486
- note?: any;
4487
- /** @example 0.01 */
4488
- quantity?: any;
4489
- /** @example "0.0.0.0" */
4490
- remoteAddr?: any;
4491
- /** @example "ultra fast browser 1.1" */
4492
- remoteDevice?: any;
4493
- /** @example "BTC/USD" */
4494
- symbol?: any;
4495
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4496
- /**
4497
- * @tags Transfers
4498
- * @name ListFees
4499
- * @summary List fees
4500
- * @request GET:/transfer/fees/classifications/fees
4501
- * @secure
4502
- */
4503
- listFees(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4504
- /**
4505
- * @tags Transfers
4506
- * @name ListCredits
4507
- * @summary List credits
4508
- * @request GET:/transfer/fees/classifications/credits
4509
- * @secure
4510
- */
4511
- listCredits(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4512
- /**
4513
- * @tags Transfers
4514
- * @name CryptoDepositAddress
4515
- * @summary Crypto Deposit Address
4516
- * @request GET:/transfer/crypto/deposit/wallet/address
4517
- * @secure
4518
- */
4519
- cryptoDepositAddress(data: {
4520
- /** @example "AB123456" */
4521
- account?: any;
4522
- /** @example "BTC" */
4523
- currency?: any;
4524
- /** @example "{optional}" */
4525
- network?: any;
4526
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4527
- /**
4528
- * @tags Transfers
4529
- * @name CryptoWithdrawalEstimate
4530
- * @summary Crypto Withdrawal Estimate
4531
- * @request POST:/transfer/crypto/withdrawal/estimate
4532
- * @secure
4533
- */
4534
- cryptoWithdrawalEstimate(data: {
4535
- /** @example "BTC" */
4536
- currency?: any;
4537
- /** @example "{optional}" */
4538
- network?: any;
4539
- /** @example "0.1" */
4540
- quantity?: any;
4541
- /** @example "{optional}" */
4542
- wallet?: any;
4543
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4544
- /**
4545
- * @tags Transfers
4546
- * @name CryptoWithdrawal
4547
- * @summary Crypto Withdrawal
4548
- * @request POST:/transfer/crypto/withdraw
4549
- * @secure
4550
- */
4551
- cryptoWithdrawal(data: {
4552
- /** @example "AB123456" */
4553
- account?: any;
4554
- /** @example "BTC" */
4555
- currency?: any;
4556
- /** @example "{optional}" */
4557
- estimateExtension?: any;
4558
- /** @example "abc123" */
4559
- estimateId?: any;
4560
- /** @example "{optional}" */
4561
- network?: any;
4562
- /** @example 0.1 */
4563
- quantity?: any;
4564
- /** @example "{conditional}" */
4565
- recipientFirstName?: any;
4566
- /** @example "{conditional}" */
4567
- recipientLastName?: any;
4568
- /** @example "{optional} 1.1.1.1" */
4569
- remoteAddr?: any;
4570
- /** @example "{optional} Some phone" */
4571
- remoteDevice?: any;
4572
- /** @example "{optional} true|false" */
4573
- selfHosted?: any;
4574
- /** @example "{optional}" */
4575
- tag?: any;
4576
- /** @example "{conditional}" */
4577
- vaspName?: any;
4578
- /** @example "wallet address" */
4579
- wallet?: any;
4580
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4581
- }
4582
- export class Miscellaneous<HandleError extends boolean = boolean> {
4583
- protected readonly apiClient: JwtClient<HandleError>;
4584
- constructor(apiClient: JwtClient<HandleError>);
4585
- /**
4586
- * @tags Miscellaneous
4587
- * @name ResearchMarketdate
4588
- * @summary /research/marketDate
4589
- * @request GET:/research/marketDate
4590
- * @secure
4591
- */
4592
- researchMarketdate(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4593
- /**
4594
- * @tags Miscellaneous
4595
- * @name ResearchDatesMarkets
4596
- * @summary /research/dates/markets
4597
- * @request GET:/research/dates/markets
4598
- * @secure
4599
- */
4600
- researchDatesMarkets(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4601
- /**
4602
- * @tags Miscellaneous
4603
- * @name ResearchDatesLastopen
4604
- * @summary /research/dates/lastOpen
4605
- * @request GET:/research/dates/lastOpen
4606
- * @secure
4607
- */
4608
- researchDatesLastopen(query?: {
4609
- /**
4610
- * Optional value for the market
4611
- * @example "U"
4612
- */
4613
- market?: any;
4614
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4615
- /**
4616
- * @tags Miscellaneous
4617
- * @name ResearchDatesCheck
4618
- * @summary /research/dates/check
4619
- * @request GET:/research/dates/check
4620
- * @secure
4621
- */
4622
- researchDatesCheck(query?: {
4623
- /**
4624
- * Optional value for the market
4625
- * @example "U"
4626
- */
4627
- market?: any;
4628
- /**
4629
- * Optional
4630
- * @example "9/24/2018"
4631
- */
4632
- date?: any;
4633
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4634
- /**
4635
- * @tags Miscellaneous
4636
- * @name AdvisoryInfo
4637
- * @request GET:/v2/advisory/info
4638
- * @secure
4639
- */
4640
- advisoryInfo(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4641
- /**
4642
- * @tags Miscellaneous
4643
- * @name AdvisoryInfoUpdate
4644
- * @request POST:/v2/advisory/info/update
4645
- * @secure
4646
- */
4647
- advisoryInfoUpdate(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4648
- /**
4649
- * @tags Miscellaneous
4650
- * @name FilesUserAvatarUpload
4651
- * @request POST:/v1/files/user/avatar/upload
4652
- * @secure
4653
- */
4654
- filesUserAvatarUpload(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4655
- /**
4656
- * @tags Miscellaneous
4657
- * @name FilesUpload
4658
- * @request POST:/v1/files/upload
4659
- * @secure
4660
- */
4661
- filesUpload(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4662
- /**
4663
- * @tags Miscellaneous
4664
- * @name FilesUploadAvatar
4665
- * @request POST:/v1/files/upload/avatar/{userId}
4666
- * @secure
4667
- */
4668
- filesUploadAvatar(userId: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4669
- /**
4670
- * @tags Miscellaneous
4671
- * @name FilesUserAvatar
4672
- * @request GET:/v1/files/user/avatar
4673
- * @secure
4674
- */
4675
- filesUserAvatar(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4676
- /**
4677
- * @tags Miscellaneous
4678
- * @name FilesAvatar
4679
- * @request GET:/v1/files/{userId}/avatar
4680
- * @secure
4681
- */
4682
- filesAvatar(userId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4683
- /**
4684
- * @tags Miscellaneous
4685
- * @name FilesDownload
4686
- * @request GET:/v1/files/download/{tag}/{id}
4687
- * @secure
4688
- */
4689
- filesDownload(tag: string, id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4690
- /**
4691
- * @tags Miscellaneous
4692
- * @name FilesList
4693
- * @request GET:/v1/files/list
4599
+ * @tags Transfers
4600
+ * @name LegalDocument
4601
+ * @summary Legal document
4602
+ * @request GET:/transfer/legal/content
4694
4603
  * @secure
4695
4604
  */
4696
- filesList(query?: {
4697
- /**
4698
- * Optional. Allows filtering for tags
4699
- * @example "document*"
4700
- */
4701
- tag?: any;
4702
- /**
4703
- * Optional. Allows filtering for filenames
4704
- * @example "application*"
4705
- */
4706
- filename?: any;
4605
+ legalDocument(query?: {
4606
+ /** Unique ID given in the types endpoint */
4607
+ id?: any;
4707
4608
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4708
4609
  /**
4709
- * @tags Miscellaneous
4710
- * @name FilesAllowedExts
4711
- * @request GET:/v1/files/allowed/exts
4610
+ * @tags Transfers
4611
+ * @name Cancel
4612
+ * @summary Cancel
4613
+ * @request POST:/transfer/ach/cancel
4712
4614
  * @secure
4713
4615
  */
4714
- filesAllowedExts(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4616
+ cancel(data: {
4617
+ /** @example "5VA0XXXX" */
4618
+ account?: any;
4619
+ /** @example "0.0.0.0" */
4620
+ remoteAddr?: any;
4621
+ /** @example "ultra fast browser 1.1" */
4622
+ remoteDevice?: any;
4623
+ /** @example "CC123456" */
4624
+ transferId?: any;
4625
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4715
4626
  /**
4716
- * @tags Miscellaneous
4717
- * @name ErrorCodeListing
4718
- * @summary Error code listing
4719
- * @request GET:/general/errors
4627
+ * @tags Transfers
4628
+ * @name FeesAndCredits
4629
+ * @summary Fees and Credits
4630
+ * @request POST:/transfer/fees/apply
4720
4631
  * @secure
4721
4632
  */
4722
- errorCodeListing(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4633
+ feesAndCredits(data: {
4634
+ /** @example "5VA0XXXX" */
4635
+ account?: any;
4636
+ /** @example 100 */
4637
+ amount?: any;
4638
+ /** @example "FeeReversal|Promotion|WriteOff|Rebate|Courtesy|Advisory|Management|Admin|Exchange|Tech|Platform|Inactivity|MarginInterest|Custodian|CryptoGift" */
4639
+ classification?: any;
4640
+ /** @example "" */
4641
+ contraNote?: any;
4642
+ /** @example "USD" */
4643
+ currency?: any;
4644
+ /** @example "" */
4645
+ note?: any;
4646
+ /** @example 0.01 */
4647
+ quantity?: any;
4648
+ /** @example "0.0.0.0" */
4649
+ remoteAddr?: any;
4650
+ /** @example "ultra fast browser 1.1" */
4651
+ remoteDevice?: any;
4652
+ /** @example "BTC/USD" */
4653
+ symbol?: any;
4654
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4723
4655
  /**
4724
- * @tags Miscellaneous
4725
- * @name Ping
4726
- * @summary Ping
4727
- * @request GET:/general/ping
4656
+ * @tags Transfers
4657
+ * @name ListFees
4658
+ * @summary List fees
4659
+ * @request GET:/transfer/fees/classifications/fees
4728
4660
  * @secure
4729
4661
  */
4730
- ping(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4662
+ listFees(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4731
4663
  /**
4732
- * @tags Miscellaneous
4733
- * @name CurrencyList
4734
- * @summary Currency list
4735
- * @request GET:/general/available-currencies
4664
+ * @tags Transfers
4665
+ * @name ListCredits
4666
+ * @summary List credits
4667
+ * @request GET:/transfer/fees/classifications/credits
4736
4668
  * @secure
4737
4669
  */
4738
- currencyList(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4670
+ listCredits(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4739
4671
  /**
4740
- * @tags Miscellaneous
4741
- * @name TradableCurrencyList
4742
- * @summary Tradable currency list
4743
- * @request GET:/general/tradable-currencies
4672
+ * @tags Transfers
4673
+ * @name CryptoDepositAddress
4674
+ * @summary Crypto Deposit Address
4675
+ * @request GET:/transfer/crypto/deposit/wallet/address
4744
4676
  * @secure
4745
4677
  */
4746
- tradableCurrencyList(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4678
+ cryptoDepositAddress(data: {
4679
+ /** @example "AB123456" */
4680
+ account?: any;
4681
+ /** @example "BTC" */
4682
+ currency?: any;
4683
+ /** @example "{optional}" */
4684
+ network?: any;
4685
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4747
4686
  /**
4748
- * @tags Miscellaneous
4749
- * @name OptionStrategyTypes
4750
- * @summary Option Strategy Types
4751
- * @request GET:/general/options/strategyTypes
4687
+ * @tags Transfers
4688
+ * @name CryptoWithdrawalEstimate
4689
+ * @summary Crypto Withdrawal Estimate
4690
+ * @request POST:/transfer/crypto/withdrawal/estimate
4752
4691
  * @secure
4753
4692
  */
4754
- optionStrategyTypes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4693
+ cryptoWithdrawalEstimate(data: {
4694
+ /** @example "BTC" */
4695
+ currency?: any;
4696
+ /** @example "{optional}" */
4697
+ network?: any;
4698
+ /** @example "0.1" */
4699
+ quantity?: any;
4700
+ /** @example "{optional}" */
4701
+ wallet?: any;
4702
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4755
4703
  /**
4756
- * @tags Miscellaneous
4757
- * @name OptionStrategyClassifications
4758
- * @summary Option Strategy Classifications
4759
- * @request GET:/general/options/strategyClassifications
4704
+ * @tags Transfers
4705
+ * @name CryptoWithdrawal
4706
+ * @summary Crypto Withdrawal
4707
+ * @request POST:/transfer/crypto/withdraw
4760
4708
  * @secure
4761
4709
  */
4762
- optionStrategyClassifications(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4710
+ cryptoWithdrawal(data: {
4711
+ /** @example "AB123456" */
4712
+ account?: any;
4713
+ /** @example "BTC" */
4714
+ currency?: any;
4715
+ /** @example "{optional}" */
4716
+ estimateExtension?: any;
4717
+ /** @example "abc123" */
4718
+ estimateId?: any;
4719
+ /** @example "{optional}" */
4720
+ network?: any;
4721
+ /** @example 0.1 */
4722
+ quantity?: any;
4723
+ /** @example "{conditional}" */
4724
+ recipientFirstName?: any;
4725
+ /** @example "{conditional}" */
4726
+ recipientLastName?: any;
4727
+ /** @example "{optional} 1.1.1.1" */
4728
+ remoteAddr?: any;
4729
+ /** @example "{optional} Some phone" */
4730
+ remoteDevice?: any;
4731
+ /** @example "{optional} true|false" */
4732
+ selfHosted?: any;
4733
+ /** @example "{optional}" */
4734
+ tag?: any;
4735
+ /** @example "{conditional}" */
4736
+ vaspName?: any;
4737
+ /** @example "wallet address" */
4738
+ wallet?: any;
4739
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4763
4740
  }
4764
4741
  export class Documents<HandleError extends boolean = boolean> {
4765
4742
  protected readonly apiClient: JwtClient<HandleError>;
@@ -4864,289 +4841,277 @@ export class Documents<HandleError extends boolean = boolean> {
4864
4841
  * Indicates end month & year (day of month is not used)
4865
4842
  * @example "12/1/2021"
4866
4843
  */
4867
- toMonth?: any;
4844
+ toMonth?: any;
4845
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4846
+ /**
4847
+ * @tags Documents
4848
+ * @name AvailableDocumentTypes
4849
+ * @summary Available document types
4850
+ * @request GET:/documents/types
4851
+ * @secure
4852
+ */
4853
+ availableDocumentTypes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4854
+ /**
4855
+ * @tags Documents
4856
+ * @name AvailableDocumentTypesAndCodes
4857
+ * @summary Available document types and codes
4858
+ * @request GET:/documents/typesAndCodes
4859
+ * @secure
4860
+ */
4861
+ availableDocumentTypesAndCodes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4862
+ /**
4863
+ * @tags Documents
4864
+ * @name Download
4865
+ * @summary Download
4866
+ * @request GET:/documents/download
4867
+ * @secure
4868
+ */
4869
+ download(query?: {
4870
+ /**
4871
+ * Account Number
4872
+ * @example "{accountNumber}"
4873
+ */
4874
+ account?: any;
4875
+ /**
4876
+ * UUID for finding specific document
4877
+ * @example "{key}"
4878
+ */
4879
+ key?: any;
4880
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4881
+ /**
4882
+ * @tags Documents
4883
+ * @name GetAllBranchDocuments
4884
+ * @summary Get all Branch Documents
4885
+ * @request GET:/documents/branch/list
4886
+ * @secure
4887
+ */
4888
+ getAllBranchDocuments(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4889
+ }
4890
+ export class Miscellaneous<HandleError extends boolean = boolean> {
4891
+ protected readonly apiClient: JwtClient<HandleError>;
4892
+ constructor(apiClient: JwtClient<HandleError>);
4893
+ /**
4894
+ * @tags Miscellaneous
4895
+ * @name ResearchMarketdate
4896
+ * @summary /research/marketDate
4897
+ * @request GET:/research/marketDate
4898
+ * @secure
4899
+ */
4900
+ researchMarketdate(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4901
+ /**
4902
+ * @tags Miscellaneous
4903
+ * @name ResearchDatesMarkets
4904
+ * @summary /research/dates/markets
4905
+ * @request GET:/research/dates/markets
4906
+ * @secure
4907
+ */
4908
+ researchDatesMarkets(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4909
+ /**
4910
+ * @tags Miscellaneous
4911
+ * @name ResearchDatesLastopen
4912
+ * @summary /research/dates/lastOpen
4913
+ * @request GET:/research/dates/lastOpen
4914
+ * @secure
4915
+ */
4916
+ researchDatesLastopen(query?: {
4917
+ /**
4918
+ * Optional value for the market
4919
+ * @example "U"
4920
+ */
4921
+ market?: any;
4922
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4923
+ /**
4924
+ * @tags Miscellaneous
4925
+ * @name ResearchDatesCheck
4926
+ * @summary /research/dates/check
4927
+ * @request GET:/research/dates/check
4928
+ * @secure
4929
+ */
4930
+ researchDatesCheck(query?: {
4931
+ /**
4932
+ * Optional value for the market
4933
+ * @example "U"
4934
+ */
4935
+ market?: any;
4936
+ /**
4937
+ * Optional
4938
+ * @example "9/24/2018"
4939
+ */
4940
+ date?: any;
4868
4941
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4869
4942
  /**
4870
- * @tags Documents
4871
- * @name AvailableDocumentTypes
4872
- * @summary Available document types
4873
- * @request GET:/documents/types
4943
+ * @tags Miscellaneous
4944
+ * @name AdvisoryInfo
4945
+ * @request GET:/v2/advisory/info
4874
4946
  * @secure
4875
4947
  */
4876
- availableDocumentTypes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4948
+ advisoryInfo(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4877
4949
  /**
4878
- * @tags Documents
4879
- * @name AvailableDocumentTypesAndCodes
4880
- * @summary Available document types and codes
4881
- * @request GET:/documents/typesAndCodes
4950
+ * @tags Miscellaneous
4951
+ * @name AdvisoryInfoUpdate
4952
+ * @request POST:/v2/advisory/info/update
4882
4953
  * @secure
4883
4954
  */
4884
- availableDocumentTypesAndCodes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4955
+ advisoryInfoUpdate(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4885
4956
  /**
4886
- * @tags Documents
4887
- * @name Download
4888
- * @summary Download
4889
- * @request GET:/documents/download
4957
+ * @tags Miscellaneous
4958
+ * @name FilesUserAvatarUpload
4959
+ * @request POST:/v1/files/user/avatar/upload
4890
4960
  * @secure
4891
4961
  */
4892
- download(query?: {
4893
- /**
4894
- * Account Number
4895
- * @example "{accountNumber}"
4896
- */
4897
- account?: any;
4898
- /**
4899
- * UUID for finding specific document
4900
- * @example "{key}"
4901
- */
4902
- key?: any;
4903
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4962
+ filesUserAvatarUpload(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4904
4963
  /**
4905
- * @tags Documents
4906
- * @name GetAllBranchDocuments
4907
- * @summary Get all Branch Documents
4908
- * @request GET:/documents/branch/list
4964
+ * @tags Miscellaneous
4965
+ * @name FilesUpload
4966
+ * @request POST:/v1/files/upload
4909
4967
  * @secure
4910
4968
  */
4911
- getAllBranchDocuments(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4912
- }
4913
- export class Branch<HandleError extends boolean = boolean> {
4914
- protected readonly apiClient: JwtClient<HandleError>;
4915
- constructor(apiClient: JwtClient<HandleError>);
4969
+ filesUpload(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4916
4970
  /**
4917
- * @tags Branch
4918
- * @name BranchRtb
4919
- * @request GET:/v1/branch/rtb
4971
+ * @tags Miscellaneous
4972
+ * @name FilesUploadAvatar
4973
+ * @request POST:/v1/files/upload/avatar/{userId}
4920
4974
  * @secure
4921
4975
  */
4922
- branchRtb(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4976
+ filesUploadAvatar(userId: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4923
4977
  /**
4924
- * @tags Branch
4925
- * @name BranchRtbs
4926
- * @request GET:/v1/branch/rtbs
4978
+ * @tags Miscellaneous
4979
+ * @name FilesUserAvatar
4980
+ * @request GET:/v1/files/user/avatar
4927
4981
  * @secure
4928
4982
  */
4929
- branchRtbs(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4983
+ filesUserAvatar(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4930
4984
  /**
4931
- * @tags Branch
4932
- * @name BranchInventory
4933
- * @request GET:/v1/branch/inventory
4985
+ * @tags Miscellaneous
4986
+ * @name FilesAvatar
4987
+ * @request GET:/v1/files/{userId}/avatar
4934
4988
  * @secure
4935
4989
  */
4936
- branchInventory(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4990
+ filesAvatar(userId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4937
4991
  /**
4938
- * @tags Branch
4939
- * @name BranchRtbsTotal
4940
- * @request GET:/v1/branch/rtbs/total
4992
+ * @tags Miscellaneous
4993
+ * @name FilesDownload
4994
+ * @request GET:/v1/files/download/{tag}/{id}
4941
4995
  * @secure
4942
4996
  */
4943
- branchRtbsTotal(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4997
+ filesDownload(tag: string, id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4944
4998
  /**
4945
- * @tags Branch
4946
- * @name BranchPortfolio
4947
- * @request GET:/v1/branch/portfolio
4999
+ * @tags Miscellaneous
5000
+ * @name FilesList
5001
+ * @request GET:/v1/files/list
4948
5002
  * @secure
4949
5003
  */
4950
- branchPortfolio(query?: {
4951
- /**
4952
- * (true or false) Allows for loading of quotes for each portfolio entry. Defaults to false.
4953
- * @example "false"
4954
- */
4955
- loadQuotes?: any;
4956
- /** @example "false" */
4957
- loadIndustries?: any;
4958
- /** @example "false" */
4959
- loadUpgrades?: any;
4960
- /** @example "false" */
4961
- loadEarnings?: any;
4962
- /**
4963
- * Load balances for weight
4964
- * @example "false"
4965
- */
4966
- loadRtb?: any;
5004
+ filesList(query?: {
4967
5005
  /**
4968
- * Analyze market caps and get `marketCapWeights`. To be used in conjuction with `loadQuotes`
4969
- * @example "false"
5006
+ * Optional. Allows filtering for tags
5007
+ * @example "document*"
4970
5008
  */
4971
- marketCapBreakdown?: any;
5009
+ tag?: any;
4972
5010
  /**
4973
- * Combined portfolio for the branch
4974
- * @example "false"
5011
+ * Optional. Allows filtering for filenames
5012
+ * @example "application*"
4975
5013
  */
4976
- combined?: any;
4977
- /** @example "1" */
4978
- pageNum?: any;
4979
- /** @example "100" */
4980
- pageSize?: any;
5014
+ filename?: any;
4981
5015
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4982
5016
  /**
4983
- * @tags Branch
4984
- * @name OptionExpirations
4985
- * @summary Option expirations
4986
- * @request GET:/v1/branch/portfolio/options/upcoming
5017
+ * @tags Miscellaneous
5018
+ * @name FilesAllowedExts
5019
+ * @request GET:/v1/files/allowed/exts
4987
5020
  * @secure
4988
5021
  */
4989
- optionExpirations(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5022
+ filesAllowedExts(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4990
5023
  /**
4991
- * @tags Branch
4992
- * @name OptionExpirationsDetails
4993
- * @summary Option expirations details
4994
- * @request POST:/v1/branch/portfolio/options/upcoming/details
5024
+ * @tags Miscellaneous
5025
+ * @name ErrorCodeListing
5026
+ * @summary Error code listing
5027
+ * @request GET:/general/errors
4995
5028
  * @secure
4996
5029
  */
4997
- optionExpirationsDetails(data: {
4998
- /** @example "true|false" */
4999
- loadQuotes?: any;
5000
- /** @example "01/15/2021 00:00:00 EST" */
5001
- maturity?: any;
5002
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5003
- }
5004
- export class BlacklistAdminBusinesses<HandleError extends boolean = boolean> {
5005
- protected readonly apiClient: JwtClient<HandleError>;
5006
- constructor(apiClient: JwtClient<HandleError>);
5030
+ errorCodeListing(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5007
5031
  /**
5008
- * @tags Blacklist Admin Businesses
5009
- * @name GetBusinessesList
5010
- * @summary Get Businesses list
5011
- * @request GET:/v1/admin/businesses
5032
+ * @tags Miscellaneous
5033
+ * @name Ping
5034
+ * @summary Ping
5035
+ * @request GET:/general/ping
5012
5036
  * @secure
5013
5037
  */
5014
- getBusinessesList(query?: {
5015
- /**
5016
- * (Required) page number
5017
- * @example "5567183"
5018
- */
5019
- page?: any;
5020
- /**
5021
- * (Required) page size in records displayed
5022
- * @example "5567183"
5023
- */
5024
- page_size?: any;
5025
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5038
+ ping(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5026
5039
  /**
5027
- * @tags Blacklist Admin Businesses
5028
- * @name CreateBusiness
5029
- * @summary Create Business
5030
- * @request POST:/v1/admin/businesses
5040
+ * @tags Miscellaneous
5041
+ * @name CurrencyList
5042
+ * @summary Currency list
5043
+ * @request GET:/general/available-currencies
5031
5044
  * @secure
5032
5045
  */
5033
- createBusiness(data: {
5034
- /** @example "Gracia Marina" */
5035
- business_name?: any;
5036
- /** @example "Los Angeles" */
5037
- city?: any;
5038
- /** @example "US" */
5039
- country?: any;
5040
- /** @example "La Granja Del Camaron" */
5041
- dba_name?: any;
5042
- /** @example "" */
5043
- incorporated?: any;
5044
- /** @example "812748955" */
5045
- number?: any;
5046
- /** @example "EIN" */
5047
- number_type?: any;
5048
- /** @example "" */
5049
- phone?: any;
5050
- /** @example "CA" */
5051
- state?: any;
5052
- /** @example "1119 E 8th St Ste C" */
5053
- street?: any;
5054
- /** @example "304902" */
5055
- tracking_number?: any;
5056
- /** @example "90021" */
5057
- zip?: any;
5058
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5046
+ currencyList(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5059
5047
  /**
5060
- * @tags Blacklist Admin Businesses
5061
- * @name GetBusinessById
5062
- * @summary Get Business by ID
5063
- * @request GET:/v1/admin/businesses/{id}
5048
+ * @tags Miscellaneous
5049
+ * @name TradableCurrencyList
5050
+ * @summary Tradable currency list
5051
+ * @request GET:/general/tradable-currencies
5064
5052
  * @secure
5065
5053
  */
5066
- getBusinessById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5054
+ tradableCurrencyList(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5067
5055
  /**
5068
- * @tags Blacklist Admin Businesses
5069
- * @name UpdateBusiness
5070
- * @summary Update Business
5071
- * @request PUT:/v1/admin/businesses/{id}
5072
- * @secure
5073
- */
5074
- updateBusiness(id: string, data: {
5075
- /** @example "Gracia Marina" */
5076
- business_name?: any;
5077
- /** @example "Los Angeles" */
5078
- city?: any;
5079
- /** @example "US" */
5080
- country?: any;
5081
- /** @example "La Granja Del Camaron" */
5082
- dba_name?: any;
5083
- /** @example "" */
5084
- incorporated?: any;
5085
- /** @example "812748955" */
5086
- number?: any;
5087
- /** @example "EIN" */
5088
- number_type?: any;
5089
- /** @example "" */
5090
- phone?: any;
5091
- /** @example "CA" */
5092
- state?: any;
5093
- /** @example "1119 E 8th St Ste C" */
5094
- street?: any;
5095
- /** @example "304902" */
5096
- tracking_number?: any;
5097
- /** @example "90021" */
5098
- zip?: any;
5099
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5056
+ * @tags Miscellaneous
5057
+ * @name OptionStrategyTypes
5058
+ * @summary Option Strategy Types
5059
+ * @request GET:/general/options/strategyTypes
5060
+ * @secure
5061
+ */
5062
+ optionStrategyTypes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5100
5063
  /**
5101
- * @tags Blacklist Admin Businesses
5102
- * @name DeleteBusiness
5103
- * @summary Delete Business
5104
- * @request DELETE:/v1/admin/businesses/{id}
5064
+ * @tags Miscellaneous
5065
+ * @name OptionStrategyClassifications
5066
+ * @summary Option Strategy Classifications
5067
+ * @request GET:/general/options/strategyClassifications
5105
5068
  * @secure
5106
5069
  */
5107
- deleteBusiness(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5070
+ optionStrategyClassifications(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5108
5071
  }
5109
- export class AdvisoryGroups<HandleError extends boolean = boolean> {
5072
+ export class Branch<HandleError extends boolean = boolean> {
5110
5073
  protected readonly apiClient: JwtClient<HandleError>;
5111
5074
  constructor(apiClient: JwtClient<HandleError>);
5112
5075
  /**
5113
- * @tags Advisory Groups
5114
- * @name GroupsManage
5115
- * @request POST:/v1/groups/manage/{action}
5076
+ * @tags Branch
5077
+ * @name BranchRtb
5078
+ * @request GET:/v1/branch/rtb
5116
5079
  * @secure
5117
5080
  */
5118
- groupsManage(action: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5081
+ branchRtb(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5119
5082
  /**
5120
- * @tags Advisory Groups
5121
- * @name GroupsList
5122
- * @request GET:/v1/groups/list
5083
+ * @tags Branch
5084
+ * @name BranchRtbs
5085
+ * @request GET:/v1/branch/rtbs
5123
5086
  * @secure
5124
5087
  */
5125
- groupsList(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5088
+ branchRtbs(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5126
5089
  /**
5127
- * @tags Advisory Groups
5128
- * @name GroupAccountsStats
5129
- * @request GET:/v2/advisory/group/accounts/stats/{groupsId}
5090
+ * @tags Branch
5091
+ * @name BranchInventory
5092
+ * @request GET:/v1/branch/inventory
5130
5093
  * @secure
5131
5094
  */
5132
- groupAccountsStats(groupsId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5095
+ branchInventory(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5133
5096
  /**
5134
- * @tags Advisory Groups
5135
- * @name GroupPortfolios
5136
- * @request GET:/v2/advisory/group/portfolios/{groupId}
5097
+ * @tags Branch
5098
+ * @name BranchRtbsTotal
5099
+ * @request GET:/v1/branch/rtbs/total
5137
5100
  * @secure
5138
5101
  */
5139
- groupPortfolios(groupId: string, query?: {
5102
+ branchRtbsTotal(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5103
+ /**
5104
+ * @tags Branch
5105
+ * @name BranchPortfolio
5106
+ * @request GET:/v1/branch/portfolio
5107
+ * @secure
5108
+ */
5109
+ branchPortfolio(query?: {
5140
5110
  /**
5141
- * Should load quotes or not.
5111
+ * (true or false) Allows for loading of quotes for each portfolio entry. Defaults to false.
5142
5112
  * @example "false"
5143
5113
  */
5144
5114
  loadQuotes?: any;
5145
- /**
5146
- * Whether to return combined portfolio (no accounts, with approximate prices)
5147
- * @example "false"
5148
- */
5149
- combined?: any;
5150
5115
  /** @example "false" */
5151
5116
  loadIndustries?: any;
5152
5117
  /** @example "false" */
@@ -5154,147 +5119,259 @@ export class AdvisoryGroups<HandleError extends boolean = boolean> {
5154
5119
  /** @example "false" */
5155
5120
  loadEarnings?: any;
5156
5121
  /**
5157
- * Whether or not to include orders comprising each position's cost
5122
+ * Load balances for weight
5158
5123
  * @example "false"
5159
5124
  */
5160
- loadCost?: any;
5125
+ loadRtb?: any;
5161
5126
  /**
5162
5127
  * Analyze market caps and get `marketCapWeights`. To be used in conjuction with `loadQuotes`
5163
5128
  * @example "false"
5164
5129
  */
5165
- marketCapWeights?: any;
5130
+ marketCapBreakdown?: any;
5131
+ /**
5132
+ * Combined portfolio for the branch
5133
+ * @example "false"
5134
+ */
5135
+ combined?: any;
5166
5136
  /** @example "1" */
5167
5137
  pageNum?: any;
5168
5138
  /** @example "100" */
5169
5139
  pageSize?: any;
5170
5140
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5171
5141
  /**
5172
- * @tags Advisory Groups
5173
- * @name GroupRtb
5174
- * @request GET:/v2/advisory/group/rtb/{groupId}
5142
+ * @tags Branch
5143
+ * @name OptionExpirations
5144
+ * @summary Option expirations
5145
+ * @request GET:/v1/branch/portfolio/options/upcoming
5175
5146
  * @secure
5176
5147
  */
5177
- groupRtb(groupId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5148
+ optionExpirations(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5178
5149
  /**
5179
- * @tags Advisory Groups
5180
- * @name GroupRtbs
5181
- * @request GET:/v2/advisory/group/rtbs/{groupId}
5150
+ * @tags Branch
5151
+ * @name OptionExpirationsDetails
5152
+ * @summary Option expirations details
5153
+ * @request POST:/v1/branch/portfolio/options/upcoming/details
5182
5154
  * @secure
5183
5155
  */
5184
- groupRtbs(groupId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5156
+ optionExpirationsDetails(data: {
5157
+ /** @example "true|false" */
5158
+ loadQuotes?: any;
5159
+ /** @example "01/15/2021 00:00:00 EST" */
5160
+ maturity?: any;
5161
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5185
5162
  }
5186
- export class AdvisoryUserAccountManagement<HandleError extends boolean = boolean> {
5163
+ export class LegalDocuments<HandleError extends boolean = boolean> {
5187
5164
  protected readonly apiClient: JwtClient<HandleError>;
5188
5165
  constructor(apiClient: JwtClient<HandleError>);
5189
5166
  /**
5190
- * @tags Advisory User Account Management
5191
- * @name List
5192
- * @summary /list
5193
- * @request GET:/v2/advisory/users/list
5167
+ * @tags Legal Documents
5168
+ * @name DocumentClassifications
5169
+ * @summary Document classifications
5170
+ * @request GET:/user/legal/classifications
5194
5171
  * @secure
5195
5172
  */
5196
- list(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5173
+ documentClassifications(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5197
5174
  /**
5198
- * @tags Advisory User Account Management
5199
- * @name Accounts
5200
- * @summary /accounts
5201
- * @request GET:/v2/advisory/users/accounts
5175
+ * @tags Legal Documents
5176
+ * @name DocumentListing
5177
+ * @summary Document listing
5178
+ * @request GET:/user/legal/documents
5202
5179
  * @secure
5203
5180
  */
5204
- accounts(query?: {
5205
- /** @example "1234" */
5206
- uid?: any;
5181
+ documentListing(query?: {
5207
5182
  /**
5208
- * true|false
5209
- * @example "false"
5183
+ * {optional}
5184
+ * @example "TermsOfUse"
5210
5185
  */
5211
- loadRtb?: any;
5186
+ classification?: any;
5212
5187
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5213
5188
  /**
5214
- * @tags Advisory User Account Management
5215
- * @name AccountsStats
5216
- * @summary /accounts/stats
5217
- * @request GET:/v2/advisory/users/accounts/stats
5189
+ * @tags Legal Documents
5190
+ * @name PolicyValues
5191
+ * @summary Policy values
5192
+ * @request GET:/user/legal/policies/listing/{type}
5218
5193
  * @secure
5219
5194
  */
5220
- accountsStats(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5195
+ policyValues(type: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5221
5196
  /**
5222
- * @tags Advisory User Account Management
5223
- * @name AccountNotes
5224
- * @summary /account/notes
5225
- * @request GET:/v2/advisory/users/account/notes
5197
+ * @tags Legal Documents
5198
+ * @name DocumentContent
5199
+ * @summary Document content
5200
+ * @request GET:/user/legal/document/content
5226
5201
  * @secure
5227
5202
  */
5228
- accountNotes(query?: {
5229
- /**
5230
- * Account's ID
5231
- * @example "1234"
5232
- */
5233
- aid?: any;
5203
+ documentContent(query?: {
5204
+ /** @example "{as provided}" */
5205
+ id?: any;
5234
5206
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5235
5207
  /**
5236
- * @tags Advisory User Account Management
5237
- * @name Notes
5238
- * @summary /notes
5239
- * @request GET:/v2/advisory/users/notes
5208
+ * @tags Legal Documents
5209
+ * @name DocumentDownload
5210
+ * @summary Document download
5211
+ * @request GET:/user/legal/document/download
5240
5212
  * @secure
5241
5213
  */
5242
- notes(query?: {
5214
+ documentDownload(query?: {
5215
+ /** @example "{as provided}" */
5216
+ id?: any;
5217
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5218
+ /**
5219
+ * @tags Legal Documents
5220
+ * @name SignTheDocument
5221
+ * @summary Sign the document
5222
+ * @request POST:/user/legal/document/sign
5223
+ * @secure
5224
+ */
5225
+ signTheDocument(data: {
5226
+ account?: {
5227
+ /** @example 1234 */
5228
+ accountId?: number;
5229
+ /** @example "AC123456" */
5230
+ accountNumber?: string;
5231
+ };
5232
+ data?: {
5233
+ /** @example "{conditional}" */
5234
+ bankAccountNumber?: string;
5235
+ };
5236
+ /** @example "{required}" */
5237
+ documentId?: any;
5238
+ /** @example true */
5239
+ esigned?: any;
5240
+ /** @example "" */
5241
+ remoteAddr?: any;
5242
+ /** @example "{required}" */
5243
+ remoteDevice?: any;
5244
+ /** @example "{required}" */
5245
+ signature?: any;
5246
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5247
+ /**
5248
+ * @tags Legal Documents
5249
+ * @name UpdatesPolicyOnTheAccount
5250
+ * @summary Updates policy on the account
5251
+ * @request POST:/user/legal/policy/{type}
5252
+ * @secure
5253
+ */
5254
+ updatesPolicyOnTheAccount(type: string, data: {
5255
+ account?: {
5256
+ /** @example 0 */
5257
+ accountId?: number;
5258
+ /** @example "{optional}" */
5259
+ accountNumber?: string;
5260
+ };
5261
+ /** @example true */
5262
+ esigned?: any;
5263
+ /** @example "Allow" */
5264
+ policy?: any;
5265
+ /** @example "" */
5266
+ remoteAddr?: any;
5267
+ /** @example "" */
5268
+ remoteDevice?: any;
5269
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5270
+ }
5271
+ export class BlacklistAdminBusinesses<HandleError extends boolean = boolean> {
5272
+ protected readonly apiClient: JwtClient<HandleError>;
5273
+ constructor(apiClient: JwtClient<HandleError>);
5274
+ /**
5275
+ * @tags Blacklist Admin Businesses
5276
+ * @name GetBusinessesList
5277
+ * @summary Get Businesses list
5278
+ * @request GET:/v1/admin/businesses
5279
+ * @secure
5280
+ */
5281
+ getBusinessesList(query?: {
5243
5282
  /**
5244
- * User's ID
5245
- * @example "1234"
5283
+ * (Required) page number
5284
+ * @example "5567183"
5246
5285
  */
5247
- uid?: any;
5286
+ page?: any;
5287
+ /**
5288
+ * (Required) page size in records displayed
5289
+ * @example "5567183"
5290
+ */
5291
+ page_size?: any;
5292
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5293
+ /**
5294
+ * @tags Blacklist Admin Businesses
5295
+ * @name CreateBusiness
5296
+ * @summary Create Business
5297
+ * @request POST:/v1/admin/businesses
5298
+ * @secure
5299
+ */
5300
+ createBusiness(data: {
5301
+ /** @example "Gracia Marina" */
5302
+ business_name?: any;
5303
+ /** @example "Los Angeles" */
5304
+ city?: any;
5305
+ /** @example "US" */
5306
+ country?: any;
5307
+ /** @example "La Granja Del Camaron" */
5308
+ dba_name?: any;
5309
+ /** @example "" */
5310
+ incorporated?: any;
5311
+ /** @example "812748955" */
5312
+ number?: any;
5313
+ /** @example "EIN" */
5314
+ number_type?: any;
5315
+ /** @example "" */
5316
+ phone?: any;
5317
+ /** @example "CA" */
5318
+ state?: any;
5319
+ /** @example "1119 E 8th St Ste C" */
5320
+ street?: any;
5321
+ /** @example "304902" */
5322
+ tracking_number?: any;
5323
+ /** @example "90021" */
5324
+ zip?: any;
5248
5325
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5249
5326
  /**
5250
- * @tags Advisory User Account Management
5251
- * @name NotesPost
5252
- * @request POST:/v2/advisory/users/notes/{action}
5327
+ * @tags Blacklist Admin Businesses
5328
+ * @name GetBusinessById
5329
+ * @summary Get Business by ID
5330
+ * @request GET:/v1/admin/businesses/{id}
5253
5331
  * @secure
5254
5332
  */
5255
- notesPost(action: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5256
- }
5257
- export class BlacklistSearch<HandleError extends boolean = boolean> {
5258
- protected readonly apiClient: JwtClient<HandleError>;
5259
- constructor(apiClient: JwtClient<HandleError>);
5333
+ getBusinessById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5260
5334
  /**
5261
- * @tags Blacklist Search
5262
- * @name SearchBusiness
5263
- * @summary Search Business
5264
- * @request POST:/v1/businesses/search
5335
+ * @tags Blacklist Admin Businesses
5336
+ * @name UpdateBusiness
5337
+ * @summary Update Business
5338
+ * @request PUT:/v1/admin/businesses/{id}
5265
5339
  * @secure
5266
5340
  */
5267
- searchBusiness(data: {
5268
- /** @example [{"distance":0,"name":"business_name","value":"Gracia Marina"},{"distance":2,"name":"dba_name","value":"La Granja Del Camar"}] */
5269
- filters?: any;
5270
- /** @example "AND" */
5271
- match_type?: any;
5272
- pagination?: {
5273
- /** @example 1 */
5274
- page?: number;
5275
- /** @example 20 */
5276
- page_size?: number;
5277
- };
5341
+ updateBusiness(id: string, data: {
5342
+ /** @example "Gracia Marina" */
5343
+ business_name?: any;
5344
+ /** @example "Los Angeles" */
5345
+ city?: any;
5346
+ /** @example "US" */
5347
+ country?: any;
5348
+ /** @example "La Granja Del Camaron" */
5349
+ dba_name?: any;
5350
+ /** @example "" */
5351
+ incorporated?: any;
5352
+ /** @example "812748955" */
5353
+ number?: any;
5354
+ /** @example "EIN" */
5355
+ number_type?: any;
5356
+ /** @example "" */
5357
+ phone?: any;
5358
+ /** @example "CA" */
5359
+ state?: any;
5360
+ /** @example "1119 E 8th St Ste C" */
5361
+ street?: any;
5362
+ /** @example "304902" */
5363
+ tracking_number?: any;
5364
+ /** @example "90021" */
5365
+ zip?: any;
5278
5366
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5279
5367
  /**
5280
- * @tags Blacklist Search
5281
- * @name SearchIndividual
5282
- * @summary Search Individual
5283
- * @request POST:/v1/individuals/search
5368
+ * @tags Blacklist Admin Businesses
5369
+ * @name DeleteBusiness
5370
+ * @summary Delete Business
5371
+ * @request DELETE:/v1/admin/businesses/{id}
5284
5372
  * @secure
5285
5373
  */
5286
- searchIndividual(data: {
5287
- /** @example [{"distance":2,"name":"first_name","value":"Hyodan"},{"distance":0,"name":"alias_middle_name","value":"Hyodon"}] */
5288
- filters?: any;
5289
- /** @example "OR" */
5290
- match_type?: any;
5291
- pagination?: {
5292
- /** @example 1 */
5293
- page?: number;
5294
- /** @example 20 */
5295
- page_size?: number;
5296
- };
5297
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5374
+ deleteBusiness(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5298
5375
  }
5299
5376
  export class BlacklistAdminIndividuals<HandleError extends boolean = boolean> {
5300
5377
  protected readonly apiClient: JwtClient<HandleError>;
@@ -5425,6 +5502,48 @@ export class BlacklistAdminIndividuals<HandleError extends boolean = boolean> {
5425
5502
  */
5426
5503
  deleteIndividual(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5427
5504
  }
5505
+ export class BlacklistSearch<HandleError extends boolean = boolean> {
5506
+ protected readonly apiClient: JwtClient<HandleError>;
5507
+ constructor(apiClient: JwtClient<HandleError>);
5508
+ /**
5509
+ * @tags Blacklist Search
5510
+ * @name SearchBusiness
5511
+ * @summary Search Business
5512
+ * @request POST:/v1/businesses/search
5513
+ * @secure
5514
+ */
5515
+ searchBusiness(data: {
5516
+ /** @example [{"distance":0,"name":"business_name","value":"Gracia Marina"},{"distance":2,"name":"dba_name","value":"La Granja Del Camar"}] */
5517
+ filters?: any;
5518
+ /** @example "AND" */
5519
+ match_type?: any;
5520
+ pagination?: {
5521
+ /** @example 1 */
5522
+ page?: number;
5523
+ /** @example 20 */
5524
+ page_size?: number;
5525
+ };
5526
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5527
+ /**
5528
+ * @tags Blacklist Search
5529
+ * @name SearchIndividual
5530
+ * @summary Search Individual
5531
+ * @request POST:/v1/individuals/search
5532
+ * @secure
5533
+ */
5534
+ searchIndividual(data: {
5535
+ /** @example [{"distance":2,"name":"first_name","value":"Hyodan"},{"distance":0,"name":"alias_middle_name","value":"Hyodon"}] */
5536
+ filters?: any;
5537
+ /** @example "OR" */
5538
+ match_type?: any;
5539
+ pagination?: {
5540
+ /** @example 1 */
5541
+ page?: number;
5542
+ /** @example 20 */
5543
+ page_size?: number;
5544
+ };
5545
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5546
+ }
5428
5547
  export class Blacklist<HandleError extends boolean = boolean> {
5429
5548
  protected readonly apiClient: JwtClient<HandleError>;
5430
5549
  adminBusinesses: BlacklistAdminBusinesses<HandleError>;
@@ -5492,148 +5611,27 @@ export class Broker<HandleError extends boolean = boolean> {
5492
5611
  */
5493
5612
  combined?: any;
5494
5613
  /** @example "1" */
5495
- pageNum?: any;
5496
- /** @example "100" */
5497
- pageSize?: any;
5498
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5499
- }
5500
- export class WatchmenFfiUserAccountManagement<HandleError extends boolean = boolean> {
5501
- protected readonly apiClient: JwtClient<HandleError>;
5502
- constructor(apiClient: JwtClient<HandleError>);
5503
- /**
5504
- * @tags Watchmen Ffi User Account Management
5505
- * @name CreateUser
5506
- * @summary Create User
5507
- * @request POST:/rest/v1/uam/user/create
5508
- * @secure
5509
- */
5510
- createUser(data: {
5511
- /** @example "{optional} enable|disable - whether or not enable user for TipRanks" */
5512
- Tipranks?: any;
5513
- /** @example "{optional} true|false - defaults to false" */
5514
- algos?: any;
5515
- /** @example "{optional} true|false - defaults to false" */
5516
- allSession?: any;
5517
- /** @example "{optional} Full Name" */
5518
- associatedName?: any;
5519
- /** @example "{optional} true|false - defaults to false" */
5520
- buyWrite?: any;
5521
- /** @example "{optional} e-mail address" */
5522
- email?: any;
5523
- /** @example "{optional} true|false - defaults to true" */
5524
- isTradingEnabled?: any;
5525
- /** @example "{optional} Limit On Close - true|false - defaults to false" */
5526
- loc?: any;
5527
- /** @example "{optional} true|false - whether user is locked" */
5528
- locked?: any;
5529
- /** @example "{optional} Limit On Open - true|false - defaults to false" */
5530
- loo?: any;
5531
- /** @example "{optional} Market On Open - true|false - defaults to false" */
5532
- moc?: any;
5533
- /** @example "{optional} Market On Close - true|false - defaults to false" */
5534
- moo?: any;
5535
- /** @example "{optional} One Cancels Other - true|false - defaults to false" */
5536
- oco?: any;
5537
- /** @example "{optional} true|false - defaults to false" */
5538
- optionRoll?: any;
5539
- /** @example "{optional} true|false - defaults to false" */
5540
- options?: any;
5541
- /** @example "{optional}" */
5542
- password?: any;
5543
- /** @example "{optional} true|false - defaults to false" */
5544
- prePostTrading?: any;
5545
- /** @example "{optional} 1 - delayed, 0 - realtime, 4 - CBOE1, 3 - BATS" */
5546
- quoteType?: any;
5547
- /** @example "{optional} true|false - defaults to false" */
5548
- spreads?: any;
5549
- /** @example "A - active, S - suspended == initial user status" */
5550
- status?: any;
5551
- /** @example "{optional} true|false - defaults to false" */
5552
- trailingStops?: any;
5553
- /** @example "UNIQUE_USERNAME" */
5554
- username?: any;
5555
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5556
- /**
5557
- * @tags Watchmen Ffi User Account Management
5558
- * @name CreateAccount
5559
- * @summary Create Account
5560
- * @request POST:/rest/v1/uam/account/create
5561
- * @secure
5562
- */
5563
- createAccount(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5564
- /**
5565
- * @tags Watchmen Ffi User Account Management
5566
- * @name AccountInformation
5567
- * @summary Account Information
5568
- * @request GET:/rest/v1/uam/account/data
5569
- * @secure
5570
- */
5571
- accountInformation(query?: {
5572
- /** @example "AC123456" */
5573
- accountNumber?: any;
5574
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5575
- /**
5576
- * @tags Watchmen Ffi User Account Management
5577
- * @name UserInformation
5578
- * @summary User Information
5579
- * @request GET:/rest/v1/uam/user/data
5580
- * @secure
5581
- */
5582
- userInformation(query?: {
5583
- /** @example "USERNAME" */
5584
- username?: any;
5585
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5586
- /**
5587
- * @tags Watchmen Ffi User Account Management
5588
- * @name ListLinkedAccounts
5589
- * @summary List Linked Accounts
5590
- * @request GET:/rest/v1/linkedaccounts/listAccounts
5591
- * @secure
5592
- */
5593
- listLinkedAccounts(query?: {
5594
- /** @example "TEST.USER" */
5595
- username?: any;
5596
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5597
- /**
5598
- * @tags Watchmen Ffi User Account Management
5599
- * @name LinkUnlinkAccount
5600
- * @summary Link/Unlink Account
5601
- * @request POST:/rest/v1/linkedaccounts/linkUnlinkAccount
5602
- * @secure
5603
- */
5604
- linkUnlinkAccount(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5605
- /**
5606
- * @tags Watchmen Ffi User Account Management
5607
- * @name Visibility
5608
- * @summary Visibility
5609
- * @request POST:/rest/v1/linkedaccounts/visibility
5610
- * @secure
5611
- */
5612
- visibility(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5614
+ pageNum?: any;
5615
+ /** @example "100" */
5616
+ pageSize?: any;
5617
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5613
5618
  /**
5614
- * @tags Watchmen Ffi User Account Management
5615
- * @name UserAccountSearch
5616
- * @summary User/Account Search
5617
- * @request POST:/rest/v1/uam/user-account-search
5619
+ * @tags Broker
5620
+ * @name Orders
5621
+ * @summary Orders
5622
+ * @request GET:/orders/broker/{type}
5618
5623
  * @secure
5619
5624
  */
5620
- userAccountSearch(data: {
5621
- /** @example "desired account number" */
5622
- accountNumber?: any;
5623
- /** @example 100 */
5624
- limit?: any;
5625
- /** @example 0 */
5626
- lockedBit?: any;
5627
- /** @example "desired username" */
5628
- login?: any;
5629
- /** @example false */
5630
- noBrokers?: any;
5631
- /** @example "" */
5632
- omnibus?: any;
5633
- /** @example false */
5634
- onlyActiveAccount?: any;
5635
- /** @example false */
5636
- onlyActiveUser?: any;
5625
+ orders(type: string, query?: {
5626
+ /**
5627
+ * `true|false` (optional)
5628
+ * @example "false"
5629
+ */
5630
+ loadQuotes?: any;
5631
+ /** @example "Decimal" */
5632
+ bondPriceType?: any;
5633
+ /** @example "Par" */
5634
+ bondQuantityType?: any;
5637
5635
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5638
5636
  }
5639
5637
  export class WatchmenFfiFirmBranch<HandleError extends boolean = boolean> {
@@ -5811,130 +5809,161 @@ export class WatchmenFfiFirmBranch<HandleError extends boolean = boolean> {
5811
5809
  id?: any;
5812
5810
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5813
5811
  }
5814
- export class Advisory<HandleError extends boolean = boolean> {
5815
- protected readonly apiClient: JwtClient<HandleError>;
5816
- charges: AdvisoryCharges<HandleError>;
5817
- models: AdvisoryModels<HandleError>;
5818
- userAccountManagement: AdvisoryUserAccountManagement<HandleError>;
5819
- groups: AdvisoryGroups<HandleError>;
5820
- analytics: AdvisoryAnalytics<HandleError>;
5821
- allocations: AdvisoryAllocations<HandleError>;
5822
- constructor(apiClient: JwtClient<HandleError>);
5823
- }
5824
- export class WatchmenFfi<HandleError extends boolean = boolean> {
5825
- protected readonly apiClient: JwtClient<HandleError>;
5826
- userAccountManagement: WatchmenFfiUserAccountManagement<HandleError>;
5827
- firmBranch: WatchmenFfiFirmBranch<HandleError>;
5828
- constructor(apiClient: JwtClient<HandleError>);
5829
- }
5830
- export class LegalDocuments<HandleError extends boolean = boolean> {
5812
+ export class WatchmenFfiUserAccountManagement<HandleError extends boolean = boolean> {
5831
5813
  protected readonly apiClient: JwtClient<HandleError>;
5832
5814
  constructor(apiClient: JwtClient<HandleError>);
5833
5815
  /**
5834
- * @tags Legal Documents
5835
- * @name DocumentClassifications
5836
- * @summary Document classifications
5837
- * @request GET:/user/legal/classifications
5816
+ * @tags Watchmen Ffi User Account Management
5817
+ * @name CreateUser
5818
+ * @summary Create User
5819
+ * @request POST:/rest/v1/uam/user/create
5838
5820
  * @secure
5839
5821
  */
5840
- documentClassifications(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5822
+ createUser(data: {
5823
+ /** @example "{optional} enable|disable - whether or not enable user for TipRanks" */
5824
+ Tipranks?: any;
5825
+ /** @example "{optional} true|false - defaults to false" */
5826
+ algos?: any;
5827
+ /** @example "{optional} true|false - defaults to false" */
5828
+ allSession?: any;
5829
+ /** @example "{optional} Full Name" */
5830
+ associatedName?: any;
5831
+ /** @example "{optional} true|false - defaults to false" */
5832
+ buyWrite?: any;
5833
+ /** @example "{optional} e-mail address" */
5834
+ email?: any;
5835
+ /** @example "{optional} true|false - defaults to true" */
5836
+ isTradingEnabled?: any;
5837
+ /** @example "{optional} Limit On Close - true|false - defaults to false" */
5838
+ loc?: any;
5839
+ /** @example "{optional} true|false - whether user is locked" */
5840
+ locked?: any;
5841
+ /** @example "{optional} Limit On Open - true|false - defaults to false" */
5842
+ loo?: any;
5843
+ /** @example "{optional} Market On Open - true|false - defaults to false" */
5844
+ moc?: any;
5845
+ /** @example "{optional} Market On Close - true|false - defaults to false" */
5846
+ moo?: any;
5847
+ /** @example "{optional} One Cancels Other - true|false - defaults to false" */
5848
+ oco?: any;
5849
+ /** @example "{optional} true|false - defaults to false" */
5850
+ optionRoll?: any;
5851
+ /** @example "{optional} true|false - defaults to false" */
5852
+ options?: any;
5853
+ /** @example "{optional}" */
5854
+ password?: any;
5855
+ /** @example "{optional} true|false - defaults to false" */
5856
+ prePostTrading?: any;
5857
+ /** @example "{optional} 1 - delayed, 0 - realtime, 4 - CBOE1, 3 - BATS" */
5858
+ quoteType?: any;
5859
+ /** @example "{optional} true|false - defaults to false" */
5860
+ spreads?: any;
5861
+ /** @example "A - active, S - suspended == initial user status" */
5862
+ status?: any;
5863
+ /** @example "{optional} true|false - defaults to false" */
5864
+ trailingStops?: any;
5865
+ /** @example "UNIQUE_USERNAME" */
5866
+ username?: any;
5867
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5841
5868
  /**
5842
- * @tags Legal Documents
5843
- * @name DocumentListing
5844
- * @summary Document listing
5845
- * @request GET:/user/legal/documents
5869
+ * @tags Watchmen Ffi User Account Management
5870
+ * @name CreateAccount
5871
+ * @summary Create Account
5872
+ * @request POST:/rest/v1/uam/account/create
5846
5873
  * @secure
5847
5874
  */
5848
- documentListing(query?: {
5849
- /**
5850
- * {optional}
5851
- * @example "TermsOfUse"
5852
- */
5853
- classification?: any;
5854
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5875
+ createAccount(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5855
5876
  /**
5856
- * @tags Legal Documents
5857
- * @name PolicyValues
5858
- * @summary Policy values
5859
- * @request GET:/user/legal/policies/listing/{type}
5877
+ * @tags Watchmen Ffi User Account Management
5878
+ * @name AccountInformation
5879
+ * @summary Account Information
5880
+ * @request GET:/rest/v1/uam/account/data
5860
5881
  * @secure
5861
5882
  */
5862
- policyValues(type: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5883
+ accountInformation(query?: {
5884
+ /** @example "AC123456" */
5885
+ accountNumber?: any;
5886
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5863
5887
  /**
5864
- * @tags Legal Documents
5865
- * @name DocumentContent
5866
- * @summary Document content
5867
- * @request GET:/user/legal/document/content
5888
+ * @tags Watchmen Ffi User Account Management
5889
+ * @name UserInformation
5890
+ * @summary User Information
5891
+ * @request GET:/rest/v1/uam/user/data
5868
5892
  * @secure
5869
5893
  */
5870
- documentContent(query?: {
5871
- /** @example "{as provided}" */
5872
- id?: any;
5894
+ userInformation(query?: {
5895
+ /** @example "USERNAME" */
5896
+ username?: any;
5873
5897
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5874
5898
  /**
5875
- * @tags Legal Documents
5876
- * @name DocumentDownload
5877
- * @summary Document download
5878
- * @request GET:/user/legal/document/download
5899
+ * @tags Watchmen Ffi User Account Management
5900
+ * @name ListLinkedAccounts
5901
+ * @summary List Linked Accounts
5902
+ * @request GET:/rest/v1/linkedaccounts/listAccounts
5879
5903
  * @secure
5880
5904
  */
5881
- documentDownload(query?: {
5882
- /** @example "{as provided}" */
5883
- id?: any;
5905
+ listLinkedAccounts(query?: {
5906
+ /** @example "TEST.USER" */
5907
+ username?: any;
5884
5908
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5885
5909
  /**
5886
- * @tags Legal Documents
5887
- * @name SignTheDocument
5888
- * @summary Sign the document
5889
- * @request POST:/user/legal/document/sign
5910
+ * @tags Watchmen Ffi User Account Management
5911
+ * @name LinkUnlinkAccount
5912
+ * @summary Link/Unlink Account
5913
+ * @request POST:/rest/v1/linkedaccounts/linkUnlinkAccount
5890
5914
  * @secure
5891
5915
  */
5892
- signTheDocument(data: {
5893
- account?: {
5894
- /** @example 1234 */
5895
- accountId?: number;
5896
- /** @example "AC123456" */
5897
- accountNumber?: string;
5898
- };
5899
- data?: {
5900
- /** @example "{conditional}" */
5901
- bankAccountNumber?: string;
5902
- };
5903
- /** @example "{required}" */
5904
- documentId?: any;
5905
- /** @example true */
5906
- esigned?: any;
5907
- /** @example "" */
5908
- remoteAddr?: any;
5909
- /** @example "{required}" */
5910
- remoteDevice?: any;
5911
- /** @example "{required}" */
5912
- signature?: any;
5913
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5916
+ linkUnlinkAccount(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5914
5917
  /**
5915
- * @tags Legal Documents
5916
- * @name UpdatesPolicyOnTheAccount
5917
- * @summary Updates policy on the account
5918
- * @request POST:/user/legal/policy/{type}
5918
+ * @tags Watchmen Ffi User Account Management
5919
+ * @name Visibility
5920
+ * @summary Visibility
5921
+ * @request POST:/rest/v1/linkedaccounts/visibility
5919
5922
  * @secure
5920
5923
  */
5921
- updatesPolicyOnTheAccount(type: string, data: {
5922
- account?: {
5923
- /** @example 0 */
5924
- accountId?: number;
5925
- /** @example "{optional}" */
5926
- accountNumber?: string;
5927
- };
5928
- /** @example true */
5929
- esigned?: any;
5930
- /** @example "Allow" */
5931
- policy?: any;
5932
- /** @example "" */
5933
- remoteAddr?: any;
5924
+ visibility(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5925
+ /**
5926
+ * @tags Watchmen Ffi User Account Management
5927
+ * @name UserAccountSearch
5928
+ * @summary User/Account Search
5929
+ * @request POST:/rest/v1/uam/user-account-search
5930
+ * @secure
5931
+ */
5932
+ userAccountSearch(data: {
5933
+ /** @example "desired account number" */
5934
+ accountNumber?: any;
5935
+ /** @example 100 */
5936
+ limit?: any;
5937
+ /** @example 0 */
5938
+ lockedBit?: any;
5939
+ /** @example "desired username" */
5940
+ login?: any;
5941
+ /** @example false */
5942
+ noBrokers?: any;
5934
5943
  /** @example "" */
5935
- remoteDevice?: any;
5944
+ omnibus?: any;
5945
+ /** @example false */
5946
+ onlyActiveAccount?: any;
5947
+ /** @example false */
5948
+ onlyActiveUser?: any;
5936
5949
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5937
5950
  }
5951
+ export class Advisory<HandleError extends boolean = boolean> {
5952
+ protected readonly apiClient: JwtClient<HandleError>;
5953
+ charges: AdvisoryCharges<HandleError>;
5954
+ models: AdvisoryModels<HandleError>;
5955
+ userAccountManagement: AdvisoryUserAccountManagement<HandleError>;
5956
+ groups: AdvisoryGroups<HandleError>;
5957
+ analytics: AdvisoryAnalytics<HandleError>;
5958
+ allocations: AdvisoryAllocations<HandleError>;
5959
+ constructor(apiClient: JwtClient<HandleError>);
5960
+ }
5961
+ export class WatchmenFfi<HandleError extends boolean = boolean> {
5962
+ protected readonly apiClient: JwtClient<HandleError>;
5963
+ userAccountManagement: WatchmenFfiUserAccountManagement<HandleError>;
5964
+ firmBranch: WatchmenFfiFirmBranch<HandleError>;
5965
+ constructor(apiClient: JwtClient<HandleError>);
5966
+ }
5938
5967
  export class OrbisApi<HandleError extends boolean = false> extends BaseApi<HandleError, OrbisClient<HandleError>> {
5939
5968
  readonly config: OrbisClientConfig<HandleError>;
5940
5969
  advisory: Advisory<HandleError>;