@orbis-systems/orbis-api-clients 0.6.7 → 0.6.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.
Files changed (41) hide show
  1. package/dist/aesmidas/index.d.ts +1114 -1105
  2. package/dist/aesmidas/index.d.ts.map +1 -1
  3. package/dist/aesmidas/index.esm.js +1 -2806
  4. package/dist/aesmidas/index.esm.js.map +1 -1
  5. package/dist/aesmidas/index.js +1 -2811
  6. package/dist/aesmidas/index.js.map +1 -1
  7. package/dist/bridgewise/index.d.ts +94 -93
  8. package/dist/bridgewise/index.d.ts.map +1 -1
  9. package/dist/bridgewise/index.esm.js +1 -1888
  10. package/dist/bridgewise/index.esm.js.map +1 -1
  11. package/dist/bridgewise/index.js +1 -1893
  12. package/dist/bridgewise/index.js.map +1 -1
  13. package/dist/index.esm.js +1 -257
  14. package/dist/index.esm.js.map +1 -1
  15. package/dist/index.js +1 -280
  16. package/dist/index.js.map +1 -1
  17. package/dist/insight/index.d.ts +326 -325
  18. package/dist/insight/index.d.ts.map +1 -1
  19. package/dist/insight/index.esm.js +1 -3753
  20. package/dist/insight/index.esm.js.map +1 -1
  21. package/dist/insight/index.js +1 -3758
  22. package/dist/insight/index.js.map +1 -1
  23. package/dist/middleware/index.d.ts +34 -34
  24. package/dist/middleware/index.d.ts.map +1 -1
  25. package/dist/middleware/index.esm.js +1 -1066
  26. package/dist/middleware/index.esm.js.map +1 -1
  27. package/dist/middleware/index.js +1 -1071
  28. package/dist/middleware/index.js.map +1 -1
  29. package/dist/orbis/index.d.ts +1236 -1236
  30. package/dist/orbis/index.d.ts.map +1 -1
  31. package/dist/orbis/index.esm.js +1 -7009
  32. package/dist/orbis/index.esm.js.map +1 -1
  33. package/dist/orbis/index.js +1 -7014
  34. package/dist/orbis/index.js.map +1 -1
  35. package/dist/uma/index.d.ts +290 -290
  36. package/dist/uma/index.d.ts.map +1 -1
  37. package/dist/uma/index.esm.js +1 -3993
  38. package/dist/uma/index.esm.js.map +1 -1
  39. package/dist/uma/index.js +1 -3998
  40. package/dist/uma/index.js.map +1 -1
  41. package/package.json +9 -1
@@ -4188,45 +4188,6 @@ export enum InsightTiprankInsidersLiveFeedParamsSortEnum {
4188
4188
  Date = "date",
4189
4189
  Rank = "rank"
4190
4190
  }
