@rundit-sdk/embed 0.3.0-rc.13 → 0.3.0-rc.3

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 CHANGED
@@ -27,6 +27,14 @@ console.log(routeManifest)
27
27
 
28
28
  ## companies
29
29
 
30
+ - companies.getDashboards: PREFERRED tool for multi-company analysis — full dashboards for many companies in one call
31
+ - Call: `client.companies.getDashboards({ companyIds: [123], currency: 'USD' })`
32
+ - Returns: `CompaniesGetDashboardsResponse`
33
+ - Params: body: CompaniesGetDashboardsBody
34
+ - companies.getDashboard: Get full company dashboard for ONE company
35
+ - Call: `client.companies.getDashboard(123, { currency: 'USD' })`
36
+ - Returns: `CompaniesGetDashboardResponse`
37
+ - Params: path: id (number); query: currency (string), metricsFrom? (string), transactionLimit? (number), reportLimit? (number)
30
38
  - companies.getOne: Get one company available to the SDK consumer
31
39
  - Call: `client.companies.getOne(123)`
32
40
  - Returns: `CompaniesGetOneResponse`
@@ -34,32 +42,40 @@ console.log(routeManifest)
34
42
  - companies.getAll: List companies available to the SDK consumer
35
43
  - Call: `client.companies.getAll({ limit: 123 })`
36
44
  - Returns: `CompaniesGetAllResponse`
37
- - Params: query: limit? (number), cursor? (string), companyIds? (number[]), companyGroupIds? (number[])
45
+ - Params: query: limit? (number), cursor? (string), companyIds? (number[]), companyGroupIds? (number[]), nameSearch? (string[])
38
46
 
39
47
  ## companyGroups
40
48
 
41
- - companyGroups.getAll: List company groups available to the SDK consumer
49
+ - companyGroups.getAll: List funds available to the SDK consumer
42
50
  - Call: `client.companyGroups.getAll({ limit: 123 })`
43
51
  - Returns: `CompanyGroupsGetAllResponse`
44
- - Params: query: limit? (number), cursor? (string), companyGroupIds? (number[])
45
- - companyGroups.getOne: Get one company group available to the SDK consumer
52
+ - Params: query: limit? (number), cursor? (string), companyGroupIds? (number[]), nameSearch? (string[])
53
+ - companyGroups.getOne: Get one fund available to the SDK consumer
46
54
  - Call: `client.companyGroups.getOne(123)`
47
55
  - Returns: `CompanyGroupsGetOneResponse`
48
56
  - Params: path: id (number)
49
57
 
50
58
  ## positions
51
59
 
60
+ - positions.getPortfolioSummary: Get portfolio summary with positions and key metrics per company
61
+ - Call: `client.positions.getPortfolioSummary({ currency: 'USD' })`
62
+ - Returns: `PositionsGetPortfolioSummaryResponse`
63
+ - Params: query: limit? (number), cursor? (string), companyGroupIds? (number[]), companyIds? (number[]), currency (string), date? (string), metricTypeNames? (string[])
52
64
  - positions.getCompanyPositions: Get positions for one company
53
65
  - Call: `client.positions.getCompanyPositions(123, { currency: 'USD' })`
54
66
  - Returns: `PositionsGetCompanyPositionsResponse`
55
67
  - Params: path: id (number); query: limit? (number), cursor? (string), companyGroupIds? (number[]), currency (string), date? (string)
56
- - positions.getPortfolioPositions: Get portfolio positions
68
+ - positions.getPortfolioPositions: Get aggregated portfolio position totals
57
69
  - Call: `client.positions.getPortfolioPositions({ currency: 'USD' })`
58
70
  - Returns: `PositionsGetPortfolioPositionsResponse`
59
71
  - Params: query: companyGroupIds? (number[]), companyIds? (number[]), currency (string), date? (string)
60
72
 
61
73
  ## transactions
62
74
 
