@orbis-systems/orbis-api-clients 0.7.10 → 0.7.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. package/dist/aesmidas/index.d.ts +114 -114
  2. package/dist/aesmidas/index.d.ts.map +1 -1
  3. package/dist/aesmidas/index.esm.js +1 -1
  4. package/dist/aesmidas/index.esm.js.map +1 -1
  5. package/dist/aesmidas/index.js +1 -1
  6. package/dist/aesmidas/index.js.map +1 -1
  7. package/dist/bridgewise/index.d.ts +500 -491
  8. package/dist/bridgewise/index.d.ts.map +1 -1
  9. package/dist/bridgewise/index.esm.js +1 -1
  10. package/dist/bridgewise/index.esm.js.map +1 -1
  11. package/dist/bridgewise/index.js +1 -1
  12. package/dist/bridgewise/index.js.map +1 -1
  13. package/dist/insight/index.d.ts +622 -544
  14. package/dist/insight/index.d.ts.map +1 -1
  15. package/dist/insight/index.esm.js +1 -1
  16. package/dist/insight/index.esm.js.map +1 -1
  17. package/dist/insight/index.js +1 -1
  18. package/dist/insight/index.js.map +1 -1
  19. package/dist/orbis/index.d.ts +1469 -1469
  20. package/dist/orbis/index.d.ts.map +1 -1
  21. package/dist/orbis/index.esm.js +1 -1
  22. package/dist/orbis/index.esm.js.map +1 -1
  23. package/dist/orbis/index.js +1 -1
  24. package/dist/orbis/index.js.map +1 -1
  25. package/dist/uma/index.d.ts +319 -319
  26. package/dist/uma/index.d.ts.map +1 -1
  27. package/dist/uma/index.esm.js +1 -1
  28. package/dist/uma/index.esm.js.map +1 -1
  29. package/dist/uma/index.js +1 -1
  30. package/dist/uma/index.js.map +1 -1
  31. package/dist/zerohash/index.d.ts +130 -130
  32. package/dist/zerohash/index.d.ts.map +1 -1
  33. package/dist/zerohash/index.esm.js +1 -1
  34. package/dist/zerohash/index.esm.js.map +1 -1
  35. package/dist/zerohash/index.js +1 -1
  36. package/dist/zerohash/index.js.map +1 -1
  37. package/package.json +1 -1
@@ -4277,6 +4277,42 @@ export enum InsightGetPreIpoCompanyResearchDocumentsParamsRelationEnum {
4277
4277
  CONNECTED = "CONNECTED"
4278
4278
  }
4279
4279
  /** search by monark stage */
