@rundit-sdk/embed 0.3.0-rc.11 → 0.3.0-rc.26

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -45,107 +45,6 @@ export interface SdkCompanyDto {
45
45
  companyGroupIds?: number[]
46
46
  }
47
47
 
48
- export interface SdkCompactCompanyDto {
49
- id: number
50
- name: string
51
- type: string | null
52
- website?: string | null
53
- currency: string
54
- logoImageFileUuid: string | null
55
- }
56
-
57
- export interface SdkPaginationMetaDto {
58
- nextCursor: string | null
59
- }
60
-
61
- export interface SdkCompaniesListResponseDto {
62
- data: SdkCompactCompanyDto[]
63
- meta: SdkPaginationMetaDto
64
- }
65
-
66
- export interface SdkCompactCompanyGroupDto {
67
- id: number
68
- name: string
69
- isDemo: boolean
70
- colorId?: number | null
71
- companyIds?: number[]
72
- }
73
-
74
- export interface SdkCompanyGroupsListResponseDto {
75
- data: SdkCompactCompanyGroupDto[]
76
- meta: SdkPaginationMetaDto
77
- }
78
-
79
- export interface SdkCompanyGroupBasicInformationDto {
80
- fullName?: string | null
81
- domicile?: string | null
82
- managementCompany?: string | null
83
- generalPartner?: string | null
84
- vintageYear?: number | null
85
- fundCurrency?: string | null
86
- closingDates?: string[]
87
- legalForm?: string | null
88
- term?: string | null
89
- endedness?: string | null
90
- }
91
-
92
- export interface SdkCompanyGroupInvestmentFocusDto {
93
- investmentFocusAndPlan?: string | null
94
- investmentFocusStage?: string | null
95
- investmentFocusGeography?: string | null
96
- investmentFocusIndustry?: string | null
97
- maximumInvestment?: string | null
98
- maximumLeverage?: string | null
99
- investmentPeriod?: string | null
100
- valuationPolicyGuidelines?: string | null
101
- reInvestmentPolicy?: string | null
102
- otherInvestmentRestrictions?: string | null
103
- accountingPrinciples?: string | null
104
- }
105
-
106
- export interface SdkCompanyGroupKeyEconomicTermsDto {
107
- hurdleRateAndCarry?: string | null
108
- managementFees?: string | null
109
- carriedInterest?: string | null
110
- feeOffsets?: string | null
111
- }
112
-
113
- export interface SdkCompanyGroupAifmdDto {
114
- financialConductAuthority?: string | null
115
- depositary?: string | null
116
- countryOfRegulation?: string | null
117
- independentRiskManager?: string | null
118
- independentValuer?: string | null
119
- }
120
-
121
- export interface SdkCompanyGroupServiceProvidersDto {
122
- auditors?: string | null
123
- administrator?: string | null
124
- lawyer?: string | null
125
- bankingFacilities?: string | null
126
- taxAndRegulatory?: string | null
127
- lpAdvisoryCommittee?: string | null
128
- membersOfLpAdvisoryCommittee?: string | null
129
- }
130
-
131
- export interface SdkCompanyGroupDetailsDto {
132
- basicInformation?: SdkCompanyGroupBasicInformationDto
133
- investmentFocus?: SdkCompanyGroupInvestmentFocusDto
134
- keyEconomicTerms?: SdkCompanyGroupKeyEconomicTermsDto
135
- aifmd?: SdkCompanyGroupAifmdDto
136
- serviceProviders?: SdkCompanyGroupServiceProvidersDto
137
- }
138
-
139
- export interface SdkCompanyGroupDto {
140
- id: number
141
- name: string
142
- isDemo: boolean
143
- colorId?: number | null
144
- companyIds?: number[]
145
- companies?: SdkCompactCompanyDto[]
146
- details?: SdkCompanyGroupDetailsDto
147
- }
148
-
149
48
  export interface SdkCompanyReferenceDto {
150
49
  id: number
151
50
  name: string
@@ -223,36 +122,58 @@ export interface SdkCompanyPositionDto {
223
122
  date: string
224
123
  }
225
124
 
226
- export interface SdkCompanyPositionsListResponseDto {
227
- data: SdkCompanyPositionDto[]
228
- meta: SdkPaginationMetaDto
125
+ export interface SdkMetricUnitDto {
126
+ unit: { }
127
+ currencyCode?: string | null
229
128
  }
230
129
 
231
- export interface SdkPortfolioPositionDto {
232
- companyIds?: number[]
233
- currency: string
130
+ export interface SdkMetricTypeOptionDto {
131
+ value: string
132
+ isPositive: boolean
133
+ }
134
+
135
+ export interface SdkMetricTypeOptionConfigDto {
136
+ options: SdkMetricTypeOptionDto[]
137
+ }
138
+
139
+ export interface SdkMetricTypeRangeConfigDto {
140
+ min: number
141
+ max: number
142
+ step: number
143
+ }
144
+
145
+ export interface SdkMetricTypeDto {
146
+ id: number
147
+ name: string
148
+ shortName?: string | null
149
+ description?: string | null
150
+ origin?: { }
151
+ aggMethod: { }
152
+ valueType?: { }
153
+ unit?: SdkMetricUnitDto
154
+ optionConfig?: SdkMetricTypeOptionConfigDto
155
+ rangeConfig?: SdkMetricTypeRangeConfigDto
156
+ }
157
+
158
+ export interface SdkMetricPointDto {
234
159
  date: string
235
- fairValue?: number | null
236
- invested?: number | null
237
- multiple?: number | null
238
- ownership?: number | null
239
- realized?: number | null
240
- xirr?: number | null
241
- fvPlusRealized?: number | null
242
- totalFundingRaised?: number | null
243
- valuation?: number | null
244
- investments?: number | null
245
- realizations?: number | null
246
- roi?: number | null
247
- numberOfActiveCompanies: number
248
- numberOfFullyExitedCompanies: number
249
- investedEquity?: number | null
250
- investedSAFE?: number | null
251
- investedConvertibleNote?: number | null
252
- investedInitial?: number | null
253
- investedFollowOn?: number | null
254
- numberOfCompanies: number
255
- averageInvestmentAmount?: number | null
160
+ timeframe: { }
161
+ value: number | null
162
+ optionValue: string | null
163
+ valueError?: string | null
164
+ aggregated?: boolean
165
+ }
166
+
167
+ export interface SdkCompanyMetricDto {
168
+ id: number
169
+ metricType: SdkMetricTypeDto
170
+ points: SdkMetricPointDto[]
171
+ }
172
+
173
+ export interface SdkCompanyDashboardMetricsDto {
174
+ companyId: number
175
+ company: SdkCompanyReferenceDto
176
+ metrics: SdkCompanyMetricDto[]
256
177
  }
257
178
 
258
179
  export interface SdkTransactionAdditionalInfoDto {
@@ -433,44 +354,233 @@ export interface SdkEquityTransactionDto {
433
354
  companyPostMoneyValuation?: number | null
434
355
  }
435
356
 
436
- export interface SdkTransactionsListResponseDto {
437
- data: (SdkEquityTransactionDto | SdkConvertibleNoteTransactionDto | SdkFutureEquityAgreementTransactionDto | SdkExtendTransactionDto | SdkConversionTransactionDto | SdkExitTransactionDto | SdkValuationChangeTransactionDto | SdkInsolvencyTransactionDto | SdkOtherInvestmentTransactionDto)[]
357
+ export interface SdkCompanyReportSummaryDto {
358
+ id: number
359
+ title: string
360
+ date: string
361
+ timeframe: { }
362
+ publishedAt?: string | null
363
+ company: SdkCompanyReferenceDto
364
+ }
365
+
366
+ export interface SdkCompanyDashboardDto {
367
+ company: SdkCompanyDto
368
+ positions: SdkCompanyPositionDto[]
369
+ metrics: SdkCompanyDashboardMetricsDto
370
+ transactions: (SdkEquityTransactionDto | SdkConvertibleNoteTransactionDto | SdkFutureEquityAgreementTransactionDto | SdkExtendTransactionDto | SdkConversionTransactionDto | SdkExitTransactionDto | SdkValuationChangeTransactionDto | SdkInsolvencyTransactionDto | SdkOtherInvestmentTransactionDto)[]
371
+ reports: SdkCompanyReportSummaryDto[]
372
+ }
373
+
374
+ export interface SdkPaginationMetaDto {
375
+ nextCursor: string | null
376
+ }
377
+
378
+ export interface SdkBatchDashboardResponseDto {
379
+ data: SdkCompanyDashboardDto[]
438
380
  meta: SdkPaginationMetaDto
439
381
  }
440
382
 
441
- export interface SdkMetricUnitDto {
442
- unit: { }
443
- currencyCode?: string | null
383
+ export interface GetBatchDashboardBodyDto {
384
+ companyIds: number[]
385
+ currency: string
386
+ metricsFrom?: string
387
+ metricsTimeframe?: "Month" | "Quarter" | "Year"
388
+ metricTypeNames?: string[]
389
+ metricTypeIds?: number[]
390
+ conversionStrategy?: "LATEST_FX_RATE" | "ENTITY_DATE_RATE"
391
+ transactionLimit?: number
392
+ reportLimit?: number
444
393
  }
445
394
 
446
- export interface SdkMetricTypeDto {
395
+ export interface SdkCompactCompanyDto {
447
396
  id: number
448
397
  name: string
449
- shortName?: string | null
450
- description?: string | null
451
- origin?: { }
452
- aggMethod: { }
453
- valueType?: { }
398
+ type: string | null
399
+ website?: string | null
400
+ currency: string
401
+ logoImageFileUuid: string | null
402
+ }
403
+
404
+ export interface SdkCompaniesListResponseDto {
405
+ data: SdkCompactCompanyDto[]
406
+ meta: SdkPaginationMetaDto
407
+ }
408
+
409
+ export interface SdkCompactCompanyGroupDto {
410
+ id: number
411
+ name: string
412
+ isDemo: boolean
413
+ colorId?: number | null
414
+ companyIds?: number[]
415
+ }
416
+
417
+ export interface SdkCompanyGroupsListResponseDto {
418
+ data: SdkCompactCompanyGroupDto[]
419
+ meta: SdkPaginationMetaDto
420
+ }
421
+
422
+ export interface SdkCompanyGroupBasicInformationDto {
423
+ fullName?: string | null
424
+ domicile?: string | null
425
+ managementCompany?: string | null
426
+ generalPartner?: string | null
427
+ vintageYear?: number | null
428
+ fundCurrency?: string | null
429
+ closingDates?: string[]
430
+ legalForm?: string | null
431
+ term?: string | null
432
+ endedness?: string | null
433
+ }
434
+
435
+ export interface SdkCompanyGroupInvestmentFocusDto {
436
+ investmentFocusAndPlan?: string | null
437
+ investmentFocusStage?: string | null
438
+ investmentFocusGeography?: string | null
439
+ investmentFocusIndustry?: string | null
440
+ maximumInvestment?: string | null
441
+ maximumLeverage?: string | null
442
+ investmentPeriod?: string | null
443
+ valuationPolicyGuidelines?: string | null
444
+ reInvestmentPolicy?: string | null
445
+ otherInvestmentRestrictions?: string | null
446
+ accountingPrinciples?: string | null
447
+ }
448
+
449
+ export interface SdkCompanyGroupKeyEconomicTermsDto {
450
+ hurdleRateAndCarry?: string | null
451
+ managementFees?: string | null
452
+ carriedInterest?: string | null
453
+ feeOffsets?: string | null
454
+ }
455
+
456
+ export interface SdkCompanyGroupAifmdDto {
457
+ financialConductAuthority?: string | null
458
+ depositary?: string | null
459
+ countryOfRegulation?: string | null
460
+ independentRiskManager?: string | null
461
+ independentValuer?: string | null
462
+ }
463
+
464
+ export interface SdkCompanyGroupServiceProvidersDto {
465
+ auditors?: string | null
466
+ administrator?: string | null
467
+ lawyer?: string | null
468
+ bankingFacilities?: string | null
469
+ taxAndRegulatory?: string | null
470
+ lpAdvisoryCommittee?: string | null
471
+ membersOfLpAdvisoryCommittee?: string | null
472
+ }
473
+
474
+ export interface SdkCompanyGroupDetailsDto {
475
+ basicInformation?: SdkCompanyGroupBasicInformationDto
476
+ investmentFocus?: SdkCompanyGroupInvestmentFocusDto
477
+ keyEconomicTerms?: SdkCompanyGroupKeyEconomicTermsDto
478
+ aifmd?: SdkCompanyGroupAifmdDto
479
+ serviceProviders?: SdkCompanyGroupServiceProvidersDto
480
+ }
481
+
482
+ export interface SdkCompanyGroupDto {
483
+ id: number
484
+ name: string
485
+ isDemo: boolean
486
+ colorId?: number | null
487
+ companyIds?: number[]
488
+ companies?: SdkCompactCompanyDto[]
489
+ details?: SdkCompanyGroupDetailsDto
490
+ }
491
+
492
+ export interface SdkLatestMetricValueDto {
493
+ metricTypeId: number
494
+ metricTypeName: string
495
+ value?: number | null
496
+ optionValue?: string | null
497
+ date: string
454
498
  unit?: SdkMetricUnitDto
455
499
  }
456
500
 
457
- export interface SdkMetricTypesListResponseDto {
458
- data: SdkMetricTypeDto[]
501
+ export interface SdkPortfolioCompanySummaryDto {
502
+ companyId: number
503
+ companyGroupId?: number | null
504
+ company?: SdkCompanyReferenceDto
505
+ companyGroup?: SdkCompanyGroupReferenceDto
506
+ investmentStatus?: string | null
507
+ invested: number
508
+ fairValue?: number | null
509
+ multiple?: number | null
510
+ roi?: number | null
511
+ xirr?: number | null
512
+ ownership?: number | null
513
+ realized?: number | null
514
+ latestMetrics: SdkLatestMetricValueDto[]
515
+ currency: string
516
+ date: string
517
+ }
518
+
519
+ export interface SdkPortfolioSummaryListResponseDto {
520
+ data: SdkPortfolioCompanySummaryDto[]
459
521
  meta: SdkPaginationMetaDto
460
522
  }
461
523
 
462
- export interface SdkMetricPointDto {
524
+ export interface SdkCompanyPositionsListResponseDto {
525
+ data: SdkCompanyPositionDto[]
526
+ meta: SdkPaginationMetaDto
527
+ }
528
+
529
+ export interface SdkPortfolioPositionDto {
530
+ companyIds?: number[]
531
+ currency: string
463
532
  date: string
464
- timeframe: { }
465
- value: number | null
466
- valueError?: string | null
467
- aggregated?: boolean
533
+ fairValue?: number | null
534
+ invested?: number | null
535
+ multiple?: number | null
536
+ ownership?: number | null
537
+ realized?: number | null
538
+ xirr?: number | null
539
+ fvPlusRealized?: number | null
540
+ totalFundingRaised?: number | null
541
+ valuation?: number | null
542
+ investments?: number | null
543
+ realizations?: number | null
544
+ roi?: number | null
545
+ numberOfActiveCompanies: number
546
+ numberOfFullyExitedCompanies: number
547
+ investedEquity?: number | null
548
+ investedSAFE?: number | null
549
+ investedConvertibleNote?: number | null
550
+ investedInitial?: number | null
551
+ investedFollowOn?: number | null
552
+ numberOfCompanies: number
553
+ averageInvestmentAmount?: number | null
468
554
  }
469
555
 
470
- export interface SdkCompanyMetricDto {
471
- id: number
472
- metricType: SdkMetricTypeDto
473
- points: SdkMetricPointDto[]
556
+ export interface SdkTransactionTypeSummaryDto {
557
+ type: "Auction" | "ConvertibleNote" | "ConvertToEquity" | "Dividend" | "EquityInvestment" | "EquityReceived" | "Extend" | "FutureEquityAgreement" | "Insolvency" | "IPO" | "LimitedAuction" | "OptionsReceived" | "OtherExit" | "OtherInvestment" | "OtherRealization" | "Payback" | "Proprietary" | "TradeSale" | "ValuationChange" | "WriteOff"
558
+ count: number
559
+ amount: number
560
+ }
561
+
562
+ export interface SdkTransactionSummaryPeriodDto {
563
+ period: string
564
+ totalInvested: number
565
+ totalRealized: number
566
+ transactionCount: number
567
+ companyCount: number
568
+ byType: SdkTransactionTypeSummaryDto[]
569
+ }
570
+
571
+ export interface SdkTransactionSummaryResponseDto {
572
+ data: SdkTransactionSummaryPeriodDto[]
573
+ meta: SdkPaginationMetaDto
574
+ }
575
+
576
+ export interface SdkTransactionsListResponseDto {
577
+ data: (SdkEquityTransactionDto | SdkConvertibleNoteTransactionDto | SdkFutureEquityAgreementTransactionDto | SdkExtendTransactionDto | SdkConversionTransactionDto | SdkExitTransactionDto | SdkValuationChangeTransactionDto | SdkInsolvencyTransactionDto | SdkOtherInvestmentTransactionDto)[]
578
+ meta: SdkPaginationMetaDto
579
+ }
580
+
581
+ export interface SdkMetricTypesListResponseDto {
582
+ data: SdkMetricTypeDto[]
583
+ meta: SdkPaginationMetaDto
474
584
  }
475
585
 
476
586
  export interface SdkCompanyMetricsDto {
@@ -488,20 +598,94 @@ export interface MetricSearchDto {
488
598
  limit?: number
489
599
  cursor?: string
490
600
  companyIds?: number[]
601
+ companyNameSearch?: string[]
491
602
  companyGroupIds?: number[]
492
603
  metricTypeIds?: number[]
604
+ metricTypeNames?: string[]
493
605
  timeframe?: "Month" | "Quarter" | "Year"
494
606
  from?: string
495
607
  to?: string
608
+ currency?: string
609
+ conversionStrategy?: "LATEST_FX_RATE" | "ENTITY_DATE_RATE"
496
610
  }
497
611
 
498
- export interface SdkCompanyReportSummaryDto {
612
+ export interface SdkMetricTypeReferenceDto {
499
613
  id: number
500
- title: string
614
+ name: string
615
+ }
616
+
617
+ export interface SdkMetricCompareValueDto {
618
+ companyId: number
619
+ value?: number | null
620
+ optionValue?: string | null
621
+ change?: number | null
622
+ }
623
+
624
+ export interface SdkMetricCompareRowDto {
501
625
  date: string
502
626
  timeframe: { }
503
- publishedAt?: string | null
504
- company: SdkCompanyReferenceDto
627
+ values: SdkMetricCompareValueDto[]
628
+ }
629
+
630
+ export interface SdkMetricCompareResponseDto {
631
+ metricType: SdkMetricTypeReferenceDto
632
+ unit?: SdkMetricUnitDto
633
+ companies: SdkCompanyReferenceDto[]
634
+ rows: SdkMetricCompareRowDto[]
635
+ }
636
+
637
+ export interface SdkMetricCompareMultiResponseDto {
638
+ comparisons: SdkMetricCompareResponseDto[]
639
+ }
640
+
641
+ export interface MetricCompareDto {
642
+ limit?: number
643
+ cursor?: string
644
+ metricTypeIds: number[]
645
+ companyIds?: number[]
646
+ companyNameSearch?: string[]
647
+ companyGroupIds?: number[]
648
+ timeframe?: "Month" | "Quarter" | "Year"
649
+ from?: string
650
+ to?: string
651
+ currency?: string
652
+ conversionStrategy?: "LATEST_FX_RATE" | "ENTITY_DATE_RATE"
653
+ includeChange?: boolean
654
+ }
655
+
656
+ export interface SdkAggregatedPointDto {
657
+ date: string
658
+ timeframe: { }
659
+ value: number | null
660
+ companyCount: number
661
+ }
662
+
663
+ export interface SdkAggregatedMetricDto {
664
+ metricType: SdkMetricTypeReferenceDto
665
+ unit?: SdkMetricUnitDto
666
+ aggregation: "SUM" | "AVG" | "MEDIAN" | "MIN" | "MAX" | "COUNT"
667
+ companyGroup?: SdkCompanyGroupReferenceDto
668
+ points: SdkAggregatedPointDto[]
669
+ }
670
+
671
+ export interface SdkMetricAggregateResponseDto {
672
+ data: SdkAggregatedMetricDto[]
673
+ meta: SdkPaginationMetaDto
674
+ }
675
+
676
+ export interface MetricAggregateDto {
677
+ limit?: number
678
+ cursor?: string
679
+ metricTypeIds: number[]
680
+ aggregation: "SUM" | "AVG" | "MEDIAN" | "MIN" | "MAX" | "COUNT"
681
+ companyIds?: number[]
682
+ companyGroupIds?: number[]
683
+ timeframe?: "Month" | "Quarter" | "Year"
684
+ from?: string
685
+ to?: string
686
+ currency?: string
687
+ conversionStrategy?: "LATEST_FX_RATE" | "ENTITY_DATE_RATE"
688
+ groupByCompanyGroup?: boolean
505
689
  }
506
690
 
507
691
  export interface SdkCompanyReportsListResponseDto {
@@ -542,6 +726,12 @@ export interface SdkCompanyReportDto {
542
726
  attachments: SdkCompanyReportAttachmentDto[]
543
727
  }
544
728
 
729
+ export type CompaniesGetDashboardsResponse = SdkBatchDashboardResponseDto
730
+
731
+ export type CompaniesGetDashboardsBody = GetBatchDashboardBodyDto
732
+
733
+ export type CompaniesGetDashboardResponse = SdkCompanyDashboardDto
734
+
545
735
  export type CompaniesGetOneResponse = SdkCompanyDto
546
736
 
547
737
  export type CompaniesGetAllResponse = SdkCompaniesListResponseDto
@@ -550,10 +740,14 @@ export type CompanyGroupsGetAllResponse = SdkCompanyGroupsListResponseDto
550
740
 
551
741
  export type CompanyGroupsGetOneResponse = SdkCompanyGroupDto
552
742
 
743
+ export type PositionsGetPortfolioSummaryResponse = SdkPortfolioSummaryListResponseDto
744
+
553
745
  export type PositionsGetCompanyPositionsResponse = SdkCompanyPositionsListResponseDto
554
746
 
555
747
  export type PositionsGetPortfolioPositionsResponse = SdkPortfolioPositionDto
556
748
 
749
+ export type TransactionsGetSummaryResponse = SdkTransactionSummaryResponseDto
750
+
557
751
  export type TransactionsGetCompanyTransactionsResponse = SdkTransactionsListResponseDto
558
752
 
559
753
  export type TransactionsGetTransactionsResponse = SdkTransactionsListResponseDto
@@ -564,10 +758,37 @@ export type MetricsSearchResponse = SdkCompanyMetricsListResponseDto
564
758
 
565
759
  export type MetricsSearchBody = MetricSearchDto
566
760
 
761
+ export type MetricsCompareResponse = SdkMetricCompareMultiResponseDto
762
+
763
+ export type MetricsCompareBody = MetricCompareDto
764
+
765
+ export type MetricsAggregateResponse = SdkMetricAggregateResponseDto
766
+
767
+ export type MetricsAggregateBody = MetricAggregateDto
768
+
567
769
  export type CompanyReportsListResponse = SdkCompanyReportsListResponseDto
568
770
 
569
771
  export type CompanyReportsGetOneResponse = SdkCompanyReportDto
570
772
 
773
+ export interface CompaniesGetDashboardQuery {
774
+ /**
775
+ * Reporting currency code (ISO 4217).
776
+ */
777
+ currency: string
778
+ /**
779
+ * Lower bound for metric data points (ISO 8601). Omit to include all available history.
780
+ */
781
+ metricsFrom?: string
782
+ /**
783
+ * Maximum number of transactions to include (most recent first). Defaults to 10.
784
+ */
785
+ transactionLimit?: number
786
+ /**
787
+ * Maximum number of reports to include (most recent first). Defaults to 5.
788
+ */
789
+ reportLimit?: number
790
+ }
791
+
571
792
  export interface CompaniesGetAllQuery {
572
793
  /**
573
794
  * Maximum items per page. Currently accepted but not enforced; reserved for future pagination.
@@ -585,6 +806,10 @@ export interface CompaniesGetAllQuery {
585
806
  * Restrict results to companies that belong to any of these company groups
586
807
  */
587
808
  companyGroupIds?: number[]
809
+ /**
810
+ * Case-insensitive substring match on company display name. Pass an array to resolve multiple companies in one call — a company matches if its name contains ANY of the listed substrings (OR semantics). Combine with companyIds/companyGroupIds to find specific companies without first listing the entire portfolio.
811
+ */
812
+ nameSearch?: string[]
588
813
  }
589
814
 
590
815
  export interface CompanyGroupsGetAllQuery {
@@ -600,6 +825,41 @@ export interface CompanyGroupsGetAllQuery {
600
825
  * Restrict results to these company group identifiers
601
826
  */
602
827
  companyGroupIds?: number[]
828
+ /**
829
+ * Case-insensitive substring match on company group display name. Pass an array to resolve multiple groups in one call — a group matches if its name contains ANY of the listed substrings (OR semantics). Useful for finding funds or visibility groups by name without first listing all groups.
830
+ */
831
+ nameSearch?: string[]
832
+ }
833
+
834
+ export interface PositionsGetPortfolioSummaryQuery {
835
+ /**
836
+ * Maximum items per page. Currently accepted but not enforced; reserved for future pagination.
837
+ */
838
+ limit?: number
839
+ /**
840
+ * Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored.
841
+ */
842
+ cursor?: string
843
+ /**
844
+ * Restrict to companies that belong to any of these company groups.
845
+ */
846
+ companyGroupIds?: number[]
847
+ /**
848
+ * Restrict to these company identifiers.
849
+ */
850
+ companyIds?: number[]
851
+ /**
852
+ * Reporting currency code (ISO 4217).
853
+ */
854
+ currency: string
855
+ /**
856
+ * Position summary date (ISO 8601). Defaults to today.
857
+ */
858
+ date?: string
859
+ /**
860
+ * Metric type names to include in the latest metrics snapshot. Defaults to MRR, Cash Balance, Headcount, Net Burn Rate, and Runway.
861
+ */
862
+ metricTypeNames?: string[]
603
863
  }
604
864
 
605
865
  export interface PositionsGetCompanyPositionsQuery {
@@ -644,6 +904,41 @@ export interface PositionsGetPortfolioPositionsQuery {
644
904
  date?: string
645
905
  }
646
906
 
907
+ export interface TransactionsGetSummaryQuery {
908
+ /**
909
+ * Maximum items per page. Currently accepted but not enforced; reserved for future pagination.
910
+ */
911
+ limit?: number
912
+ /**
913
+ * Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored.
914
+ */
915
+ cursor?: string
916
+ /**
917
+ * Restrict to companies that belong to any of these company groups.
918
+ */
919
+ companyGroupIds?: number[]
920
+ /**
921
+ * Restrict to these company identifiers.
922
+ */
923
+ companyIds?: number[]
924
+ /**
925
+ * Reporting currency code (ISO 4217).
926
+ */
927
+ currency: string
928
+ /**
929
+ * Group results by this period granularity. When omitted, returns a single summary across all time.
930
+ */
931
+ groupBy?: "Month" | "Quarter" | "Year"
932
+ /**
933
+ * Lower bound for transaction date (ISO 8601, inclusive).
934
+ */
935
+ from?: string
936
+ /**
937
+ * Upper bound for transaction date (ISO 8601, inclusive).
938
+ */
939
+ to?: string
940
+ }
941
+
647
942
  export interface TransactionsGetCompanyTransactionsQuery {
648
943
  /**
649
944
  * Maximum items per page. Currently accepted but not enforced; reserved for future pagination.
@@ -711,6 +1006,10 @@ export interface CompanyReportsListQuery {
711
1006
  * Restrict to companies that belong to any of these company groups.
712
1007
  */
713
1008
  companyGroupIds?: number[]
1009
+ /**
1010
+ * Case-insensitive substring match on the reporting company name. Pass an array to resolve multiple companies in one call — a report matches if its company name contains ANY of the listed substrings (OR semantics). Intersects with `companyIds`/`companyGroupIds`.
1011
+ */
1012
+ companyNameSearch?: string[]
714
1013
  /**
715
1014
  * Restrict to a reporting period granularity (Month, Quarter, Year).
716
1015
  */
@@ -726,6 +1025,20 @@ export interface CompanyReportsListQuery {
726
1025
  }
727
1026
 
728
1027
  export interface CompaniesNamespace {
1028
+ /**
1029
+ * PREFERRED tool for multi-company analysis — full dashboards for many companies in one call
1030
+ * PREFERRED tool for multi-company analysis. Returns full dashboards (company metadata, positions, metrics with data points, recent transactions, report summaries) for many companies in a single request, grouped per company. Use this instead of looping `GET /companies/:id/dashboard` (the N+1 pattern) whenever the agent needs to look at more than one company — it returns the same shape per company but in one round trip. Typical workflow: resolve company ids (e.g. `GET /companies?nameSearch=["acme","beta"]`), then call this with their `companyIds`. Use `metricTypeIds` or `metricTypeNames` to scope the returned metrics, `metricsTimeframe` to restrict data point granularity, `currency` (ISO 4217) to FX-convert monetary metrics across the batch, and `transactionLimit` / `reportLimit` to cap list sizes per company.
1031
+ * Parameters: body: CompaniesGetDashboardsBody
1032
+ * Returns: CompaniesGetDashboardsResponse
1033
+ */
1034
+ getDashboards(body: CompaniesGetDashboardsBody, init?: RequestOptions): Promise<CompaniesGetDashboardsResponse>
1035
+ /**
1036
+ * Get full company dashboard for ONE company
1037
+ * Returns company metadata, positions per fund, all metrics with data points, recent transactions, and report summaries for a single company. For more than one company, prefer POST /companies/dashboards (`companies.getDashboards`) instead — it returns the same payload per company in one call and avoids the N+1 pattern. Use `metricsFrom` to limit metric history, `transactionLimit` and `reportLimit` to cap list sizes.
1038
+ * Parameters: path: id (number); query: currency (string), metricsFrom? (string), transactionLimit? (number), reportLimit? (number)
1039
+ * Returns: CompaniesGetDashboardResponse
1040
+ */
1041
+ getDashboard(id: number, query?: CompaniesGetDashboardQuery, init?: RequestOptions): Promise<CompaniesGetDashboardResponse>
729
1042
  /**
730
1043
  * Get one company available to the SDK consumer
731
1044
  * Parameters: path: id (number)
@@ -734,7 +1047,8 @@ export interface CompaniesNamespace {
734
1047
  getOne(id: number, init?: RequestOptions): Promise<CompaniesGetOneResponse>
735
1048
  /**
736
1049
  * List companies available to the SDK consumer
737
- * Parameters: query: limit? (number), cursor? (string), companyIds? (number[]), companyGroupIds? (number[])
1050
+ * Returns the compact form (id, name, currency, type, website, logo) for every company the caller can read. Filter by `companyIds`, `companyGroupIds`, and/or `nameSearch` (case-insensitive substring on display name; accepts an array to resolve multiple companies at once with OR semantics — e.g. `nameSearch=["acme","beta","gamma"]` returns any company whose name contains any of the three substrings). Avoids listing the full portfolio when the agent only knows companies by name.
1051
+ * Parameters: query: limit? (number), cursor? (string), companyIds? (number[]), companyGroupIds? (number[]), nameSearch? (string[])
738
1052
  * Returns: CompaniesGetAllResponse
739
1053
  */
740
1054
  getAll(query?: CompaniesGetAllQuery, init?: RequestOptions): Promise<CompaniesGetAllResponse>
@@ -743,7 +1057,8 @@ export interface CompaniesNamespace {
743
1057
  export interface CompanyGroupsNamespace {
744
1058
  /**
745
1059
  * List company groups available to the SDK consumer
746
- * Parameters: query: limit? (number), cursor? (string), companyGroupIds? (number[])
1060
+ * Returns compact company group metadata (id, name, demo flag, color, member company ids). Filter by `companyGroupIds` and/or `nameSearch` (case-insensitive substring on name; accepts an array to resolve multiple groups in one call with OR semantics — e.g. `nameSearch=["fund i","fund ii"]`).
1061
+ * Parameters: query: limit? (number), cursor? (string), companyGroupIds? (number[]), nameSearch? (string[])
747
1062
  * Returns: CompanyGroupsGetAllResponse
748
1063
  */
749
1064
  getAll(query?: CompanyGroupsGetAllQuery, init?: RequestOptions): Promise<CompanyGroupsGetAllResponse>
@@ -756,6 +1071,13 @@ export interface CompanyGroupsNamespace {
756
1071
  }
757
1072
 
758
1073
  export interface PositionsNamespace {
1074
+ /**
1075
+ * Get portfolio summary with positions and key metrics per company
1076
+ * Returns one row per company with position data (invested, fair value, multiple, ROI) and latest values for selected metrics. Defaults to MRR, Cash Balance, Headcount, Net Burn Rate, and Runway. Override with `metricTypeNames`. Designed for portfolio overview tables.
1077
+ * Parameters: query: limit? (number), cursor? (string), companyGroupIds? (number[]), companyIds? (number[]), currency (string), date? (string), metricTypeNames? (string[])
1078
+ * Returns: PositionsGetPortfolioSummaryResponse
1079
+ */
1080
+ getPortfolioSummary(query?: PositionsGetPortfolioSummaryQuery, init?: RequestOptions): Promise<PositionsGetPortfolioSummaryResponse>
759
1081
  /**
760
1082
  * Get positions for one company
761
1083
  * Parameters: path: id (number); query: limit? (number), cursor? (string), companyGroupIds? (number[]), currency (string), date? (string)
@@ -771,6 +1093,13 @@ export interface PositionsNamespace {
771
1093
  }
772
1094
 
773
1095
  export interface TransactionsNamespace {
1096
+ /**
1097
+ * Get transaction activity summary
1098
+ * Returns aggregated transaction statistics: total invested, total realized, transaction count, company count, and breakdown by transaction type. Optionally group by period (Month, Quarter, Year). Filter by company, company group, and date range.
1099
+ * Parameters: query: limit? (number), cursor? (string), companyGroupIds? (number[]), companyIds? (number[]), currency (string), groupBy? ("Month" | "Quarter" | "Year"), from? (string), to? (string)
1100
+ * Returns: TransactionsGetSummaryResponse
1101
+ */
1102
+ getSummary(query?: TransactionsGetSummaryQuery, init?: RequestOptions): Promise<TransactionsGetSummaryResponse>
774
1103
  /**
775
1104
  * Get transactions for one company
776
1105
  * Parameters: path: id (number); query: limit? (number), cursor? (string), companyGroupIds? (number[]), types? (("Auction" | "ConvertibleNote" | "ConvertToEquity" | "Dividend" | "EquityInvestment" | "EquityReceived" | "Extend" | "FutureEquityAgreement" | "Insolvency" | "IPO" | "LimitedAuction" | "OptionsReceived" | "OtherExit" | "OtherInvestment" | "OtherRealization" | "Payback" | "Proprietary" | "TradeSale" | "ValuationChange" | "WriteOff")[]), priorTo? (string)
@@ -788,24 +1117,38 @@ export interface TransactionsNamespace {
788
1117
  export interface MetricsNamespace {
789
1118
  /**
790
1119
  * List metric types available to the SDK consumer
791
- * Returns predefined metric types plus user-defined metric types scoped to the caller — VC group custom types for VC users, company custom types for company users. Each entry includes a numeric id and a human-readable name suitable for display or LLM context.
1120
+ * Returns predefined metric types plus user-defined metric types scoped to the caller — VC group custom types for VC users, company custom types for company users. Each entry carries the metric shape needed to interpret values: `valueType` is `"numeric"` (read `point.value` as a number; may carry `rangeConfig` with min/max/step for ranged metrics) or `"option"` (read `point.optionValue` as a string from `optionConfig.options[]` — this is how boolean / yes-no metrics are encoded, as two options typically labelled "Yes"/"No"). `unit.unit` describes the measurement (`Currency`, `Percentage`, `Number`, time units, ...); `unit.currencyCode` is intentionally null on this endpoint because monetary types resolve their concrete currency per company — call /metrics to receive `unit.currencyCode` populated with each company's native currency, or pass `currency` to convert all monetary metrics to a chosen target.
792
1121
  * Returns: MetricsGetTypesResponse
793
1122
  */
794
1123
  getTypes(init?: RequestOptions): Promise<MetricsGetTypesResponse>
795
1124
  /**
796
1125
  * Read metric values for accessible companies, grouped by company
797
- * Returns metric data points for companies the caller can access (companies in the caller's VC group portfolio, or the caller's own company for company users). Each entry carries company and metric type references with id and human-readable name. Filter by company, company group, metric type, timeframe, and date range to narrow the response.
1126
+ * Returns metric data points for companies the caller can access (companies in the caller's VC group portfolio, or the caller's own company for company users). Each entry carries company and metric type references with id and human-readable name. Each point carries both `value` (number, for `valueType === "numeric"`, including ranged numerics constrained by the type's `rangeConfig`) and `optionValue` (string, for `valueType === "option"`, matching one of `metricType.optionConfig.options[].value` — this is how boolean/yes-no metrics report their reading); read whichever matches the metric type's `valueType`. Filter by company id, company name substring (`companyNameSearch`), company group, metric type id, metric type name (`metricTypeNames`), timeframe, and date range to narrow the response. Pass `currency` (ISO 4217) to FX-convert monetary metrics to that target currency in one call instead of fetching company currencies separately.
798
1127
  * Parameters: body: MetricsSearchBody
799
1128
  * Returns: MetricsSearchResponse
800
1129
  */
801
1130
  search(body: MetricsSearchBody, init?: RequestOptions): Promise<MetricsSearchResponse>
1131
+ /**
1132
+ * Compare metrics across companies
1133
+ * Returns date-aligned rows for one or more metric types across multiple companies. Pass `metricTypeIds` (resolve from /metrics/types) to compare several metrics in a single round trip; names are not accepted on this endpoint to keep selection stable. Each row contains one value per company for a given period. Optionally includes period-over-period percentage change. Use `companyIds`, `companyNameSearch`, or `companyGroupIds` to select companies.
1134
+ * Parameters: body: MetricsCompareBody
1135
+ * Returns: MetricsCompareResponse
1136
+ */
1137
+ compare(body: MetricsCompareBody, init?: RequestOptions): Promise<MetricsCompareResponse>
1138
+ /**
1139
+ * Aggregate metrics across portfolio companies
1140
+ * Returns aggregated metric values (SUM, AVG, MEDIAN, MIN, MAX, COUNT) across companies for each reporting period. Pass `metricTypeIds` (resolve from /metrics/types) to select what to aggregate; names are not accepted on this endpoint to keep selection stable. Optionally group results by company group for fund-level breakdowns. MIN, MAX, and COUNT are always computed. SUM, AVG, and MEDIAN are only produced when the metric type enables them in its `summaryAggregationMethods` configuration; otherwise `point.value` is `null` for that aggregation.
1141
+ * Parameters: body: MetricsAggregateBody
1142
+ * Returns: MetricsAggregateResponse
1143
+ */
1144
+ aggregate(body: MetricsAggregateBody, init?: RequestOptions): Promise<MetricsAggregateResponse>
802
1145
  }
803
1146
 
804
1147
  export interface CompanyReportsNamespace {
805
1148
  /**
806
1149
  * List published company reports accessible to the caller (metadata only)
807
- * Returns lightweight report metadata (id, title, period, publisher company reference). Use GET /company-reports/:id to fetch the full content of a specific report. Visibility is determined by the caller's roles — VC users see reports for managed-portfolio companies, company employees see their own company's reports, portfolio investors see Published reports shared with their visibility groups. Filters narrow the list by company ids and reporting period (timeframe + date range).
808
- * Parameters: query: limit? (number), cursor? (string), companyIds? (number[]), companyGroupIds? (number[]), timeframe? ("Month" | "Quarter" | "Year"), from? (string), to? (string)
1150
+ * Returns lightweight report metadata (id, title, period, publisher company reference). Use GET /company-reports/:id to fetch the full content of a specific report. Visibility is determined by the caller's roles — VC users see reports for managed-portfolio companies, company employees see their own company's reports, portfolio investors see Published reports shared with their visibility groups. Filters narrow the list by company ids, company groups, company name substring (`companyNameSearch`), and reporting period (timeframe + date range).
1151
+ * Parameters: query: limit? (number), cursor? (string), companyIds? (number[]), companyGroupIds? (number[]), companyNameSearch? (string[]), timeframe? ("Month" | "Quarter" | "Year"), from? (string), to? (string)
809
1152
  * Returns: CompanyReportsListResponse
810
1153
  */
811
1154
  list(query?: CompanyReportsListQuery, init?: RequestOptions): Promise<CompanyReportsListResponse>
@@ -831,27 +1174,33 @@ export declare function createEmbedClient(options: CreateEmbedClientOptions): Em
831
1174
 
832
1175
  export declare const routeManifest: {
833
1176
  companies: {
1177
+ getDashboards: { method: "POST"; path: "/companies/dashboards"; summary: "PREFERRED tool for multi-company analysis — full dashboards for many companies in one call"; description: "PREFERRED tool for multi-company analysis. Returns full dashboards (company metadata, positions, metrics with data points, recent transactions, report summaries) for many companies in a single request, grouped per company. Use this instead of looping `GET /companies/:id/dashboard` (the N+1 pattern) whenever the agent needs to look at more than one company — it returns the same shape per company but in one round trip. Typical workflow: resolve company ids (e.g. `GET /companies?nameSearch=[\"acme\",\"beta\"]`), then call this with their `companyIds`. Use `metricTypeIds` or `metricTypeNames` to scope the returned metrics, `metricsTimeframe` to restrict data point granularity, `currency` (ISO 4217) to FX-convert monetary metrics across the batch, and `transactionLimit` / `reportLimit` to cap list sizes per company."; exampleCall: "client.companies.getDashboards({ companyIds: [123], currency: 'USD' })"; responseType: "CompaniesGetDashboardsResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
1178
+ getDashboard: { method: "GET"; path: "/companies/:id/dashboard"; summary: "Get full company dashboard for ONE company"; description: "Returns company metadata, positions per fund, all metrics with data points, recent transactions, and report summaries for a single company. For more than one company, prefer POST /companies/dashboards (`companies.getDashboards`) instead — it returns the same payload per company in one call and avoids the N+1 pattern. Use `metricsFrom` to limit metric history, `transactionLimit` and `reportLimit` to cap list sizes."; exampleCall: "client.companies.getDashboard(123, { currency: 'USD' })"; responseType: "CompaniesGetDashboardResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
834
1179
  getOne: { method: "GET"; path: "/companies/:id"; summary: "Get one company available to the SDK consumer"; description: null; exampleCall: "client.companies.getOne(123)"; responseType: "CompaniesGetOneResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
835
- getAll: { method: "GET"; path: "/companies"; summary: "List companies available to the SDK consumer"; description: null; exampleCall: "client.companies.getAll({ limit: 123 })"; responseType: "CompaniesGetAllResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
1180
+ getAll: { method: "GET"; path: "/companies"; summary: "List companies available to the SDK consumer"; description: "Returns the compact form (id, name, currency, type, website, logo) for every company the caller can read. Filter by `companyIds`, `companyGroupIds`, and/or `nameSearch` (case-insensitive substring on display name; accepts an array to resolve multiple companies at once with OR semantics — e.g. `nameSearch=[\"acme\",\"beta\",\"gamma\"]` returns any company whose name contains any of the three substrings). Avoids listing the full portfolio when the agent only knows companies by name."; exampleCall: "client.companies.getAll({ limit: 123 })"; responseType: "CompaniesGetAllResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
836
1181
  }
837
1182
  companyGroups: {
838
- getAll: { method: "GET"; path: "/company-groups"; summary: "List company groups available to the SDK consumer"; description: null; exampleCall: "client.companyGroups.getAll({ limit: 123 })"; responseType: "CompanyGroupsGetAllResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
1183
+ getAll: { method: "GET"; path: "/company-groups"; summary: "List company groups available to the SDK consumer"; description: "Returns compact company group metadata (id, name, demo flag, color, member company ids). Filter by `companyGroupIds` and/or `nameSearch` (case-insensitive substring on name; accepts an array to resolve multiple groups in one call with OR semantics — e.g. `nameSearch=[\"fund i\",\"fund ii\"]`)."; exampleCall: "client.companyGroups.getAll({ limit: 123 })"; responseType: "CompanyGroupsGetAllResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
839
1184
  getOne: { method: "GET"; path: "/company-groups/:id"; summary: "Get one company group available to the SDK consumer"; description: null; exampleCall: "client.companyGroups.getOne(123)"; responseType: "CompanyGroupsGetOneResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
840
1185
  }
841
1186
  positions: {
1187
+ getPortfolioSummary: { method: "GET"; path: "/positions/portfolio/summary"; summary: "Get portfolio summary with positions and key metrics per company"; description: "Returns one row per company with position data (invested, fair value, multiple, ROI) and latest values for selected metrics. Defaults to MRR, Cash Balance, Headcount, Net Burn Rate, and Runway. Override with `metricTypeNames`. Designed for portfolio overview tables."; exampleCall: "client.positions.getPortfolioSummary({ currency: 'USD' })"; responseType: "PositionsGetPortfolioSummaryResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
842
1188
  getCompanyPositions: { method: "GET"; path: "/positions/companies/:id"; summary: "Get positions for one company"; description: null; exampleCall: "client.positions.getCompanyPositions(123, { currency: 'USD' })"; responseType: "PositionsGetCompanyPositionsResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
843
1189
  getPortfolioPositions: { method: "GET"; path: "/positions/portfolio"; summary: "Get portfolio positions"; description: null; exampleCall: "client.positions.getPortfolioPositions({ currency: 'USD' })"; responseType: "PositionsGetPortfolioPositionsResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
844
1190
  }
845
1191
  transactions: {
1192
+ getSummary: { method: "GET"; path: "/transactions/summary"; summary: "Get transaction activity summary"; description: "Returns aggregated transaction statistics: total invested, total realized, transaction count, company count, and breakdown by transaction type. Optionally group by period (Month, Quarter, Year). Filter by company, company group, and date range."; exampleCall: "client.transactions.getSummary({ currency: 'USD' })"; responseType: "TransactionsGetSummaryResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
846
1193
  getCompanyTransactions: { method: "GET"; path: "/transactions/companies/:id"; summary: "Get transactions for one company"; description: null; exampleCall: "client.transactions.getCompanyTransactions(123, { limit: 123 })"; responseType: "TransactionsGetCompanyTransactionsResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
847
1194
  getTransactions: { method: "GET"; path: "/transactions"; summary: "Get transactions for multiple companies"; description: null; exampleCall: "client.transactions.getTransactions({ limit: 123 })"; responseType: "TransactionsGetTransactionsResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
848
1195
  }
849
1196
  metrics: {
850
- getTypes: { method: "GET"; path: "/metrics/types"; summary: "List metric types available to the SDK consumer"; description: "Returns predefined metric types plus user-defined metric types scoped to the caller — VC group custom types for VC users, company custom types for company users. Each entry includes a numeric id and a human-readable name suitable for display or LLM context."; exampleCall: "client.metrics.getTypes()"; responseType: "MetricsGetTypesResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
851
- search: { method: "POST"; path: "/metrics"; summary: "Read metric values for accessible companies, grouped by company"; description: "Returns metric data points for companies the caller can access (companies in the caller's VC group portfolio, or the caller's own company for company users). Each entry carries company and metric type references with id and human-readable name. Filter by company, company group, metric type, timeframe, and date range to narrow the response."; exampleCall: "client.metrics.search({})"; responseType: "MetricsSearchResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
1197
+ getTypes: { method: "GET"; path: "/metrics/types"; summary: "List metric types available to the SDK consumer"; description: "Returns predefined metric types plus user-defined metric types scoped to the caller — VC group custom types for VC users, company custom types for company users. Each entry carries the metric shape needed to interpret values: `valueType` is `\"numeric\"` (read `point.value` as a number; may carry `rangeConfig` with min/max/step for ranged metrics) or `\"option\"` (read `point.optionValue` as a string from `optionConfig.options[]` — this is how boolean / yes-no metrics are encoded, as two options typically labelled \"Yes\"/\"No\"). `unit.unit` describes the measurement (`Currency`, `Percentage`, `Number`, time units, ...); `unit.currencyCode` is intentionally null on this endpoint because monetary types resolve their concrete currency per company — call /metrics to receive `unit.currencyCode` populated with each company's native currency, or pass `currency` to convert all monetary metrics to a chosen target."; exampleCall: "client.metrics.getTypes()"; responseType: "MetricsGetTypesResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
1198
+ search: { method: "POST"; path: "/metrics"; summary: "Read metric values for accessible companies, grouped by company"; description: "Returns metric data points for companies the caller can access (companies in the caller's VC group portfolio, or the caller's own company for company users). Each entry carries company and metric type references with id and human-readable name. Each point carries both `value` (number, for `valueType === \"numeric\"`, including ranged numerics constrained by the type's `rangeConfig`) and `optionValue` (string, for `valueType === \"option\"`, matching one of `metricType.optionConfig.options[].value` — this is how boolean/yes-no metrics report their reading); read whichever matches the metric type's `valueType`. Filter by company id, company name substring (`companyNameSearch`), company group, metric type id, metric type name (`metricTypeNames`), timeframe, and date range to narrow the response. Pass `currency` (ISO 4217) to FX-convert monetary metrics to that target currency in one call instead of fetching company currencies separately."; exampleCall: "client.metrics.search({})"; responseType: "MetricsSearchResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
1199
+ compare: { method: "POST"; path: "/metrics/compare"; summary: "Compare metrics across companies"; description: "Returns date-aligned rows for one or more metric types across multiple companies. Pass `metricTypeIds` (resolve from /metrics/types) to compare several metrics in a single round trip; names are not accepted on this endpoint to keep selection stable. Each row contains one value per company for a given period. Optionally includes period-over-period percentage change. Use `companyIds`, `companyNameSearch`, or `companyGroupIds` to select companies."; exampleCall: "client.metrics.compare({ metricTypeIds: [1,7] })"; responseType: "MetricsCompareResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
1200
+ aggregate: { method: "POST"; path: "/metrics/aggregate"; summary: "Aggregate metrics across portfolio companies"; description: "Returns aggregated metric values (SUM, AVG, MEDIAN, MIN, MAX, COUNT) across companies for each reporting period. Pass `metricTypeIds` (resolve from /metrics/types) to select what to aggregate; names are not accepted on this endpoint to keep selection stable. Optionally group results by company group for fund-level breakdowns. MIN, MAX, and COUNT are always computed. SUM, AVG, and MEDIAN are only produced when the metric type enables them in its `summaryAggregationMethods` configuration; otherwise `point.value` is `null` for that aggregation."; exampleCall: "client.metrics.aggregate({ metricTypeIds: [1,7], aggregation: \"SUM\" })"; responseType: "MetricsAggregateResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
852
1201
  }
853
1202
  companyReports: {
854
- list: { method: "GET"; path: "/company-reports"; summary: "List published company reports accessible to the caller (metadata only)"; description: "Returns lightweight report metadata (id, title, period, publisher company reference). Use GET /company-reports/:id to fetch the full content of a specific report. Visibility is determined by the caller's roles — VC users see reports for managed-portfolio companies, company employees see their own company's reports, portfolio investors see Published reports shared with their visibility groups. Filters narrow the list by company ids and reporting period (timeframe + date range)."; exampleCall: "client.companyReports.list({ limit: 123 })"; responseType: "CompanyReportsListResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
1203
+ list: { method: "GET"; path: "/company-reports"; summary: "List published company reports accessible to the caller (metadata only)"; description: "Returns lightweight report metadata (id, title, period, publisher company reference). Use GET /company-reports/:id to fetch the full content of a specific report. Visibility is determined by the caller's roles — VC users see reports for managed-portfolio companies, company employees see their own company's reports, portfolio investors see Published reports shared with their visibility groups. Filters narrow the list by company ids, company groups, company name substring (`companyNameSearch`), and reporting period (timeframe + date range)."; exampleCall: "client.companyReports.list({ limit: 123 })"; responseType: "CompanyReportsListResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
855
1204
  getOne: { method: "GET"; path: "/company-reports/:id"; summary: "Fetch the full content of a single company report"; description: "Returns the report metadata plus structured sections (text/markdown/image) and attachments with pre-signed URLs. Returns 404 if the report does not exist and 403 if the caller cannot access it under their role-based permissions."; exampleCall: "client.companyReports.getOne(123)"; responseType: "CompanyReportsGetOneResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
856
1205
  }
857
1206
  }