75
+ - transactions.getSummary: Get transaction activity summary
76
+ - Call: `client.transactions.getSummary({ currency: 'USD' })`
77
+ - Returns: `TransactionsGetSummaryResponse`
78
+ - Params: query: limit? (number), cursor? (string), companyGroupIds? (number[]), companyIds? (number[]), currency (string), groupBy? ("Month" | "Quarter" | "Year"), from? (string), to? (string)
63
79
  - transactions.getCompanyTransactions: Get transactions for one company
64
80
  - Call: `client.transactions.getCompanyTransactions(123, { limit: 123 })`
65
81
  - Returns: `TransactionsGetCompanyTransactionsResponse`
@@ -78,13 +94,21 @@ console.log(routeManifest)
78
94
  - Call: `client.metrics.search({})`
79
95
  - Returns: `MetricsSearchResponse`
80
96
  - Params: body: MetricsSearchBody
97
+ - metrics.compare: Compare metrics across companies
98
+ - Call: `client.metrics.compare({ metricTypeIds: [1,7] })`
99
+ - Returns: `MetricsCompareResponse`
100
+ - Params: body: MetricsCompareBody
101
+ - metrics.aggregate: Aggregate metrics across portfolio companies
102
+ - Call: `client.metrics.aggregate({ metricTypeIds: [1,7], aggregation: "SUM" })`
103
+ - Returns: `MetricsAggregateResponse`
104
+ - Params: body: MetricsAggregateBody
81
105
 
82
106
  ## companyReports
83
107
 
84
108
  - companyReports.list: List published company reports accessible to the caller (metadata only)
85
109
  - Call: `client.companyReports.list({ limit: 123 })`
86
110
  - Returns: `CompanyReportsListResponse`
87
- - Params: query: limit? (number), cursor? (string), companyIds? (number[]), companyGroupIds? (number[]), timeframe? ("Month" | "Quarter" | "Year"), from? (string), to? (string)
111
+ - Params: query: limit? (number), cursor? (string), companyIds? (number[]), companyGroupIds? (number[]), companyNameSearch? (string[]), timeframe? ("Month" | "Quarter" | "Year"), from? (string), to? (string)
88
112
  - companyReports.getOne: Fetch the full content of a single company report
89
113
  - Call: `client.companyReports.getOne(123)`
90
114
  - Returns: `CompanyReportsGetOneResponse`
package/README.md CHANGED
@@ -20,7 +20,7 @@ const client = createEmbedClient({
20
20
  // baseUrl: 'https://test.rundit.com/api/v2/sdk',
21
21
  })
22
22
 