4280
+ export enum InsightGetInvestorParamsMonarkStageEnum {
4281
+ DRAFT = "DRAFT",
4282
+ WAITING_MONARK_REVIEW = "WAITING_MONARK_REVIEW",
4283
+ FUND_ADMIN_REVIEW = "FUND_ADMIN_REVIEW",
4284
+ FUND_ADMIN_APPROVED = "FUND_ADMIN_APPROVED",
4285
+ PRIMARY_FUNDRAISE = "PRIMARY_FUNDRAISE",
4286
+ MONARK_DILIGENCE = "MONARK_DILIGENCE",
4287
+ PRE_CLOSE_REVIEW = "PRE_CLOSE_REVIEW",
4288
+ CLOSE_REQUESTED = "CLOSE_REQUESTED",
4289
+ CLOSE_IN_PROCESS = "CLOSE_IN_PROCESS",
4290
+ FUNDS_SENT_TO_TARGET = "FUNDS_SENT_TO_TARGET",
4291
+ CLOSED = "CLOSED",
4292
+ REGULATORY_HOLD_PERIOD = "REGULATORY_HOLD_PERIOD",
4293
+ ACTIVELY_TRADING = "ACTIVELY_TRADING",
4294
+ CLOSE_FAILED = "CLOSE_FAILED",
4295
+ HALTED = "HALTED",
4296
+ LIQUIDATION = "LIQUIDATION",
4297
+ DISSOLVED = "DISSOLVED"
4298
+ }
4299
+ /** sort direction */
4300
+ export enum InsightGetInvestorParamsSortOrderEnum {
4301
+ Ascending = "Ascending",
4302
+ Descending = "Descending"
4303
+ }
4304
+ /** sort field */
4305
+ export enum InsightGetInvestorParamsSortByEnum {
4306
+ UpdatedAt = "UpdatedAt",
4307
+ CreatedAt = "CreatedAt",
4308
+ Name = "Name",
4309
+ RemainingDollarAllocation = "RemainingDollarAllocation",
4310
+ RemainingShareAllocation = "RemainingShareAllocation",
4311
+ NumberOfSeatsRemaining = "NumberOfSeatsRemaining",
4312
+ Valuation = "Valuation",
4313
+ MinCommitmentAmount = "MinCommitmentAmount"
4314
+ }
4315
+ /** search by monark stage */
4280
4316
  export enum InsightGetPreIpoCompanySpvsParamsMonarkStageEnum {
4281
4317
  DRAFT = "DRAFT",
4282
4318
  WAITING_MONARK_REVIEW = "WAITING_MONARK_REVIEW",
@@ -4338,6 +4374,178 @@ export enum InsightTiprankInsidersLiveFeedParamsSortEnum {
4338
4374
  Date = "date",
4339
4375
  Rank = "rank"
4340
4376
  }
4377
+ export class CustomLists<HandleError extends boolean = boolean> {
4378
+ protected readonly apiClient: JwtClient<HandleError>;
4379
+ constructor(apiClient: JwtClient<HandleError>);
4380
+ /**
4381
+ * @description get custom lists
4382
+ * @tags Custom Lists
4383
+ * @name GetCustomLists
4384
+ * @summary get custom lists
4385
+ * @request GET:/custom-lists
4386
+ * @secure
4387
+ */
4388
+ getCustomLists(query: {
4389
+ /** how many records to return. Max value is 50 */
4390
+ limit: number;
4391
+ /** how many records to skip */
4392
+ offset: number;
4393
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
4394
+ /**
4395
+ * @description update custom list
4396
+ * @tags Custom Lists
4397
+ * @name UpdateCustomList
4398
+ * @summary update custom list
4399
+ * @request PUT:/custom-lists
4400
+ * @secure
4401
+ */
4402
+ updateCustomList(filter: InsightUpdateCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCustomIndex, HandleError>>;
4403
+ /**
4404
+ * @description create custom list
4405
+ * @tags Custom Lists
4406
+ * @name CreateCustomList
4407
+ * @summary create custom list
4408
+ * @request POST:/custom-lists
4409
+ * @secure
4410
+ */
4411
+ createCustomList(filter: InsightCreateCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCustomIndex, HandleError>>;
4412
+ /**
4413
+ * @description remove custom list
4414
+ * @tags Custom Lists
4415
+ * @name RemoveCustomList
4416
+ * @summary remove custom list
4417
+ * @request DELETE:/custom-lists
4418
+ * @secure
4419
+ */
4420
+ removeCustomList(filter: InsightRemoveCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4421
+ /**
4422
+ * @description filter custom lists
4423
+ * @tags Custom Lists
4424
+ * @name FilterCustomLists
4425
+ * @summary filter custom lists
4426
+ * @request POST:/custom-lists/filter
4427
+ * @secure
4428
+ */
4429
+ filterCustomLists(filter: InsightFilterCustomIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
4430
+ /**
4431
+ * @description get custom list with quotes
4432
+ * @tags Custom Lists
4433
+ * @name GetCustomListWithQuotes
4434
+ * @summary get custom list with quotes
4435
+ * @request GET:/custom-lists/{id-or-slug}
4436
+ * @secure
4437
+ */
4438
+ getCustomListWithQuotes(idOrSlug: string, query: {
4439
+ /** sort direction - asc or desc */
4440
+ order_direction: string;
4441
+ /** sort field - volume, symbol(alphabetical), market_cap, dividend_percent */
4442
+ order_field: string;
4443
+ /** how many equities records to return. Max value is 50 */
4444
+ limit: number;
4445
+ /** how many equities records to skip */
4446
+ offset: number;
4447
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
4448
+ /**
4449
+ * @description filter custom list
4450
+ * @tags Custom Lists
4451
+ * @name FilterCustomList
4452
+ * @summary filter custom list
4453
+ * @request GET:/custom-lists/{id-or-slug}/filter
4454
+ * @secure
4455
+ */
4456
+ filterCustomList(idOrSlug: string, query?: {
4457
+ /** symbols to check inclusion */
4458
+ symbols?: string[];
4459
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFilteredCustomIndexResponse, HandleError>>;
4460
+ }
4461
+ export class Earnings<HandleError extends boolean = boolean> {
4462
+ protected readonly apiClient: JwtClient<HandleError>;
4463
+ constructor(apiClient: JwtClient<HandleError>);
4464
+ /**
4465
+ * @description get earnings release dates for symbols
4466
+ * @tags Earnings
4467
+ * @name GetEarningsCalendar
4468
+ * @summary get earnings calendar data
4469
+ * @request POST:/earnings-calendar
4470
+ * @secure
4471
+ */
4472
+ getEarningsCalendar(filter: InsightEarningReleasesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEarningReleasesResponse, HandleError>>;
4473
+ }
4474
+ export class Dashboard<HandleError extends boolean = boolean> {
4475
+ protected readonly apiClient: JwtClient<HandleError>;
4476
+ constructor(apiClient: JwtClient<HandleError>);
4477
+ /**
4478
+ * @description get ownerships by symbol
4479
+ * @tags Dashboard
4480
+ * @name DashboardGetOwnershipsBySymbol
4481
+ * @summary get ownerships by symbol
4482
+ * @request POST:/dashboard/ownerships
4483
+ * @secure
4484
+ */
4485
+ dashboardGetOwnershipsBySymbol(filter: InsightGetOwnershipsBySymbolRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolAsDashboardFieldsResponse, HandleError>>;
4486
+ /**
4487
+ * @description rewrite field value
4488
+ * @tags Dashboard
4489
+ * @name RewriteFieldValue
4490
+ * @summary rewrite field value
4491
+ * @request POST:/rewrite-field
4492
+ * @secure
4493
+ */
4494
+ rewriteFieldValue(input: InsightRewriteFieldValueRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4495
+ /**
4496
+ * @description remove rewritten value
4497
+ * @tags Dashboard
4498
+ * @name CreateRewriteField
4499
+ * @summary remove rewritten value
4500
+ * @request DELETE:/rewrite-field
4501
+ * @secure
4502
+ */
4503
+ createRewriteField(input: InsightRemoveRewrittenFieldValueRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4504
+ /**
4505
+ * @description Get rewritten field action log
4506
+ * @tags Dashboard
4507
+ * @name GetRewrittenFieldActionLog
4508
+ * @summary get rewritten field action log
4509
+ * @request GET:/rewritten-field-action-log
4510
+ * @secure
4511
+ */
4512
+ getRewrittenFieldActionLog(query: {
4513
+ /** Internal UUID */
4514
+ internal_id: string;
4515
+ /** Field ID */
4516
+ field_id: string;
4517
+ /** how many records to return. Max value is 50 */
4518
+ limit: number;
4519
+ /** how many records to skip */
4520
+ offset: number;
4521
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4522
+ /**
4523
+ * @description Get rewritten values
4524
+ * @tags Dashboard
4525
+ * @name GetRewrittenValues
4526
+ * @summary get rewritten values
4527
+ * @request GET:/rewritten-fields
4528
+ * @secure
4529
+ */
4530
+ getRewrittenValues(query: {
4531
+ /** how many records to return. Max value is 50 */
4532
+ limit: number;
4533
+ /** how many records to skip */
4534
+ offset: number;
4535
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4536
+ /**
4537
+ * @description get symbol-related fields
4538
+ * @tags Dashboard
4539
+ * @name GetSymbolRelatedFields
4540
+ * @summary get symbol-related fields
4541
+ * @request GET:/symbol-related-fields
4542
+ * @secure
4543
+ */
4544
+ getSymbolRelatedFields(query: {
4545
+ /** Symbol */
4546
+ symbol: string;
4547
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolRelatedFieldsResponse, HandleError>>;
4548
+ }
4341
4549
  export class WorldMarkets<HandleError extends boolean = boolean> {
4342
4550
  protected readonly apiClient: JwtClient<HandleError>;
4343
4551
  constructor(apiClient: JwtClient<HandleError>);
@@ -4520,216 +4728,243 @@ export class WorldMarkets<HandleError extends boolean = boolean> {
4520
4728
  id: string;
4521
4729
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4522
4730
  }
4523
- export class CompanyProfile<HandleError extends boolean = boolean> {
4731
+ export class FixedIncome<HandleError extends boolean = boolean> {
4524
4732
  protected readonly apiClient: JwtClient<HandleError>;
4525
4733
  constructor(apiClient: JwtClient<HandleError>);
4526
4734
  /**
4527
- * @description get company profile, industries classification and closest earning release
4528
- * @tags CompanyProfile
4529
- * @name GetCompanyProfile
4530
- * @summary get company profile
4531
- * @request GET:/company-profile
4532
- * @secure
4533
- */
4534
- getCompanyProfile(query: {
4535
- /** Company symbol */
4536
- symbol: string;
4537
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCompanyProfile, HandleError>>;
4538
- /**
4539
- * @description get combined profile, equities and funds
4540
- * @tags CompanyProfile
4541
- * @name GetCombinedProfile
4542
- * @summary get company profile
4543
- * @request GET:/quote-profile
4735
+ * @description get fixed income entries
4736
+ * @tags FixedIncome
4737
+ * @name GetFixedIncomeEntries
4738
+ * @summary get fixed income entries
4739
+ * @request POST:/fixed-income
4544
4740
  * @secure
4545
4741
  */
4546
- getCombinedProfile(query: {
4547
- /** Company symbol */
4548
- symbol: string;
4549
- /** Desired symbol type - [ANY,FUND,EQUITY,INDEX] */
4550
- symbol_type?: InsightGetCombinedProfileParamsSymbolTypeEnum;
4551
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCombinedProfileResponse, HandleError>>;
4742
+ getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponse, HandleError>>;
4552
4743
  /**
4553
- * @description sort input array of symbols by type
4554
- * @tags CompanyProfile
4555
- * @name GetSymbolsPerSymbolType
4556
- * @summary sort input array of symbols by type
4557
- * @request POST:/symbols-per-type
4744
+ * @description Returns historical fixed income
4745
+ * @tags FixedIncome
4746
+ * @name FixedIncomeHistorical
4747
+ * @summary Get historical fixed income
4748
+ * @request POST:/fixed-income/historical
4558
4749
  * @secure
4559
4750
  */
4560
- getSymbolsPerSymbolType(input: InsightGetSymbolsPerTypeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolsPerTypeResponse, HandleError>>;
4561
- }
4562
- export class CustomLists<HandleError extends boolean = boolean> {
4563
- protected readonly apiClient: JwtClient<HandleError>;
4564
- constructor(apiClient: JwtClient<HandleError>);
4751
+ fixedIncomeHistorical(filter: InsightGetFixedIncomeHistoricalRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeHistoricalResponse, HandleError>>;
4565
4752
  /**
4566
- * @description get custom lists
4567
- * @tags Custom Lists
4568
- * @name GetCustomLists
4569
- * @summary get custom lists
4570
- * @request GET:/custom-lists
4753
+ * @description get fixed-income presets
4754
+ * @tags FixedIncome
4755
+ * @name GetFixedIncomePresets
4756
+ * @summary get fixed-income presets
4757
+ * @request GET:/fixed-income/presets
4571
4758
  * @secure
4572
4759
  */
4573
- getCustomLists(query: {
4574
- /** how many records to return. Max value is 50 */
4760
+ getFixedIncomePresets(query: {
4761
+ /** how many records to return */
4575
4762
  limit: number;
4576
4763
  /** how many records to skip */
4577
4764
  offset: number;
4578
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
4765
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
4579
4766
  /**
4580
- * @description update custom list
4581
- * @tags Custom Lists
4582
- * @name UpdateCustomList
4583
- * @summary update custom list
4584
- * @request PUT:/custom-lists
4767
+ * @description update fixed-income preset
4768
+ * @tags FixedIncome
4769
+ * @name UpdateFixedIncomePreset
4770
+ * @summary update fixed-income preset
4771
+ * @request PUT:/fixed-income/presets
4585
4772
  * @secure
4586
4773
  */
4587
- updateCustomList(filter: InsightUpdateCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCustomIndex, HandleError>>;
4774
+ updateFixedIncomePreset(input: InsightCreateOrUpdateFixedIncomePresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
4588
4775
  /**
4589
- * @description create custom list
4590
- * @tags Custom Lists
4591
- * @name CreateCustomList
4592
- * @summary create custom list
4593
- * @request POST:/custom-lists
4776
+ * @description create fixed-income preset
4777
+ * @tags FixedIncome
4778
+ * @name CreateFixedIncomePreset
4779
+ * @summary create fixed-income preset
4780
+ * @request POST:/fixed-income/presets
4594
4781
  * @secure
4595
4782
  */
4596
- createCustomList(filter: InsightCreateCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCustomIndex, HandleError>>;
4783
+ createFixedIncomePreset(input: InsightCreateOrUpdateFixedIncomePresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
4597
4784
  /**
4598
- * @description remove custom list
4599
- * @tags Custom Lists
4600
- * @name RemoveCustomList
4601
- * @summary remove custom list
4602
- * @request DELETE:/custom-lists
4785
+ * @description remove fixed-income preset
4786
+ * @tags FixedIncome
4787
+ * @name RemoveFixedIncomePreset
4788
+ * @summary remove fixed-income preset
4789
+ * @request DELETE:/fixed-income/presets
4603
4790
  * @secure
4604
4791
  */
4605
- removeCustomList(filter: InsightRemoveCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4792
+ removeFixedIncomePreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4606
4793
  /**
4607
- * @description filter custom lists
4608
- * @tags Custom Lists
4609
- * @name FilterCustomLists
4610
- * @summary filter custom lists
4611
- * @request POST:/custom-lists/filter
4794
+ * @description get single fixed income entry
4795
+ * @tags FixedIncome
4796
+ * @name GetSingleFixedIncomeEntry
4797
+ * @summary get single fixed income entry
4798
+ * @request GET:/fixed-income/{id}
4612
4799
  * @secure
4613
4800
  */
4614
- filterCustomLists(filter: InsightFilterCustomIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
4801
+ getSingleFixedIncomeEntry(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFixedIncome, HandleError>>;
4802
+ }
4803
+ export class CompanyProfile<HandleError extends boolean = boolean> {
4804
+ protected readonly apiClient: JwtClient<HandleError>;
4805
+ constructor(apiClient: JwtClient<HandleError>);
4615
4806
  /**
4616
- * @description get custom list with quotes
4617
- * @tags Custom Lists
4618
- * @name GetCustomListWithQuotes
4619
- * @summary get custom list with quotes
4620
- * @request GET:/custom-lists/{id-or-slug}
4807
+ * @description get company profile, industries classification and closest earning release
4808
+ * @tags CompanyProfile
4809
+ * @name GetCompanyProfile
4810
+ * @summary get company profile
4811
+ * @request GET:/company-profile
4621
4812
  * @secure
4622
4813
  */
4623
- getCustomListWithQuotes(idOrSlug: string, query: {
4624
- /** sort direction - asc or desc */
4625
- order_direction: string;
4626
- /** sort field - volume, symbol(alphabetical), market_cap, dividend_percent */
4627
- order_field: string;
4628
- /** how many equities records to return. Max value is 50 */
4629
- limit: number;
4630
- /** how many equities records to skip */
4631
- offset: number;
4632
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
4814
+ getCompanyProfile(query: {
4815
+ /** Company symbol */
4816
+ symbol: string;
4817
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCompanyProfile, HandleError>>;
4633
4818
  /**
4634
- * @description filter custom list
4635
- * @tags Custom Lists
4636
- * @name FilterCustomList
4637
- * @summary filter custom list
4638
- * @request GET:/custom-lists/{id-or-slug}/filter
4819
+ * @description get combined profile, equities and funds
4820
+ * @tags CompanyProfile
4821
+ * @name GetCombinedProfile
4822
+ * @summary get company profile
4823
+ * @request GET:/quote-profile
4639
4824
  * @secure
4640
4825
  */
4641
- filterCustomList(idOrSlug: string, query?: {
4642
- /** symbols to check inclusion */
4643
- symbols?: string[];
4644
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFilteredCustomIndexResponse, HandleError>>;
4826
+ getCombinedProfile(query: {
4827
+ /** Company symbol */
4828
+ symbol: string;
4829
+ /** Desired symbol type - [ANY,FUND,EQUITY,INDEX] */
4830
+ symbol_type?: InsightGetCombinedProfileParamsSymbolTypeEnum;
4831
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCombinedProfileResponse, HandleError>>;
4832
+ /**
4833
+ * @description sort input array of symbols by type
4834
+ * @tags CompanyProfile
4835
+ * @name GetSymbolsPerSymbolType
4836
+ * @summary sort input array of symbols by type
4837
+ * @request POST:/symbols-per-type
4838
+ * @secure
4839
+ */
4840
+ getSymbolsPerSymbolType(input: InsightGetSymbolsPerTypeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolsPerTypeResponse, HandleError>>;
4645
4841
  }
4646
- export class Dashboard<HandleError extends boolean = boolean> {
4842
+ export class Fundamentals<HandleError extends boolean = boolean> {
4647
4843
  protected readonly apiClient: JwtClient<HandleError>;
4648
4844
  constructor(apiClient: JwtClient<HandleError>);
4649
4845
  /**
4650
- * @description get ownerships by symbol
4651
- * @tags Dashboard
4652
- * @name DashboardGetOwnershipsBySymbol
4653
- * @summary get ownerships by symbol
4654
- * @request POST:/dashboard/ownerships
4846
+ * @description get fundamentals by symbol data
4847
+ * @tags Fundamentals
4848
+ * @name GetFundamentalsBySymbolData
4849
+ * @summary get fundamentals by symbol data
4850
+ * @request POST:/fundamentals
4655
4851
  * @secure
4656
4852
  */
4657
- dashboardGetOwnershipsBySymbol(filter: InsightGetOwnershipsBySymbolRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolAsDashboardFieldsResponse, HandleError>>;
4853
+ getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
4854
+ }
4855
+ export class Funds<HandleError extends boolean = boolean> {
4856
+ protected readonly apiClient: JwtClient<HandleError>;
4857
+ constructor(apiClient: JwtClient<HandleError>);
4658
4858
  /**
4659
- * @description rewrite field value
4660
- * @tags Dashboard
4661
- * @name RewriteFieldValue
4662
- * @summary rewrite field value
4663
- * @request POST:/rewrite-field
4859
+ * @description get fund details
4860
+ * @tags Funds
4861
+ * @name GetFundDetails
4862
+ * @summary get fund details
4863
+ * @request GET:/funds/details
4664
4864
  * @secure
4665
4865
  */
4666
- rewriteFieldValue(input: InsightRewriteFieldValueRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4866
+ getFundDetails(query: {
4867
+ /** Fund symbol */
4868
+ symbol: string;
4869
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundDetailsResponse, HandleError>>;
4667
4870
  /**
4668
- * @description remove rewritten value
4669
- * @tags Dashboard
4670
- * @name CreateRewriteField
4671
- * @summary remove rewritten value
4672
- * @request DELETE:/rewrite-field
4871
+ * @description get funds for holding
4872
+ * @tags Funds
4873
+ * @name GetFundsForHolding
4874
+ * @summary get funds for holding
4875
+ * @request POST:/funds/funds-for-holding
4673
4876
  * @secure
4674
4877
  */
4675
- createRewriteField(input: InsightRemoveRewrittenFieldValueRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4878
+ getFundsForHolding(filter: InsightGetFundsForHoldingRequest, headers?: {
4879
+ /** Authorization */
4880
+ Authorization?: string;
4881
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundsForHoldingResponse, HandleError>>;
4676
4882
  /**
4677
- * @description Get rewritten field action log
4678
- * @tags Dashboard
4679
- * @name GetRewrittenFieldActionLog
4680
- * @summary get rewritten field action log
4681
- * @request GET:/rewritten-field-action-log
4883
+ * @description filter funds by params
4884
+ * @tags Funds
4885
+ * @name FundScreener
4886
+ * @summary filter funds by params
4887
+ * @request POST:/funds/screener
4682
4888
  * @secure
4683
4889
  */
4684
- getRewrittenFieldActionLog(query: {
4685
- /** Internal UUID */
4686
- internal_id: string;
4687
- /** Field ID */
4688
- field_id: string;
4689
- /** how many records to return. Max value is 50 */
4690
- limit: number;
4691
- /** how many records to skip */
4692
- offset: number;
4693
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4890
+ fundScreener(filter: InsightFundScreenerRequest, headers?: {
4891
+ /** Authorization */
4892
+ Authorization?: string;
4893
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFundScreenerResponse, HandleError>>;
4694
4894
  /**
4695
- * @description Get rewritten values
4696
- * @tags Dashboard
4697
- * @name GetRewrittenValues
4698
- * @summary get rewritten values
4699
- * @request GET:/rewritten-fields
4895
+ * @description get fund screener filters
4896
+ * @tags Funds
4897
+ * @name GetScreenerFilters
4898
+ * @summary get fund screener filters
4899
+ * @request GET:/funds/screener/filters
4700
4900
  * @secure
4701
4901
  */
4702
- getRewrittenValues(query: {
4703
- /** how many records to return. Max value is 50 */
4902
+ getScreenerFilters(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundScreenerFiltersResponse, HandleError>>;
4903
+ /**
4904
+ * @description get fund screener presets
4905
+ * @tags Funds
4906
+ * @name GetFundScreenerPresets
4907
+ * @summary get fund screener presets
4908
+ * @request GET:/funds/screener/presets
4909
+ * @secure
4910
+ */
4911
+ getFundScreenerPresets(query: {
4912
+ /** how many records to return */
4704
4913
  limit: number;
4705
4914
  /** how many records to skip */
4706
4915
  offset: number;
4707
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4916
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
4708
4917
  /**
4709
- * @description get symbol-related fields
4710
- * @tags Dashboard
4711
- * @name GetSymbolRelatedFields
4712
- * @summary get symbol-related fields
4713
- * @request GET:/symbol-related-fields
4918
+ * @description update fund screener preset
4919
+ * @tags Funds
4920
+ * @name UpdateFundScreenerPreset
4921
+ * @summary update fund screener preset
4922
+ * @request PUT:/funds/screener/presets
4714
4923
  * @secure
4715
4924
  */
4716
- getSymbolRelatedFields(query: {
4717
- /** Symbol */
4718
- symbol: string;
4719
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolRelatedFieldsResponse, HandleError>>;
4720
- }
4721
- export class Earnings<HandleError extends boolean = boolean> {
4722
- protected readonly apiClient: JwtClient<HandleError>;
4723
- constructor(apiClient: JwtClient<HandleError>);
4925
+ updateFundScreenerPreset(input: InsightCreateOrUpdateFundScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
4724
4926
  /**
4725
- * @description get earnings release dates for symbols
4726
- * @tags Earnings
4727
- * @name GetEarningsCalendar
4728
- * @summary get earnings calendar data
4729
- * @request POST:/earnings-calendar
4927
+ * @description create fund screener preset
4928
+ * @tags Funds
4929
+ * @name CreateFundScreenerPreset
4930
+ * @summary create fund screener preset
4931
+ * @request POST:/funds/screener/presets
4730
4932
  * @secure
4731
4933
  */
4732
- getEarningsCalendar(filter: InsightEarningReleasesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEarningReleasesResponse, HandleError>>;
4934
+ createFundScreenerPreset(input: InsightCreateOrUpdateFundScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
4935
+ /**
4936
+ * @description remove fund screener preset
4937
+ * @tags Funds
4938
+ * @name RemoveFundScreenerPreset
4939
+ * @summary remove fund screener preset
4940
+ * @request DELETE:/funds/screener/presets
4941
+ * @secure
4942
+ */
4943
+ removeFundScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4944
+ /**
4945
+ * @description filter funds by params
4946
+ * @tags Funds
4947
+ * @name FundSectorScreener
4948
+ * @summary filter funds by params
4949
+ * @request POST:/funds/sector-screener
4950
+ * @secure
4951
+ */
4952
+ fundSectorScreener(filter: InsightFundSectorScreenerRequest, headers?: {
4953
+ /** Authorization */
4954
+ Authorization?: string;
4955
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFundScreenerResponse, HandleError>>;
4956
+ /**
4957
+ * @description get top funds
4958
+ * @tags Funds
4959
+ * @name GetTopFunds
4960
+ * @summary get top funds
4961
+ * @request POST:/funds/top
4962
+ * @secure
4963
+ */
4964
+ getTopFunds(filter: InsightGetTopFundsRequest, headers?: {
4965
+ /** Authorization */
4966
+ Authorization?: string;
4967
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetTopFundsResponse, HandleError>>;
4733
4968
  }
4734
4969
  export class StockScreener<HandleError extends boolean = boolean> {
4735
4970
  protected readonly apiClient: JwtClient<HandleError>;
@@ -4883,7 +5118,7 @@ export class PreIpoCompanies<HandleError extends boolean = boolean> {
4883
5118
  protected readonly apiClient: JwtClient<HandleError>;
4884
5119
  constructor(apiClient: JwtClient<HandleError>);
4885
5120
  /**
4886
- * @description Retrieves OHLC (Open, High, Low, Close) market data for a given symbola
5121
+ * @description Retrieves OHLC (Open, High, Low, Close) market data for a given symbol
4887
5122
  * @tags PreIPOCompanies
4888
5123
  * @name MonarkOghlcDataForSymbol
4889
5124
  * @summary Retrieves OHLC (Open, High, Low, Close) market data for a given symbol
@@ -5069,6 +5304,48 @@ export class PreIpoCompanies<HandleError extends boolean = boolean> {
5069
5304
  * @secure
5070
5305
  */
5071
5306
  getPreIpoCompanyResearchDocumentsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyResearchDocument, HandleError>>;
5307
+ /**
5308
+ * @description get pre ipo company spvs
5309
+ * @tags PreIPOCompanies
5310
+ * @name GetInvestor
5311
+ * @summary get pre ipo company spvs
5312
+ * @request GET:/ipos/pre-ipo-company-spv/investor/{investor_id}
5313
+ * @secure
5314
+ */
5315
+ getInvestor(investorId: string, query: {
5316
+ /** search by monark stage */
5317
+ monark_stage?: InsightGetInvestorParamsMonarkStageEnum;
5318
+ /** Optional param to filter returned spv's based on the exemptions claimed */
5319
+ exemptions_claimed?: string[];
5320
+ /** Optional param to filter returned spv's based on the name */
5321
+ name_filter?: string;
5322
+ /** investment id */
5323
+ pre_ipo_company_id?: string;
5324
+ /** investment id */
5325
+ pre_ipo_company_investment_id?: string;
5326
+ /** page number */
5327
+ page: number;
5328
+ /** page size */
5329
+ page_size: number;
5330
+ /** sort direction */
5331
+ sort_order?: InsightGetInvestorParamsSortOrderEnum;
5332
+ /** sort field */
5333
+ sort_by?: InsightGetInvestorParamsSortByEnum;
5334
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsResponse, HandleError>>;
5335
+ /**
5336
+ * @description get pre ipo company spv by id
5337
+ * @tags PreIPOCompanies
5338
+ * @name GetInvestorByIdAndInvestorId
5339
+ * @summary get pre ipo company spv by id
5340
+ * @request GET:/ipos/pre-ipo-company-spv/{id}/investor/{investor_id}
5341
+ * @originalName getInvestor
5342
+ * @duplicate
5343
+ * @secure
5344
+ */
5345
+ getInvestorByIdAndInvestorId(id: string, investorId: string, query?: {
5346
+ /** default is false, if true documents will be included in the response */
5347
+ include_documents?: boolean;
5348
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanySPV, HandleError>>;
5072
5349
  /**
5073
5350
  * @description get pre ipo company spvs
5074
5351
  * @tags PreIPOCompanies
@@ -5112,47 +5389,6 @@ export class PreIpoCompanies<HandleError extends boolean = boolean> {
5112
5389
  include_documents?: boolean;
5113
5390
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanySPV, HandleError>>;
5114
5391
  }
5115
- export class Ipos<HandleError extends boolean = boolean> {
5116
- protected readonly apiClient: JwtClient<HandleError>;
5117
- constructor(apiClient: JwtClient<HandleError>);
5118
- /**
5119
- * @description get recent ipos info
5120
- * @tags Ipos
5121
- * @name PostRecent
5122
- * @summary get recent ipos info
5123
- * @request POST:/ipos/recent
5124
- * @secure
5125
- */
5126
- postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
5127
- /**
5128
- * @description get upcoming ipos info
5129
- * @tags Ipos
5130
- * @name GetUpcoming
5131
- * @summary get upcoming ipos info
5132
- * @request GET:/ipos/upcoming
5133
- * @secure
5134
- */
5135
- getUpcoming(query: {
5136
- /** how many records to return. Max value is 50 */
5137
- limit: number;
5138
- /** how many records to skip */
5139
- offset: number;
5140
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
5141
- /**
5142
- * @description get ipo info by symbol
5143
- * @tags Ipos
5144
- * @name GetIpos
5145
- * @summary get ipo info by symbol
5146
- * @request GET:/ipos/{symbol}
5147
- * @secure
5148
- */
5149
- getIpos(symbol: string, query?: {
5150
- /** load quotes */
5151
- load_quotes?: boolean;
5152
- /** statuses */
5153
- statuses?: string[];
5154
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOResponse, HandleError>>;
5155
- }
5156
5392
  export class Logos<HandleError extends boolean = boolean> {
5157
5393
  protected readonly apiClient: JwtClient<HandleError>;
5158
5394
  constructor(apiClient: JwtClient<HandleError>);
@@ -5241,17 +5477,58 @@ export class Logos<HandleError extends boolean = boolean> {
5241
5477
  symbol: string;
5242
5478
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolSocialsResponse, HandleError>>;
5243
5479
  /**
5244
- * @description Returns logos for company symbol
5245
- * @tags Logos
5246
- * @name LogosSymbolLogos
5247
- * @summary Get symbol logos
5248
- * @request GET:/logos/symbol-logos
5480
+ * @description Returns logos for company symbol
5481
+ * @tags Logos
5482
+ * @name LogosSymbolLogos
5483
+ * @summary Get symbol logos
5484
+ * @request GET:/logos/symbol-logos
5485
+ * @secure
5486
+ */
5487
+ logosSymbolLogos(query: {
5488
+ /** Company symbol */
5489
+ symbol: string;
5490
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse, HandleError>>;
5491
+ }
5492
+ export class Ipos<HandleError extends boolean = boolean> {
5493
+ protected readonly apiClient: JwtClient<HandleError>;
5494
+ constructor(apiClient: JwtClient<HandleError>);
5495
+ /**
5496
+ * @description get recent ipos info
5497
+ * @tags Ipos
5498
+ * @name PostRecent
5499
+ * @summary get recent ipos info
5500
+ * @request POST:/ipos/recent
5501
+ * @secure
5502
+ */
5503
+ postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
5504
+ /**
5505
+ * @description get upcoming ipos info
5506
+ * @tags Ipos
5507
+ * @name GetUpcoming
5508
+ * @summary get upcoming ipos info
5509
+ * @request GET:/ipos/upcoming
5510
+ * @secure
5511
+ */
5512
+ getUpcoming(query: {
5513
+ /** how many records to return. Max value is 50 */
5514
+ limit: number;
5515
+ /** how many records to skip */
5516
+ offset: number;
5517
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
5518
+ /**
5519
+ * @description get ipo info by symbol
5520
+ * @tags Ipos
5521
+ * @name GetIpos
5522
+ * @summary get ipo info by symbol
5523
+ * @request GET:/ipos/{symbol}
5249
5524
  * @secure
5250
5525
  */
5251
- logosSymbolLogos(query: {
5252
- /** Company symbol */
5253
- symbol: string;
5254
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse, HandleError>>;
5526
+ getIpos(symbol: string, query?: {
5527
+ /** load quotes */
5528
+ load_quotes?: boolean;
5529
+ /** statuses */
5530
+ statuses?: string[];
5531
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOResponse, HandleError>>;
5255
5532
  }
5256
5533
  export class MarketDates<HandleError extends boolean = boolean> {
5257
5534
  protected readonly apiClient: JwtClient<HandleError>;
@@ -5356,294 +5633,73 @@ export class News<HandleError extends boolean = boolean> {
5356
5633
  /**
5357
5634
  * @description Get featured article
5358
5635
  * @tags News
5359
- * @name GetFeaturedArticle
5360
- * @summary Get featured article
5361
- * @request GET:/news/featured-articles/{id}
5362
- * @secure
5363
- */
5364
- getFeaturedArticle(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFeaturedArticle, HandleError>>;
5365
- /**
5366
- * @description Returns news by filters
5367
- * @tags News
5368
- * @name NewsFiltered
5369
- * @summary Get filtered news
5370
- * @request POST:/news/filter
5371
- * @secure
5372
- */
5373
- newsFiltered(filter: InsightNewsFilterRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsResponse, HandleError>>;
5374
- /**
5375
- * @description Returns news by id
5376
- * @tags News
5377
- * @name NewsById
5378
- * @summary Get news by id
5379
- * @request POST:/news/id
5380
- * @secure
5381
- */
5382
- newsById(filter: InsightNewsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNews, HandleError>>;
5383
- /**
5384
- * @description Returns news previews
5385
- * @tags News
5386
- * @name NewsPreviewsFiltered
5387
- * @summary Get news previews
5388
- * @request GET:/news/previews
5389
- * @secure
5390
- */
5391
- newsPreviewsFiltered(query: {
5392
- /** Start date */
5393
- start_date?: string;
5394
- /** End date */
5395
- end_date?: string;
5396
- /** Symbol */
5397
- symbol?: string;
5398
- /** how many records to return. Max value is 50 */
5399
- limit: number;
5400
- /** how many records to skip */
5401
- offset: number;
5402
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRecentNewsPreviewsResponse, HandleError>>;
5403
- /**
5404
- * @description Returns available stocks in DB
5405
- * @tags News
5406
- * @name NewsAvailableStocks
5407
- * @summary Get available stocks in DB (for filters)
5408
- * @request GET:/news/symbols
5409
- * @secure
5410
- */
5411
- newsAvailableStocks(query?: {
5412
- /** Limit */
5413
- limit?: number;
5414
- /** Offset */
5415
- offset?: number;
5416
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
5417
- /**
5418
- * @description Returns available tags in DB
5419
- * @tags News
5420
- * @name NewsAvailableTags
5421
- * @summary Get available tags in DB (for filters)
5422
- * @request POST:/news/tags
5423
- * @secure
5424
- */
5425
- newsAvailableTags(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
5426
- }
5427
- export class OptionGreeks<HandleError extends boolean = boolean> {
5428
- protected readonly apiClient: JwtClient<HandleError>;
5429
- constructor(apiClient: JwtClient<HandleError>);
5430
- /**
5431
- * @description Returns calculated matrix
5432
- * @tags OptionGreeks
5433
- * @name OgCalculateMatrix
5434
- * @summary Calculate matrix
5435
- * @request POST:/og/calculate-matrix
5436
- * @secure
5437
- */
5438
- ogCalculateMatrix(filter: InsightCalculateMatrixParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateMatrixResponse, HandleError>>;
5439
- /**
5440
- * @description Returns calculated params
5441
- * @tags OptionGreeks
5442
- * @name OgCalculateParams
5443
- * @summary Calculate params
5444
- * @request POST:/og/calculate-params
5445
- * @secure
5446
- */
5447
- ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
5448
- }
5449
- export class FixedIncome<HandleError extends boolean = boolean> {
5450
- protected readonly apiClient: JwtClient<HandleError>;
5451
- constructor(apiClient: JwtClient<HandleError>);
5452
- /**
5453
- * @description get fixed income entries
5454
- * @tags FixedIncome
5455
- * @name GetFixedIncomeEntries
5456
- * @summary get fixed income entries
5457
- * @request POST:/fixed-income
5458
- * @secure
5459
- */
5460
- getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponse, HandleError>>;
5461
- /**
5462
- * @description Returns historical fixed income
5463
- * @tags FixedIncome
5464
- * @name FixedIncomeHistorical
5465
- * @summary Get historical fixed income
5466
- * @request POST:/fixed-income/historical
5467
- * @secure
5468
- */
5469
- fixedIncomeHistorical(filter: InsightGetFixedIncomeHistoricalRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeHistoricalResponse, HandleError>>;
5470
- /**
5471
- * @description get fixed-income presets
5472
- * @tags FixedIncome
5473
- * @name GetFixedIncomePresets
5474
- * @summary get fixed-income presets
5475
- * @request GET:/fixed-income/presets
5476
- * @secure
5477
- */
5478
- getFixedIncomePresets(query: {
5479
- /** how many records to return */
5480
- limit: number;
5481
- /** how many records to skip */
5482
- offset: number;
5483
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
5484
- /**
5485
- * @description update fixed-income preset
5486
- * @tags FixedIncome
5487
- * @name UpdateFixedIncomePreset
5488
- * @summary update fixed-income preset
5489
- * @request PUT:/fixed-income/presets
5490
- * @secure
5491
- */
5492
- updateFixedIncomePreset(input: InsightCreateOrUpdateFixedIncomePresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
5493
- /**
5494
- * @description create fixed-income preset
5495
- * @tags FixedIncome
5496
- * @name CreateFixedIncomePreset
5497
- * @summary create fixed-income preset
5498
- * @request POST:/fixed-income/presets
5499
- * @secure
5500
- */
5501
- createFixedIncomePreset(input: InsightCreateOrUpdateFixedIncomePresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
5502
- /**
5503
- * @description remove fixed-income preset
5504
- * @tags FixedIncome
5505
- * @name RemoveFixedIncomePreset
5506
- * @summary remove fixed-income preset
5507
- * @request DELETE:/fixed-income/presets
5508
- * @secure
5509
- */
5510
- removeFixedIncomePreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5511
- /**
5512
- * @description get single fixed income entry
5513
- * @tags FixedIncome
5514
- * @name GetSingleFixedIncomeEntry
5515
- * @summary get single fixed income entry
5516
- * @request GET:/fixed-income/{id}
5517
- * @secure
5518
- */
5519
- getSingleFixedIncomeEntry(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFixedIncome, HandleError>>;
5520
- }
5521
- export class Fundamentals<HandleError extends boolean = boolean> {
5522
- protected readonly apiClient: JwtClient<HandleError>;
5523
- constructor(apiClient: JwtClient<HandleError>);
5524
- /**
5525
- * @description get fundamentals by symbol data
5526
- * @tags Fundamentals
5527
- * @name GetFundamentalsBySymbolData
5528
- * @summary get fundamentals by symbol data
5529
- * @request POST:/fundamentals
5530
- * @secure
5531
- */
5532
- getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
5533
- }
5534
- export class Funds<HandleError extends boolean = boolean> {
5535
- protected readonly apiClient: JwtClient<HandleError>;
5536
- constructor(apiClient: JwtClient<HandleError>);
5537
- /**
5538
- * @description get fund details
5539
- * @tags Funds
5540
- * @name GetFundDetails
5541
- * @summary get fund details
5542
- * @request GET:/funds/details
5543
- * @secure
5544
- */
5545
- getFundDetails(query: {
5546
- /** Fund symbol */
5547
- symbol: string;
5548
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundDetailsResponse, HandleError>>;
5549
- /**
5550
- * @description get funds for holding
5551
- * @tags Funds
5552
- * @name GetFundsForHolding
5553
- * @summary get funds for holding
5554
- * @request POST:/funds/funds-for-holding
5555
- * @secure
5556
- */
5557
- getFundsForHolding(filter: InsightGetFundsForHoldingRequest, headers?: {
5558
- /** Authorization */
5559
- Authorization?: string;
5560
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundsForHoldingResponse, HandleError>>;
5561
- /**
5562
- * @description filter funds by params
5563
- * @tags Funds
5564
- * @name FundScreener
5565
- * @summary filter funds by params
5566
- * @request POST:/funds/screener
5567
- * @secure
5568
- */
5569
- fundScreener(filter: InsightFundScreenerRequest, headers?: {
5570
- /** Authorization */
5571
- Authorization?: string;
5572
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFundScreenerResponse, HandleError>>;
5573
- /**
5574
- * @description get fund screener filters
5575
- * @tags Funds
5576
- * @name GetScreenerFilters
5577
- * @summary get fund screener filters
5578
- * @request GET:/funds/screener/filters
5579
- * @secure
5580
- */
5581
- getScreenerFilters(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundScreenerFiltersResponse, HandleError>>;
5582
- /**
5583
- * @description get fund screener presets
5584
- * @tags Funds
5585
- * @name GetFundScreenerPresets
5586
- * @summary get fund screener presets
5587
- * @request GET:/funds/screener/presets
5636
+ * @name GetFeaturedArticle
5637
+ * @summary Get featured article
5638
+ * @request GET:/news/featured-articles/{id}
5588
5639
  * @secure
5589
5640
  */
5590
- getFundScreenerPresets(query: {
5591
- /** how many records to return */
5592
- limit: number;
5593
- /** how many records to skip */
5594
- offset: number;
5595
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
5641
+ getFeaturedArticle(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFeaturedArticle, HandleError>>;
5596
5642
  /**
5597
- * @description update fund screener preset
5598
- * @tags Funds
5599
- * @name UpdateFundScreenerPreset
5600
- * @summary update fund screener preset
5601
- * @request PUT:/funds/screener/presets
5643
+ * @description Returns news by filters
5644
+ * @tags News
5645
+ * @name NewsFiltered
5646
+ * @summary Get filtered news
5647
+ * @request POST:/news/filter
5602
5648
  * @secure
5603
5649
  */
5604
- updateFundScreenerPreset(input: InsightCreateOrUpdateFundScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
5650
+ newsFiltered(filter: InsightNewsFilterRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsResponse, HandleError>>;
5605
5651
  /**
5606
- * @description create fund screener preset
5607
- * @tags Funds
5608
- * @name CreateFundScreenerPreset
5609
- * @summary create fund screener preset
5610
- * @request POST:/funds/screener/presets
5652
+ * @description Returns news by id
5653
+ * @tags News
5654
+ * @name NewsById
5655
+ * @summary Get news by id
5656
+ * @request POST:/news/id
5611
5657
  * @secure
5612
5658
  */
5613
- createFundScreenerPreset(input: InsightCreateOrUpdateFundScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
5659
+ newsById(filter: InsightNewsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNews, HandleError>>;
5614
5660
  /**
5615
- * @description remove fund screener preset
5616
- * @tags Funds
5617
- * @name RemoveFundScreenerPreset
5618
- * @summary remove fund screener preset
5619
- * @request DELETE:/funds/screener/presets
5661
+ * @description Returns news previews
5662
+ * @tags News
5663
+ * @name NewsPreviewsFiltered
5664
+ * @summary Get news previews
5665
+ * @request GET:/news/previews
5620
5666
  * @secure
5621
5667
  */
5622
- removeFundScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5668
+ newsPreviewsFiltered(query: {
5669
+ /** Start date */
5670
+ start_date?: string;
5671
+ /** End date */
5672
+ end_date?: string;
5673
+ /** Symbol */
5674
+ symbol?: string;
5675
+ /** how many records to return. Max value is 50 */
5676
+ limit: number;
5677
+ /** how many records to skip */
5678
+ offset: number;
5679
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRecentNewsPreviewsResponse, HandleError>>;
5623
5680
  /**
5624
- * @description filter funds by params
5625
- * @tags Funds
5626
- * @name FundSectorScreener
5627
- * @summary filter funds by params
5628
- * @request POST:/funds/sector-screener
5681
+ * @description Returns available stocks in DB
5682
+ * @tags News
5683
+ * @name NewsAvailableStocks
5684
+ * @summary Get available stocks in DB (for filters)
5685
+ * @request GET:/news/symbols
5629
5686
  * @secure
5630
5687
  */
5631
- fundSectorScreener(filter: InsightFundSectorScreenerRequest, headers?: {
5632
- /** Authorization */
5633
- Authorization?: string;
5634
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFundScreenerResponse, HandleError>>;
5688
+ newsAvailableStocks(query?: {
5689
+ /** Limit */
5690
+ limit?: number;
5691
+ /** Offset */
5692
+ offset?: number;
5693
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
5635
5694
  /**
5636
- * @description get top funds
5637
- * @tags Funds
5638
- * @name GetTopFunds
5639
- * @summary get top funds
5640
- * @request POST:/funds/top
5695
+ * @description Returns available tags in DB
5696
+ * @tags News
5697
+ * @name NewsAvailableTags
5698
+ * @summary Get available tags in DB (for filters)
5699
+ * @request POST:/news/tags
5641
5700
  * @secure
5642
5701
  */
5643
- getTopFunds(filter: InsightGetTopFundsRequest, headers?: {
5644
- /** Authorization */
5645
- Authorization?: string;
5646
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetTopFundsResponse, HandleError>>;
5702
+ newsAvailableTags(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
5647
5703
  }
5648
5704
  export class Ownerships<HandleError extends boolean = boolean> {
5649
5705
  protected readonly apiClient: JwtClient<HandleError>;
@@ -5667,6 +5723,28 @@ export class Ownerships<HandleError extends boolean = boolean> {
5667
5723
  */
5668
5724
  getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
5669
5725
  }
5726
+ export class AlphaTools<HandleError extends boolean = boolean> {
5727
+ protected readonly apiClient: JwtClient<HandleError>;
5728
+ constructor(apiClient: JwtClient<HandleError>);
5729
+ /**
5730
+ * @description get seasonlity data with comparison to benchmark
5731
+ * @tags AlphaTools
5732
+ * @name GetMomentumRatioGraph
5733
+ * @summary get seasonlity data
5734
+ * @request POST:/rst
5735
+ * @secure
5736
+ */
5737
+ getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
5738
+ /**
5739
+ * @description get seasonlity data with comparison to benchmark
5740
+ * @tags AlphaTools
5741
+ * @name GetSeasonality
5742
+ * @summary get seasonlity data
5743
+ * @request POST:/seasonality
5744
+ * @secure
5745
+ */
5746
+ getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
5747
+ }
5670
5748
  export class TipRank<HandleError extends boolean = boolean> {
5671
5749
  protected readonly apiClient: JwtClient<HandleError>;
5672
5750
  constructor(apiClient: JwtClient<HandleError>);
@@ -6046,27 +6124,85 @@ export class UsageTracking<HandleError extends boolean = boolean> {
6046
6124
  */
6047
6125
  getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
6048
6126
  }
6049
- export class AlphaTools<HandleError extends boolean = boolean> {
6127
+ export class Passport<HandleError extends boolean = boolean> {
6050
6128
  protected readonly apiClient: JwtClient<HandleError>;
6051
6129
  constructor(apiClient: JwtClient<HandleError>);
6052
6130
  /**
6053
- * @description get seasonlity data with comparison to benchmark
6054
- * @tags AlphaTools
6055
- * @name GetMomentumRatioGraph
6056
- * @summary get seasonlity data
6057
- * @request POST:/rst
6131
+ * @description Returns article by id
6132
+ * @tags Passport
6133
+ * @name PassportArticleById
6134
+ * @summary Get article by id
6135
+ * @request POST:/passport/article-by-id
6058
6136
  * @secure
6059
6137
  */
6060
- getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
6138
+ passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError>>;
6061
6139
  /**
6062
- * @description get seasonlity data with comparison to benchmark
6063
- * @tags AlphaTools
6064
- * @name GetSeasonality
6065
- * @summary get seasonlity data
6066
- * @request POST:/seasonality
6140
+ * @description Returns articles
6141
+ * @tags Passport
6142
+ * @name PassportArticles
6143
+ * @summary Get articles
6144
+ * @request POST:/passport/articles
6067
6145
  * @secure
6068
6146
  */
6069
- getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
6147
+ passportArticles(filter: InsightArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
6148
+ /**
6149
+ * @description Returns author profile
6150
+ * @tags Passport
6151
+ * @name PassportAuthorProfile
6152
+ * @summary Get author profile
6153
+ * @request POST:/passport/author-profile
6154
+ * @secure
6155
+ */
6156
+ passportAuthorProfile(filter: InsightAuthorProfileRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAuthorProfileResponse[], HandleError>>;
6157
+ /**
6158
+ * @description Returns most popular tags
6159
+ * @tags Passport
6160
+ * @name PassportMostPopularTags
6161
+ * @summary Get most popular tags
6162
+ * @request POST:/passport/most-popular-tags
6163
+ * @secure
6164
+ */
6165
+ passportMostPopularTags(filter: InsightMostPopularTagsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTagShortInfo[][], HandleError>>;
6166
+ /**
6167
+ * @description Returns news feed
6168
+ * @tags Passport
6169
+ * @name PassportNewsFeed
6170
+ * @summary Get news feed
6171
+ * @request POST:/passport/newsfeed
6172
+ * @secure
6173
+ */
6174
+ passportNewsFeed(filter: InsightNewsfeedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsfeed[][], HandleError>>;
6175
+ /**
6176
+ * @description Returns article by parameters
6177
+ * @tags Passport
6178
+ * @name PassportSearchArticle
6179
+ * @summary Search article by parameters
6180
+ * @request POST:/passport/search-article
6181
+ * @secure
6182
+ */
6183
+ passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
6184
+ }
6185
+ export class OptionGreeks<HandleError extends boolean = boolean> {
6186
+ protected readonly apiClient: JwtClient<HandleError>;
6187
+ constructor(apiClient: JwtClient<HandleError>);
6188
+ /**
6189
+ * @description Returns calculated matrix
6190
+ * @tags OptionGreeks
6191
+ * @name OgCalculateMatrix
6192
+ * @summary Calculate matrix
6193
+ * @request POST:/og/calculate-matrix
6194
+ * @secure
6195
+ */
6196
+ ogCalculateMatrix(filter: InsightCalculateMatrixParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateMatrixResponse, HandleError>>;
6197
+ /**
6198
+ * @description Returns calculated params
6199
+ * @tags OptionGreeks
6200
+ * @name OgCalculateParams
6201
+ * @summary Calculate params
6202
+ * @request POST:/og/calculate-params
6203
+ * @secure
6204
+ */
6205
+ ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
6070
6206
  }
6071
6207
  export class Public<HandleError extends boolean = boolean> {
6072
6208
  protected readonly apiClient: JwtClient<HandleError>;
@@ -6194,64 +6330,6 @@ export class Public<HandleError extends boolean = boolean> {
6194
6330
  offset: number;
6195
6331
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
6196
6332
  }
6197
- export class Passport<HandleError extends boolean = boolean> {
6198
- protected readonly apiClient: JwtClient<HandleError>;
6199
- constructor(apiClient: JwtClient<HandleError>);
6200
- /**
6201
- * @description Returns article by id
6202
- * @tags Passport
6203
- * @name PassportArticleById
6204
- * @summary Get article by id
6205
- * @request POST:/passport/article-by-id
6206
- * @secure
6207
- */
6208
- passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError>>;
6209
- /**
6210
- * @description Returns articles
6211
- * @tags Passport
6212
- * @name PassportArticles
6213
- * @summary Get articles
6214
- * @request POST:/passport/articles
6215
- * @secure
6216
- */
6217
- passportArticles(filter: InsightArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
6218
- /**
6219
- * @description Returns author profile
6220
- * @tags Passport
6221
- * @name PassportAuthorProfile
6222
- * @summary Get author profile
6223
- * @request POST:/passport/author-profile
6224
- * @secure
6225
- */
6226
- passportAuthorProfile(filter: InsightAuthorProfileRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAuthorProfileResponse[], HandleError>>;
6227
- /**
6228
- * @description Returns most popular tags
6229
- * @tags Passport
6230
- * @name PassportMostPopularTags
6231
- * @summary Get most popular tags
6232
- * @request POST:/passport/most-popular-tags
6233
- * @secure
6234
- */
6235
- passportMostPopularTags(filter: InsightMostPopularTagsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTagShortInfo[][], HandleError>>;
6236
- /**
6237
- * @description Returns news feed
6238
- * @tags Passport
6239
- * @name PassportNewsFeed
6240
- * @summary Get news feed
6241
- * @request POST:/passport/newsfeed
6242
- * @secure
6243
- */
6244
- passportNewsFeed(filter: InsightNewsfeedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsfeed[][], HandleError>>;
6245
- /**
6246
- * @description Returns article by parameters
6247
- * @tags Passport
6248
- * @name PassportSearchArticle
6249
- * @summary Search article by parameters
6250
- * @request POST:/passport/search-article
6251
- * @secure
6252
- */
6253
- passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
6254
- }
6255
6333
  export interface InsightBeforeAndAfterV2 {
6256
6334
  after?: string;
6257
6335
  before?: string;