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

package/dist/index.d.ts

@@ -16,7 +16,7 @@ export declare class RunditSdkError extends Error {
 }
 
 export interface CreateEmbedClientOptions {
-  baseUrl: string
+  baseUrl?: string
   token: string
   fetch?: typeof fetch
   headers?: Record<string, string>
@@ -25,10 +25,10 @@ export interface CreateEmbedClientOptions {
 export interface SdkCompanyDto {
   id: number
   name: string
-  type?: string
+  type: string | null
   website?: string | null
   currency: string
-  logoImageFileUuid?: string | null
+  logoImageFileUuid: string | null
   legalName?: string | null
   status?: string | null
   description?: string | null
@@ -48,10 +48,19 @@ export interface SdkCompanyDto {
 export interface SdkCompactCompanyDto {
   id: number
   name: string
-  type?: string
+  type: string | null
   website?: string | null
   currency: string
-  logoImageFileUuid?: string | null
+  logoImageFileUuid: string | null
+}
+
+export interface SdkPaginationMetaDto {
+  nextCursor: string | null
+}
+
+export interface SdkCompaniesListResponseDto {
+  data: SdkCompactCompanyDto[]
+  meta: SdkPaginationMetaDto
 }
 
 export interface SdkCompactCompanyGroupDto {
@@ -62,6 +71,11 @@ export interface SdkCompactCompanyGroupDto {
   companyIds?: number[]
 }
 
+export interface SdkCompanyGroupsListResponseDto {
+  data: SdkCompactCompanyGroupDto[]
+  meta: SdkPaginationMetaDto
+}
+
 export interface SdkCompanyGroupBasicInformationDto {
   fullName?: string | null
   domicile?: string | null
@@ -135,7 +149,7 @@ export interface SdkCompanyGroupDto {
 export interface SdkCompanyReferenceDto {
   id: number
   name: string
-  type?: string
+  type: string | null
 }
 
 export interface SdkCompanyGroupReferenceDto {
@@ -209,6 +223,11 @@ export interface SdkCompanyPositionDto {
   date: string
 }
 
+export interface SdkCompanyPositionsListResponseDto {
+  data: SdkCompanyPositionDto[]
+  meta: SdkPaginationMetaDto
+}
+
 export interface SdkPortfolioPositionDto {
   companyIds?: number[]
   currency: string
@@ -244,9 +263,9 @@ export interface SdkTransactionAdditionalInfoDto {
   earnOut?: string | null
 }
 
-export interface SdkTransactionBaseDto {
+export interface SdkOtherInvestmentTransactionDto {
   id: number
-  type: "Auction" | "ConvertibleNote" | "ConvertToEquity" | "Dividend" | "EquityInvestment" | "EquityReceived" | "Extend" | "FutureEquityAgreement" | "Insolvency" | "IPO" | "LimitedAuction" | "OptionsReceived" | "OtherExit" | "OtherInvestment" | "OtherRealization" | "Payback" | "Proprietary" | "TradeSale" | "ValuationChange" | "WriteOff"
+  type: "OtherInvestment"
   date: string
   companyId: number
   companyGroupId?: number | null
@@ -254,12 +273,14 @@ export interface SdkTransactionBaseDto {
   companyGroup?: SdkCompanyGroupReferenceDto
   currency?: string | null
   additionalInfo?: SdkTransactionAdditionalInfoDto
-  children?: SdkTransactionBaseDto[]
+  children?: (SdkEquityTransactionDto | SdkConvertibleNoteTransactionDto | SdkFutureEquityAgreementTransactionDto | SdkExtendTransactionDto | SdkConversionTransactionDto | SdkExitTransactionDto | SdkValuationChangeTransactionDto | SdkInsolvencyTransactionDto | SdkOtherInvestmentTransactionDto)[]
+  invested: number
+  name?: string | null
 }
 
-export interface SdkEquityTransactionDto {
+export interface SdkInsolvencyTransactionDto {
   id: number
-  type: "EquityInvestment" | "EquityReceived" | "OptionsReceived"
+  type: "Insolvency"
   date: string
   companyId: number
   companyGroupId?: number | null
@@ -267,13 +288,27 @@ export interface SdkEquityTransactionDto {
   companyGroup?: SdkCompanyGroupReferenceDto
   currency?: string | null
   additionalInfo?: SdkTransactionAdditionalInfoDto
-  children?: SdkTransactionBaseDto[]
-  invested?: number | null
+  children?: (SdkEquityTransactionDto | SdkConvertibleNoteTransactionDto | SdkFutureEquityAgreementTransactionDto | SdkExtendTransactionDto | SdkConversionTransactionDto | SdkExitTransactionDto | SdkValuationChangeTransactionDto | SdkInsolvencyTransactionDto | SdkOtherInvestmentTransactionDto)[]
+  customSummaryFairValue?: number | null
+}
+
+export interface SdkValuationChangeTransactionDto {
+  id: number
+  type: "ValuationChange"
+  date: string
+  companyId: number
+  companyGroupId?: number | null
+  company?: SdkCompanyReferenceDto
+  companyGroup?: SdkCompanyGroupReferenceDto
+  currency?: string | null
+  additionalInfo?: SdkTransactionAdditionalInfoDto
+  children?: (SdkEquityTransactionDto | SdkConvertibleNoteTransactionDto | SdkFutureEquityAgreementTransactionDto | SdkExtendTransactionDto | SdkConversionTransactionDto | SdkExitTransactionDto | SdkValuationChangeTransactionDto | SdkInsolvencyTransactionDto | SdkOtherInvestmentTransactionDto)[]
+  companyPostMoneyValuation?: number | null
   pricePerShare?: number | null
-  sharesAcquired?: number | null
   sharesIssuedTotalDiluted?: number | null
   sharesIssuedTotalCurrent?: number | null
-  companyPostMoneyValuation?: number | null
+  valuationMethod?: "Historical" | "NewFinancingRound" | "PubliclyListedSecurity" | "Realization" | "RecentTransactionMultiples" | "RecentMarketMultiples" | "RecentMarketAndTransactionMultiples" | "DiscountToPrimaryRound" | "ThirdPartyOpinion" | "Dcf" | "Other"
+  customSummaryFairValue?: number | null
 }
 
 export interface SdkTransactionPaymentDto {
@@ -281,9 +316,9 @@ export interface SdkTransactionPaymentDto {
   dueDate: string
 }
 
-export interface SdkConvertibleNoteTransactionDto {
+export interface SdkExitTransactionDto {
   id: number
-  type: "ConvertibleNote"
+  type: "TradeSale" | "IPO" | "Auction" | "LimitedAuction" | "Proprietary" | "OtherExit" | "Dividend" | "OtherRealization"
   date: string
   companyId: number
   companyGroupId?: number | null
@@ -291,22 +326,19 @@ export interface SdkConvertibleNoteTransactionDto {
   companyGroup?: SdkCompanyGroupReferenceDto
   currency?: string | null
   additionalInfo?: SdkTransactionAdditionalInfoDto
-  children?: SdkTransactionBaseDto[]
-  invested: number
-  valuationCap?: number | null
-  discountRate?: number | null
-  interestRate?: number | null
-  interestType?: string | null
-  compounded?: string | null
-  dayCountConvention?: string | null
-  maturityDate?: string | null
-  warrantedOwnership?: number | null
+  children?: (SdkEquityTransactionDto | SdkConvertibleNoteTransactionDto | SdkFutureEquityAgreementTransactionDto | SdkExtendTransactionDto | SdkConversionTransactionDto | SdkExitTransactionDto | SdkValuationChangeTransactionDto | SdkInsolvencyTransactionDto | SdkOtherInvestmentTransactionDto)[]
+  profit?: number | null
+  pricePerShare?: number | null
+  sharesAcquired?: number | null
+  companyPostMoneyValuation?: number | null
+  ticker?: string | null
+  name?: string | null
   payments?: SdkTransactionPaymentDto[]
 }
 
-export interface SdkFutureEquityAgreementTransactionDto {
+export interface SdkConversionTransactionDto {
   id: number
-  type: "FutureEquityAgreement"
+  type: "ConvertToEquity" | "Payback" | "WriteOff"
   date: string
   companyId: number
   companyGroupId?: number | null
@@ -314,13 +346,14 @@ export interface SdkFutureEquityAgreementTransactionDto {
   companyGroup?: SdkCompanyGroupReferenceDto
   currency?: string | null
   additionalInfo?: SdkTransactionAdditionalInfoDto
-  children?: SdkTransactionBaseDto[]
-  invested: number
-  valuationCap?: number | null
-  discountRate?: number | null
-  valuationTiming?: string | null
-  companyPostMoneyValuation?: number | null
-  warrantedOwnership?: number | null
+  children?: (SdkEquityTransactionDto | SdkConvertibleNoteTransactionDto | SdkFutureEquityAgreementTransactionDto | SdkExtendTransactionDto | SdkConversionTransactionDto | SdkExitTransactionDto | SdkValuationChangeTransactionDto | SdkInsolvencyTransactionDto | SdkOtherInvestmentTransactionDto)[]
+  parentId: number
+  convertedTransactionType?: "Auction" | "ConvertibleNote" | "ConvertToEquity" | "Dividend" | "EquityInvestment" | "EquityReceived" | "Extend" | "FutureEquityAgreement" | "Insolvency" | "IPO" | "LimitedAuction" | "OptionsReceived" | "OtherExit" | "OtherInvestment" | "OtherRealization" | "Payback" | "Proprietary" | "TradeSale" | "ValuationChange" | "WriteOff"
+  amountConverted?: number | null
+  writeOffAmount?: number | null
+  pricePerShare?: number | null
+  sharesAcquired?: number | null
+  payments?: SdkTransactionPaymentDto[]
 }
 
 export interface SdkExtendTransactionDto {
@@ -333,15 +366,15 @@ export interface SdkExtendTransactionDto {
   companyGroup?: SdkCompanyGroupReferenceDto
   currency?: string | null
   additionalInfo?: SdkTransactionAdditionalInfoDto
-  children?: SdkTransactionBaseDto[]
+  children?: (SdkEquityTransactionDto | SdkConvertibleNoteTransactionDto | SdkFutureEquityAgreementTransactionDto | SdkExtendTransactionDto | SdkConversionTransactionDto | SdkExitTransactionDto | SdkValuationChangeTransactionDto | SdkInsolvencyTransactionDto | SdkOtherInvestmentTransactionDto)[]
   parentId: number
   maturityDate?: string | null
   transactionFairValue?: number | null
 }
 
-export interface SdkConversionTransactionDto {
+export interface SdkFutureEquityAgreementTransactionDto {
   id: number
-  type: "ConvertToEquity" | "Payback" | "WriteOff"
+  type: "FutureEquityAgreement"
   date: string
   companyId: number
   companyGroupId?: number | null
@@ -349,19 +382,18 @@ export interface SdkConversionTransactionDto {
   companyGroup?: SdkCompanyGroupReferenceDto
   currency?: string | null
   additionalInfo?: SdkTransactionAdditionalInfoDto
-  children?: SdkTransactionBaseDto[]
-  parentId: number
-  convertedTransactionType?: "Auction" | "ConvertibleNote" | "ConvertToEquity" | "Dividend" | "EquityInvestment" | "EquityReceived" | "Extend" | "FutureEquityAgreement" | "Insolvency" | "IPO" | "LimitedAuction" | "OptionsReceived" | "OtherExit" | "OtherInvestment" | "OtherRealization" | "Payback" | "Proprietary" | "TradeSale" | "ValuationChange" | "WriteOff"
-  amountConverted?: number | null
-  writeOffAmount?: number | null
-  pricePerShare?: number | null
-  sharesAcquired?: number | null
-  payments?: SdkTransactionPaymentDto[]
+  children?: (SdkEquityTransactionDto | SdkConvertibleNoteTransactionDto | SdkFutureEquityAgreementTransactionDto | SdkExtendTransactionDto | SdkConversionTransactionDto | SdkExitTransactionDto | SdkValuationChangeTransactionDto | SdkInsolvencyTransactionDto | SdkOtherInvestmentTransactionDto)[]
+  invested: number
+  valuationCap?: number | null
+  discountRate?: number | null
+  valuationTiming?: string | null
+  companyPostMoneyValuation?: number | null
+  warrantedOwnership?: number | null
 }
 
-export interface SdkExitTransactionDto {
+export interface SdkConvertibleNoteTransactionDto {
   id: number
-  type: "TradeSale" | "IPO" | "Auction" | "LimitedAuction" | "Proprietary" | "OtherExit" | "Dividend" | "OtherRealization"
+  type: "ConvertibleNote"
   date: string
   companyId: number
   companyGroupId?: number | null
@@ -369,19 +401,22 @@ export interface SdkExitTransactionDto {
   companyGroup?: SdkCompanyGroupReferenceDto
   currency?: string | null
   additionalInfo?: SdkTransactionAdditionalInfoDto
-  children?: SdkTransactionBaseDto[]
-  profit?: number | null
-  pricePerShare?: number | null
-  sharesAcquired?: number | null
-  companyPostMoneyValuation?: number | null
-  ticker?: string | null
-  name?: string | null
+  children?: (SdkEquityTransactionDto | SdkConvertibleNoteTransactionDto | SdkFutureEquityAgreementTransactionDto | SdkExtendTransactionDto | SdkConversionTransactionDto | SdkExitTransactionDto | SdkValuationChangeTransactionDto | SdkInsolvencyTransactionDto | SdkOtherInvestmentTransactionDto)[]
+  invested: number
+  valuationCap?: number | null
+  discountRate?: number | null
+  interestRate?: number | null
+  interestType?: string | null
+  compounded?: string | null
+  dayCountConvention?: string | null
+  maturityDate?: string | null
+  warrantedOwnership?: number | null
   payments?: SdkTransactionPaymentDto[]
 }
 
-export interface SdkValuationChangeTransactionDto {
+export interface SdkEquityTransactionDto {
   id: number
-  type: "ValuationChange"
+  type: "EquityInvestment" | "EquityReceived" | "OptionsReceived"
   date: string
   companyId: number
   companyGroupId?: number | null
@@ -389,65 +424,197 @@ export interface SdkValuationChangeTransactionDto {
   companyGroup?: SdkCompanyGroupReferenceDto
   currency?: string | null
   additionalInfo?: SdkTransactionAdditionalInfoDto
-  children?: SdkTransactionBaseDto[]
-  companyPostMoneyValuation?: number | null
+  children?: (SdkEquityTransactionDto | SdkConvertibleNoteTransactionDto | SdkFutureEquityAgreementTransactionDto | SdkExtendTransactionDto | SdkConversionTransactionDto | SdkExitTransactionDto | SdkValuationChangeTransactionDto | SdkInsolvencyTransactionDto | SdkOtherInvestmentTransactionDto)[]
+  invested?: number | null
   pricePerShare?: number | null
+  sharesAcquired?: number | null
   sharesIssuedTotalDiluted?: number | null
   sharesIssuedTotalCurrent?: number | null
-  valuationMethod?: "Historical" | "NewFinancingRound" | "PubliclyListedSecurity" | "Realization" | "RecentTransactionMultiples" | "RecentMarketMultiples" | "RecentMarketAndTransactionMultiples" | "DiscountToPrimaryRound" | "ThirdPartyOpinion" | "Dcf" | "Other"
-  customSummaryFairValue?: number | null
+  companyPostMoneyValuation?: number | null
 }
 
-export interface SdkInsolvencyTransactionDto {
+export interface SdkTransactionsListResponseDto {
+  data: (SdkEquityTransactionDto | SdkConvertibleNoteTransactionDto | SdkFutureEquityAgreementTransactionDto | SdkExtendTransactionDto | SdkConversionTransactionDto | SdkExitTransactionDto | SdkValuationChangeTransactionDto | SdkInsolvencyTransactionDto | SdkOtherInvestmentTransactionDto)[]
+  meta: SdkPaginationMetaDto
+}
+
+export interface SdkMetricUnitDto {
+  unit: {  }
+  currencyCode?: string | null
+}
+
+export interface SdkMetricTypeDto {
   id: number
-  type: "Insolvency"
+  name: string
+  shortName?: string | null
+  description?: string | null
+  origin?: {  }
+  aggMethod: {  }
+  valueType?: {  }
+  unit?: SdkMetricUnitDto
+}
+
+export interface SdkMetricTypesListResponseDto {
+  data: SdkMetricTypeDto[]
+  meta: SdkPaginationMetaDto
+}
+
+export interface SdkMetricPointDto {
   date: string
+  timeframe: {  }
+  value: number | null
+  valueError?: string | null
+  aggregated?: boolean
+}
+
+export interface SdkCompanyMetricDto {
+  id: number
+  metricType: SdkMetricTypeDto
+  points: SdkMetricPointDto[]
+}
+
+export interface SdkCompanyMetricsDto {
   companyId: number
-  companyGroupId?: number | null
-  company?: SdkCompanyReferenceDto
-  companyGroup?: SdkCompanyGroupReferenceDto
-  currency?: string | null
-  additionalInfo?: SdkTransactionAdditionalInfoDto
-  children?: SdkTransactionBaseDto[]
-  customSummaryFairValue?: number | null
+  company: SdkCompanyReferenceDto
+  metrics: SdkCompanyMetricDto[]
 }
 
-export interface SdkOtherInvestmentTransactionDto {
+export interface SdkCompanyMetricsListResponseDto {
+  data: SdkCompanyMetricsDto[]
+  meta: SdkPaginationMetaDto
+}
+
+export interface MetricSearchDto {
+  limit?: number
+  cursor?: string
+  companyIds?: number[]
+  companyGroupIds?: number[]
+  metricTypeIds?: number[]
+  timeframe?: "Month" | "Quarter" | "Year"
+  from?: string
+  to?: string
+}
+
+export interface SdkCompanyReportSummaryDto {
   id: number
-  type: "OtherInvestment"
+  title: string
   date: string
-  companyId: number
-  companyGroupId?: number | null
-  company?: SdkCompanyReferenceDto
-  companyGroup?: SdkCompanyGroupReferenceDto
-  currency?: string | null
-  additionalInfo?: SdkTransactionAdditionalInfoDto
-  children?: SdkTransactionBaseDto[]
-  invested: number
-  name?: string | null
+  timeframe: {  }
+  publishedAt?: string | null
+  company: SdkCompanyReferenceDto
+}
+
+export interface SdkCompanyReportsListResponseDto {
+  data: SdkCompanyReportSummaryDto[]
+  meta: SdkPaginationMetaDto
+}
+
+export interface SdkUserReferenceDto {
+  id: number
+  name: string
+}
+
+export interface SdkCompanyReportAttachmentDto {
+  id: number
+  name: string
+  url?: string | null
+}
+
+export interface SdkCompanyReportSectionDto {
+  id: number
+  type: {  }
+  order: number
+  title: string
+  content?: string | null
+  file?: SdkCompanyReportAttachmentDto
+  imageUrl?: string | null
+}
+
+export interface SdkCompanyReportDto {
+  id: number
+  title: string
+  date: string
+  timeframe: {  }
+  publishedAt?: string | null
+  company: SdkCompanyReferenceDto
+  createdBy?: SdkUserReferenceDto
+  sections: SdkCompanyReportSectionDto[]
+  attachments: SdkCompanyReportAttachmentDto[]
 }
 
 export type CompaniesGetOneResponse = SdkCompanyDto
 
-export type CompaniesGetAllResponse = SdkCompactCompanyDto[]
+export type CompaniesGetAllResponse = SdkCompaniesListResponseDto
 
-export type CompanyGroupsGetAllResponse = SdkCompactCompanyGroupDto[]
+export type CompanyGroupsGetAllResponse = SdkCompanyGroupsListResponseDto
 
 export type CompanyGroupsGetOneResponse = SdkCompanyGroupDto
 
-export type PositionsGetCompanyPositionsResponse = SdkCompanyPositionDto[]
+export type PositionsGetCompanyPositionsResponse = SdkCompanyPositionsListResponseDto
 
 export type PositionsGetPortfolioPositionsResponse = SdkPortfolioPositionDto
 
-export type TransactionsGetCompanyTransactionsResponse = (SdkEquityTransactionDto | SdkConvertibleNoteTransactionDto | SdkFutureEquityAgreementTransactionDto | SdkExtendTransactionDto | SdkConversionTransactionDto | SdkExitTransactionDto | SdkValuationChangeTransactionDto | SdkInsolvencyTransactionDto | SdkOtherInvestmentTransactionDto)[]
+export type TransactionsGetCompanyTransactionsResponse = SdkTransactionsListResponseDto
+
+export type TransactionsGetTransactionsResponse = SdkTransactionsListResponseDto
+
+export type MetricsGetTypesResponse = SdkMetricTypesListResponseDto
+
+export type MetricsSearchResponse = SdkCompanyMetricsListResponseDto
 
-export type TransactionsGetTransactionsResponse = (SdkEquityTransactionDto | SdkConvertibleNoteTransactionDto | SdkFutureEquityAgreementTransactionDto | SdkExtendTransactionDto | SdkConversionTransactionDto | SdkExitTransactionDto | SdkValuationChangeTransactionDto | SdkInsolvencyTransactionDto | SdkOtherInvestmentTransactionDto)[]
+export type MetricsSearchBody = MetricSearchDto
+
+export type CompanyReportsListResponse = SdkCompanyReportsListResponseDto
+
+export type CompanyReportsGetOneResponse = SdkCompanyReportDto
+
+export interface CompaniesGetAllQuery {
+  /**
+   * Maximum items per page. Currently accepted but not enforced; reserved for future pagination.
+   */
+  limit?: number
+  /**
+   * Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored.
+   */
+  cursor?: string
+  /**
+   * Restrict results to these company identifiers
+   */
+  companyIds?: number[]
+  /**
+   * Restrict results to companies that belong to any of these company groups
+   */
+  companyGroupIds?: number[]
+}
+
+export interface CompanyGroupsGetAllQuery {
+  /**
+   * Maximum items per page. Currently accepted but not enforced; reserved for future pagination.
+   */
+  limit?: number
+  /**
+   * Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored.
+   */
+  cursor?: string
+  /**
+   * Restrict results to these company group identifiers
+   */
+  companyGroupIds?: number[]
+}
 
 export interface PositionsGetCompanyPositionsQuery {
   /**
-   * Optional company group identifier to filter by
+   * Maximum items per page. Currently accepted but not enforced; reserved for future pagination.
+   */
+  limit?: number
+  /**
+   * Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored.
+   */
+  cursor?: string
+  /**
+   * Optional list of company group identifiers to filter the position breakdown
    */
-  companyGroupId?: number
+  companyGroupIds?: number[]
   /**
    * Reporting currency code
    */
@@ -463,6 +630,10 @@ export interface PositionsGetPortfolioPositionsQuery {
    * Optional list of company group identifiers to filter the portfolio positions
    */
   companyGroupIds?: number[]
+  /**
+   * Optional list of company identifiers to narrow the aggregation to
+   */
+  companyIds?: number[]
   /**
    * Reporting currency code
    */
@@ -474,23 +645,86 @@ export interface PositionsGetPortfolioPositionsQuery {
 }
 
 export interface TransactionsGetCompanyTransactionsQuery {
+  /**
+   * Maximum items per page. Currently accepted but not enforced; reserved for future pagination.
+   */
+  limit?: number
+  /**
+   * Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored.
+   */
+  cursor?: string
   /**
    * Optional company group identifiers to filter transactions by
    */
   companyGroupIds?: number[]
+  /**
+   * Restrict results to these transaction types
+   */
+  types?: ("Auction" | "ConvertibleNote" | "ConvertToEquity" | "Dividend" | "EquityInvestment" | "EquityReceived" | "Extend" | "FutureEquityAgreement" | "Insolvency" | "IPO" | "LimitedAuction" | "OptionsReceived" | "OtherExit" | "OtherInvestment" | "OtherRealization" | "Payback" | "Proprietary" | "TradeSale" | "ValuationChange" | "WriteOff")[]
+  /**
+   * Exclude transactions on or after this ISO 8601 date (cut-off filter)
+   */
+  priorTo?: string
 }
 
 export interface TransactionsGetTransactionsQuery {
+  /**
+   * Maximum items per page. Currently accepted but not enforced; reserved for future pagination.
+   */
+  limit?: number
+  /**
+   * Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored.
+   */
+  cursor?: string
   /**
    * Optional company group identifiers to filter transactions by
    */
   companyGroupIds?: number[]
+  /**
+   * Restrict results to these transaction types
+   */
+  types?: ("Auction" | "ConvertibleNote" | "ConvertToEquity" | "Dividend" | "EquityInvestment" | "EquityReceived" | "Extend" | "FutureEquityAgreement" | "Insolvency" | "IPO" | "LimitedAuction" | "OptionsReceived" | "OtherExit" | "OtherInvestment" | "OtherRealization" | "Payback" | "Proprietary" | "TradeSale" | "ValuationChange" | "WriteOff")[]
+  /**
+   * Exclude transactions on or after this ISO 8601 date (cut-off filter)
+   */
+  priorTo?: string
   /**
    * Optional company identifiers to filter transactions by
    */
   companyIds?: number[]
 }
 
+export interface CompanyReportsListQuery {
+  /**
+   * Maximum items per page. Currently accepted but not enforced; reserved for future pagination.
+   */
+  limit?: number
+  /**
+   * Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored.
+   */
+  cursor?: string
+  /**
+   * Restrict results to these companies. Defaults to all companies the caller can access.
+   */
+  companyIds?: number[]
+  /**
+   * Restrict to companies that belong to any of these company groups.
+   */
+  companyGroupIds?: number[]
+  /**
+   * Restrict to a reporting period granularity (Month, Quarter, Year).
+   */
+  timeframe?: "Month" | "Quarter" | "Year"
+  /**
+   * Lower bound for the reporting period date (ISO 8601, inclusive).
+   */
+  from?: string
+  /**
+   * Upper bound for the reporting period date (ISO 8601, inclusive).
+   */
+  to?: string
+}
+
 export interface CompaniesNamespace {
   /**
    * Get one company available to the SDK consumer
@@ -500,17 +734,19 @@ export interface CompaniesNamespace {
   getOne(id: number, init?: RequestOptions): Promise<CompaniesGetOneResponse>
   /**
    * List companies available to the SDK consumer
+   * Parameters: query: limit? (number), cursor? (string), companyIds? (number[]), companyGroupIds? (number[])
    * Returns: CompaniesGetAllResponse
    */
-  getAll(init?: RequestOptions): Promise<CompaniesGetAllResponse>
+  getAll(query?: CompaniesGetAllQuery, init?: RequestOptions): Promise<CompaniesGetAllResponse>
 }
 
 export interface CompanyGroupsNamespace {
   /**
    * List company groups available to the SDK consumer
+   * Parameters: query: limit? (number), cursor? (string), companyGroupIds? (number[])
    * Returns: CompanyGroupsGetAllResponse
    */
-  getAll(init?: RequestOptions): Promise<CompanyGroupsGetAllResponse>
+  getAll(query?: CompanyGroupsGetAllQuery, init?: RequestOptions): Promise<CompanyGroupsGetAllResponse>
   /**
    * Get one company group available to the SDK consumer
    * Parameters: path: id (number)
@@ -522,13 +758,13 @@ export interface CompanyGroupsNamespace {
 export interface PositionsNamespace {
   /**
    * Get positions for one company
-   * Parameters: path: id (number); query: companyGroupId? (number), currency (string), date? (string)
+   * Parameters: path: id (number); query: limit? (number), cursor? (string), companyGroupIds? (number[]), currency (string), date? (string)
    * Returns: PositionsGetCompanyPositionsResponse
    */
   getCompanyPositions(id: number, query?: PositionsGetCompanyPositionsQuery, init?: RequestOptions): Promise<PositionsGetCompanyPositionsResponse>
   /**
    * Get portfolio positions
-   * Parameters: query: companyGroupIds? (number[]), currency (string), date? (string)
+   * Parameters: query: companyGroupIds? (number[]), companyIds? (number[]), currency (string), date? (string)
    * Returns: PositionsGetPortfolioPositionsResponse
    */
   getPortfolioPositions(query?: PositionsGetPortfolioPositionsQuery, init?: RequestOptions): Promise<PositionsGetPortfolioPositionsResponse>
@@ -537,23 +773,58 @@ export interface PositionsNamespace {
 export interface TransactionsNamespace {
   /**
    * Get transactions for one company
-   * Parameters: path: id (number); query: companyGroupIds? (number[])
+   * 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)
    * Returns: TransactionsGetCompanyTransactionsResponse
    */
   getCompanyTransactions(id: number, query?: TransactionsGetCompanyTransactionsQuery, init?: RequestOptions): Promise<TransactionsGetCompanyTransactionsResponse>
   /**
    * Get transactions for multiple companies
-   * Parameters: query: companyGroupIds? (number[]), companyIds? (number[])
+   * Parameters: 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), companyIds? (number[])
    * Returns: TransactionsGetTransactionsResponse
    */
   getTransactions(query?: TransactionsGetTransactionsQuery, init?: RequestOptions): Promise<TransactionsGetTransactionsResponse>
 }
 
+export interface MetricsNamespace {
+  /**
+   * List metric types available to the SDK consumer
+   * 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.
+   * Returns: MetricsGetTypesResponse
+   */
+  getTypes(init?: RequestOptions): Promise<MetricsGetTypesResponse>
+  /**
+   * Read metric values for accessible companies, grouped by company
+   * 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.
+   * Parameters: body: MetricsSearchBody
+   * Returns: MetricsSearchResponse
+   */
+  search(body: MetricsSearchBody, init?: RequestOptions): Promise<MetricsSearchResponse>
+}
+
+export interface CompanyReportsNamespace {
+  /**
+   * List published company reports accessible to the caller (metadata only)
+   * 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).
+   * Parameters: query: limit? (number), cursor? (string), companyIds? (number[]), companyGroupIds? (number[]), timeframe? ("Month" | "Quarter" | "Year"), from? (string), to? (string)
+   * Returns: CompanyReportsListResponse
+   */
+  list(query?: CompanyReportsListQuery, init?: RequestOptions): Promise<CompanyReportsListResponse>
+  /**
+   * Fetch the full content of a single company report
+   * 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.
+   * Parameters: path: id (number)
+   * Returns: CompanyReportsGetOneResponse
+   */
+  getOne(id: number, init?: RequestOptions): Promise<CompanyReportsGetOneResponse>
+}
+
 export interface EmbedClient {
   companies: CompaniesNamespace
   companyGroups: CompanyGroupsNamespace
   positions: PositionsNamespace
   transactions: TransactionsNamespace
+  metrics: MetricsNamespace
+  companyReports: CompanyReportsNamespace
 }
 
 export declare function createEmbedClient(options: CreateEmbedClientOptions): EmbedClient
@@ -561,10 +832,10 @@ export declare function createEmbedClient(options: CreateEmbedClientOptions): Em
 export declare const routeManifest: {
   companies: {
     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 }[] }
-    getAll: { method: "GET"; path: "/companies"; summary: "List companies available to the SDK consumer"; description: null; exampleCall: "client.companies.getAll()"; responseType: "CompaniesGetAllResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
+    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 }[] }
   }
   companyGroups: {
-    getAll: { method: "GET"; path: "/company-groups"; summary: "List company groups available to the SDK consumer"; description: null; exampleCall: "client.companyGroups.getAll()"; responseType: "CompanyGroupsGetAllResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
+    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 }[] }
     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 }[] }
   }
   positions: {
@@ -572,7 +843,15 @@ export declare const routeManifest: {
     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 }[] }
   }
   transactions: {
-    getCompanyTransactions: { method: "GET"; path: "/transactions/companies/:id"; summary: "Get transactions for one company"; description: null; exampleCall: "client.transactions.getCompanyTransactions(123, { companyGroupIds: [123] })"; responseType: "TransactionsGetCompanyTransactionsResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
-    getTransactions: { method: "GET"; path: "/transactions"; summary: "Get transactions for multiple companies"; description: null; exampleCall: "client.transactions.getTransactions({ companyGroupIds: [123] })"; responseType: "TransactionsGetTransactionsResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
+    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 }[] }
+    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 }[] }
+  }
+  metrics: {
+    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 }[] }
+    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 }[] }
+  }
+  companyReports: {
+    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 }[] }
+    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 }[] }
   }
 }