23
- await client.companies.getOne(123)
23
+ await client.companies.getDashboards({ companyIds: [123], currency: 'USD' })
24
24
  ```
25
25
 
26
26
  ## Authentication
@@ -44,6 +44,24 @@ await client.companies.getOne(123)
44
44
 
45
45
  ## companies
46
46
 
47
+ ### `companies.getDashboards`
48
+
49
+ PREFERRED tool for multi-company analysis — full dashboards for many companies in one call
50
+
51
+ - Call: `client.companies.getDashboards({ companyIds: [123], currency: 'USD' })`
52
+ - HTTP: `POST /companies/dashboards`
53
+ - Returns: `CompaniesGetDashboardsResponse`
54
+ - Params: body: CompaniesGetDashboardsBody
55
+
56
+ ### `companies.getDashboard`
57
+
58
+ Get full company dashboard for ONE company
59
+
60
+ - Call: `client.companies.getDashboard(123, { currency: 'USD' })`
61
+ - HTTP: `GET /companies/:id/dashboard`
62
+ - Returns: `CompaniesGetDashboardResponse`
63
+ - Params: path: id (number); query: currency (string), metricsFrom? (string), transactionLimit? (number), reportLimit? (number)
64
+
47
65
  ### `companies.getOne`
48
66
 
49
67
  Get one company available to the SDK consumer
@@ -60,22 +78,22 @@ List companies available to the SDK consumer
60
78
  - Call: `client.companies.getAll({ limit: 123 })`
61
79
  - HTTP: `GET /companies`
62
80
  - Returns: `CompaniesGetAllResponse`
63
- - Params: query: limit? (number), cursor? (string), companyIds? (number[]), companyGroupIds? (number[])
81
+ - Params: query: limit? (number), cursor? (string), companyIds? (number[]), companyGroupIds? (number[]), nameSearch? (string[])
64
82
 
65
83
  ## companyGroups
66
84
 
67
85
  ### `companyGroups.getAll`
68
86
 
69
- List company groups available to the SDK consumer
87
+ List funds available to the SDK consumer
70
88
 
71
89
  - Call: `client.companyGroups.getAll({ limit: 123 })`
72
90
  - HTTP: `GET /company-groups`
73
91
  - Returns: `CompanyGroupsGetAllResponse`
74
- - Params: query: limit? (number), cursor? (string), companyGroupIds? (number[])
92
+ - Params: query: limit? (number), cursor? (string), companyGroupIds? (number[]), nameSearch? (string[])
75
93
 
76
94
  ### `companyGroups.getOne`
77
95
 
78
- Get one company group available to the SDK consumer
96
+ Get one fund available to the SDK consumer
79
97
 
80
98
  - Call: `client.companyGroups.getOne(123)`
81
99
  - HTTP: `GET /company-groups/:id`
@@ -84,6 +102,15 @@ Get one company group available to the SDK consumer
84
102
 
85
103
  ## positions
86
104
 
105
+ ### `positions.getPortfolioSummary`
106
+
107
+ Get portfolio summary with positions and key metrics per company
108
+
109
+ - Call: `client.positions.getPortfolioSummary({ currency: 'USD' })`
110
+ - HTTP: `GET /positions/portfolio/summary`
111
+ - Returns: `PositionsGetPortfolioSummaryResponse`
112
+ - Params: query: limit? (number), cursor? (string), companyGroupIds? (number[]), companyIds? (number[]), currency (string), date? (string), metricTypeNames? (string[])
113
+
87
114
  ### `positions.getCompanyPositions`
88
115
 
89
116
  Get positions for one company
@@ -95,7 +122,7 @@ Get positions for one company
95
122
 
96
123
  ### `positions.getPortfolioPositions`
97
124
 
98
- Get portfolio positions
125
+ Get aggregated portfolio position totals
99
126
 
100
127
  - Call: `client.positions.getPortfolioPositions({ currency: 'USD' })`
101
128
  - HTTP: `GET /positions/portfolio`
@@ -104,6 +131,15 @@ Get portfolio positions
104
131
 
105
132
  ## transactions
106
133
 
134
+ ### `transactions.getSummary`
135
+
136
+ Get transaction activity summary
137
+
138
+ - Call: `client.transactions.getSummary({ currency: 'USD' })`
139
+ - HTTP: `GET /transactions/summary`
140
+ - Returns: `TransactionsGetSummaryResponse`
141
+ - Params: query: limit? (number), cursor? (string), companyGroupIds? (number[]), companyIds? (number[]), currency (string), groupBy? ("Month" | "Quarter" | "Year"), from? (string), to? (string)
142
+
107
143
  ### `transactions.getCompanyTransactions`
108
144
 
109
145
  Get transactions for one company
@@ -141,6 +177,24 @@ Read metric values for accessible companies, grouped by company
141
177
  - Returns: `MetricsSearchResponse`
142
178
  - Params: body: MetricsSearchBody
143
179
 
180
+ ### `metrics.compare`
181
+
182
+ Compare metrics across companies
183
+
184
+ - Call: `client.metrics.compare({ metricTypeIds: [1,7] })`
185
+ - HTTP: `POST /metrics/compare`
186
+ - Returns: `MetricsCompareResponse`
187
+ - Params: body: MetricsCompareBody
188
+
189
+ ### `metrics.aggregate`
190
+
191
+ Aggregate metrics across portfolio companies
192
+
193
+ - Call: `client.metrics.aggregate({ metricTypeIds: [1,7], aggregation: "SUM" })`
194
+ - HTTP: `POST /metrics/aggregate`
195
+ - Returns: `MetricsAggregateResponse`
196
+ - Params: body: MetricsAggregateBody
197
+
144
198
  ## companyReports
145
199
 
146
200
  ### `companyReports.list`
@@ -150,7 +204,7 @@ List published company reports accessible to the caller (metadata only)
150
204
  - Call: `client.companyReports.list({ limit: 123 })`
151
205
  - HTTP: `GET /company-reports`
152
206
  - Returns: `CompanyReportsListResponse`
153
- - Params: query: limit? (number), cursor? (string), companyIds? (number[]), companyGroupIds? (number[]), timeframe? ("Month" | "Quarter" | "Year"), from? (string), to? (string)
207
+ - Params: query: limit? (number), cursor? (string), companyIds? (number[]), companyGroupIds? (number[]), companyNameSearch? (string[]), timeframe? ("Month" | "Quarter" | "Year"), from? (string), to? (string)
154
208
 
155
209
  ### `companyReports.getOne`
156
210
 
@@ -164,12 +218,12 @@ Fetch the full content of a single company report
164
218
  ## TypeScript
165
219
 
166
220
  - This package ships generated `.d.ts` files
167
- - Public DTOs, response aliases, and query parameter types are generated from `sdk-packages/openapi/sdk.openapi.json`
221
+ - Public DTOs, response aliases, and query parameter types are generated from `spec/sdk.openapi.json`
168
222
  - Generated methods and query types include JSDoc summaries for editor and agent consumption
169
223
  - Agent skill metadata is published under `skills/rundit-sdk-embed/SKILL.md`
170
224
 
171
225
  ## Notes
172
226
 
173
- - This package is generated from `sdk-packages/openapi/sdk.openapi.json`
227
+ - This package is generated from `spec/sdk.openapi.json`
174
228
  - Defaults to `https://api.rundit.com/api/v2/sdk`; pass `baseUrl` to target a different environment such as test
