@rundit-sdk/embed 0.3.3 → 0.3.4
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/AGENTS.md +2 -1
- package/README.md +2 -1
- package/ai-manifest.json +43 -30
- package/dist/index.d.ts +55 -43
- package/dist/index.js +44 -31
- package/openapi.json +85 -42
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -382,6 +382,8 @@ export interface SdkBatchDashboardResponseDto {
|
|
|
382
382
|
}
|
|
383
383
|
|
|
384
384
|
export interface GetBatchDashboardBodyDto {
|
|
385
|
+
limit?: number
|
|
386
|
+
cursor?: string
|
|
385
387
|
companyIds: number[]
|
|
386
388
|
currency: string
|
|
387
389
|
metricsFrom?: string
|
|
@@ -641,8 +643,6 @@ export interface SdkMetricCompareMultiResponseDto {
|
|
|
641
643
|
}
|
|
642
644
|
|
|
643
645
|
export interface MetricCompareDto {
|
|
644
|
-
limit?: number
|
|
645
|
-
cursor?: string
|
|
646
646
|
metricTypeIds: number[]
|
|
647
647
|
companyIds?: number[]
|
|
648
648
|
companyNameSearch?: string[]
|
|
@@ -844,11 +844,11 @@ export interface CompaniesGetDashboardQuery {
|
|
|
844
844
|
|
|
845
845
|
export interface CompaniesGetAllQuery {
|
|
846
846
|
/**
|
|
847
|
-
* Maximum items per page.
|
|
847
|
+
* Maximum items per page (1-500). Omit to receive the full result set in one response. Values outside that range are rejected with 422 rather than clamped, so a page is never quietly smaller than requested.
|
|
848
848
|
*/
|
|
849
849
|
limit?: number
|
|
850
850
|
/**
|
|
851
|
-
* Opaque cursor from a previous response's meta.nextCursor.
|
|
851
|
+
* Opaque cursor from a previous response's `meta.nextCursor`. Carries the page size it was issued with, so a follow-up call needs only the cursor. Valid solely for the endpoint, filters, and caller that produced it — change any of them and you get 422; start again without a cursor. Paging reflects the data as of each request, so rows added or removed mid-walk can shift positions.
|
|
852
852
|
*/
|
|
853
853
|
cursor?: string
|
|
854
854
|
/**
|
|
@@ -867,11 +867,11 @@ export interface CompaniesGetAllQuery {
|
|
|
867
867
|
|
|
868
868
|
export interface CompanyGroupsGetAllQuery {
|
|
869
869
|
/**
|
|
870
|
-
* Maximum items per page.
|
|
870
|
+
* Maximum items per page (1-500). Omit to receive the full result set in one response. Values outside that range are rejected with 422 rather than clamped, so a page is never quietly smaller than requested.
|
|
871
871
|
*/
|
|
872
872
|
limit?: number
|
|
873
873
|
/**
|
|
874
|
-
* Opaque cursor from a previous response's meta.nextCursor.
|
|
874
|
+
* Opaque cursor from a previous response's `meta.nextCursor`. Carries the page size it was issued with, so a follow-up call needs only the cursor. Valid solely for the endpoint, filters, and caller that produced it — change any of them and you get 422; start again without a cursor. Paging reflects the data as of each request, so rows added or removed mid-walk can shift positions.
|
|
875
875
|
*/
|
|
876
876
|
cursor?: string
|
|
877
877
|
/**
|
|
@@ -886,11 +886,11 @@ export interface CompanyGroupsGetAllQuery {
|
|
|
886
886
|
|
|
887
887
|
export interface PositionsGetPortfolioSummaryQuery {
|
|
888
888
|
/**
|
|
889
|
-
* Maximum items per page.
|
|
889
|
+
* Maximum items per page (1-500). Omit to receive the full result set in one response. Values outside that range are rejected with 422 rather than clamped, so a page is never quietly smaller than requested.
|
|
890
890
|
*/
|
|
891
891
|
limit?: number
|
|
892
892
|
/**
|
|
893
|
-
* Opaque cursor from a previous response's meta.nextCursor.
|
|
893
|
+
* Opaque cursor from a previous response's `meta.nextCursor`. Carries the page size it was issued with, so a follow-up call needs only the cursor. Valid solely for the endpoint, filters, and caller that produced it — change any of them and you get 422; start again without a cursor. Paging reflects the data as of each request, so rows added or removed mid-walk can shift positions.
|
|
894
894
|
*/
|
|
895
895
|
cursor?: string
|
|
896
896
|
/**
|
|
@@ -917,11 +917,11 @@ export interface PositionsGetPortfolioSummaryQuery {
|
|
|
917
917
|
|
|
918
918
|
export interface PositionsGetCompanyPositionsQuery {
|
|
919
919
|
/**
|
|
920
|
-
* Maximum items per page.
|
|
920
|
+
* Maximum items per page (1-500). Omit to receive the full result set in one response. Values outside that range are rejected with 422 rather than clamped, so a page is never quietly smaller than requested.
|
|
921
921
|
*/
|
|
922
922
|
limit?: number
|
|
923
923
|
/**
|
|
924
|
-
* Opaque cursor from a previous response's meta.nextCursor.
|
|
924
|
+
* Opaque cursor from a previous response's `meta.nextCursor`. Carries the page size it was issued with, so a follow-up call needs only the cursor. Valid solely for the endpoint, filters, and caller that produced it — change any of them and you get 422; start again without a cursor. Paging reflects the data as of each request, so rows added or removed mid-walk can shift positions.
|
|
925
925
|
*/
|
|
926
926
|
cursor?: string
|
|
927
927
|
/**
|
|
@@ -959,11 +959,11 @@ export interface PositionsGetPortfolioPositionsQuery {
|
|
|
959
959
|
|
|
960
960
|
export interface TransactionsGetSummaryQuery {
|
|
961
961
|
/**
|
|
962
|
-
* Maximum items per page.
|
|
962
|
+
* Maximum items per page (1-500). Omit to receive the full result set in one response. Values outside that range are rejected with 422 rather than clamped, so a page is never quietly smaller than requested.
|
|
963
963
|
*/
|
|
964
964
|
limit?: number
|
|
965
965
|
/**
|
|
966
|
-
* Opaque cursor from a previous response's meta.nextCursor.
|
|
966
|
+
* Opaque cursor from a previous response's `meta.nextCursor`. Carries the page size it was issued with, so a follow-up call needs only the cursor. Valid solely for the endpoint, filters, and caller that produced it — change any of them and you get 422; start again without a cursor. Paging reflects the data as of each request, so rows added or removed mid-walk can shift positions.
|
|
967
967
|
*/
|
|
968
968
|
cursor?: string
|
|
969
969
|
/**
|
|
@@ -994,11 +994,11 @@ export interface TransactionsGetSummaryQuery {
|
|
|
994
994
|
|
|
995
995
|
export interface TransactionsGetCompanyTransactionsQuery {
|
|
996
996
|
/**
|
|
997
|
-
* Maximum items per page.
|
|
997
|
+
* Maximum items per page (1-500). Omit to receive the full result set in one response. Values outside that range are rejected with 422 rather than clamped, so a page is never quietly smaller than requested.
|
|
998
998
|
*/
|
|
999
999
|
limit?: number
|
|
1000
1000
|
/**
|
|
1001
|
-
* Opaque cursor from a previous response's meta.nextCursor.
|
|
1001
|
+
* Opaque cursor from a previous response's `meta.nextCursor`. Carries the page size it was issued with, so a follow-up call needs only the cursor. Valid solely for the endpoint, filters, and caller that produced it — change any of them and you get 422; start again without a cursor. Paging reflects the data as of each request, so rows added or removed mid-walk can shift positions.
|
|
1002
1002
|
*/
|
|
1003
1003
|
cursor?: string
|
|
1004
1004
|
/**
|
|
@@ -1017,11 +1017,11 @@ export interface TransactionsGetCompanyTransactionsQuery {
|
|
|
1017
1017
|
|
|
1018
1018
|
export interface TransactionsGetTransactionsQuery {
|
|
1019
1019
|
/**
|
|
1020
|
-
* Maximum items per page.
|
|
1020
|
+
* Maximum items per page (1-500). Omit to receive the full result set in one response. Values outside that range are rejected with 422 rather than clamped, so a page is never quietly smaller than requested.
|
|
1021
1021
|
*/
|
|
1022
1022
|
limit?: number
|
|
1023
1023
|
/**
|
|
1024
|
-
* Opaque cursor from a previous response's meta.nextCursor.
|
|
1024
|
+
* Opaque cursor from a previous response's `meta.nextCursor`. Carries the page size it was issued with, so a follow-up call needs only the cursor. Valid solely for the endpoint, filters, and caller that produced it — change any of them and you get 422; start again without a cursor. Paging reflects the data as of each request, so rows added or removed mid-walk can shift positions.
|
|
1025
1025
|
*/
|
|
1026
1026
|
cursor?: string
|
|
1027
1027
|
/**
|
|
@@ -1042,13 +1042,24 @@ export interface TransactionsGetTransactionsQuery {
|
|
|
1042
1042
|
companyIds?: number[]
|
|
1043
1043
|
}
|
|
1044
1044
|
|
|
1045
|
+
export interface MetricsGetTypesQuery {
|
|
1046
|
+
/**
|
|
1047
|
+
* Maximum items per page (1-500). Omit to receive the full result set in one response. Values outside that range are rejected with 422 rather than clamped, so a page is never quietly smaller than requested.
|
|
1048
|
+
*/
|
|
1049
|
+
limit?: number
|
|
1050
|
+
/**
|
|
1051
|
+
* Opaque cursor from a previous response's `meta.nextCursor`. Carries the page size it was issued with, so a follow-up call needs only the cursor. Valid solely for the endpoint, filters, and caller that produced it — change any of them and you get 422; start again without a cursor. Paging reflects the data as of each request, so rows added or removed mid-walk can shift positions.
|
|
1052
|
+
*/
|
|
1053
|
+
cursor?: string
|
|
1054
|
+
}
|
|
1055
|
+
|
|
1045
1056
|
export interface CompanyReportsListQuery {
|
|
1046
1057
|
/**
|
|
1047
|
-
* Maximum items per page.
|
|
1058
|
+
* Maximum items per page (1-500). Omit to receive the full result set in one response. Values outside that range are rejected with 422 rather than clamped, so a page is never quietly smaller than requested.
|
|
1048
1059
|
*/
|
|
1049
1060
|
limit?: number
|
|
1050
1061
|
/**
|
|
1051
|
-
* Opaque cursor from a previous response's meta.nextCursor.
|
|
1062
|
+
* Opaque cursor from a previous response's `meta.nextCursor`. Carries the page size it was issued with, so a follow-up call needs only the cursor. Valid solely for the endpoint, filters, and caller that produced it — change any of them and you get 422; start again without a cursor. Paging reflects the data as of each request, so rows added or removed mid-walk can shift positions.
|
|
1052
1063
|
*/
|
|
1053
1064
|
cursor?: string
|
|
1054
1065
|
/**
|
|
@@ -1080,7 +1091,7 @@ export interface CompanyReportsListQuery {
|
|
|
1080
1091
|
export interface CompaniesNamespace {
|
|
1081
1092
|
/**
|
|
1082
1093
|
* PREFERRED tool for multi-company analysis — full dashboards for many companies in one call
|
|
1083
|
-
* 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. `metricsFrom` (ISO 8601) sets a lower-bound date for metric data points; omit to include all history. `metricsTimeframe` restricts data point granularity to Month, Quarter, or Year. `currency` (ISO 4217, required) FX-converts all monetary metrics across the batch. `conversionStrategy` controls which rate is applied: `LATEST_FX_RATE` (default) or `ENTITY_DATE_RATE` (the rate on each point's own date). `transactionLimit` / `reportLimit` cap list sizes per company (defaults: 10 and 5 respectively).
|
|
1094
|
+
* 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. `metricsFrom` (ISO 8601) sets a lower-bound date for metric data points; omit to include all history. `metricsTimeframe` restricts data point granularity to Month, Quarter, or Year. `currency` (ISO 4217, required) FX-converts all monetary metrics across the batch. `conversionStrategy` controls which rate is applied: `LATEST_FX_RATE` (default) or `ENTITY_DATE_RATE` (the rate on each point's own date). `transactionLimit` / `reportLimit` cap list sizes per company (defaults: 10 and 5 respectively). Dashboards come back in the order the `companyIds` were requested, so `limit`/`cursor` paging is stable.
|
|
1084
1095
|
* Parameters: body: CompaniesGetDashboardsBody
|
|
1085
1096
|
* Returns: CompaniesGetDashboardsResponse
|
|
1086
1097
|
*/
|
|
@@ -1101,7 +1112,7 @@ export interface CompaniesNamespace {
|
|
|
1101
1112
|
getOne(id: number, init?: RequestOptions): Promise<CompaniesGetOneResponse>
|
|
1102
1113
|
/**
|
|
1103
1114
|
* List companies available to the SDK consumer
|
|
1104
|
-
* 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.
|
|
1115
|
+
* 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. Ordered by company id ascending.
|
|
1105
1116
|
* Parameters: query: limit? (number), cursor? (string), companyIds? (number[]), companyGroupIds? (number[]), nameSearch? (string[])
|
|
1106
1117
|
* Returns: CompaniesGetAllResponse
|
|
1107
1118
|
*/
|
|
@@ -1111,7 +1122,7 @@ export interface CompaniesNamespace {
|
|
|
1111
1122
|
export interface CompanyGroupsNamespace {
|
|
1112
1123
|
/**
|
|
1113
1124
|
* List funds available to the SDK consumer
|
|
1114
|
-
* Returns compact fund 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"]`).
|
|
1125
|
+
* Returns compact fund 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"]`). Ordered by fund id ascending.
|
|
1115
1126
|
* Parameters: query: limit? (number), cursor? (string), companyGroupIds? (number[]), nameSearch? (string[])
|
|
1116
1127
|
* Returns: CompanyGroupsGetAllResponse
|
|
1117
1128
|
*/
|
|
@@ -1128,14 +1139,14 @@ export interface CompanyGroupsNamespace {
|
|
|
1128
1139
|
export interface PositionsNamespace {
|
|
1129
1140
|
/**
|
|
1130
1141
|
* Get portfolio summary with positions and key metrics per company
|
|
1131
|
-
* 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.
|
|
1142
|
+
* Returns one row per company *per fund* — a company held by two funds appears twice, distinguished by `companyGroupId` — 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. Ordered by company id, then fund id.
|
|
1132
1143
|
* Parameters: query: limit? (number), cursor? (string), companyGroupIds? (number[]), companyIds? (number[]), currency (string), date? (string), metricTypeNames? (string[])
|
|
1133
1144
|
* Returns: PositionsGetPortfolioSummaryResponse
|
|
1134
1145
|
*/
|
|
1135
1146
|
getPortfolioSummary(query?: PositionsGetPortfolioSummaryQuery, init?: RequestOptions): Promise<PositionsGetPortfolioSummaryResponse>
|
|
1136
1147
|
/**
|
|
1137
1148
|
* Get positions for one company
|
|
1138
|
-
* Returns all fund-level positions for a single company — one entry per fund (`companyGroupId`) that holds a position in the company. Each entry carries invested amount, fair market value, ownership percentage, share counts, multiple, and ROI, all FX-converted to `currency` (ISO 4217, required). Filter by `companyGroupIds` to scope to specific funds. Use `date` (ISO 8601) for a historical snapshot; omit to use the latest available data.
|
|
1149
|
+
* Returns all fund-level positions for a single company — one entry per fund (`companyGroupId`) that holds a position in the company. Each entry carries invested amount, fair market value, ownership percentage, share counts, multiple, and ROI, all FX-converted to `currency` (ISO 4217, required). Filter by `companyGroupIds` to scope to specific funds. Use `date` (ISO 8601) for a historical snapshot; omit to use the latest available data. Ordered by fund id ascending.
|
|
1139
1150
|
* Parameters: path: id (number); query: limit? (number), cursor? (string), companyGroupIds? (number[]), currency (string), date? (string)
|
|
1140
1151
|
* Returns: PositionsGetCompanyPositionsResponse
|
|
1141
1152
|
*/
|
|
@@ -1152,21 +1163,21 @@ export interface PositionsNamespace {
|
|
|
1152
1163
|
export interface TransactionsNamespace {
|
|
1153
1164
|
/**
|
|
1154
1165
|
* Get transaction activity summary
|
|
1155
|
-
* 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, fund (`companyGroupIds`), and date range.
|
|
1166
|
+
* 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, fund (`companyGroupIds`), and date range. Ordered by period ascending.
|
|
1156
1167
|
* Parameters: query: limit? (number), cursor? (string), companyGroupIds? (number[]), companyIds? (number[]), currency (string), groupBy? ("Month" | "Quarter" | "Year"), from? (string), to? (string)
|
|
1157
1168
|
* Returns: TransactionsGetSummaryResponse
|
|
1158
1169
|
*/
|
|
1159
1170
|
getSummary(query?: TransactionsGetSummaryQuery, init?: RequestOptions): Promise<TransactionsGetSummaryResponse>
|
|
1160
1171
|
/**
|
|
1161
1172
|
* Get transactions for one company
|
|
1162
|
-
* Returns all transactions for a single company, ordered by date descending. Each transaction is a typed variant — narrow it via its `type` field. Filter by `companyGroupIds` to scope to a specific fund, `types` to limit to specific transaction kinds, and `priorTo` (ISO 8601) for a historical snapshot. Requires transaction read access on the company.
|
|
1173
|
+
* Returns all transactions for a single company, ordered by date descending then id descending. Each transaction is a typed variant — narrow it via its `type` field. Filter by `companyGroupIds` to scope to a specific fund, `types` to limit to specific transaction kinds, and `priorTo` (ISO 8601) for a historical snapshot. Requires transaction read access on the company.
|
|
1163
1174
|
* 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)
|
|
1164
1175
|
* Returns: TransactionsGetCompanyTransactionsResponse
|
|
1165
1176
|
*/
|
|
1166
1177
|
getCompanyTransactions(id: number, query?: TransactionsGetCompanyTransactionsQuery, init?: RequestOptions): Promise<TransactionsGetCompanyTransactionsResponse>
|
|
1167
1178
|
/**
|
|
1168
1179
|
* Get transactions for multiple companies
|
|
1169
|
-
* Returns transactions across multiple companies. Each transaction is a typed variant — narrow it via its `type` field. Filter by `companyIds`, `companyGroupIds`, `types`, and `priorTo` (ISO 8601 upper-bound date for a historical snapshot). When `companyIds` is provided, the caller must have transaction read access on every listed company.
|
|
1180
|
+
* Returns transactions across multiple companies. Each transaction is a typed variant — narrow it via its `type` field. Filter by `companyIds`, `companyGroupIds`, `types`, and `priorTo` (ISO 8601 upper-bound date for a historical snapshot). When `companyIds` is provided, the caller must have transaction read access on every listed company. Ordered by date descending, then id descending.
|
|
1170
1181
|
* 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[])
|
|
1171
1182
|
* Returns: TransactionsGetTransactionsResponse
|
|
1172
1183
|
*/
|
|
@@ -1176,13 +1187,14 @@ export interface TransactionsNamespace {
|
|
|
1176
1187
|
export interface MetricsNamespace {
|
|
1177
1188
|
/**
|
|
1178
1189
|
* List metric types available to the SDK consumer
|
|
1179
|
-
* 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.
|
|
1190
|
+
* 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. Ordered by metric type id ascending.
|
|
1191
|
+
* Parameters: query: limit? (number), cursor? (string)
|
|
1180
1192
|
* Returns: MetricsGetTypesResponse
|
|
1181
1193
|
*/
|
|
1182
|
-
getTypes(init?: RequestOptions): Promise<MetricsGetTypesResponse>
|
|
1194
|
+
getTypes(query?: MetricsGetTypesQuery, init?: RequestOptions): Promise<MetricsGetTypesResponse>
|
|
1183
1195
|
/**
|
|
1184
1196
|
* Read metric values for accessible companies, grouped by company
|
|
1185
|
-
* 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.
|
|
1197
|
+
* 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. Entries are ordered by company id ascending — one entry per company, so `limit` pages whole companies, never partial metric lists.
|
|
1186
1198
|
* Parameters: body: MetricsSearchBody
|
|
1187
1199
|
* Returns: MetricsSearchResponse
|
|
1188
1200
|
*/
|
|
@@ -1196,7 +1208,7 @@ export interface MetricsNamespace {
|
|
|
1196
1208
|
compare(body: MetricsCompareBody, init?: RequestOptions): Promise<MetricsCompareResponse>
|
|
1197
1209
|
/**
|
|
1198
1210
|
* Aggregate metrics across portfolio companies
|
|
1199
|
-
* 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 fund (`companyGroupId`) 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.
|
|
1211
|
+
* 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 fund (`companyGroupId`) 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. Ordered by metric type id, then aggregation, then fund id.
|
|
1200
1212
|
* Parameters: body: MetricsAggregateBody
|
|
1201
1213
|
* Returns: MetricsAggregateResponse
|
|
1202
1214
|
*/
|
|
@@ -1206,7 +1218,7 @@ export interface MetricsNamespace {
|
|
|
1206
1218
|
export interface CompanyReportsNamespace {
|
|
1207
1219
|
/**
|
|
1208
1220
|
* List published company reports accessible to the caller (metadata only)
|
|
1209
|
-
* 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, funds (`companyGroupIds`), company name substring (`companyNameSearch`), and reporting period (timeframe + date range).
|
|
1221
|
+
* 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, funds (`companyGroupIds`), company name substring (`companyNameSearch`), and reporting period (timeframe + date range). Ordered by report date descending, then id descending — newest first.
|
|
1210
1222
|
* Parameters: query: limit? (number), cursor? (string), companyIds? (number[]), companyGroupIds? (number[]), companyNameSearch? (string[]), timeframe? ("Month" | "Quarter" | "Year"), from? (string), to? (string)
|
|
1211
1223
|
* Returns: CompanyReportsListResponse
|
|
1212
1224
|
*/
|
|
@@ -1233,33 +1245,33 @@ export declare function createEmbedClient(options: CreateEmbedClientOptions): Em
|
|
|
1233
1245
|
|
|
1234
1246
|
export declare const routeManifest: {
|
|
1235
1247
|
companies: {
|
|
1236
|
-
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. `metricsFrom` (ISO 8601) sets a lower-bound date for metric data points; omit to include all history. `metricsTimeframe` restricts data point granularity to Month, Quarter, or Year. `currency` (ISO 4217, required) FX-converts all monetary metrics across the batch. `conversionStrategy` controls which rate is applied: `LATEST_FX_RATE` (default) or `ENTITY_DATE_RATE` (the rate on each point's own date). `transactionLimit` / `reportLimit` cap list sizes per company (defaults: 10 and 5 respectively)."; 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 }[] }
|
|
1248
|
+
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. `metricsFrom` (ISO 8601) sets a lower-bound date for metric data points; omit to include all history. `metricsTimeframe` restricts data point granularity to Month, Quarter, or Year. `currency` (ISO 4217, required) FX-converts all monetary metrics across the batch. `conversionStrategy` controls which rate is applied: `LATEST_FX_RATE` (default) or `ENTITY_DATE_RATE` (the rate on each point's own date). `transactionLimit` / `reportLimit` cap list sizes per company (defaults: 10 and 5 respectively). Dashboards come back in the order the `companyIds` were requested, so `limit`/`cursor` paging is stable."; 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 }[] }
|
|
1237
1249
|
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 }[] }
|
|
1238
1250
|
getOne: { method: "GET"; path: "/companies/:id"; summary: "Get one company available to the SDK consumer"; description: "Returns the full company object for a single company. Includes all compact-list fields (id, name, type, currency, website, logo) plus extended metadata: legal name, status, description, vision, address, city, state, country, operating countries, VAT number, founding year, established date, total funding, and accessible fund ids (as `companyGroupIds`). Returns 404 if the company does not exist or is inaccessible to the caller."; 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 }[] }
|
|
1239
|
-
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 }[] }
|
|
1251
|
+
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. Ordered by company id ascending."; 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 }[] }
|
|
1240
1252
|
}
|
|
1241
1253
|
companyGroups: {
|
|
1242
|
-
getAll: { method: "GET"; path: "/company-groups"; summary: "List funds available to the SDK consumer"; description: "Returns compact fund 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 }[] }
|
|
1254
|
+
getAll: { method: "GET"; path: "/company-groups"; summary: "List funds available to the SDK consumer"; description: "Returns compact fund 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\"]`). Ordered by fund id ascending."; 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 }[] }
|
|
1243
1255
|
getOne: { method: "GET"; path: "/company-groups/:id"; summary: "Get one fund available to the SDK consumer"; description: "Returns full fund details. Includes all compact-list fields (id, name, type, currency, logo) plus extended fund metadata: legal name, domicile, management company, GP, vintage year, fund currency, opening and closing dates, legal form, investment policy, fees, regulatory info, and service providers. Also includes the list of member companies the caller can access. Returns 404 if the fund does not exist or is inaccessible to the caller."; 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 }[] }
|
|
1244
1256
|
}
|
|
1245
1257
|
positions: {
|
|
1246
|
-
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 }[] }
|
|
1247
|
-
getCompanyPositions: { method: "GET"; path: "/positions/companies/:id"; summary: "Get positions for one company"; description: "Returns all fund-level positions for a single company — one entry per fund (`companyGroupId`) that holds a position in the company. Each entry carries invested amount, fair market value, ownership percentage, share counts, multiple, and ROI, all FX-converted to `currency` (ISO 4217, required). Filter by `companyGroupIds` to scope to specific funds. Use `date` (ISO 8601) for a historical snapshot; omit to use the latest available data."; 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 }[] }
|
|
1258
|
+
getPortfolioSummary: { method: "GET"; path: "/positions/portfolio/summary"; summary: "Get portfolio summary with positions and key metrics per company"; description: "Returns one row per company *per fund* — a company held by two funds appears twice, distinguished by `companyGroupId` — 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. Ordered by company id, then fund id."; 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 }[] }
|
|
1259
|
+
getCompanyPositions: { method: "GET"; path: "/positions/companies/:id"; summary: "Get positions for one company"; description: "Returns all fund-level positions for a single company — one entry per fund (`companyGroupId`) that holds a position in the company. Each entry carries invested amount, fair market value, ownership percentage, share counts, multiple, and ROI, all FX-converted to `currency` (ISO 4217, required). Filter by `companyGroupIds` to scope to specific funds. Use `date` (ISO 8601) for a historical snapshot; omit to use the latest available data. Ordered by fund id ascending."; 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 }[] }
|
|
1248
1260
|
getPortfolioPositions: { method: "GET"; path: "/positions/portfolio"; summary: "Get aggregated portfolio position totals"; description: "Returns a single aggregated position object that sums invested amount, fair market value, ownership percentage, share counts, multiple, and ROI across all accessible companies (optionally filtered by `companyIds` and/or `companyGroupIds` to scope to specific funds). `currency` (ISO 4217, required) converts all monetary values. Use `date` (ISO 8601) for a historical snapshot; omit for the latest available data. For a per-company breakdown instead of a single aggregate, use `GET /positions/portfolio/summary`."; 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 }[] }
|
|
1249
1261
|
}
|
|
1250
1262
|
transactions: {
|
|
1251
|
-
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, fund (`companyGroupIds`), 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 }[] }
|
|
1252
|
-
getCompanyTransactions: { method: "GET"; path: "/transactions/companies/:id"; summary: "Get transactions for one company"; description: "Returns all transactions for a single company, ordered by date descending. Each transaction is a typed variant — narrow it via its `type` field. Filter by `companyGroupIds` to scope to a specific fund, `types` to limit to specific transaction kinds, and `priorTo` (ISO 8601) for a historical snapshot. Requires transaction read access on the company."; 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 }[] }
|
|
1253
|
-
getTransactions: { method: "GET"; path: "/transactions"; summary: "Get transactions for multiple companies"; description: "Returns transactions across multiple companies. Each transaction is a typed variant — narrow it via its `type` field. Filter by `companyIds`, `companyGroupIds`, `types`, and `priorTo` (ISO 8601 upper-bound date for a historical snapshot). When `companyIds` is provided, the caller must have transaction read access on every listed company."; 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 }[] }
|
|
1263
|
+
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, fund (`companyGroupIds`), and date range. Ordered by period ascending."; 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 }[] }
|
|
1264
|
+
getCompanyTransactions: { method: "GET"; path: "/transactions/companies/:id"; summary: "Get transactions for one company"; description: "Returns all transactions for a single company, ordered by date descending then id descending. Each transaction is a typed variant — narrow it via its `type` field. Filter by `companyGroupIds` to scope to a specific fund, `types` to limit to specific transaction kinds, and `priorTo` (ISO 8601) for a historical snapshot. Requires transaction read access on the company."; 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 }[] }
|
|
1265
|
+
getTransactions: { method: "GET"; path: "/transactions"; summary: "Get transactions for multiple companies"; description: "Returns transactions across multiple companies. Each transaction is a typed variant — narrow it via its `type` field. Filter by `companyIds`, `companyGroupIds`, `types`, and `priorTo` (ISO 8601 upper-bound date for a historical snapshot). When `companyIds` is provided, the caller must have transaction read access on every listed company. Ordered by date descending, then id descending."; 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 }[] }
|
|
1254
1266
|
}
|
|
1255
1267
|
metrics: {
|
|
1256
|
-
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 }[] }
|
|
1257
|
-
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 }[] }
|
|
1268
|
+
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. Ordered by metric type id ascending."; exampleCall: "client.metrics.getTypes({ limit: 123 })"; responseType: "MetricsGetTypesResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
|
|
1269
|
+
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. Entries are ordered by company id ascending — one entry per company, so `limit` pages whole companies, never partial metric lists."; exampleCall: "client.metrics.search({})"; responseType: "MetricsSearchResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
|
|
1258
1270
|
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 }[] }
|
|
1259
|
-
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 fund (`companyGroupId`) 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 }[] }
|
|
1271
|
+
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 fund (`companyGroupId`) 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. Ordered by metric type id, then aggregation, then fund id."; 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 }[] }
|
|
1260
1272
|
}
|
|
1261
1273
|
companyReports: {
|
|
1262
|
-
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, funds (`companyGroupIds`), 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 }[] }
|
|
1274
|
+
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, funds (`companyGroupIds`), company name substring (`companyNameSearch`), and reporting period (timeframe + date range). Ordered by report date descending, then id descending — newest first."; 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 }[] }
|
|
1263
1275
|
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 }[] }
|
|
1264
1276
|
}
|
|
1265
1277
|
}
|