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

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.
@@ -754,43 +754,6 @@ 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
- }
794
757
  export class OrdersArchived<HandleError extends boolean = boolean> {
795
758
  protected readonly apiClient: JwtClient<HandleError>;
796
759
  constructor(apiClient: JwtClient<HandleError>);
@@ -872,6 +835,43 @@ export class OrdersArchived<HandleError extends boolean = boolean> {
872
835
  orderRef?: string;
873
836
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
874
837
  }
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
875
  export class Orders<HandleError extends boolean = boolean> {
876
876
  protected readonly apiClient: JwtClient<HandleError>;
877
877
  violationManagement: OrdersViolationManagement<HandleError>;
@@ -998,187 +998,6 @@ export class Orders<HandleError extends boolean = boolean> {
998
998
  bondQuantityType?: any;
999
999
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1000
1000
  }
1001
- export class ResearchTipranks<HandleError extends boolean = boolean> {
1002
- protected readonly apiClient: JwtClient<HandleError>;
1003
- constructor(apiClient: JwtClient<HandleError>);
1004
- /**
1005
- * @tags Research Tipranks
1006
- * @name Livefeed
1007
- * @summary Livefeed
1008
- * @request GET:/research/tipranks/livefeed
1009
- * @secure
1010
- */
1011
- livefeed(query?: {
1012
- /**
1013
- * Amount to include. Defaults to 20.
1014
- * @example "20"
1015
- */
1016
- count?: any;
1017
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1018
- /**
1019
- * @tags Research Tipranks
1020
- * @name AnalystPortfolio
1021
- * @summary Analyst Portfolio
1022
- * @request GET:/research/tipranks/analyst/portfolio/{expertUID}
1023
- * @secure
1024
- */
1025
- analystPortfolio(expertUid: string, query?: {
1026
- /**
1027
- * Total number of entries
1028
- * @example "5"
1029
- */
1030
- count?: any;
1031
- /**
1032
- * Optional. Defaults to false
1033
- * @example "true"
1034
- */
1035
- loadQuotes?: any;
1036
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1037
- /**
1038
- * @tags Research Tipranks
1039
- * @name AnalystProfile
1040
- * @summary Analyst Profile
1041
- * @request GET:/research/tipranks/analyst/profile/{expertUID}
1042
- * @secure
1043
- */
1044
- analystProfile(expertUid: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1045
- /**
1046
- * @tags Research Tipranks
1047
- * @name TopAnalysts
1048
- * @summary Top Analysts
1049
- * @request GET:/research/tipranks/analyst/top
1050
- * @secure
1051
- */
1052
- topAnalysts(query?: {
1053
- /**
1054
- * Total entries. Defaults to 20.
1055
- * @example "25"
1056
- */
1057
- count?: any;
1058
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1059
- /**
1060
- * @tags Research Tipranks
1061
- * @name RatingsBySymbol
1062
- * @summary Ratings by Symbol
1063
- * @request GET:/research/tipranks/analyst/{symbol}
1064
- * @secure
1065
- */
1066
- ratingsBySymbol(symbol: string, query?: {
1067
- /**
1068
- * Number of analysts to include. Defaults to 20
1069
- * @example "10"
1070
- */
1071
- count?: any;
1072
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1073
- /**
1074
- * @tags Research Tipranks
1075
- * @name Insiders
1076
- * @summary Insiders
1077
- * @request GET:/research/tipranks/insiders
1078
- * @secure
1079
- */
1080
- insiders(query?: {
1081
- /**
1082
- * Comma seperated for multiple symbols
1083
- * @example "AAPL,GOOGL"
1084
- */
1085
- symbols?: any;
1086
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1087
- /**
1088
- * @tags Research Tipranks
1089
- * @name InsiderTransactions
1090
- * @summary Insider Transactions
1091
- * @request GET:/research/tipranks/insiders/transactions
1092
- * @secure
1093
- */
1094
- insiderTransactions(query?: {
1095
- /**
1096
- * Symbols (comma seperated)
1097
- * @example "FB"
1098
- */
1099
- symbols?: any;
1100
- /**
1101
- * Number of entries (defaults to 20)
1102
- * @example "10"
1103
- */
1104
- count?: any;
1105
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1106
- /**
1107
- * @tags Research Tipranks
1108
- * @name SimilarStocks
1109
- * @summary Similar Stocks
1110
- * @request GET:/research/tipranks/stocks/similar/{symbol}
1111
- * @secure
1112
- */
1113
- similarStocks(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1114
- /**
1115
- * @tags Research Tipranks
1116
- * @name Overview
1117
- * @summary Overview
1118
- * @request GET:/research/tipranks/stocks/overview/{symbols}
1119
- * @secure
1120
- */
1121
- overview(symbols: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1122
- /**
1123
- * @tags Research Tipranks
1124
- * @name ConsensusBySector
1125
- * @summary Consensus by Sector
1126
- * @request GET:/research/tipranks/consensus/sector
1127
- * @secure
1128
- */
1129
- consensusBySector(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1130
- /**
1131
- * @tags Research Tipranks
1132
- * @name ConsensusByBlogger
1133
- * @summary Consensus by Blogger
1134
- * @request GET:/research/tipranks/consensus/blogger/{symbol}
1135
- * @secure
1136
- */
1137
- consensusByBlogger(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1138
- /**
1139
- * @tags Research Tipranks
1140
- * @name Trending
1141
- * @summary Trending
1142
- * @request GET:/research/tipranks/trending
1143
- * @secure
1144
- */
1145
- trending(query?: {
1146
- /**
1147
- * Total entries. Defaults to 20.
1148
- * @example "10"
1149
- */
1150
- count?: any;
1151
- /**
1152
- * Days to go back. Can be 3, 7, or 30 only. Defaults to 7.
1153
- * @example "7"
1154
- */
1155
- period?: any;
1156
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1157
- /**
1158
- * @tags Research Tipranks
1159
- * @name Hedgefunds
1160
- * @summary Hedgefunds
1161
- * @request GET:/research/tipranks/hedgefunds/{symbol}
1162
- * @secure
1163
- */
1164
- hedgefunds(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1165
- /**
1166
- * @tags Research Tipranks
1167
- * @name StockSentiment
1168
- * @summary Stock Sentiment
1169
- * @request GET:/research/tipranks/news/sentiment/{symbol}
1170
- * @secure
1171
- */
1172
- stockSentiment(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1173
- /**
1174
- * @tags Research Tipranks
1175
- * @name BloggerRatings
1176
- * @summary Blogger Ratings
1177
- * @request GET:/research/tipranks/rating/blogger/{symbol}
1178
- * @secure
1179
- */
1180
- bloggerRatings(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1181
- }
1182
1001
  export class Quotes<HandleError extends boolean = boolean> {
1183
1002
  protected readonly apiClient: JwtClient<HandleError>;
1184
1003
  constructor(apiClient: JwtClient<HandleError>);
@@ -1466,7 +1285,188 @@ export class Quotes<HandleError extends boolean = boolean> {
1466
1285
  symbols?: any;
1467
1286
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1468
1287
  }
1469
- export class ResearchEtfs<HandleError extends boolean = boolean> {
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
+ * @example "20"
1302
+ */
1303
+ count?: any;
1304
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1305
+ /**
1306
+ * @tags Research Tipranks
1307
+ * @name AnalystPortfolio
1308
+ * @summary Analyst Portfolio
1309
+ * @request GET:/research/tipranks/analyst/portfolio/{expertUID}
1310
+ * @secure
1311
+ */
1312
+ analystPortfolio(expertUid: string, query?: {
1313
+ /**
1314
+ * Total number of entries
1315
+ * @example "5"
1316
+ */
1317
+ count?: any;
1318
+ /**
1319
+ * Optional. Defaults to false
1320
+ * @example "true"
1321
+ */
1322
+ loadQuotes?: any;
1323
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1324
+ /**
1325
+ * @tags Research Tipranks
1326
+ * @name AnalystProfile
1327
+ * @summary Analyst Profile
1328
+ * @request GET:/research/tipranks/analyst/profile/{expertUID}
1329
+ * @secure
1330
+ */
1331
+ analystProfile(expertUid: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1332
+ /**
1333
+ * @tags Research Tipranks
1334
+ * @name TopAnalysts
1335
+ * @summary Top Analysts
1336
+ * @request GET:/research/tipranks/analyst/top
1337
+ * @secure
1338
+ */
1339
+ topAnalysts(query?: {
1340
+ /**
1341
+ * Total entries. Defaults to 20.
1342
+ * @example "25"
1343
+ */
1344
+ count?: any;
1345
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1346
+ /**
1347
+ * @tags Research Tipranks
1348
+ * @name RatingsBySymbol
1349
+ * @summary Ratings by Symbol
1350
+ * @request GET:/research/tipranks/analyst/{symbol}
1351
+ * @secure
1352
+ */
1353
+ ratingsBySymbol(symbol: string, query?: {
1354
+ /**
1355
+ * Number of analysts to include. Defaults to 20
1356
+ * @example "10"
1357
+ */
1358
+ count?: any;
1359
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1360
+ /**
1361
+ * @tags Research Tipranks
1362
+ * @name Insiders
1363
+ * @summary Insiders
1364
+ * @request GET:/research/tipranks/insiders
1365
+ * @secure
1366
+ */
1367
+ insiders(query?: {
1368
+ /**
1369
+ * Comma seperated for multiple symbols
1370
+ * @example "AAPL,GOOGL"
1371
+ */
1372
+ symbols?: any;
1373
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1374
+ /**
1375
+ * @tags Research Tipranks
1376
+ * @name InsiderTransactions
1377
+ * @summary Insider Transactions
1378
+ * @request GET:/research/tipranks/insiders/transactions
1379
+ * @secure
1380
+ */
1381
+ insiderTransactions(query?: {
1382
+ /**
1383
+ * Symbols (comma seperated)
1384
+ * @example "FB"
1385
+ */
1386
+ symbols?: any;
1387
+ /**
1388
+ * Number of entries (defaults to 20)
1389
+ * @example "10"
1390
+ */
1391
+ count?: any;
1392
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1393
+ /**
1394
+ * @tags Research Tipranks
1395
+ * @name SimilarStocks
1396
+ * @summary Similar Stocks
1397
+ * @request GET:/research/tipranks/stocks/similar/{symbol}
1398
+ * @secure
1399
+ */
1400
+ similarStocks(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1401
+ /**
1402
+ * @tags Research Tipranks
1403
+ * @name Overview
1404
+ * @summary Overview
1405
+ * @request GET:/research/tipranks/stocks/overview/{symbols}
1406
+ * @secure
1407
+ */
1408
+ overview(symbols: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1409
+ /**
1410
+ * @tags Research Tipranks
1411
+ * @name ConsensusBySector
1412
+ * @summary Consensus by Sector
1413
+ * @request GET:/research/tipranks/consensus/sector
1414
+ * @secure
1415
+ */
1416
+ consensusBySector(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1417
+ /**
1418
+ * @tags Research Tipranks
1419
+ * @name ConsensusByBlogger
1420
+ * @summary Consensus by Blogger
1421
+ * @request GET:/research/tipranks/consensus/blogger/{symbol}
1422
+ * @secure
1423
+ */
1424
+ consensusByBlogger(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1425
+ /**
1426
+ * @tags Research Tipranks
1427
+ * @name Trending
1428
+ * @summary Trending
1429
+ * @request GET:/research/tipranks/trending
1430
+ * @secure
1431
+ */
1432
+ trending(query?: {
1433
+ /**
1434
+ * Total entries. Defaults to 20.
1435
+ * @example "10"
1436
+ */
1437
+ count?: any;
1438
+ /**
1439
+ * Days to go back. Can be 3, 7, or 30 only. Defaults to 7.
1440
+ * @example "7"
1441
+ */
1442
+ period?: any;
1443
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1444
+ /**
1445
+ * @tags Research Tipranks
1446
+ * @name Hedgefunds
1447
+ * @summary Hedgefunds
1448
+ * @request GET:/research/tipranks/hedgefunds/{symbol}
1449
+ * @secure
1450
+ */
1451
+ hedgefunds(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1452
+ /**
1453
+ * @tags Research Tipranks
1454
+ * @name StockSentiment
1455
+ * @summary Stock Sentiment
1456
+ * @request GET:/research/tipranks/news/sentiment/{symbol}
1457
+ * @secure
1458
+ */
1459
+ stockSentiment(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1460
+ /**
1461
+ * @tags Research Tipranks
1462
+ * @name BloggerRatings
1463
+ * @summary Blogger Ratings
1464
+ * @request GET:/research/tipranks/rating/blogger/{symbol}
1465
+ * @secure
1466
+ */
1467
+ bloggerRatings(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
1468
+ }
1469
+ export class ResearchEtfs<HandleError extends boolean = boolean> {
1470
1470
  protected readonly apiClient: JwtClient<HandleError>;
1471
1471
  constructor(apiClient: JwtClient<HandleError>);
1472
1472
  /**
@@ -2320,6 +2320,35 @@ export class UserAgreements<HandleError extends boolean = boolean> {
2320
2320
  */
2321
2321
  cryptoSign(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2322
2322
  }
2323
+ export class UserTradingLimitManagement<HandleError extends boolean = boolean> {
2324
+ protected readonly apiClient: JwtClient<HandleError>;
2325
+ constructor(apiClient: JwtClient<HandleError>);
2326
+ /**
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
+ }
2323
2352
  export class UserAttachedBanks<HandleError extends boolean = boolean> {
2324
2353
  protected readonly apiClient: JwtClient<HandleError>;
2325
2354
  constructor(apiClient: JwtClient<HandleError>);
@@ -2352,35 +2381,6 @@ export class UserAttachedBanks<HandleError extends boolean = boolean> {
2352
2381
  account?: any;
2353
2382
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2354
2383
  }
2355
- export class UserTradingLimitManagement<HandleError extends boolean = boolean> {
2356
- protected readonly apiClient: JwtClient<HandleError>;
2357
- constructor(apiClient: JwtClient<HandleError>);
2358
- /**
2359
- * @tags User Trading Limit Management
2360
- * @name Update
2361
- * @summary Update
2362
- * @request POST:/user/balance/adjust
2363
- * @secure
2364
- */
2365
- update(data: {
2366
- account?: {
2367
- /** @example "AB123456" */
2368
- accountNumber?: string;
2369
- };
2370
- /** @example 100 */
2371
- adjustment?: any;
2372
- /** @example "USD" */
2373
- currency?: any;
2374
- /** @example "something nice" */
2375
- note?: any;
2376
- /** @example "tbd" */
2377
- reason?: any;
2378
- /** @example "" */
2379
- referenceNo?: any;
2380
- /** @example "Delta|Absolute" */
2381
- type?: any;
2382
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
2383
- }
2384
2384
  export class UserProfitLoss<HandleError extends boolean = boolean> {
2385
2385
  protected readonly apiClient: JwtClient<HandleError>;
2386
2386
  constructor(apiClient: JwtClient<HandleError>);
@@ -3112,366 +3112,20 @@ 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 AdvisoryModels<HandleError extends boolean = boolean> {
3115
+ export class AdvisoryAnalytics<HandleError extends boolean = boolean> {
3116
3116
  protected readonly apiClient: JwtClient<HandleError>;
3117
3117
  constructor(apiClient: JwtClient<HandleError>);
3118
3118
  /**
3119
- * @tags Advisory Models
3120
- * @name Listing
3121
- * @summary Listing
3122
- * @request GET:/v2/advisory/models
3119
+ * @tags Advisory Analytics
3120
+ * @name OverexposureAnalysis
3121
+ * @summary Overexposure analysis
3122
+ * @request GET:/v2/advisory/analytics/overexposure/{type}/{scope}/{id}
3123
3123
  * @secure
3124
3124
  */
3125
- listing(query?: {
3125
+ overexposureAnalysis(type: string, scope: string, id: string, query?: {
3126
3126
  /**
3127
- * true|false
3128
- * @example "false"
3129
- */
3130
- loadQuotes?: any;
3131
- /**
3132
- * true|false
3133
- * @example "false"
3134
- */
3135
- loadAccounts?: any;
3136
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3137
- /**
3138
- * @tags Advisory Models
3139
- * @name ModelsByAccount
3140
- * @summary Models by account
3141
- * @request GET:/v2/advisory/modelsOfAccount
3142
- * @secure
3143
- */
3144
- modelsByAccount(query?: {
3145
- /** @example "" */
3146
- accountId?: any;
3147
- /** @example "" */
3148
- account?: any;
3149
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3150
- /**
3151
- * @tags Advisory Models
3152
- * @name ComponentTags
3153
- * @summary Component tags
3154
- * @request GET:/v2/advisory/models/components/tags
3155
- * @secure
3156
- */
3157
- componentTags(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3158
- /**
3159
- * @tags Advisory Models
3160
- * @name BuyingPower
3161
- * @summary Buying power
3162
- * @request GET:/v2/advisory/model/balance/{currency}/{modelId}
3163
- * @secure
3164
- */
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;
3188
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3189
- /**
3190
- * @tags Advisory Models
3191
- * @name Adjustments
3192
- * @summary Adjustments
3193
- * @request GET:/v2/advisory/model/adjustments/{modelId}
3194
- * @secure
3195
- */
3196
- adjustments(modelId: string, query?: {
3197
- /**
3198
- * true|false
3199
- * @example "false"
3200
- */
3201
- loadQuotes?: any;
3202
- /** Pending, Active, Complete, Rejected, Cancelled */
3203
- status?: any;
3204
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3205
- /**
3206
- * @tags Advisory Models
3207
- * @name AdjustmentPreview
3208
- * @summary Adjustment preview
3209
- * @request GET:/v2/advisory/model/adjustments/preview/{adjustmentId}
3210
- * @secure
3211
- */
3212
- adjustmentPreview(adjustmentId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3213
- /**
3214
- * @tags Advisory Models
3215
- * @name MemberAccounts
3216
- * @summary Member accounts
3217
- * @request GET:/v2/advisory/model/accounts/{modelId}
3218
- * @secure
3219
- */
3220
- memberAccounts(modelId: string, query?: {
3221
- /**
3222
- * `true`|`false` - whether or not to load account's realtime balance
3223
- * @example "false"
3224
- */
3225
- loadRtb?: any;
3226
- /**
3227
- * `true`|`false` - whether or not to load account's 3 months of balance history
3228
- * @example "false"
3229
- */
3230
- loadRtbHistory?: any;
3231
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3232
- /**
3233
- * @tags Advisory Models
3234
- * @name OrphanedAccounts
3235
- * @summary Orphaned accounts
3236
- * @request GET:/v2/advisory/model/accounts/orphaned
3237
- * @secure
3238
- */
3239
- orphanedAccounts(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3240
- /**
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 AdvisoryUserAccountManagement<HandleError extends boolean = boolean> {
3391
- protected readonly apiClient: JwtClient<HandleError>;
3392
- constructor(apiClient: JwtClient<HandleError>);
3393
- /**
3394
- * @tags Advisory User Account Management
3395
- * @name List
3396
- * @summary /list
3397
- * @request GET:/v2/advisory/users/list
3398
- * @secure
3399
- */
3400
- list(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3401
- /**
3402
- * @tags Advisory User Account Management
3403
- * @name Accounts
3404
- * @summary /accounts
3405
- * @request GET:/v2/advisory/users/accounts
3406
- * @secure
3407
- */
3408
- accounts(query?: {
3409
- /** @example "1234" */
3410
- uid?: any;
3411
- /**
3412
- * true|false
3413
- * @example "false"
3414
- */
3415
- loadRtb?: any;
3416
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3417
- /**
3418
- * @tags Advisory User Account Management
3419
- * @name AccountsStats
3420
- * @summary /accounts/stats
3421
- * @request GET:/v2/advisory/users/accounts/stats
3422
- * @secure
3423
- */
3424
- accountsStats(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3425
- /**
3426
- * @tags Advisory User Account Management
3427
- * @name AccountNotes
3428
- * @summary /account/notes
3429
- * @request GET:/v2/advisory/users/account/notes
3430
- * @secure
3431
- */
3432
- accountNotes(query?: {
3433
- /**
3434
- * Account's ID
3435
- * @example "1234"
3436
- */
3437
- aid?: any;
3438
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3439
- /**
3440
- * @tags Advisory User Account Management
3441
- * @name Notes
3442
- * @summary /notes
3443
- * @request GET:/v2/advisory/users/notes
3444
- * @secure
3445
- */
3446
- notes(query?: {
3447
- /**
3448
- * User's ID
3449
- * @example "1234"
3450
- */
3451
- uid?: any;
3452
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3453
- /**
3454
- * @tags Advisory User Account Management
3455
- * @name NotesPost
3456
- * @request POST:/v2/advisory/users/notes/{action}
3457
- * @secure
3458
- */
3459
- notesPost(action: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3460
- }
3461
- export class AdvisoryAnalytics<HandleError extends boolean = boolean> {
3462
- protected readonly apiClient: JwtClient<HandleError>;
3463
- constructor(apiClient: JwtClient<HandleError>);
3464
- /**
3465
- * @tags Advisory Analytics
3466
- * @name OverexposureAnalysis
3467
- * @summary Overexposure analysis
3468
- * @request GET:/v2/advisory/analytics/overexposure/{type}/{scope}/{id}
3469
- * @secure
3470
- */
3471
- overexposureAnalysis(type: string, scope: string, id: string, query?: {
3472
- /**
3473
- * Threshold of 70% or greater
3474
- * @example ".7"
3127
+ * Threshold of 70% or greater
3128
+ * @example ".7"
3475
3129
  */
3476
3130
  threshold?: any;
3477
3131
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
@@ -3512,58 +3166,6 @@ export class AdvisoryAnalytics<HandleError extends boolean = boolean> {
3512
3166
  threshold?: any;
3513
3167
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3514
3168
  }
3515
- export class AdvisoryAllocations<HandleError extends boolean = boolean> {
3516
- protected readonly apiClient: JwtClient<HandleError>;
3517
- constructor(apiClient: JwtClient<HandleError>);
3518
- /**
3519
- * @tags Advisory Allocations
3520
- * @name SearchNa
3521
- * @summary Search (n/a)
3522
- * @request GET:/v2/allocations/search
3523
- * @secure
3524
- */
3525
- searchNa(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3526
- /**
3527
- * @tags Advisory Allocations
3528
- * @name Details
3529
- * @summary Details
3530
- * @request GET:/v2/allocations/details/{allocationRef}
3531
- * @secure
3532
- */
3533
- details(allocationRef: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3534
- /**
3535
- * @tags Advisory Allocations
3536
- * @name Cancel
3537
- * @summary Cancel
3538
- * @request POST:/v2/allocations/cancel
3539
- * @secure
3540
- */
3541
- cancel(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3542
- /**
3543
- * @tags Advisory Allocations
3544
- * @name Validation
3545
- * @summary Validation
3546
- * @request POST:/v2/allocations/validate
3547
- * @secure
3548
- */
3549
- validation(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3550
- /**
3551
- * @tags Advisory Allocations
3552
- * @name Scheduling
3553
- * @summary Scheduling
3554
- * @request POST:/v2/allocations/preallocate
3555
- * @secure
3556
- */
3557
- scheduling(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3558
- /**
3559
- * @tags Advisory Allocations
3560
- * @name Trigger
3561
- * @summary Trigger
3562
- * @request POST:/v2/allocations/trigger
3563
- * @secure
3564
- */
3565
- trigger(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3566
- }
3567
3169
  export class Device<HandleError extends boolean = boolean> {
3568
3170
  protected readonly apiClient: JwtClient<HandleError>;
3569
3171
  constructor(apiClient: JwtClient<HandleError>);
@@ -3826,82 +3428,104 @@ export class TransfersRelationships<HandleError extends boolean = boolean> {
3826
3428
  };
3827
3429
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3828
3430
  }
3829
- export class AdvisoryGroups<HandleError extends boolean = boolean> {
3431
+ export class TransfersInstantAccountVerification<HandleError extends boolean = boolean> {
3830
3432
  protected readonly apiClient: JwtClient<HandleError>;
3831
3433
  constructor(apiClient: JwtClient<HandleError>);
3832
3434
  /**
3833
- * @tags Advisory Groups
3834
- * @name GroupsManage
3835
- * @request POST:/v1/groups/manage/{action}
3435
+ * @tags Transfers Instant Account Verification
3436
+ * @name Initiate
3437
+ * @summary Initiate
3438
+ * @request GET:/iav/init
3836
3439
  * @secure
3837
3440
  */
3838
- groupsManage(action: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3441
+ initiate(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3839
3442
  /**
3840
- * @tags Advisory Groups
3841
- * @name GroupsList
3842
- * @request GET:/v1/groups/list
3443
+ * @tags Transfers Instant Account Verification
3444
+ * @name InitiatePost
3445
+ * @summary Initiate Post
3446
+ * @request POST:/iav/init
3843
3447
  * @secure
3844
3448
  */
3845
- groupsList(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3449
+ initiatePost(query: object, data: {
3450
+ /** @example "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" */
3451
+ subject?: string;
3452
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3846
3453
  /**
3847
- * @tags Advisory Groups
3848
- * @name GroupAccountsStats
3849
- * @request GET:/v2/advisory/group/accounts/stats/{groupsId}
3454
+ * @tags Transfers Instant Account Verification
3455
+ * @name Complete
3456
+ * @summary Complete
3457
+ * @request POST:/iav/complete
3850
3458
  * @secure
3851
3459
  */
3852
- groupAccountsStats(groupsId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3460
+ complete(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3853
3461
  /**
3854
- * @tags Advisory Groups
3855
- * @name GroupPortfolios
3856
- * @request GET:/v2/advisory/group/portfolios/{groupId}
3462
+ * @tags Transfers Instant Account Verification
3463
+ * @name ListBankAccounts
3464
+ * @summary List Bank Accounts
3465
+ * @request POST:/iav/list
3857
3466
  * @secure
3858
3467
  */
3859
- groupPortfolios(groupId: string, query?: {
3860
- /**
3861
- * Should load quotes or not.
3862
- * @example "false"
3863
- */
3864
- loadQuotes?: any;
3865
- /**
3866
- * Whether to return combined portfolio (no accounts, with approximate prices)
3867
- * @example "false"
3868
- */
3869
- combined?: any;
3870
- /** @example "false" */
3871
- loadIndustries?: any;
3872
- /** @example "false" */
3873
- loadUpgrades?: any;
3874
- /** @example "false" */
3875
- loadEarnings?: any;
3876
- /**
3877
- * Whether or not to include orders comprising each position's cost
3878
- * @example "false"
3879
- */
3880
- loadCost?: any;
3881
- /**
3882
- * Analyze market caps and get `marketCapWeights`. To be used in conjuction with `loadQuotes`
3883
- * @example "false"
3884
- */
3885
- marketCapWeights?: any;
3886
- /** @example "1" */
3887
- pageNum?: any;
3888
- /** @example "100" */
3889
- pageSize?: any;
3468
+ listBankAccounts(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3469
+ /**
3470
+ * @tags Transfers Instant Account Verification
3471
+ * @name LinkBankAccount
3472
+ * @summary Link Bank Account
3473
+ * @request POST:/iav/link
3474
+ * @secure
3475
+ */
3476
+ linkBankAccount(data: {
3477
+ /** @example "5VXXXXX" */
3478
+ account?: any;
3479
+ /** @example "XXXXXXX" */
3480
+ bankAccountId?: any;
3481
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3482
+ /**
3483
+ * @tags Transfers Instant Account Verification
3484
+ * @name ImportWithPlaid
3485
+ * @summary Import With Plaid
3486
+ * @request POST:/iav/import
3487
+ * @secure
3488
+ */
3489
+ importWithPlaid(data: {
3490
+ /** @example "3AB123456" */
3491
+ account?: any;
3492
+ /** @example "123456" */
3493
+ bankAccountNumber?: any;
3494
+ /** @example "John Smith" */
3495
+ bankAccountOwnerName?: any;
3496
+ /** @example "checking" */
3497
+ bankAccountType?: any;
3498
+ /** @example "122105155" */
3499
+ bankRoutingNumber?: any;
3500
+ /** @example "Checking x456" */
3501
+ nickname?: any;
3502
+ /** @example "{optional}" */
3503
+ note?: any;
3504
+ /** @example "{optional}" */
3505
+ remoteAddr?: any;
3506
+ /** @example "{optional}" */
3507
+ remoteDevice?: any;
3890
3508
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3509
+ }
3510
+ export class TransfersAch<HandleError extends boolean = boolean> {
3511
+ protected readonly apiClient: JwtClient<HandleError>;
3512
+ constructor(apiClient: JwtClient<HandleError>);
3891
3513
  /**
3892
- * @tags Advisory Groups
3893
- * @name GroupRtb
3894
- * @request GET:/v2/advisory/group/rtb/{groupId}
3514
+ * @tags Transfers Ach
3515
+ * @name Deposit
3516
+ * @summary Deposit
3517
+ * @request POST:/transfer/ach/deposit
3895
3518
  * @secure
3896
3519
  */
3897
- groupRtb(groupId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3520
+ deposit(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3898
3521
  /**
3899
- * @tags Advisory Groups
3900
- * @name GroupRtbs
3901
- * @request GET:/v2/advisory/group/rtbs/{groupId}
3522
+ * @tags Transfers Ach
3523
+ * @name Withdraw
3524
+ * @summary Withdraw
3525
+ * @request POST:/transfer/ach/withdraw
3902
3526
  * @secure
3903
3527
  */
3904
- groupRtbs(groupId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3528
+ withdraw(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3905
3529
  }
3906
3530
  export class TransfersAcats<HandleError extends boolean = boolean> {
3907
3531
  protected readonly apiClient: JwtClient<HandleError>;
@@ -4063,6 +3687,76 @@ export class TransfersAcats<HandleError extends boolean = boolean> {
4063
3687
  type?: string;
4064
3688
  }[], config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4065
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" */
3752
+ accountNumber?: string;
3753
+ };
3754
+ /** @example "PLACED|SENT|..." */
3755
+ status?: any;
3756
+ /** @example "AB123456" */
3757
+ transferId?: any;
3758
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3759
+ }
4066
3760
  export class TransfersWires<HandleError extends boolean = boolean> {
4067
3761
  protected readonly apiClient: JwtClient<HandleError>;
4068
3762
  constructor(apiClient: JwtClient<HandleError>);
@@ -4155,115 +3849,281 @@ export class TransfersWires<HandleError extends boolean = boolean> {
4155
3849
  /** @example "ultra fast browser 1.1" */
4156
3850
  remoteDevice?: any;
4157
3851
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4158
- }
4159
- export class TransfersJournals<HandleError extends boolean = boolean> {
4160
- protected readonly apiClient: JwtClient<HandleError>;
4161
- constructor(apiClient: JwtClient<HandleError>);
3852
+ }
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>>;
4162
4029
  /**
4163
- * @tags Transfers Journals
4164
- * @name JournalRequest
4165
- * @summary Journal request
4166
- * @request POST:/transfer/journal/request
4030
+ * @tags Advisory Models
4031
+ * @name AllModelBuyingPower
4032
+ * @summary All model buying power
4033
+ * @request GET:/v2/advisory/model/balances/{currency}
4167
4034
  * @secure
4168
4035
  */
4169
- journalRequest(data: {
4170
- /** @example 1000 */
4171
- amount?: any;
4172
- deliverFrom?: {
4173
- /** @example 124 */
4174
- accountId?: number;
4175
- /** @example "ABC123456" */
4176
- accountNumber?: string;
4177
- };
4178
- deliverTo?: {
4179
- /** @example 456 */
4180
- accountId?: number;
4181
- /** @example "DEF123456" */
4182
- accountNumber?: string;
4183
- };
4184
- /** @example "MM/dd/yyyy HH:mm:ss z" */
4185
- deliveryDate?: any;
4186
- loa?: {
4187
- /** @example "" */
4188
- fullName?: string;
4189
- /** @example "" */
4190
- remoteAddr?: string;
4191
- /** @example "" */
4192
- remoteDevice?: string;
4193
- /** @example "" */
4194
- signature?: string;
4195
- /** @example "MM/dd/yyyy HH:mm:ss z" */
4196
- timestamp?: string;
4197
- };
4198
- /** @example "NoPurpose|Gift|StockGift" */
4199
- purpose?: any;
4200
- /** @example "" */
4201
- reason?: any;
4202
- /** @example "0.0.0.0" */
4203
- remoteAddr?: any;
4204
- /** @example "Ultra fast proxy" */
4205
- remoteDevice?: any;
4206
- /** @example "required for StockGift" */
4207
- symbol?: any;
4036
+ allModelBuyingPower(currency: string, query?: {
4037
+ /**
4038
+ * [optional] when omitted defaults to system's setting.
4039
+ * @example "USD"
4040
+ */
4041
+ currency?: any;
4208
4042
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4209
4043
  /**
4210
- * @tags Transfers Journals
4211
- * @name Search
4212
- * @summary Search
4213
- * @request POST:/transfer/journal/search
4044
+ * @tags Advisory Models
4045
+ * @name PositionLookup
4046
+ * @summary Position lookup
4047
+ * @request GET:/v2/advisory/model/position/equity/{modelId}
4214
4048
  * @secure
4215
4049
  */
4216
- search(data: {
4217
- account?: {
4218
- /** @example 0 */
4219
- accountId?: number;
4220
- /** @example "ABC123456" */
4221
- accountNumber?: string;
4222
- };
4223
- /** @example "PLACED|SENT|..." */
4224
- status?: any;
4225
- /** @example "AB123456" */
4226
- transferId?: any;
4050
+ positionLookup(modelId: string, query?: {
4051
+ symbol?: any;
4227
4052
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4228
- }
4229
- export class TransfersPositions<HandleError extends boolean = boolean> {
4230
- protected readonly apiClient: JwtClient<HandleError>;
4231
- constructor(apiClient: JwtClient<HandleError>);
4232
4053
  /**
4233
- * @tags Transfers Positions
4234
- * @name TransferRequest
4235
- * @summary Transfer request
4236
- * @request POST:/transfer/position/request
4054
+ * @tags Advisory Models
4055
+ * @name PositionLookupOptions
4056
+ * @summary Position lookup (options)
4057
+ * @request GET:/v2/advisory/model/position/option/{modelId}
4237
4058
  * @secure
4238
4059
  */
4239
- transferRequest(data: {
4240
- deliverFrom?: {
4241
- /** @example 124 */
4242
- accountId?: number;
4243
- /** @example "ABC123456" */
4244
- accountNumber?: string;
4245
- };
4246
- deliverTo?: {
4247
- /** @example 456 */
4248
- accountId?: number;
4249
- /** @example "DEF123456" */
4250
- accountNumber?: string;
4251
- };
4252
- /** @example "NoPurpose|Gift" */
4253
- purpose?: any;
4254
- /** @example 1000 */
4255
- quantity?: any;
4256
- quote?: {
4257
- /** @example "IBM" */
4258
- symbol?: string;
4259
- };
4260
- /** @example "" */
4261
- reason?: any;
4262
- /** @example "0.0.0.0" */
4263
- remoteAddr?: any;
4264
- /** @example "Ultra fast proxy" */
4265
- remoteDevice?: any;
4060
+ positionLookupOptions(modelId: string, query?: {
4061
+ symbol?: any;
4266
4062
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4063
+ /**
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
4124
+ * @secure
4125
+ */
4126
+ allocations(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4267
4127
  }
4268
4128
  export class TransfersBank<HandleError extends boolean = boolean> {
4269
4129
  protected readonly apiClient: JwtClient<HandleError>;
@@ -4382,116 +4242,108 @@ export class TransfersInstantCashTransfers<HandleError extends boolean = boolean
4382
4242
  */
4383
4243
  listReports(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4384
4244
  }
4385
- export class TransfersCheques<HandleError extends boolean = boolean> {
4386
- protected readonly apiClient: JwtClient<HandleError>;
4387
- constructor(apiClient: JwtClient<HandleError>);
4388
- /**
4389
- * @tags Transfers Cheques
4390
- * @name Withdrawal
4391
- * @summary Withdrawal
4392
- * @request POST:/transfer/check/outgoing
4393
- * @secure
4394
- */
4395
- withdrawal(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4396
- }
4397
- export class TransfersInstantAccountVerification<HandleError extends boolean = boolean> {
4245
+ export class AdvisoryAllocations<HandleError extends boolean = boolean> {
4398
4246
  protected readonly apiClient: JwtClient<HandleError>;
4399
4247
  constructor(apiClient: JwtClient<HandleError>);
4400
4248
  /**
4401
- * @tags Transfers Instant Account Verification
4402
- * @name Initiate
4403
- * @summary Initiate
4404
- * @request GET:/iav/init
4249
+ * @tags Advisory Allocations
4250
+ * @name SearchNa
4251
+ * @summary Search (n/a)
4252
+ * @request GET:/v2/allocations/search
4405
4253
  * @secure
4406
4254
  */
4407
- initiate(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4255
+ searchNa(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4408
4256
  /**
4409
- * @tags Transfers Instant Account Verification
4410
- * @name InitiatePost
4411
- * @summary Initiate Post
4412
- * @request POST:/iav/init
4257
+ * @tags Advisory Allocations
4258
+ * @name Details
4259
+ * @summary Details
4260
+ * @request GET:/v2/allocations/details/{allocationRef}
4413
4261
  * @secure
4414
4262
  */
4415
- initiatePost(query: object, data: {
4416
- /** @example "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" */
4417
- subject?: string;
4418
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4263
+ details(allocationRef: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4419
4264
  /**
4420
- * @tags Transfers Instant Account Verification
4421
- * @name Complete
4422
- * @summary Complete
4423
- * @request POST:/iav/complete
4265
+ * @tags Advisory Allocations
4266
+ * @name Cancel
4267
+ * @summary Cancel
4268
+ * @request POST:/v2/allocations/cancel
4424
4269
  * @secure
4425
4270
  */
4426
- complete(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4271
+ cancel(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4427
4272
  /**
4428
- * @tags Transfers Instant Account Verification
4429
- * @name ListBankAccounts
4430
- * @summary List Bank Accounts
4431
- * @request POST:/iav/list
4273
+ * @tags Advisory Allocations
4274
+ * @name Validation
4275
+ * @summary Validation
4276
+ * @request POST:/v2/allocations/validate
4432
4277
  * @secure
4433
4278
  */
4434
- listBankAccounts(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4279
+ validation(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4435
4280
  /**
4436
- * @tags Transfers Instant Account Verification
4437
- * @name LinkBankAccount
4438
- * @summary Link Bank Account
4439
- * @request POST:/iav/link
4281
+ * @tags Advisory Allocations
4282
+ * @name Scheduling
4283
+ * @summary Scheduling
4284
+ * @request POST:/v2/allocations/preallocate
4440
4285
  * @secure
4441
4286
  */
4442
- linkBankAccount(data: {
4443
- /** @example "5VXXXXX" */
4444
- account?: any;
4445
- /** @example "XXXXXXX" */
4446
- bankAccountId?: any;
4447
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4287
+ scheduling(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4448
4288
  /**
4449
- * @tags Transfers Instant Account Verification
4450
- * @name ImportWithPlaid
4451
- * @summary Import With Plaid
4452
- * @request POST:/iav/import
4289
+ * @tags Advisory Allocations
4290
+ * @name Trigger
4291
+ * @summary Trigger
4292
+ * @request POST:/v2/allocations/trigger
4453
4293
  * @secure
4454
4294
  */
4455
- importWithPlaid(data: {
4456
- /** @example "3AB123456" */
4457
- account?: any;
4458
- /** @example "123456" */
4459
- bankAccountNumber?: any;
4460
- /** @example "John Smith" */
4461
- bankAccountOwnerName?: any;
4462
- /** @example "checking" */
4463
- bankAccountType?: any;
4464
- /** @example "122105155" */
4465
- bankRoutingNumber?: any;
4466
- /** @example "Checking x456" */
4467
- nickname?: any;
4468
- /** @example "{optional}" */
4469
- note?: any;
4470
- /** @example "{optional}" */
4471
- remoteAddr?: any;
4472
- /** @example "{optional}" */
4473
- remoteDevice?: any;
4474
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4295
+ trigger(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4475
4296
  }
4476
- export class TransfersAch<HandleError extends boolean = boolean> {
4297
+ export class TransfersCheques<HandleError extends boolean = boolean> {
4477
4298
  protected readonly apiClient: JwtClient<HandleError>;
4478
4299
  constructor(apiClient: JwtClient<HandleError>);
4479
4300
  /**
4480
- * @tags Transfers Ach
4481
- * @name Deposit
4482
- * @summary Deposit
4483
- * @request POST:/transfer/ach/deposit
4301
+ * @tags Transfers Cheques
4302
+ * @name Withdrawal
4303
+ * @summary Withdrawal
4304
+ * @request POST:/transfer/check/outgoing
4484
4305
  * @secure
4485
4306
  */
4486
- deposit(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4307
+ withdrawal(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4308
+ }
4309
+ export class TransfersPositions<HandleError extends boolean = boolean> {
4310
+ protected readonly apiClient: JwtClient<HandleError>;
4311
+ constructor(apiClient: JwtClient<HandleError>);
4487
4312
  /**
4488
- * @tags Transfers Ach
4489
- * @name Withdraw
4490
- * @summary Withdraw
4491
- * @request POST:/transfer/ach/withdraw
4313
+ * @tags Transfers Positions
4314
+ * @name TransferRequest
4315
+ * @summary Transfer request
4316
+ * @request POST:/transfer/position/request
4492
4317
  * @secure
4493
4318
  */
4494
- withdraw(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
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>>;
4495
4347
  }
4496
4348
  export class Transfers<HandleError extends boolean = boolean> {
4497
4349
  protected readonly apiClient: JwtClient<HandleError>;
@@ -4712,169 +4564,20 @@ export class Transfers<HandleError extends boolean = boolean> {
4712
4564
  /** @example "{conditional}" */
4713
4565
  recipientFirstName?: any;
4714
4566
  /** @example "{conditional}" */
4715
- recipientLastName?: any;
4716
- /** @example "{optional} 1.1.1.1" */
4717
- remoteAddr?: any;
4718
- /** @example "{optional} Some phone" */
4719
- remoteDevice?: any;
4720
- /** @example "{optional} true|false" */
4721
- selfHosted?: any;
4722
- /** @example "{optional}" */
4723
- tag?: any;
4724
- /** @example "{conditional}" */
4725
- vaspName?: any;
4726
- /** @example "wallet address" */
4727
- wallet?: any;
4728
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4729
- }
4730
- export class Documents<HandleError extends boolean = boolean> {
4731
- protected readonly apiClient: JwtClient<HandleError>;
4732
- constructor(apiClient: JwtClient<HandleError>);
4733
- /**
4734
- * @tags Documents
4735
- * @name Confirm
4736
- * @summary Confirm
4737
- * @request GET:/documents/confirm
4738
- * @secure
4739
- */
4740
- confirm(query?: {
4741
- /**
4742
- * *_accountNumber_ is accepted as well*
4743
- * @example "5VA0XXXX"
4744
- */
4745
- account?: any;
4746
- /**
4747
- * Date for the confirm. The required date format is: mm/dd/yyyy.
4748
- * @example "03/03/2018"
4749
- */
4750
- date?: any;
4751
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4752
- /**
4753
- * @tags Documents
4754
- * @name ListOfConfirms
4755
- * @summary List of Confirms
4756
- * @request GET:/documents/confirm/list
4757
- * @secure
4758
- */
4759
- listOfConfirms(query?: {
4760
- /**
4761
- * *_accountNumber_ is accepted as well*
4762
- * @example "5VA0XXXX"
4763
- */
4764
- account?: any;
4765
- /**
4766
- * Start date for the list of confirms. The required date format is: `mm/dd/yyyy`.
4767
- * @example "01/01/2017"
4768
- */
4769
- beginDate?: any;
4770
- /**
4771
- * End date for the list of confirms. The required date format is: `mm/dd/yyyy`.
4772
- * @example "03/01/2018"
4773
- */
4774
- endDate?: any;
4775
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4776
- /**
4777
- * @tags Documents
4778
- * @name ServiceDocs
4779
- * @summary Service Docs
4780
- * @request GET:/documents/service
4781
- * @secure
4782
- */
4783
- serviceDocs(query?: {
4784
- /** @example "5VA0XXXX" */
4785
- accountNumber?: any;
4786
- /** See table for details. Leave blank for all document types. */
4787
- docType?: any;
4788
- /**
4789
- * The beginning 2-digit month (MM) to be used as search criteria.
4790
- * @example "01"
4791
- */
4792
- beginMonth?: any;
4793
- /**
4794
- * The beginning 4-digit year (YYYY) to be used as search criteria.
4795
- * @example "2012"
4796
- */
4797
- beginYear?: any;
4798
- /**
4799
- * The ending 2-digit month (MM) to be used as search criteria.
4800
- * @example "12"
4801
- */
4802
- endMonth?: any;
4803
- /**
4804
- * The ending 4-digit year (YYYY) to be used as search criteria.
4805
- * @example "2017"
4806
- */
4807
- endYear?: any;
4808
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4809
- /**
4810
- * @tags Documents
4811
- * @name DocumentList
4812
- * @summary Document list
4813
- * @request GET:/documents/list
4814
- * @secure
4815
- */
4816
- documentList(query?: {
4817
- /** @example "5VA0XXXX" */
4818
- account?: any;
4819
- /**
4820
- * Omit for all document types.
4821
- * @example "All"
4822
- */
4823
- documentType?: any;
4824
- /**
4825
- * Indicates start month & year (day of month is not used)
4826
- * @example "1/1/2021"
4827
- */
4828
- fromMonth?: any;
4829
- /**
4830
- * Indicates end month & year (day of month is not used)
4831
- * @example "12/1/2021"
4832
- */
4833
- toMonth?: any;
4834
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4835
- /**
4836
- * @tags Documents
4837
- * @name AvailableDocumentTypes
4838
- * @summary Available document types
4839
- * @request GET:/documents/types
4840
- * @secure
4841
- */
4842
- availableDocumentTypes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4843
- /**
4844
- * @tags Documents
4845
- * @name AvailableDocumentTypesAndCodes
4846
- * @summary Available document types and codes
4847
- * @request GET:/documents/typesAndCodes
4848
- * @secure
4849
- */
4850
- availableDocumentTypesAndCodes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4851
- /**
4852
- * @tags Documents
4853
- * @name Download
4854
- * @summary Download
4855
- * @request GET:/documents/download
4856
- * @secure
4857
- */
4858
- download(query?: {
4859
- /**
4860
- * Account Number
4861
- * @example "{accountNumber}"
4862
- */
4863
- account?: any;
4864
- /**
4865
- * UUID for finding specific document
4866
- * @example "{key}"
4867
- */
4868
- key?: any;
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;
4869
4580
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4870
- /**
4871
- * @tags Documents
4872
- * @name GetAllBranchDocuments
4873
- * @summary Get all Branch Documents
4874
- * @request GET:/documents/branch/list
4875
- * @secure
4876
- */
4877
- getAllBranchDocuments(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4878
4581
  }
4879
4582
  export class Miscellaneous<HandleError extends boolean = boolean> {
4880
4583
  protected readonly apiClient: JwtClient<HandleError>;
@@ -5058,203 +4761,244 @@ export class Miscellaneous<HandleError extends boolean = boolean> {
5058
4761
  */
5059
4762
  optionStrategyClassifications(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5060
4763
  }
5061
- export class Branch<HandleError extends boolean = boolean> {
4764
+ export class Documents<HandleError extends boolean = boolean> {
5062
4765
  protected readonly apiClient: JwtClient<HandleError>;
5063
4766
  constructor(apiClient: JwtClient<HandleError>);
5064
4767
  /**
5065
- * @tags Branch
5066
- * @name BranchRtb
5067
- * @request GET:/v1/branch/rtb
5068
- * @secure
5069
- */
5070
- branchRtb(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5071
- /**
5072
- * @tags Branch
5073
- * @name BranchRtbs
5074
- * @request GET:/v1/branch/rtbs
4768
+ * @tags Documents
4769
+ * @name Confirm
4770
+ * @summary Confirm
4771
+ * @request GET:/documents/confirm
5075
4772
  * @secure
5076
4773
  */
5077
- branchRtbs(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4774
+ confirm(query?: {
4775
+ /**
4776
+ * *_accountNumber_ is accepted as well*
4777
+ * @example "5VA0XXXX"
4778
+ */
4779
+ account?: any;
4780
+ /**
4781
+ * Date for the confirm. The required date format is: mm/dd/yyyy.
4782
+ * @example "03/03/2018"
4783
+ */
4784
+ date?: any;
4785
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5078
4786
  /**
5079
- * @tags Branch
5080
- * @name BranchInventory
5081
- * @request GET:/v1/branch/inventory
4787
+ * @tags Documents
4788
+ * @name ListOfConfirms
4789
+ * @summary List of Confirms
4790
+ * @request GET:/documents/confirm/list
5082
4791
  * @secure
5083
4792
  */
5084
- branchInventory(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4793
+ listOfConfirms(query?: {
4794
+ /**
4795
+ * *_accountNumber_ is accepted as well*
4796
+ * @example "5VA0XXXX"
4797
+ */
4798
+ account?: any;
4799
+ /**
4800
+ * Start date for the list of confirms. The required date format is: `mm/dd/yyyy`.
4801
+ * @example "01/01/2017"
4802
+ */
4803
+ beginDate?: any;
4804
+ /**
4805
+ * End date for the list of confirms. The required date format is: `mm/dd/yyyy`.
4806
+ * @example "03/01/2018"
4807
+ */
4808
+ endDate?: any;
4809
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5085
4810
  /**
5086
- * @tags Branch
5087
- * @name BranchRtbsTotal
5088
- * @request GET:/v1/branch/rtbs/total
4811
+ * @tags Documents
4812
+ * @name ServiceDocs
4813
+ * @summary Service Docs
4814
+ * @request GET:/documents/service
5089
4815
  * @secure
5090
4816
  */
5091
- branchRtbsTotal(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4817
+ serviceDocs(query?: {
4818
+ /** @example "5VA0XXXX" */
4819
+ accountNumber?: any;
4820
+ /** See table for details. Leave blank for all document types. */
4821
+ docType?: any;
4822
+ /**
4823
+ * The beginning 2-digit month (MM) to be used as search criteria.
4824
+ * @example "01"
4825
+ */
4826
+ beginMonth?: any;
4827
+ /**
4828
+ * The beginning 4-digit year (YYYY) to be used as search criteria.
4829
+ * @example "2012"
4830
+ */
4831
+ beginYear?: any;
4832
+ /**
4833
+ * The ending 2-digit month (MM) to be used as search criteria.
4834
+ * @example "12"
4835
+ */
4836
+ endMonth?: any;
4837
+ /**
4838
+ * The ending 4-digit year (YYYY) to be used as search criteria.
4839
+ * @example "2017"
4840
+ */
4841
+ endYear?: any;
4842
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5092
4843
  /**
5093
- * @tags Branch
5094
- * @name BranchPortfolio
5095
- * @request GET:/v1/branch/portfolio
4844
+ * @tags Documents
4845
+ * @name DocumentList
4846
+ * @summary Document list
4847
+ * @request GET:/documents/list
5096
4848
  * @secure
5097
4849
  */
5098
- branchPortfolio(query?: {
5099
- /**
5100
- * (true or false) Allows for loading of quotes for each portfolio entry. Defaults to false.
5101
- * @example "false"
5102
- */
5103
- loadQuotes?: any;
5104
- /** @example "false" */
5105
- loadIndustries?: any;
5106
- /** @example "false" */
5107
- loadUpgrades?: any;
5108
- /** @example "false" */
5109
- loadEarnings?: any;
4850
+ documentList(query?: {
4851
+ /** @example "5VA0XXXX" */
4852
+ account?: any;
5110
4853
  /**
5111
- * Load balances for weight
5112
- * @example "false"
4854
+ * Omit for all document types.
4855
+ * @example "All"
5113
4856
  */
5114
- loadRtb?: any;
4857
+ documentType?: any;
5115
4858
  /**
5116
- * Analyze market caps and get `marketCapWeights`. To be used in conjuction with `loadQuotes`
5117
- * @example "false"
4859
+ * Indicates start month & year (day of month is not used)
4860
+ * @example "1/1/2021"
5118
4861
  */
5119
- marketCapBreakdown?: any;
4862
+ fromMonth?: any;
5120
4863
  /**
5121
- * Combined portfolio for the branch
5122
- * @example "false"
4864
+ * Indicates end month & year (day of month is not used)
4865
+ * @example "12/1/2021"
5123
4866
  */
5124
- combined?: any;
5125
- /** @example "1" */
5126
- pageNum?: any;
5127
- /** @example "100" */
5128
- pageSize?: any;
4867
+ toMonth?: any;
5129
4868
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5130
4869
  /**
5131
- * @tags Branch
5132
- * @name OptionExpirations
5133
- * @summary Option expirations
5134
- * @request GET:/v1/branch/portfolio/options/upcoming
4870
+ * @tags Documents
4871
+ * @name AvailableDocumentTypes
4872
+ * @summary Available document types
4873
+ * @request GET:/documents/types
5135
4874
  * @secure
5136
4875
  */
5137
- optionExpirations(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4876
+ availableDocumentTypes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5138
4877
  /**
5139
- * @tags Branch
5140
- * @name OptionExpirationsDetails
5141
- * @summary Option expirations details
5142
- * @request POST:/v1/branch/portfolio/options/upcoming/details
4878
+ * @tags Documents
4879
+ * @name AvailableDocumentTypesAndCodes
4880
+ * @summary Available document types and codes
4881
+ * @request GET:/documents/typesAndCodes
5143
4882
  * @secure
5144
4883
  */
5145
- optionExpirationsDetails(data: {
5146
- /** @example "true|false" */
5147
- loadQuotes?: any;
5148
- /** @example "01/15/2021 00:00:00 EST" */
5149
- maturity?: any;
4884
+ availableDocumentTypesAndCodes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4885
+ /**
4886
+ * @tags Documents
4887
+ * @name Download
4888
+ * @summary Download
4889
+ * @request GET:/documents/download
4890
+ * @secure
4891
+ */
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;
5150
4903
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4904
+ /**
4905
+ * @tags Documents
4906
+ * @name GetAllBranchDocuments
4907
+ * @summary Get all Branch Documents
4908
+ * @request GET:/documents/branch/list
4909
+ * @secure
4910
+ */
4911
+ getAllBranchDocuments(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5151
4912
  }
5152
- export class LegalDocuments<HandleError extends boolean = boolean> {
4913
+ export class Branch<HandleError extends boolean = boolean> {
5153
4914
  protected readonly apiClient: JwtClient<HandleError>;
5154
4915
  constructor(apiClient: JwtClient<HandleError>);
5155
4916
  /**
5156
- * @tags Legal Documents
5157
- * @name DocumentClassifications
5158
- * @summary Document classifications
5159
- * @request GET:/user/legal/classifications
4917
+ * @tags Branch
4918
+ * @name BranchRtb
4919
+ * @request GET:/v1/branch/rtb
5160
4920
  * @secure
5161
4921
  */
5162
- documentClassifications(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4922
+ branchRtb(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5163
4923
  /**
5164
- * @tags Legal Documents
5165
- * @name DocumentListing
5166
- * @summary Document listing
5167
- * @request GET:/user/legal/documents
4924
+ * @tags Branch
4925
+ * @name BranchRtbs
4926
+ * @request GET:/v1/branch/rtbs
5168
4927
  * @secure
5169
4928
  */
5170
- documentListing(query?: {
5171
- /**
5172
- * {optional}
5173
- * @example "TermsOfUse"
5174
- */
5175
- classification?: any;
5176
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4929
+ branchRtbs(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5177
4930
  /**
5178
- * @tags Legal Documents
5179
- * @name PolicyValues
5180
- * @summary Policy values
5181
- * @request GET:/user/legal/policies/listing/{type}
4931
+ * @tags Branch
4932
+ * @name BranchInventory
4933
+ * @request GET:/v1/branch/inventory
5182
4934
  * @secure
5183
4935
  */
5184
- policyValues(type: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4936
+ branchInventory(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5185
4937
  /**
5186
- * @tags Legal Documents
5187
- * @name DocumentContent
5188
- * @summary Document content
5189
- * @request GET:/user/legal/document/content
4938
+ * @tags Branch
4939
+ * @name BranchRtbsTotal
4940
+ * @request GET:/v1/branch/rtbs/total
5190
4941
  * @secure
5191
4942
  */
5192
- documentContent(query?: {
5193
- /** @example "{as provided}" */
5194
- id?: any;
5195
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4943
+ branchRtbsTotal(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5196
4944
  /**
5197
- * @tags Legal Documents
5198
- * @name DocumentDownload
5199
- * @summary Document download
5200
- * @request GET:/user/legal/document/download
4945
+ * @tags Branch
4946
+ * @name BranchPortfolio
4947
+ * @request GET:/v1/branch/portfolio
5201
4948
  * @secure
5202
4949
  */
5203
- documentDownload(query?: {
5204
- /** @example "{as provided}" */
5205
- id?: any;
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;
4967
+ /**
4968
+ * Analyze market caps and get `marketCapWeights`. To be used in conjuction with `loadQuotes`
4969
+ * @example "false"
4970
+ */
4971
+ marketCapBreakdown?: any;
4972
+ /**
4973
+ * Combined portfolio for the branch
4974
+ * @example "false"
4975
+ */
4976
+ combined?: any;
4977
+ /** @example "1" */
4978
+ pageNum?: any;
4979
+ /** @example "100" */
4980
+ pageSize?: any;
5206
4981
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5207
4982
  /**
5208
- * @tags Legal Documents
5209
- * @name SignTheDocument
5210
- * @summary Sign the document
5211
- * @request POST:/user/legal/document/sign
4983
+ * @tags Branch
4984
+ * @name OptionExpirations
4985
+ * @summary Option expirations
4986
+ * @request GET:/v1/branch/portfolio/options/upcoming
5212
4987
  * @secure
5213
4988
  */
5214
- signTheDocument(data: {
5215
- account?: {
5216
- /** @example 1234 */
5217
- accountId?: number;
5218
- /** @example "AC123456" */
5219
- accountNumber?: string;
5220
- };
5221
- data?: {
5222
- /** @example "{conditional}" */
5223
- bankAccountNumber?: string;
5224
- };
5225
- /** @example "{required}" */
5226
- documentId?: any;
5227
- /** @example true */
5228
- esigned?: any;
5229
- /** @example "" */
5230
- remoteAddr?: any;
5231
- /** @example "{required}" */
5232
- remoteDevice?: any;
5233
- /** @example "{required}" */
5234
- signature?: any;
5235
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4989
+ optionExpirations(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5236
4990
  /**
5237
- * @tags Legal Documents
5238
- * @name UpdatesPolicyOnTheAccount
5239
- * @summary Updates policy on the account
5240
- * @request POST:/user/legal/policy/{type}
4991
+ * @tags Branch
4992
+ * @name OptionExpirationsDetails
4993
+ * @summary Option expirations details
4994
+ * @request POST:/v1/branch/portfolio/options/upcoming/details
5241
4995
  * @secure
5242
4996
  */
5243
- updatesPolicyOnTheAccount(type: string, data: {
5244
- account?: {
5245
- /** @example 0 */
5246
- accountId?: number;
5247
- /** @example "{optional}" */
5248
- accountNumber?: string;
5249
- };
5250
- /** @example true */
5251
- esigned?: any;
5252
- /** @example "Allow" */
5253
- policy?: any;
5254
- /** @example "" */
5255
- remoteAddr?: any;
5256
- /** @example "" */
5257
- remoteDevice?: any;
4997
+ optionExpirationsDetails(data: {
4998
+ /** @example "true|false" */
4999
+ loadQuotes?: any;
5000
+ /** @example "01/15/2021 00:00:00 EST" */
5001
+ maturity?: any;
5258
5002
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5259
5003
  }
5260
5004
  export class BlacklistAdminBusinesses<HandleError extends boolean = boolean> {
@@ -5313,54 +5057,244 @@ export class BlacklistAdminBusinesses<HandleError extends boolean = boolean> {
5313
5057
  zip?: any;
5314
5058
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5315
5059
  /**
5316
- * @tags Blacklist Admin Businesses
5317
- * @name GetBusinessById
5318
- * @summary Get Business by ID
5319
- * @request GET:/v1/admin/businesses/{id}
5060
+ * @tags Blacklist Admin Businesses
5061
+ * @name GetBusinessById
5062
+ * @summary Get Business by ID
5063
+ * @request GET:/v1/admin/businesses/{id}
5064
+ * @secure
5065
+ */
5066
+ getBusinessById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5067
+ /**
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>>;
5100
+ /**
5101
+ * @tags Blacklist Admin Businesses
5102
+ * @name DeleteBusiness
5103
+ * @summary Delete Business
5104
+ * @request DELETE:/v1/admin/businesses/{id}
5105
+ * @secure
5106
+ */
5107
+ deleteBusiness(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5108
+ }
5109
+ export class AdvisoryGroups<HandleError extends boolean = boolean> {
5110
+ protected readonly apiClient: JwtClient<HandleError>;
5111
+ constructor(apiClient: JwtClient<HandleError>);
5112
+ /**
5113
+ * @tags Advisory Groups
5114
+ * @name GroupsManage
5115
+ * @request POST:/v1/groups/manage/{action}
5116
+ * @secure
5117
+ */
5118
+ groupsManage(action: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5119
+ /**
5120
+ * @tags Advisory Groups
5121
+ * @name GroupsList
5122
+ * @request GET:/v1/groups/list
5123
+ * @secure
5124
+ */
5125
+ groupsList(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5126
+ /**
5127
+ * @tags Advisory Groups
5128
+ * @name GroupAccountsStats
5129
+ * @request GET:/v2/advisory/group/accounts/stats/{groupsId}
5130
+ * @secure
5131
+ */
5132
+ groupAccountsStats(groupsId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5133
+ /**
5134
+ * @tags Advisory Groups
5135
+ * @name GroupPortfolios
5136
+ * @request GET:/v2/advisory/group/portfolios/{groupId}
5137
+ * @secure
5138
+ */
5139
+ groupPortfolios(groupId: string, query?: {
5140
+ /**
5141
+ * Should load quotes or not.
5142
+ * @example "false"
5143
+ */
5144
+ loadQuotes?: any;
5145
+ /**
5146
+ * Whether to return combined portfolio (no accounts, with approximate prices)
5147
+ * @example "false"
5148
+ */
5149
+ combined?: any;
5150
+ /** @example "false" */
5151
+ loadIndustries?: any;
5152
+ /** @example "false" */
5153
+ loadUpgrades?: any;
5154
+ /** @example "false" */
5155
+ loadEarnings?: any;
5156
+ /**
5157
+ * Whether or not to include orders comprising each position's cost
5158
+ * @example "false"
5159
+ */
5160
+ loadCost?: any;
5161
+ /**
5162
+ * Analyze market caps and get `marketCapWeights`. To be used in conjuction with `loadQuotes`
5163
+ * @example "false"
5164
+ */
5165
+ marketCapWeights?: any;
5166
+ /** @example "1" */
5167
+ pageNum?: any;
5168
+ /** @example "100" */
5169
+ pageSize?: any;
5170
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5171
+ /**
5172
+ * @tags Advisory Groups
5173
+ * @name GroupRtb
5174
+ * @request GET:/v2/advisory/group/rtb/{groupId}
5175
+ * @secure
5176
+ */
5177
+ groupRtb(groupId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5178
+ /**
5179
+ * @tags Advisory Groups
5180
+ * @name GroupRtbs
5181
+ * @request GET:/v2/advisory/group/rtbs/{groupId}
5182
+ * @secure
5183
+ */
5184
+ groupRtbs(groupId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5185
+ }
5186
+ export class AdvisoryUserAccountManagement<HandleError extends boolean = boolean> {
5187
+ protected readonly apiClient: JwtClient<HandleError>;
5188
+ constructor(apiClient: JwtClient<HandleError>);
5189
+ /**
5190
+ * @tags Advisory User Account Management
5191
+ * @name List
5192
+ * @summary /list
5193
+ * @request GET:/v2/advisory/users/list
5194
+ * @secure
5195
+ */
5196
+ list(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5197
+ /**
5198
+ * @tags Advisory User Account Management
5199
+ * @name Accounts
5200
+ * @summary /accounts
5201
+ * @request GET:/v2/advisory/users/accounts
5202
+ * @secure
5203
+ */
5204
+ accounts(query?: {
5205
+ /** @example "1234" */
5206
+ uid?: any;
5207
+ /**
5208
+ * true|false
5209
+ * @example "false"
5210
+ */
5211
+ loadRtb?: any;
5212
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5213
+ /**
5214
+ * @tags Advisory User Account Management
5215
+ * @name AccountsStats
5216
+ * @summary /accounts/stats
5217
+ * @request GET:/v2/advisory/users/accounts/stats
5218
+ * @secure
5219
+ */
5220
+ accountsStats(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5221
+ /**
5222
+ * @tags Advisory User Account Management
5223
+ * @name AccountNotes
5224
+ * @summary /account/notes
5225
+ * @request GET:/v2/advisory/users/account/notes
5226
+ * @secure
5227
+ */
5228
+ accountNotes(query?: {
5229
+ /**
5230
+ * Account's ID
5231
+ * @example "1234"
5232
+ */
5233
+ aid?: any;
5234
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5235
+ /**
5236
+ * @tags Advisory User Account Management
5237
+ * @name Notes
5238
+ * @summary /notes
5239
+ * @request GET:/v2/advisory/users/notes
5320
5240
  * @secure
5321
5241
  */
5322
- getBusinessById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5242
+ notes(query?: {
5243
+ /**
5244
+ * User's ID
5245
+ * @example "1234"
5246
+ */
5247
+ uid?: any;
5248
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5323
5249
  /**
5324
- * @tags Blacklist Admin Businesses
5325
- * @name UpdateBusiness
5326
- * @summary Update Business
5327
- * @request PUT:/v1/admin/businesses/{id}
5250
+ * @tags Advisory User Account Management
5251
+ * @name NotesPost
5252
+ * @request POST:/v2/advisory/users/notes/{action}
5328
5253
  * @secure
5329
5254
  */
5330
- updateBusiness(id: string, data: {
5331
- /** @example "Gracia Marina" */
5332
- business_name?: any;
5333
- /** @example "Los Angeles" */
5334
- city?: any;
5335
- /** @example "US" */
5336
- country?: any;
5337
- /** @example "La Granja Del Camaron" */
5338
- dba_name?: any;
5339
- /** @example "" */
5340
- incorporated?: any;
5341
- /** @example "812748955" */
5342
- number?: any;
5343
- /** @example "EIN" */
5344
- number_type?: any;
5345
- /** @example "" */
5346
- phone?: any;
5347
- /** @example "CA" */
5348
- state?: any;
5349
- /** @example "1119 E 8th St Ste C" */
5350
- street?: any;
5351
- /** @example "304902" */
5352
- tracking_number?: any;
5353
- /** @example "90021" */
5354
- zip?: any;
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>);
5260
+ /**
5261
+ * @tags Blacklist Search
5262
+ * @name SearchBusiness
5263
+ * @summary Search Business
5264
+ * @request POST:/v1/businesses/search
5265
+ * @secure
5266
+ */
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
+ };
5355
5278
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5356
5279
  /**
5357
- * @tags Blacklist Admin Businesses
5358
- * @name DeleteBusiness
5359
- * @summary Delete Business
5360
- * @request DELETE:/v1/admin/businesses/{id}
5280
+ * @tags Blacklist Search
5281
+ * @name SearchIndividual
5282
+ * @summary Search Individual
5283
+ * @request POST:/v1/individuals/search
5361
5284
  * @secure
5362
5285
  */
5363
- deleteBusiness(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
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>>;
5364
5298
  }
5365
5299
  export class BlacklistAdminIndividuals<HandleError extends boolean = boolean> {
5366
5300
  protected readonly apiClient: JwtClient<HandleError>;
@@ -5491,48 +5425,6 @@ export class BlacklistAdminIndividuals<HandleError extends boolean = boolean> {
5491
5425
  */
5492
5426
  deleteIndividual(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5493
5427
  }
5494
- export class BlacklistSearch<HandleError extends boolean = boolean> {
5495
- protected readonly apiClient: JwtClient<HandleError>;
5496
- constructor(apiClient: JwtClient<HandleError>);
5497
- /**
5498
- * @tags Blacklist Search
5499
- * @name SearchBusiness
5500
- * @summary Search Business
5501
- * @request POST:/v1/businesses/search
5502
- * @secure
5503
- */
5504
- searchBusiness(data: {
5505
- /** @example [{"distance":0,"name":"business_name","value":"Gracia Marina"},{"distance":2,"name":"dba_name","value":"La Granja Del Camar"}] */
5506
- filters?: any;
5507
- /** @example "AND" */
5508
- match_type?: any;
5509
- pagination?: {
5510
- /** @example 1 */
5511
- page?: number;
5512
- /** @example 20 */
5513
- page_size?: number;
5514
- };
5515
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5516
- /**
5517
- * @tags Blacklist Search
5518
- * @name SearchIndividual
5519
- * @summary Search Individual
5520
- * @request POST:/v1/individuals/search
5521
- * @secure
5522
- */
5523
- searchIndividual(data: {
5524
- /** @example [{"distance":2,"name":"first_name","value":"Hyodan"},{"distance":0,"name":"alias_middle_name","value":"Hyodon"}] */
5525
- filters?: any;
5526
- /** @example "OR" */
5527
- match_type?: any;
5528
- pagination?: {
5529
- /** @example 1 */
5530
- page?: number;
5531
- /** @example 20 */
5532
- page_size?: number;
5533
- };
5534
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5535
- }
5536
5428
  export class Blacklist<HandleError extends boolean = boolean> {
5537
5429
  protected readonly apiClient: JwtClient<HandleError>;
5538
5430
  adminBusinesses: BlacklistAdminBusinesses<HandleError>;
@@ -5935,6 +5827,114 @@ export class WatchmenFfi<HandleError extends boolean = boolean> {
5935
5827
  firmBranch: WatchmenFfiFirmBranch<HandleError>;
5936
5828
  constructor(apiClient: JwtClient<HandleError>);
5937
5829
  }
5830
+ export class LegalDocuments<HandleError extends boolean = boolean> {
5831
+ protected readonly apiClient: JwtClient<HandleError>;
5832
+ constructor(apiClient: JwtClient<HandleError>);
5833
+ /**
5834
+ * @tags Legal Documents
5835
+ * @name DocumentClassifications
5836
+ * @summary Document classifications
5837
+ * @request GET:/user/legal/classifications
5838
+ * @secure
5839
+ */
5840
+ documentClassifications(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5841
+ /**
5842
+ * @tags Legal Documents
5843
+ * @name DocumentListing
5844
+ * @summary Document listing
5845
+ * @request GET:/user/legal/documents
5846
+ * @secure
5847
+ */
5848
+ documentListing(query?: {
5849
+ /**
5850
+ * {optional}
5851
+ * @example "TermsOfUse"
5852
+ */
5853
+ classification?: any;
5854
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5855
+ /**
5856
+ * @tags Legal Documents
5857
+ * @name PolicyValues
5858
+ * @summary Policy values
5859
+ * @request GET:/user/legal/policies/listing/{type}
5860
+ * @secure
5861
+ */
5862
+ policyValues(type: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5863
+ /**
5864
+ * @tags Legal Documents
5865
+ * @name DocumentContent
5866
+ * @summary Document content
5867
+ * @request GET:/user/legal/document/content
5868
+ * @secure
5869
+ */
5870
+ documentContent(query?: {
5871
+ /** @example "{as provided}" */
5872
+ id?: any;
5873
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5874
+ /**
5875
+ * @tags Legal Documents
5876
+ * @name DocumentDownload
5877
+ * @summary Document download
5878
+ * @request GET:/user/legal/document/download
5879
+ * @secure
5880
+ */
5881
+ documentDownload(query?: {
5882
+ /** @example "{as provided}" */
5883
+ id?: any;
5884
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5885
+ /**
5886
+ * @tags Legal Documents
5887
+ * @name SignTheDocument
5888
+ * @summary Sign the document
5889
+ * @request POST:/user/legal/document/sign
5890
+ * @secure
5891
+ */
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>>;
5914
+ /**
5915
+ * @tags Legal Documents
5916
+ * @name UpdatesPolicyOnTheAccount
5917
+ * @summary Updates policy on the account
5918
+ * @request POST:/user/legal/policy/{type}
5919
+ * @secure
5920
+ */
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;
5934
+ /** @example "" */
5935
+ remoteDevice?: any;
5936
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5937
+ }
5938
5938
  export class OrbisApi<HandleError extends boolean = false> extends BaseApi<HandleError, OrbisClient<HandleError>> {
5939
5939
  readonly config: OrbisClientConfig<HandleError>;
5940
5940
  advisory: Advisory<HandleError>;