175
229
  - Do not edit files under `dist/` manually
package/ai-manifest.json CHANGED
@@ -20,10 +20,63 @@
20
20
  },
21
21
  "namespaces": {
22
22
  "companies": [
23
+ {
24
+ "operation": "getDashboards",
25
+ "summary": "PREFERRED tool for multi-company analysis — full dashboards for many companies in one call",
26
+ "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).",
27
+ "method": "POST",
28
+ "path": "/companies/dashboards",
29
+ "exampleCall": "client.companies.getDashboards({ companyIds: [123], currency: 'USD' })",
30
+ "responseType": "CompaniesGetDashboardsResponse",
31
+ "pathParams": [],
32
+ "queryParams": []
33
+ },
34
+ {
35
+ "operation": "getDashboard",
36
+ "summary": "Get full company dashboard for ONE company",
37
+ "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.",
38
+ "method": "GET",
39
+ "path": "/companies/:id/dashboard",
40
+ "exampleCall": "client.companies.getDashboard(123, { currency: 'USD' })",
41
+ "responseType": "CompaniesGetDashboardResponse",
42
+ "pathParams": [
43
+ {
44
+ "name": "id",
45
+ "type": "number",
46
+ "description": "Company identifier"
47
+ }
48
+ ],
49
+ "queryParams": [
50
+ {
51
+ "name": "currency",
52
+ "required": true,
53
+ "type": "string",
54
+ "description": "Reporting currency code (ISO 4217)."
55
+ },
56
+ {
57
+ "name": "metricsFrom",
58
+ "required": false,
59
+ "type": "string",
60
+ "description": "Lower bound for metric data points (ISO 8601). Omit to include all available history."
61
+ },
62
+ {
63
+ "name": "transactionLimit",
64
+ "required": false,
65
+ "type": "number",
66
+ "description": "Maximum number of transactions to include (most recent first). Defaults to 10."
67
+ },
68
+ {
69
+ "name": "reportLimit",
70
+ "required": false,
71
+ "type": "number",
72
+ "description": "Maximum number of reports to include (most recent first). Defaults to 5."
73
+ }
74
+ ]
75
+ },
23
76
  {
24
77
  "operation": "getOne",
25
78
  "summary": "Get one company available to the SDK consumer",
26
- "description": null,
79
+ "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.",
27
80
  "method": "GET",
28
81
  "path": "/companies/:id",
29
82
  "exampleCall": "client.companies.getOne(123)",
@@ -40,7 +93,7 @@
40
93
  {
41
94
  "operation": "getAll",
42
95
  "summary": "List companies available to the SDK consumer",
43
- "description": null,
96
+ "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.",
44
97
  "method": "GET",
45
98
  "path": "/companies",
46
99
  "exampleCall": "client.companies.getAll({ limit: 123 })",
@@ -70,6 +123,12 @@
70
123
  "required": false,
71
124
  "type": "number[]",
72
125
  "description": "Restrict results to companies that belong to any of these company groups"
126
+ },
127
+ {
128
+ "name": "nameSearch",
129
+ "required": false,
130
+ "type": "string[]",
131
+ "description": "Case-insensitive substring match on company display name. Pass an array to resolve multiple companies in one call — a company matches if its name contains ANY of the listed substrings (OR semantics). Combine with companyIds/companyGroupIds to find specific companies without first listing the entire portfolio."
73
132
  }
74
133
  ]
75
134
  }
@@ -77,8 +136,8 @@
77
136
  "companyGroups": [
78
137
  {
79
138
  "operation": "getAll",
80
- "summary": "List company groups available to the SDK consumer",
81
- "description": null,
139
+ "summary": "List funds available to the SDK consumer",
140
+ "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\"]`).",
82
141
  "method": "GET",
83
142
  "path": "/company-groups",
84
143
  "exampleCall": "client.companyGroups.getAll({ limit: 123 })",
@@ -102,13 +161,19 @@
102
161
  "required": false,
103
162
  "type": "number[]",
104
163
  "description": "Restrict results to these company group identifiers"
164
+ },
165
+ {
166
+ "name": "nameSearch",
167
+ "required": false,
168
+ "type": "string[]",
169
+ "description": "Case-insensitive substring match on company group display name. Pass an array to resolve multiple groups in one call — a group matches if its name contains ANY of the listed substrings (OR semantics). Useful for finding funds or visibility groups by name without first listing all groups."
105
170
  }
106
171
  ]
107
172
  },