4191
- export class CompanyProfile<HandleError extends boolean = boolean> {
4192
- protected readonly apiClient: JwtClient<HandleError>;
4193
- constructor(apiClient: JwtClient<HandleError>);
4194
- /**
4195
- * @description get company profile, industries classification and closest earning release
4196
- * @tags CompanyProfile
4197
- * @name GetCompanyProfile
4198
- * @summary get company profile
4199
- * @request GET:/company-profile
4200
- * @secure
4201
- */
4202
- getCompanyProfile(query: {
4203
- /** Company symbol */
4204
- symbol: string;
4205
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCompanyProfile, HandleError>>;
4206
- /**
4207
- * @description get combined profile, equities and funds
4208
- * @tags CompanyProfile
4209
- * @name GetCombinedProfile
4210
- * @summary get company profile
4211
- * @request GET:/quote-profile
4212
- * @secure
4213
- */
4214
- getCombinedProfile(query: {
4215
- /** Company symbol */
4216
- symbol: string;
4217
- /** Desired symbol type - [ANY,FUND,EQUITY,INDEX] */
4218
- symbol_type?: InsightGetCombinedProfileParamsSymbolTypeEnum;
4219
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCombinedProfileResponse, HandleError>>;
4220
- /**
4221
- * @description sort input array of symbols by type
4222
- * @tags CompanyProfile
4223
- * @name GetSymbolsPerSymbolType
4224
- * @summary sort input array of symbols by type
4225
- * @request POST:/symbols-per-type
4226
- * @secure
4227
- */
4228
- getSymbolsPerSymbolType(input: InsightGetSymbolsPerTypeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolsPerTypeResponse, HandleError>>;
4229
- }
4230
4191
  export class WorldMarkets<HandleError extends boolean = boolean> {
4231
4192
  protected readonly apiClient: JwtClient<HandleError>;
4232
4193
  constructor(apiClient: JwtClient<HandleError>);
@@ -4409,6 +4370,45 @@ export class WorldMarkets<HandleError extends boolean = boolean> {
4409
4370
  id: string;
4410
4371
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4411
4372
  }
4373
+ export class CompanyProfile<HandleError extends boolean = boolean> {
4374
+ protected readonly apiClient: JwtClient<HandleError>;
4375
+ constructor(apiClient: JwtClient<HandleError>);
4376
+ /**
4377
+ * @description get company profile, industries classification and closest earning release
4378
+ * @tags CompanyProfile
4379
+ * @name GetCompanyProfile
4380
+ * @summary get company profile
4381
+ * @request GET:/company-profile
4382
+ * @secure
4383
+ */
4384
+ getCompanyProfile(query: {
4385
+ /** Company symbol */
4386
+ symbol: string;
4387
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCompanyProfile, HandleError>>;
4388
+ /**
4389
+ * @description get combined profile, equities and funds
4390
+ * @tags CompanyProfile
4391
+ * @name GetCombinedProfile
4392
+ * @summary get company profile
4393
+ * @request GET:/quote-profile
4394
+ * @secure
4395
+ */
4396
+ getCombinedProfile(query: {
4397
+ /** Company symbol */
4398
+ symbol: string;
4399
+ /** Desired symbol type - [ANY,FUND,EQUITY,INDEX] */
4400
+ symbol_type?: InsightGetCombinedProfileParamsSymbolTypeEnum;
4401
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCombinedProfileResponse, HandleError>>;
4402
+ /**
4403
+ * @description sort input array of symbols by type
4404
+ * @tags CompanyProfile
4405
+ * @name GetSymbolsPerSymbolType
4406
+ * @summary sort input array of symbols by type
4407
+ * @request POST:/symbols-per-type
4408
+ * @secure
4409
+ */
4410
+ getSymbolsPerSymbolType(input: InsightGetSymbolsPerTypeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolsPerTypeResponse, HandleError>>;
4411
+ }
4412
4412
  export class CustomLists<HandleError extends boolean = boolean> {
4413
4413
  protected readonly apiClient: JwtClient<HandleError>;
4414
4414
  constructor(apiClient: JwtClient<HandleError>);
@@ -4581,19 +4581,6 @@ export class Earnings<HandleError extends boolean = boolean> {
4581
4581
  */
4582
4582
  getEarningsCalendar(filter: InsightEarningReleasesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEarningReleasesResponse, HandleError>>;
4583
4583
  }
4584
- export class Fundamentals<HandleError extends boolean = boolean> {
4585
- protected readonly apiClient: JwtClient<HandleError>;
4586
- constructor(apiClient: JwtClient<HandleError>);
4587
- /**
4588
- * @description get fundamentals by symbol data
4589
- * @tags Fundamentals
4590
- * @name GetFundamentalsBySymbolData
4591
- * @summary get fundamentals by symbol data
4592
- * @request POST:/fundamentals
4593
- * @secure
4594
- */
4595
- getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
4596
- }
4597
4584
  export class FixedIncome<HandleError extends boolean = boolean> {
4598
4585
  protected readonly apiClient: JwtClient<HandleError>;
4599
4586
  constructor(apiClient: JwtClient<HandleError>);
@@ -4666,6 +4653,19 @@ export class FixedIncome<HandleError extends boolean = boolean> {
4666
4653
  */
4667
4654
  getSingleFixedIncomeEntry(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFixedIncome, HandleError>>;
4668
4655
  }
4656
+ export class Fundamentals<HandleError extends boolean = boolean> {
4657
+ protected readonly apiClient: JwtClient<HandleError>;
4658
+ constructor(apiClient: JwtClient<HandleError>);
4659
+ /**
4660
+ * @description get fundamentals by symbol data
4661
+ * @tags Fundamentals
4662
+ * @name GetFundamentalsBySymbolData
4663
+ * @summary get fundamentals by symbol data
4664
+ * @request POST:/fundamentals
4665
+ * @secure
4666
+ */
4667
+ getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
4668
+ }
4669
4669
  export class Funds<HandleError extends boolean = boolean> {
4670
4670
  protected readonly apiClient: JwtClient<HandleError>;
4671
4671
  constructor(apiClient: JwtClient<HandleError>);
@@ -5005,6 +5005,33 @@ export class PreIpoCompanies<HandleError extends boolean = boolean> {
5005
5005
  */
5006
5006
  getPreIpoCompanyResearchDocuments2(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyResearchDocument, HandleError>>;
5007
5007
  }
5008
+ export class Ipos<HandleError extends boolean = boolean> {
5009
+ protected readonly apiClient: JwtClient<HandleError>;
5010
+ constructor(apiClient: JwtClient<HandleError>);
5011
+ /**
5012
+ * @description get recent ipos info
5013
+ * @tags Ipos
5014
+ * @name PostRecent
5015
+ * @summary get recent ipos info
5016
+ * @request POST:/ipos/recent
5017
+ * @secure
5018
+ */
5019
+ postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
5020
+ /**
5021
+ * @description get upcoming ipos info
5022
+ * @tags Ipos
5023
+ * @name GetUpcoming
5024
+ * @summary get upcoming ipos info
5025
+ * @request GET:/ipos/upcoming
5026
+ * @secure
5027
+ */
5028
+ getUpcoming(query: {
5029
+ /** how many records to return. Max value is 50 */
5030
+ limit: number;
5031
+ /** how many records to skip */
5032
+ offset: number;
5033
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
5034
+ }
5008
5035
  export class Logos<HandleError extends boolean = boolean> {
5009
5036
  protected readonly apiClient: JwtClient<HandleError>;
5010
5037
  constructor(apiClient: JwtClient<HandleError>);
@@ -5105,6 +5132,53 @@ export class Logos<HandleError extends boolean = boolean> {
5105
5132
  symbol: string;
5106
5133
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse, HandleError>>;
5107
5134
  }
5135
+ export class MarketDates<HandleError extends boolean = boolean> {
5136
+ protected readonly apiClient: JwtClient<HandleError>;
5137
+ constructor(apiClient: JwtClient<HandleError>);
5138
+ /**
5139
+ * @description get market dates history
5140
+ * @tags MarketDates
5141
+ * @name GetMarketDatesHistory
5142
+ * @summary get market dates history
5143
+ * @request POST:/market-dates/history
5144
+ * @secure
5145
+ */
5146
+ getMarketDatesHistory(filter: InsightGetMarketDatesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketDatesResponse, HandleError>>;
5147
+ /**
5148
+ * @description get todays market hours
5149
+ * @tags MarketDates
5150
+ * @name GetTodaysMarketHours
5151
+ * @summary get todays market hours
5152
+ * @request GET:/market-dates/today
5153
+ * @secure
5154
+ */
5155
+ getTodaysMarketHours(query: {
5156
+ /** Market */
5157
+ market: string;
5158
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketHoursResponse, HandleError>>;
5159
+ }
5160
+ export class OptionGreeks<HandleError extends boolean = boolean> {
5161
+ protected readonly apiClient: JwtClient<HandleError>;
5162
+ constructor(apiClient: JwtClient<HandleError>);
5163
+ /**
5164
+ * @description Returns calculated matrix
5165
+ * @tags OptionGreeks
5166
+ * @name OgCalculateMatrix
5167
+ * @summary Calculate matrix
5168
+ * @request POST:/og/calculate-matrix
5169
+ * @secure
5170
+ */
5171
+ ogCalculateMatrix(filter: InsightCalculateMatrixParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateMatrixResponse, HandleError>>;
5172
+ /**
5173
+ * @description Returns calculated params
5174
+ * @tags OptionGreeks
5175
+ * @name OgCalculateParams
5176
+ * @summary Calculate params
5177
+ * @request POST:/og/calculate-params
5178
+ * @secure
5179
+ */
5180
+ ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
5181
+ }
5108
5182
  export class News<HandleError extends boolean = boolean> {
5109
5183
  protected readonly apiClient: JwtClient<HandleError>;
5110
5184
  constructor(apiClient: JwtClient<HandleError>);
@@ -5246,101 +5320,224 @@ export class News<HandleError extends boolean = boolean> {
5246
5320
  */
5247
5321
  newsAvailableTags(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
5248
5322
  }
5249
- export class Ipos<HandleError extends boolean = boolean> {
5323
+ export class Ownerships<HandleError extends boolean = boolean> {
5250
5324
  protected readonly apiClient: JwtClient<HandleError>;
5251
5325
  constructor(apiClient: JwtClient<HandleError>);
5252
5326
  /**
5253
- * @description get recent ipos info
5254
- * @tags Ipos
5255
- * @name PostRecent
5256
- * @summary get recent ipos info
5257
- * @request POST:/ipos/recent
5327
+ * @description get ownerships by id datadata
5328
+ * @tags Ownerships
5329
+ * @name GetOwnershipsByIdData
5330
+ * @summary get ownerships by id data
5331
+ * @request POST:/ownerships
5258
5332
  * @secure
5259
5333
  */
5260
- postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
5334
+ getOwnershipsByIdData(filter: InsightGetOwnershipsByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
5261
5335
  /**
5262
- * @description get upcoming ipos info
5263
- * @tags Ipos
5264
- * @name GetUpcoming
5265
- * @summary get upcoming ipos info
5266
- * @request GET:/ipos/upcoming
5336
+ * @description get ownerships by symbol data
5337
+ * @tags Ownerships
5338
+ * @name GetOwnershipsBySymbolData
5339
+ * @summary get ownerships by symbol data
5340
+ * @request POST:/symbol-ownerships
5267
5341
  * @secure
5268
5342
  */
5269
- getUpcoming(query: {
5270
- /** how many records to return. Max value is 50 */
5271
- limit: number;
5272
- /** how many records to skip */
5273
- offset: number;
5274
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
5343
+ getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
5275
5344
  }
5276
- export class MarketDates<HandleError extends boolean = boolean> {
5345
+ export class Public<HandleError extends boolean = boolean> {
5277
5346
  protected readonly apiClient: JwtClient<HandleError>;
5278
5347
  constructor(apiClient: JwtClient<HandleError>);
5279
5348
  /**
5280
- * @description get market dates history
5281
- * @tags MarketDates
5282
- * @name GetMarketDatesHistory
5283
- * @summary get market dates history
5284
- * @request POST:/market-dates/history
5349
+ * @description Calculate estimated returns for selected symbols. Uses split adjusted prices
5350
+ * @tags Public
5351
+ * @name CalculateEstimatedReturns
5352
+ * @summary Calculate Estimated Returns
5353
+ * @request GET:/public/estimated-returns
5285
5354
  * @secure
5286
5355
  */
5287
- getMarketDatesHistory(filter: InsightGetMarketDatesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketDatesResponse, HandleError>>;
5356
+ calculateEstimatedReturns(query: {
5357
+ /** Single symbol */
5358
+ symbol: string;
5359
+ /** Non-zero amount */
5360
+ amount: number;
5361
+ /** Start date for calculations */
5362
+ start_date: string;
5363
+ /** End date for calculations */
5364
+ end_date: string;
5365
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateEstimatedReturnsResponse, HandleError>>;
5288
5366
  /**
5289
- * @description get todays market hours
5290
- * @tags MarketDates
5291
- * @name GetTodaysMarketHours
5292
- * @summary get todays market hours
5293
- * @request GET:/market-dates/today
5367
+ * @description Returns an expert forecast
5368
+ * @tags Public
5369
+ * @name ExpertForecast
5370
+ * @summary Expert forecast
5371
+ * @request GET:/public/expert-forecast
5294
5372
  * @secure
5295
5373
  */
5296
- getTodaysMarketHours(query: {
5297
- /** Market */
5298
- market: string;
5299
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketHoursResponse, HandleError>>;
5300
- }
5301
- export class OptionGreeks<HandleError extends boolean = boolean> {
5302
- protected readonly apiClient: JwtClient<HandleError>;
5303
- constructor(apiClient: JwtClient<HandleError>);
5374
+ expertForecast(query: {
5375
+ /** Comma separated symbols */
5376
+ symbols: string;
5377
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError>>;
5304
5378
  /**
5305
- * @description Returns calculated matrix
5306
- * @tags OptionGreeks
5307
- * @name OgCalculateMatrix
5308
- * @summary Calculate matrix
5309
- * @request POST:/og/calculate-matrix
5379
+ * @description get fundamentals by symbol data
5380
+ * @tags Public
5381
+ * @name GetPublicFundamentalsBySymbolData
5382
+ * @summary get fundamentals by symbol data
5383
+ * @request GET:/public/fundamentals/{symbol}
5310
5384
  * @secure
5311
5385
  */
5312
- ogCalculateMatrix(filter: InsightCalculateMatrixParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateMatrixResponse, HandleError>>;
5386
+ getPublicFundamentalsBySymbolData(symbol: string, query: {
5387
+ /** Annual or quarterly */
5388
+ mode: string;
5389
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
5313
5390
  /**
5314
- * @description Returns calculated params
5315
- * @tags OptionGreeks
5316
- * @name OgCalculateParams
5317
- * @summary Calculate params
5318
- * @request POST:/og/calculate-params
5391
+ * @description Daily price history
5392
+ * @tags Public
5393
+ * @name DailyPriceHistory
5394
+ * @summary Daily price history
5395
+ * @request GET:/public/price-history/daily
5319
5396
  * @secure
5320
5397
  */
5321
- ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
5398
+ dailyPriceHistory(query: {
5399
+ /** Single symbol */
5400
+ symbol: string;
5401
+ /** Target date */
5402
+ date: string;
5403
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightDailyPriceHistoryResponse, HandleError>>;
5404
+ /**
5405
+ * @description Public quote profile
5406
+ * @tags Public
5407
+ * @name PublicQuoteProfile
5408
+ * @summary Public quote profile
5409
+ * @request GET:/public/quote-profile/{symbol}
5410
+ * @secure
5411
+ */
5412
+ publicQuoteProfile(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPublicQuoteProfile, HandleError>>;
5413
+ /**
5414
+ * @description get ratios by symbol data
5415
+ * @tags Public
5416
+ * @name GetPublicRatiosBySymbolData
5417
+ * @summary get ratios by symbol data
5418
+ * @request GET:/public/ratios/{symbol}
5419
+ * @secure
5420
+ */
5421
+ getPublicRatiosBySymbolData(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRatios, HandleError>>;
5422
+ /**
5423
+ * @description find a symbol by name or description
5424
+ * @tags Public
5425
+ * @name QuoteFundamentalsSearch
5426
+ * @summary find a symbol by name or description
5427
+ * @request GET:/public/symbol-search
5428
+ * @secure
5429
+ */
5430
+ quoteFundamentalsSearch(query: {
5431
+ /** Search query */
5432
+ search_query: string;
5433
+ /** how many records to return. Max value is 50 */
5434
+ limit: number;
5435
+ /** how many records to skip */
5436
+ offset: number;
5437
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteFundamentalsSearchResponse, HandleError>>;
5438
+ /**
5439
+ * @description Get top gainers
5440
+ * @tags Public
5441
+ * @name TopGainers
5442
+ * @summary Top Gainers
5443
+ * @request GET:/public/top-gainers
5444
+ * @secure
5445
+ */
5446
+ topGainers(query: {
5447
+ /** sort direction - asc or desc */
5448
+ order_direction?: string;
5449
+ /** how many records to return. Max value is 50 */
5450
+ limit: number;
5451
+ /** how many records to skip */
5452
+ offset: number;
5453
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
5454
+ /**
5455
+ * @description Get top stocks
5456
+ * @tags Public
5457
+ * @name TopStocks
5458
+ * @summary Top Stocks
5459
+ * @request GET:/public/top-stocks
5460
+ * @secure
5461
+ */
5462
+ topStocks(query: {
5463
+ /** EQUITY|ETF|CRYPTO */
5464
+ stock_type: InsightTopStocksParamsStockTypeEnum;
5465
+ /** how many records to return. Max value is 50 */
5466
+ limit: number;
5467
+ /** how many records to skip */
5468
+ offset: number;
5469
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
5322
5470
  }
5323
- export class AlphaTools<HandleError extends boolean = boolean> {
5471
+ export class UsageTracking<HandleError extends boolean = boolean> {
5324
5472
  protected readonly apiClient: JwtClient<HandleError>;
5325
5473
  constructor(apiClient: JwtClient<HandleError>);
5326
5474
  /**
5327
- * @description get seasonlity data with comparison to benchmark
5328
- * @tags AlphaTools
5329
- * @name GetMomentumRatioGraph
5330
- * @summary get seasonlity data
5331
- * @request POST:/rst
5475
+ * @description get usage date per branch for a period
5476
+ * @tags UsageTracking
5477
+ * @name GetUsageData
5478
+ * @summary get insight usage data
5479
+ * @request POST:/tracking/usage
5332
5480
  * @secure
5333
5481
  */
5334
- getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
5482
+ getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
5483
+ }
5484
+ export class Passport<HandleError extends boolean = boolean> {
5485
+ protected readonly apiClient: JwtClient<HandleError>;
5486
+ constructor(apiClient: JwtClient<HandleError>);
5335
5487
  /**
5336
- * @description get seasonlity data with comparison to benchmark
5337
- * @tags AlphaTools
5338
- * @name GetSeasonality
5339
- * @summary get seasonlity data
5340
- * @request POST:/seasonality
5488
+ * @description Returns article by id
5489
+ * @tags Passport
5490
+ * @name PassportArticleById
5491
+ * @summary Get article by id
5492
+ * @request POST:/passport/article-by-id
5341
5493
  * @secure
5342
5494
  */
5343
- getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
5495
+ passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError>>;
5496
+ /**
5497
+ * @description Returns articles
5498
+ * @tags Passport
5499
+ * @name PassportArticles
5500
+ * @summary Get articles
5501
+ * @request POST:/passport/articles
5502
+ * @secure
5503
+ */
5504
+ passportArticles(filter: InsightArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
5505
+ /**
5506
+ * @description Returns author profile
5507
+ * @tags Passport
5508
+ * @name PassportAuthorProfile
5509
+ * @summary Get author profile
5510
+ * @request POST:/passport/author-profile
5511
+ * @secure
5512
+ */
5513
+ passportAuthorProfile(filter: InsightAuthorProfileRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAuthorProfileResponse[], HandleError>>;
5514
+ /**
5515
+ * @description Returns most popular tags
5516
+ * @tags Passport
5517
+ * @name PassportMostPopularTags
5518
+ * @summary Get most popular tags
5519
+ * @request POST:/passport/most-popular-tags
5520
+ * @secure
5521
+ */
5522
+ passportMostPopularTags(filter: InsightMostPopularTagsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTagShortInfo[][], HandleError>>;
5523
+ /**
5524
+ * @description Returns news feed
5525
+ * @tags Passport
5526
+ * @name PassportNewsFeed
5527
+ * @summary Get news feed
5528
+ * @request POST:/passport/newsfeed
5529
+ * @secure
5530
+ */
5531
+ passportNewsFeed(filter: InsightNewsfeedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsfeed[][], HandleError>>;
5532
+ /**
5533
+ * @description Returns article by parameters
5534
+ * @tags Passport
5535
+ * @name PassportSearchArticle
5536
+ * @summary Search article by parameters
5537
+ * @request POST:/passport/search-article
5538
+ * @secure
5539
+ */
5540
+ passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
5344
5541
  }
5345
5542
  export class TipRank<HandleError extends boolean = boolean> {
5346
5543
  protected readonly apiClient: JwtClient<HandleError>;
@@ -5708,224 +5905,27 @@ export class TipRank<HandleError extends boolean = boolean> {
5708
5905
  Authorization?: string;
5709
5906
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTrendingStocksResponse[], HandleError>>;
5710
5907
  }
5711
- export class UsageTracking<HandleError extends boolean = boolean> {
5712
- protected readonly apiClient: JwtClient<HandleError>;
5713
- constructor(apiClient: JwtClient<HandleError>);
5714
- /**
5715
- * @description get usage date per branch for a period
5716
- * @tags UsageTracking
5717
- * @name GetUsageData
5718
- * @summary get insight usage data
5719
- * @request POST:/tracking/usage
5720
- * @secure
5721
- */
5722
- getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
5723
- }
5724
- export class Ownerships<HandleError extends boolean = boolean> {
5725
- protected readonly apiClient: JwtClient<HandleError>;
5726
- constructor(apiClient: JwtClient<HandleError>);
5727
- /**
5728
- * @description get ownerships by id datadata
5729
- * @tags Ownerships
5730
- * @name GetOwnershipsByIdData
5731
- * @summary get ownerships by id data
5732
- * @request POST:/ownerships
5733
- * @secure
5734
- */
5735
- getOwnershipsByIdData(filter: InsightGetOwnershipsByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
5736
- /**
5737
- * @description get ownerships by symbol data
5738
- * @tags Ownerships
5739
- * @name GetOwnershipsBySymbolData
5740
- * @summary get ownerships by symbol data
5741
- * @request POST:/symbol-ownerships
5742
- * @secure
5743
- */
5744
- getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
5745
- }
5746
- export class Public<HandleError extends boolean = boolean> {
5747
- protected readonly apiClient: JwtClient<HandleError>;
5748
- constructor(apiClient: JwtClient<HandleError>);
5749
- /**
5750
- * @description Calculate estimated returns for selected symbols. Uses split adjusted prices
5751
- * @tags Public
5752
- * @name CalculateEstimatedReturns
5753
- * @summary Calculate Estimated Returns
5754
- * @request GET:/public/estimated-returns
5755
- * @secure
5756
- */
5757
- calculateEstimatedReturns(query: {
5758
- /** Single symbol */
5759
- symbol: string;
5760
- /** Non-zero amount */
5761
- amount: number;
5762
- /** Start date for calculations */
5763
- start_date: string;
5764
- /** End date for calculations */
5765
- end_date: string;
5766
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateEstimatedReturnsResponse, HandleError>>;
5767
- /**
5768
- * @description Returns an expert forecast
5769
- * @tags Public
5770
- * @name ExpertForecast
5771
- * @summary Expert forecast
5772
- * @request GET:/public/expert-forecast
5773
- * @secure
5774
- */
5775
- expertForecast(query: {
5776
- /** Comma separated symbols */
5777
- symbols: string;
5778
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError>>;
5779
- /**
5780
- * @description get fundamentals by symbol data
5781
- * @tags Public
5782
- * @name GetPublicFundamentalsBySymbolData
5783
- * @summary get fundamentals by symbol data
5784
- * @request GET:/public/fundamentals/{symbol}
5785
- * @secure
5786
- */
5787
- getPublicFundamentalsBySymbolData(symbol: string, query: {
5788
- /** Annual or quarterly */
5789
- mode: string;
5790
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
5791
- /**
5792
- * @description Daily price history
5793
- * @tags Public
5794
- * @name DailyPriceHistory
5795
- * @summary Daily price history
5796
- * @request GET:/public/price-history/daily
5797
- * @secure
5798
- */
5799
- dailyPriceHistory(query: {
5800
- /** Single symbol */
5801
- symbol: string;
5802
- /** Target date */
5803
- date: string;
5804
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightDailyPriceHistoryResponse, HandleError>>;
5805
- /**
5806
- * @description Public quote profile
5807
- * @tags Public
5808
- * @name PublicQuoteProfile
5809
- * @summary Public quote profile
5810
- * @request GET:/public/quote-profile/{symbol}
5811
- * @secure
5812
- */
5813
- publicQuoteProfile(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPublicQuoteProfile, HandleError>>;
5814
- /**
5815
- * @description get ratios by symbol data
5816
- * @tags Public
5817
- * @name GetPublicRatiosBySymbolData
5818
- * @summary get ratios by symbol data
5819
- * @request GET:/public/ratios/{symbol}
5820
- * @secure
5821
- */
5822
- getPublicRatiosBySymbolData(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRatios, HandleError>>;
5823
- /**
5824
- * @description find a symbol by name or description
5825
- * @tags Public
5826
- * @name QuoteFundamentalsSearch
5827
- * @summary find a symbol by name or description
5828
- * @request GET:/public/symbol-search
5829
- * @secure
5830
- */
5831
- quoteFundamentalsSearch(query: {
5832
- /** Search query */
5833
- search_query: string;
5834
- /** how many records to return. Max value is 50 */
5835
- limit: number;
5836
- /** how many records to skip */
5837
- offset: number;
5838
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteFundamentalsSearchResponse, HandleError>>;
5839
- /**
5840
- * @description Get top gainers
5841
- * @tags Public
5842
- * @name TopGainers
5843
- * @summary Top Gainers
5844
- * @request GET:/public/top-gainers
5845
- * @secure
5846
- */
5847
- topGainers(query: {
5848
- /** sort direction - asc or desc */
5849
- order_direction?: string;
5850
- /** how many records to return. Max value is 50 */
5851
- limit: number;
5852
- /** how many records to skip */
5853
- offset: number;
5854
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
5855
- /**
5856
- * @description Get top stocks
5857
- * @tags Public
5858
- * @name TopStocks
5859
- * @summary Top Stocks
5860
- * @request GET:/public/top-stocks
5861
- * @secure
5862
- */
5863
- topStocks(query: {
5864
- /** EQUITY|ETF|CRYPTO */
5865
- stock_type: InsightTopStocksParamsStockTypeEnum;
5866
- /** how many records to return. Max value is 50 */
5867
- limit: number;
5868
- /** how many records to skip */
5869
- offset: number;
5870
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
5871
- }
5872
- export class Passport<HandleError extends boolean = boolean> {
5908
+ export class AlphaTools<HandleError extends boolean = boolean> {
5873
5909
  protected readonly apiClient: JwtClient<HandleError>;
5874
5910
  constructor(apiClient: JwtClient<HandleError>);
5875
5911
  /**
5876
- * @description Returns article by id
5877
- * @tags Passport
5878
- * @name PassportArticleById
5879
- * @summary Get article by id
5880
- * @request POST:/passport/article-by-id
5881
- * @secure
5882
- */
5883
- passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError>>;
5884
- /**
5885
- * @description Returns articles
5886
- * @tags Passport
5887
- * @name PassportArticles
5888
- * @summary Get articles
5889
- * @request POST:/passport/articles
5890
- * @secure
5891
- */
5892
- passportArticles(filter: InsightArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
5893
- /**
5894
- * @description Returns author profile
5895
- * @tags Passport
5896
- * @name PassportAuthorProfile
5897
- * @summary Get author profile
5898
- * @request POST:/passport/author-profile
5899
- * @secure
5900
- */
5901
- passportAuthorProfile(filter: InsightAuthorProfileRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAuthorProfileResponse[], HandleError>>;
5902
- /**
5903
- * @description Returns most popular tags
5904
- * @tags Passport
5905
- * @name PassportMostPopularTags
5906
- * @summary Get most popular tags
5907
- * @request POST:/passport/most-popular-tags
5908
- * @secure
5909
- */
5910
- passportMostPopularTags(filter: InsightMostPopularTagsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTagShortInfo[][], HandleError>>;
5911
- /**
5912
- * @description Returns news feed
5913
- * @tags Passport
5914
- * @name PassportNewsFeed
5915
- * @summary Get news feed
5916
- * @request POST:/passport/newsfeed
5912
+ * @description get seasonlity data with comparison to benchmark
5913
+ * @tags AlphaTools
5914
+ * @name GetMomentumRatioGraph
5915
+ * @summary get seasonlity data
5916
+ * @request POST:/rst
5917
5917
  * @secure
5918
5918
  */
5919
- passportNewsFeed(filter: InsightNewsfeedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsfeed[][], HandleError>>;
5919
+ getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
5920
5920
  /**
5921
- * @description Returns article by parameters
5922
- * @tags Passport
5923
- * @name PassportSearchArticle
5924
- * @summary Search article by parameters
5925
- * @request POST:/passport/search-article
5921
+ * @description get seasonlity data with comparison to benchmark
5922
+ * @tags AlphaTools
5923
+ * @name GetSeasonality
5924
+ * @summary get seasonlity data
5925
+ * @request POST:/seasonality
5926
5926
  * @secure
5927
5927
  */
5928
- passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
5928
+ getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
5929
5929
  }
5930
5930
  export interface InsightBeforeAndAfterV2 {
5931
5931
  after?: string;
@@ -6205,6 +6205,7 @@ export class InsightApi<HandleError extends boolean = false> extends BaseApi<Han
6205
6205
  optionGreeks: OptionGreeks<HandleError>;
6206
6206
  ownerships: Ownerships<HandleError>;
6207
6207
  passport: Passport<HandleError>;
6208
+ preIpoCompanies: PreIpoCompanies<HandleError>;
6208
6209
  public: Public<HandleError>;
6209
6210
  quotes: Quotes<HandleError>;
6210
6211
  stockScreener: StockScreener<HandleError>;