@rundit-sdk/embed 0.3.5-rc.14 → 0.3.5-rc.16
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 +6 -6
- package/README.md +6 -6
- package/ai-manifest.json +84 -12
- package/dist/index.d.ts +96 -36
- package/dist/index.js +84 -12
- package/openapi.json +413 -56
- package/package.json +1 -1
package/dist/index.js
CHANGED
|
@@ -4,7 +4,7 @@ const routeManifest = {
|
|
|
4
4
|
"method": "POST",
|
|
5
5
|
"path": "/companies/dashboards",
|
|
6
6
|
"summary": "PREFERRED tool for multi-company analysis — full dashboards for many companies in one call",
|
|
7
|
-
"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` (case-insensitive exact match on full name or `shortName`) 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.",
|
|
7
|
+
"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` (case-insensitive exact match on full name or `shortName`) 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. `metricsPointLimit` keeps only the most recent N points per metric (`1` = latest dated point; set `metricsTo` to today to exclude future values) — full histories for many companies add up quickly. `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.",
|
|
8
8
|
"exampleCall": "client.companies.getDashboards({ companyIds: [123], currency: 'USD' })",
|
|
9
9
|
"responseType": "CompaniesGetDashboardsResponse",
|
|
10
10
|
"pathParams": [],
|
|
@@ -14,7 +14,7 @@ const routeManifest = {
|
|
|
14
14
|
"method": "GET",
|
|
15
15
|
"path": "/companies/:id/dashboard",
|
|
16
16
|
"summary": "Get full company dashboard for ONE company",
|
|
17
|
-
"description": "Returns company metadata, positions per fund,
|
|
17
|
+
"description": "Returns company metadata, positions per fund, 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. Takes the same metric options as the batch route: `metricTypeNames` / `metricTypeIds` scope which metrics are included, `metricsTimeframe` picks a granularity, `metricsFrom`, `metricsTo`, and `metricsPointLimit` limit history (`metricsPointLimit: 1` = latest dated point; set `metricsTo` to today for current values — prefer it over `metricsFrom` for \"latest\" reads, since a date lower bound hides values last reported before it). `transactionLimit` and `reportLimit` cap list sizes.",
|
|
18
18
|
"exampleCall": "client.companies.getDashboard(123, { currency: 'USD' })",
|
|
19
19
|
"responseType": "CompaniesGetDashboardResponse",
|
|
20
20
|
"pathParams": [
|
|
@@ -37,6 +37,42 @@ const routeManifest = {
|
|
|
37
37
|
"type": "string",
|
|
38
38
|
"description": "Lower bound for metric data points (ISO 8601). Omit to include all available history."
|
|
39
39
|
},
|
|
40
|
+
{
|
|
41
|
+
"name": "metricsTo",
|
|
42
|
+
"required": false,
|
|
43
|
+
"type": "string",
|
|
44
|
+
"description": "Inclusive upper bound for metric data points (ISO 8601). Pair with metricsPointLimit: 1 for latest values as of this date; omit to allow future-dated points."
|
|
45
|
+
},
|
|
46
|
+
{
|
|
47
|
+
"name": "metricsTimeframe",
|
|
48
|
+
"required": false,
|
|
49
|
+
"type": "\"Month\" | \"Quarter\" | \"Year\"",
|
|
50
|
+
"description": "Restrict metric data points to this reporting period granularity."
|
|
51
|
+
},
|
|
52
|
+
{
|
|
53
|
+
"name": "metricsPointLimit",
|
|
54
|
+
"required": false,
|
|
55
|
+
"type": "number",
|
|
56
|
+
"description": "Keep only the most recent N data points per metric (applied after `metricsFrom` / `metricsTo` / `metricsTimeframe`). Omit for the full history; `1` yields the latest dated point, which may be in the future. Set `metricsTo` to today for current values and `metricsTimeframe` for a single granularity."
|
|
57
|
+
},
|
|
58
|
+
{
|
|
59
|
+
"name": "metricTypeNames",
|
|
60
|
+
"required": false,
|
|
61
|
+
"type": "string[]",
|
|
62
|
+
"description": "Metric type names to include (case-insensitive exact match on display name or `shortName`). Omit to include all metrics. Names that match no accessible metric type are ignored."
|
|
63
|
+
},
|
|
64
|
+
{
|
|
65
|
+
"name": "metricTypeIds",
|
|
66
|
+
"required": false,
|
|
67
|
+
"type": "number[]",
|
|
68
|
+
"description": "Metric type identifiers to include. Intersected with `metricTypeNames` when both are provided."
|
|
69
|
+
},
|
|
70
|
+
{
|
|
71
|
+
"name": "conversionStrategy",
|
|
72
|
+
"required": false,
|
|
73
|
+
"type": "\"LATEST_FX_RATE\" | \"ENTITY_DATE_RATE\"",
|
|
74
|
+
"description": "FX rate selection when converting monetary metrics. `LATEST_FX_RATE` (default) uses the most recent rate; `ENTITY_DATE_RATE` uses the rate on each point's date."
|
|
75
|
+
},
|
|
40
76
|
{
|
|
41
77
|
"name": "transactionLimit",
|
|
42
78
|
"required": false,
|
|
@@ -167,7 +203,7 @@ const routeManifest = {
|
|
|
167
203
|
"method": "GET",
|
|
168
204
|
"path": "/positions/portfolio/summary",
|
|
169
205
|
"summary": "Get portfolio summary with positions and key metrics per company",
|
|
170
|
-
"description": "Returns
|
|
206
|
+
"description": "Returns position data (invested, fair value, multiple, ROI) and latest monthly metrics as of `date` (today by default). One row per company and fund by default; `groupBy: Company` combines selected accessible funds into one row per company. For top 3 companies by fair value use `groupBy: Company`, `sortBy: fairValue`, `sortDirection: desc`, `limit: 3`, `includeMetrics: false`. Sorting happens before pagination; metrics are loaded only for the returned page. Default metrics are MRR, Cash Balance, Headcount, Net Burn Rate, and Runway. Override with `metricTypeNames` or set `includeMetrics: false` to skip metrics entirely. Without a limit all rows are returned and can be large. Default order is company id, then fund id.",
|
|
171
207
|
"exampleCall": "client.positions.getPortfolioSummary({ currency: 'USD' })",
|
|
172
208
|
"responseType": "PositionsGetPortfolioSummaryResponse",
|
|
173
209
|
"pathParams": [],
|
|
@@ -184,6 +220,30 @@ const routeManifest = {
|
|
|
184
220
|
"type": "string",
|
|
185
221
|
"description": "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."
|
|
186
222
|
},
|
|
223
|
+
{
|
|
224
|
+
"name": "groupBy",
|
|
225
|
+
"required": false,
|
|
226
|
+
"type": "\"CompanyGroup\" | \"Company\"",
|
|
227
|
+
"description": "CompanyGroup (default) returns one row per company and fund. Company combines all selected, accessible funds into one row per company using the investment engine totals; companyGroupId is null and companyGroup is omitted."
|
|
228
|
+
},
|
|
229
|
+
{
|
|
230
|
+
"name": "sortBy",
|
|
231
|
+
"required": false,
|
|
232
|
+
"type": "\"companyId\" | \"fairValue\" | \"invested\" | \"realized\" | \"multiple\"",
|
|
233
|
+
"description": "Sort before pagination. For the top companies by fair value use groupBy: Company, sortBy: fairValue, sortDirection: desc, limit: 3. Missing values sort last; company and fund ids break ties."
|
|
234
|
+
},
|
|
235
|
+
{
|
|
236
|
+
"name": "sortDirection",
|
|
237
|
+
"required": false,
|
|
238
|
+
"type": "\"asc\" | \"desc\"",
|
|
239
|
+
"description": null
|
|
240
|
+
},
|
|
241
|
+
{
|
|
242
|
+
"name": "includeMetrics",
|
|
243
|
+
"required": false,
|
|
244
|
+
"type": "boolean",
|
|
245
|
+
"description": "Include the latest monthly metric snapshot as of date (defaults to today). Set false for position-only queries: skips metric computation and returns latestMetrics: []."
|
|
246
|
+
},
|
|
187
247
|
{
|
|
188
248
|
"name": "companyGroupIds",
|
|
189
249
|
"required": false,
|
|
@@ -253,7 +313,7 @@ const routeManifest = {
|
|
|
253
313
|
"name": "currency",
|
|
254
314
|
"required": true,
|
|
255
315
|
"type": "string",
|
|
256
|
-
"description": "Reporting currency code"
|
|
316
|
+
"description": "Reporting currency code (ISO 4217)"
|
|
257
317
|
},
|
|
258
318
|
{
|
|
259
319
|
"name": "date",
|
|
@@ -288,7 +348,7 @@ const routeManifest = {
|
|
|
288
348
|
"name": "currency",
|
|
289
349
|
"required": true,
|
|
290
350
|
"type": "string",
|
|
291
|
-
"description": "Reporting currency code"
|
|
351
|
+
"description": "Reporting currency code (ISO 4217)"
|
|
292
352
|
},
|
|
293
353
|
{
|
|
294
354
|
"name": "date",
|
|
@@ -459,7 +519,7 @@ const routeManifest = {
|
|
|
459
519
|
"method": "GET",
|
|
460
520
|
"path": "/metrics/types",
|
|
461
521
|
"summary": "List metric types available to the SDK consumer",
|
|
462
|
-
"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.",
|
|
522
|
+
"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. Filter with `nameSearch` (case-insensitive substring on name or `shortName`, OR across an array) to find a few types without paging the whole catalogue — e.g. `nameSearch=[\"mrr\",\"burn\"]`. Ordered by metric type id ascending.",
|
|
463
523
|
"exampleCall": "client.metrics.getTypes({ limit: 123 })",
|
|
464
524
|
"responseType": "MetricsGetTypesResponse",
|
|
465
525
|
"pathParams": [],
|
|
@@ -475,6 +535,12 @@ const routeManifest = {
|
|
|
475
535
|
"required": false,
|
|
476
536
|
"type": "string",
|
|
477
537
|
"description": "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."
|
|
538
|
+
},
|
|
539
|
+
{
|
|
540
|
+
"name": "nameSearch",
|
|
541
|
+
"required": false,
|
|
542
|
+
"type": "string[]",
|
|
543
|
+
"description": "Case-insensitive substring match on metric type name or `shortName`. Pass an array to look up several types in one call — a type matches if ANY listed substring occurs (OR semantics). Use it to find ids or exact names without paging the whole catalogue."
|
|
478
544
|
}
|
|
479
545
|
]
|
|
480
546
|
},
|
|
@@ -482,7 +548,7 @@ const routeManifest = {
|
|
|
482
548
|
"method": "POST",
|
|
483
549
|
"path": "/metrics",
|
|
484
550
|
"summary": "Read metric values for accessible companies, grouped by company",
|
|
485
|
-
"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` — case-insensitive exact match on either the full name or the `shortName`, so \"MRR\" and \"MRR - Monthly Recurring Revenue\" both work), 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.",
|
|
551
|
+
"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`. Each entry embeds a metric type *summary* (id, name, shortName, valueType, unit, plus option/range config when relevant); the full definition lives on /metrics/types. Filter by company id, company name substring (`companyNameSearch`), company group, metric type id, metric type name (`metricTypeNames` — case-insensitive exact match on either the full name or the `shortName`, so \"MRR\" and \"MRR - Monthly Recurring Revenue\" both work), 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. Use `pointLimit` to keep only the most recent N points per metric (`pointLimit: 1` = latest dated point; set `to` to today to exclude future values) — without it every historical point is returned, which can be very large across a portfolio. Entries are ordered by company id ascending — one entry per company, so `limit` pages whole companies, never partial metric lists.",
|
|
486
552
|
"exampleCall": "client.metrics.search({})",
|
|
487
553
|
"responseType": "MetricsSearchResponse",
|
|
488
554
|
"pathParams": [],
|
|
@@ -492,8 +558,8 @@ const routeManifest = {
|
|
|
492
558
|
"method": "POST",
|
|
493
559
|
"path": "/metrics/compare",
|
|
494
560
|
"summary": "Compare metrics across companies",
|
|
495
|
-
"description": "Returns date-aligned rows for one or more metric types across multiple companies.
|
|
496
|
-
"exampleCall": "client.metrics.compare({
|
|
561
|
+
"description": "Returns date-aligned rows for one or more metric types across multiple companies. Select metric types with `metricTypeIds` and/or `metricTypeNames` (case-insensitive exact match on name or `shortName`, e.g. \"MRR\"); several metrics are compared in a single round trip, one entry per metric type in `metricTypeIds` order; name-only selections follow catalogue order. 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.",
|
|
562
|
+
"exampleCall": "client.metrics.compare({})",
|
|
497
563
|
"responseType": "MetricsCompareResponse",
|
|
498
564
|
"pathParams": [],
|
|
499
565
|
"queryParams": []
|
|
@@ -502,8 +568,8 @@ const routeManifest = {
|
|
|
502
568
|
"method": "POST",
|
|
503
569
|
"path": "/metrics/aggregate",
|
|
504
570
|
"summary": "Aggregate metrics across portfolio companies",
|
|
505
|
-
"description": "Returns aggregated metric values (SUM, AVG, MEDIAN, MIN, MAX, COUNT) across companies for each reporting period.
|
|
506
|
-
"exampleCall": "client.metrics.aggregate({
|
|
571
|
+
"description": "Returns aggregated metric values (SUM, AVG, MEDIAN, MIN, MAX, COUNT) across companies for each reporting period. Select metric types with `metricTypeIds` and/or `metricTypeNames` (case-insensitive exact match on name or `shortName`, e.g. \"MRR\"). 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. Every requested metric type the caller can access yields one entry (per fund when grouped) — with an empty `points` array when none of the selected companies has a value for it, so \"no data\" is explicit rather than a missing row. Ids that match no accessible metric type produce no entry. Select companies with `companyIds`, `companyNameSearch`, or `companyGroupIds`; when those select no company at all the response is an empty list. Ordered by fund id, then in the order the metric types were requested (`metricTypeIds` order; name-resolved types follow the catalogue order).",
|
|
572
|
+
"exampleCall": "client.metrics.aggregate({ aggregation: \"SUM\" })",
|
|
507
573
|
"responseType": "MetricsAggregateResponse",
|
|
508
574
|
"pathParams": [],
|
|
509
575
|
"queryParams": []
|
|
@@ -514,7 +580,7 @@ const routeManifest = {
|
|
|
514
580
|
"method": "GET",
|
|
515
581
|
"path": "/company-reports",
|
|
516
582
|
"summary": "List published company reports accessible to the caller (metadata only)",
|
|
517
|
-
"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
|
|
583
|
+
"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 reporting period date descending, then id descending by default. Use `sortBy: publishedAt` and `limit: 1` for the most recently published report; publication order can differ from period order.",
|
|
518
584
|
"exampleCall": "client.companyReports.list({ limit: 123 })",
|
|
519
585
|
"responseType": "CompanyReportsListResponse",
|
|
520
586
|
"pathParams": [],
|
|
@@ -531,6 +597,12 @@ const routeManifest = {
|
|
|
531
597
|
"type": "string",
|
|
532
598
|
"description": "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."
|
|
533
599
|
},
|
|
600
|
+
{
|
|
601
|
+
"name": "sortBy",
|
|
602
|
+
"required": false,
|
|
603
|
+
"type": "\"date\" | \"publishedAt\"",
|
|
604
|
+
"description": "Descending sort, with report id descending as a tiebreaker and missing dates last. date (default) is the reporting period; publishedAt is the publication timestamp. Use publishedAt with limit: 1 for the most recently published report."
|
|
605
|
+
},
|
|
534
606
|
{
|
|
535
607
|
"name": "companyIds",
|
|
536
608
|
"required": false,
|