108
173
  {
109
174
  "operation": "getOne",
110
- "summary": "Get one company group available to the SDK consumer",
111
- "description": null,
175
+ "summary": "Get one fund available to the SDK consumer",
176
+ "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.",
112
177
  "method": "GET",
113
178
  "path": "/company-groups/:id",
114
179
  "exampleCall": "client.companyGroups.getOne(123)",
@@ -124,10 +189,64 @@
124
189
  }
125
190
  ],
126
191
  "positions": [
192
+ {
193
+ "operation": "getPortfolioSummary",
194
+ "summary": "Get portfolio summary with positions and key metrics per company",
195
+ "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.",
196
+ "method": "GET",
197
+ "path": "/positions/portfolio/summary",
198
+ "exampleCall": "client.positions.getPortfolioSummary({ currency: 'USD' })",
199
+ "responseType": "PositionsGetPortfolioSummaryResponse",
200
+ "pathParams": [],
201
+ "queryParams": [
202
+ {
203
+ "name": "limit",
204
+ "required": false,
205
+ "type": "number",
206
+ "description": "Maximum items per page. Currently accepted but not enforced; reserved for future pagination."
207
+ },
208
+ {
209
+ "name": "cursor",
210
+ "required": false,
211
+ "type": "string",
212
+ "description": "Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored."
213
+ },
214
+ {
215
+ "name": "companyGroupIds",
216
+ "required": false,
217
+ "type": "number[]",
218
+ "description": "Restrict to companies that belong to any of these company groups."
219
+ },
220
+ {
221
+ "name": "companyIds",
222
+ "required": false,
223
+ "type": "number[]",
224
+ "description": "Restrict to these company identifiers."
225
+ },
226
+ {
227
+ "name": "currency",
228
+ "required": true,
229
+ "type": "string",
230
+ "description": "Reporting currency code (ISO 4217)."
231
+ },
232
+ {
233
+ "name": "date",
234
+ "required": false,
235
+ "type": "string",
236
+ "description": "Position summary date (ISO 8601). Defaults to today."
237
+ },
238
+ {
239
+ "name": "metricTypeNames",
240
+ "required": false,
241
+ "type": "string[]",
242
+ "description": "Metric type names to include in the latest metrics snapshot. Defaults to MRR, Cash Balance, Headcount, Net Burn Rate, and Runway."
243
+ }
244
+ ]
245
+ },
127
246
  {
128
247
  "operation": "getCompanyPositions",
129
248
  "summary": "Get positions for one company",
130
- "description": null,
249
+ "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.",
131
250
  "method": "GET",
132
251
  "path": "/positions/companies/:id",
133
252
  "exampleCall": "client.positions.getCompanyPositions(123, { currency: 'USD' })",
@@ -174,8 +293,8 @@
174
293
  },
175
294
  {
176
295
  "operation": "getPortfolioPositions",
177
- "summary": "Get portfolio positions",
178
- "description": null,
296
+ "summary": "Get aggregated portfolio position totals",
297
+ "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`.",
179
298
  "method": "GET",
180
299
  "path": "/positions/portfolio",
181
300
  "exampleCall": "client.positions.getPortfolioPositions({ currency: 'USD' })",
@@ -210,10 +329,70 @@
210
329
  }
211
330
  ],
212
331
  "transactions": [
332
+ {
333
+ "operation": "getSummary",
334
+ "summary": "Get transaction activity summary",
335
+ "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.",
336
+ "method": "GET",
337
+ "path": "/transactions/summary",
338
+ "exampleCall": "client.transactions.getSummary({ currency: 'USD' })",
339
+ "responseType": "TransactionsGetSummaryResponse",
340
+ "pathParams": [],
341
+ "queryParams": [
342
+ {
343
+ "name": "limit",
344
+ "required": false,
345
+ "type": "number",
346
+ "description": "Maximum items per page. Currently accepted but not enforced; reserved for future pagination."
347
+ },
348
+ {
349
+ "name": "cursor",
350
+ "required": false,
351
+ "type": "string",
352
+ "description": "Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored."
353
+ },
354
+ {
355
+ "name": "companyGroupIds",
356
+ "required": false,
357
+ "type": "number[]",
358
+ "description": "Restrict to companies that belong to any of these company groups."
359
+ },
360
+ {
361
+ "name": "companyIds",
362
+ "required": false,
363
+ "type": "number[]",
364
+ "description": "Restrict to these company identifiers."
365
+ },
366
+ {
367
+ "name": "currency",
368
+ "required": true,
369
+ "type": "string",
370
+ "description": "Reporting currency code (ISO 4217)."
371
+ },
372
+ {
373
+ "name": "groupBy",
374
+ "required": false,
375
+ "type": "\"Month\" | \"Quarter\" | \"Year\"",
376
+ "description": "Group results by this period granularity. When omitted, returns a single summary across all time."
377
+ },
378
+ {
379
+ "name": "from",
380
+ "required": false,
381
+ "type": "string",
382
+ "description": "Lower bound for transaction date (ISO 8601, inclusive)."
383
+ },
384
+ {
385
+ "name": "to",
386
+ "required": false,
387
+ "type": "string",
388
+ "description": "Upper bound for transaction date (ISO 8601, inclusive)."
389
+ }
390
+ ]
391
+ },
213
392
  {
214
393
  "operation": "getCompanyTransactions",
215
394
  "summary": "Get transactions for one company",
216
- "description": null,
395
+ "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.",
217
396
  "method": "GET",
218
397
  "path": "/transactions/companies/:id",
219
398
  "exampleCall": "client.transactions.getCompanyTransactions(123, { limit: 123 })",
@@ -261,7 +440,7 @@
261
440
  {
262
441
  "operation": "getTransactions",
263
442
  "summary": "Get transactions for multiple companies",
264
- "description": null,
443
+ "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.",
265
444
  "method": "GET",
266
445
  "path": "/transactions",
267
446
  "exampleCall": "client.transactions.getTransactions({ limit: 123 })",
@@ -311,7 +490,7 @@
311
490
  {
312
491
  "operation": "getTypes",
313
492
  "summary": "List metric types available to the SDK consumer",
314
- "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.",
493
+ "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.",
315
494
  "method": "GET",
316
495
  "path": "/metrics/types",
317
496
  "exampleCall": "client.metrics.getTypes()",
@@ -322,20 +501,42 @@
322
501
  {
323
502
  "operation": "search",
324
503
  "summary": "Read metric values for accessible companies, grouped by company",
325
- "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.",
504
+ "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.",
326
505
  "method": "POST",
327
506
  "path": "/metrics",
328
507
  "exampleCall": "client.metrics.search({})",
329
508
  "responseType": "MetricsSearchResponse",
330
509
  "pathParams": [],
331
510
  "queryParams": []
511
+ },
512
+ {
513
+ "operation": "compare",
514
+ "summary": "Compare metrics across companies",
515
+ "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.",
516
+ "method": "POST",
517
+ "path": "/metrics/compare",
518
+ "exampleCall": "client.metrics.compare({ metricTypeIds: [1,7] })",
519
+ "responseType": "MetricsCompareResponse",
520
+ "pathParams": [],
521
+ "queryParams": []
522
+ },
523
+ {
524
+ "operation": "aggregate",
525
+ "summary": "Aggregate metrics across portfolio companies",
526
+ "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.",
527
+ "method": "POST",
528
+ "path": "/metrics/aggregate",
529
+ "exampleCall": "client.metrics.aggregate({ metricTypeIds: [1,7], aggregation: \"SUM\" })",
530
+ "responseType": "MetricsAggregateResponse",
531
+ "pathParams": [],
532
+ "queryParams": []
332
533
  }
333
534
  ],
334
535
  "companyReports": [
335
536
  {
336
537
  "operation": "list",
337
538
  "summary": "List published company reports accessible to the caller (metadata only)",
338
- "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).",
539
+ "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).",
339
540
  "method": "GET",
340
541
  "path": "/company-reports",
341
542
  "exampleCall": "client.companyReports.list({ limit: 123 })",
@@ -366,6 +567,12 @@
366
567
  "type": "number[]",
367
568
  "description": "Restrict to companies that belong to any of these company groups."
368
569
  },
570
+ {
571
+ "name": "companyNameSearch",
572
+ "required": false,
573
+ "type": "string[]",
574
+ "description": "Case-insensitive substring match on the reporting company name. Pass an array to resolve multiple companies in one call — a report matches if its company name contains ANY of the listed substrings (OR semantics). Intersects with `companyIds`/`companyGroupIds`."
575
+ },
369
576
  {
370
577
  "name": "timeframe",
371
578
  "required": false,