@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 +30 -6
- package/README.md +63 -9
- package/ai-manifest.json +221 -14
- package/dist/index.d.ts +529 -174
- package/dist/index.js +221 -14
- package/openapi.json +2151 -659
- package/package.json +3 -2
- package/skills/rundit-sdk-embed/SKILL.md +1 -1
package/dist/index.js
CHANGED
|
@@ -1,10 +1,61 @@
|
|
|
1
1
|
const routeManifest = {
|
|
2
2
|
"companies": {
|
|
3
|
+
"getDashboards": {
|
|
4
|
+
"method": "POST",
|
|
5
|
+
"path": "/companies/dashboards",
|
|
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` 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).",
|
|
8
|
+
"exampleCall": "client.companies.getDashboards({ companyIds: [123], currency: 'USD' })",
|
|
9
|
+
"responseType": "CompaniesGetDashboardsResponse",
|
|
10
|
+
"pathParams": [],
|
|
11
|
+
"queryParams": []
|
|
12
|
+
},
|
|
13
|
+
"getDashboard": {
|
|
14
|
+
"method": "GET",
|
|
15
|
+
"path": "/companies/:id/dashboard",
|
|
16
|
+
"summary": "Get full company dashboard for ONE company",
|
|
17
|
+
"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.",
|
|
18
|
+
"exampleCall": "client.companies.getDashboard(123, { currency: 'USD' })",
|
|
19
|
+
"responseType": "CompaniesGetDashboardResponse",
|
|
20
|
+
"pathParams": [
|
|
21
|
+
{
|
|
22
|
+
"name": "id",
|
|
23
|
+
"type": "number",
|
|
24
|
+
"description": "Company identifier"
|
|
25
|
+
}
|
|
26
|
+
],
|
|
27
|
+
"queryParams": [
|
|
28
|
+
{
|
|
29
|
+
"name": "currency",
|
|
30
|
+
"required": true,
|
|
31
|
+
"type": "string",
|
|
32
|
+
"description": "Reporting currency code (ISO 4217)."
|
|
33
|
+
},
|
|
34
|
+
{
|
|
35
|
+
"name": "metricsFrom",
|
|
36
|
+
"required": false,
|
|
37
|
+
"type": "string",
|
|
38
|
+
"description": "Lower bound for metric data points (ISO 8601). Omit to include all available history."
|
|
39
|
+
},
|
|
40
|
+
{
|
|
41
|
+
"name": "transactionLimit",
|
|
42
|
+
"required": false,
|
|
43
|
+
"type": "number",
|
|
44
|
+
"description": "Maximum number of transactions to include (most recent first). Defaults to 10."
|
|
45
|
+
},
|
|
46
|
+
{
|
|
47
|
+
"name": "reportLimit",
|
|
48
|
+
"required": false,
|
|
49
|
+
"type": "number",
|
|
50
|
+
"description": "Maximum number of reports to include (most recent first). Defaults to 5."
|
|
51
|
+
}
|
|
52
|
+
]
|
|
53
|
+
},
|
|
3
54
|
"getOne": {
|
|
4
55
|
"method": "GET",
|
|
5
56
|
"path": "/companies/:id",
|
|
6
57
|
"summary": "Get one company available to the SDK consumer",
|
|
7
|
-
"description":
|
|
58
|
+
"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.",
|
|
8
59
|
"exampleCall": "client.companies.getOne(123)",
|
|
9
60
|
"responseType": "CompaniesGetOneResponse",
|
|
10
61
|
"pathParams": [
|
|
@@ -20,7 +71,7 @@ const routeManifest = {
|
|
|
20
71
|
"method": "GET",
|
|
21
72
|
"path": "/companies",
|
|
22
73
|
"summary": "List companies available to the SDK consumer",
|
|
23
|
-
"description":
|
|
74
|
+
"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.",
|
|
24
75
|
"exampleCall": "client.companies.getAll({ limit: 123 })",
|
|
25
76
|
"responseType": "CompaniesGetAllResponse",
|
|
26
77
|
"pathParams": [],
|
|
@@ -48,6 +99,12 @@ const routeManifest = {
|
|
|
48
99
|
"required": false,
|
|
49
100
|
"type": "number[]",
|
|
50
101
|
"description": "Restrict results to companies that belong to any of these company groups"
|
|
102
|
+
},
|
|
103
|
+
{
|
|
104
|
+
"name": "nameSearch",
|
|
105
|
+
"required": false,
|
|
106
|
+
"type": "string[]",
|
|
107
|
+
"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."
|
|
51
108
|
}
|
|
52
109
|
]
|
|
53
110
|
}
|
|
@@ -56,8 +113,8 @@ const routeManifest = {
|
|
|
56
113
|
"getAll": {
|
|
57
114
|
"method": "GET",
|
|
58
115
|
"path": "/company-groups",
|
|
59
|
-
"summary": "List
|
|
60
|
-
"description":
|
|
116
|
+
"summary": "List funds available to the SDK consumer",
|
|
117
|
+
"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\"]`).",
|
|
61
118
|
"exampleCall": "client.companyGroups.getAll({ limit: 123 })",
|
|
62
119
|
"responseType": "CompanyGroupsGetAllResponse",
|
|
63
120
|
"pathParams": [],
|
|
@@ -79,14 +136,20 @@ const routeManifest = {
|
|
|
79
136
|
"required": false,
|
|
80
137
|
"type": "number[]",
|
|
81
138
|
"description": "Restrict results to these company group identifiers"
|
|
139
|
+
},
|
|
140
|
+
{
|
|
141
|
+
"name": "nameSearch",
|
|
142
|
+
"required": false,
|
|
143
|
+
"type": "string[]",
|
|
144
|
+
"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."
|
|
82
145
|
}
|
|
83
146
|
]
|
|
84
147
|
},
|
|
85
148
|
"getOne": {
|
|
86
149
|
"method": "GET",
|
|
87
150
|
"path": "/company-groups/:id",
|
|
88
|
-
"summary": "Get one
|
|
89
|
-
"description":
|
|
151
|
+
"summary": "Get one fund available to the SDK consumer",
|
|
152
|
+
"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.",
|
|
90
153
|
"exampleCall": "client.companyGroups.getOne(123)",
|
|
91
154
|
"responseType": "CompanyGroupsGetOneResponse",
|
|
92
155
|
"pathParams": [
|
|
@@ -100,11 +163,64 @@ const routeManifest = {
|
|
|
100
163
|
}
|
|
101
164
|
},
|
|
102
165
|
"positions": {
|
|
166
|
+
"getPortfolioSummary": {
|
|
167
|
+
"method": "GET",
|
|
168
|
+
"path": "/positions/portfolio/summary",
|
|
169
|
+
"summary": "Get portfolio summary with positions and key metrics per company",
|
|
170
|
+
"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.",
|
|
171
|
+
"exampleCall": "client.positions.getPortfolioSummary({ currency: 'USD' })",
|
|
172
|
+
"responseType": "PositionsGetPortfolioSummaryResponse",
|
|
173
|
+
"pathParams": [],
|
|
174
|
+
"queryParams": [
|
|
175
|
+
{
|
|
176
|
+
"name": "limit",
|
|
177
|
+
"required": false,
|
|
178
|
+
"type": "number",
|
|
179
|
+
"description": "Maximum items per page. Currently accepted but not enforced; reserved for future pagination."
|
|
180
|
+
},
|
|
181
|
+
{
|
|
182
|
+
"name": "cursor",
|
|
183
|
+
"required": false,
|
|
184
|
+
"type": "string",
|
|
185
|
+
"description": "Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored."
|
|
186
|
+
},
|
|
187
|
+
{
|
|
188
|
+
"name": "companyGroupIds",
|
|
189
|
+
"required": false,
|
|
190
|
+
"type": "number[]",
|
|
191
|
+
"description": "Restrict to companies that belong to any of these company groups."
|
|
192
|
+
},
|
|
193
|
+
{
|
|
194
|
+
"name": "companyIds",
|
|
195
|
+
"required": false,
|
|
196
|
+
"type": "number[]",
|
|
197
|
+
"description": "Restrict to these company identifiers."
|
|
198
|
+
},
|
|
199
|
+
{
|
|
200
|
+
"name": "currency",
|
|
201
|
+
"required": true,
|
|
202
|
+
"type": "string",
|
|
203
|
+
"description": "Reporting currency code (ISO 4217)."
|
|
204
|
+
},
|
|
205
|
+
{
|
|
206
|
+
"name": "date",
|
|
207
|
+
"required": false,
|
|
208
|
+
"type": "string",
|
|
209
|
+
"description": "Position summary date (ISO 8601). Defaults to today."
|
|
210
|
+
},
|
|
211
|
+
{
|
|
212
|
+
"name": "metricTypeNames",
|
|
213
|
+
"required": false,
|
|
214
|
+
"type": "string[]",
|
|
215
|
+
"description": "Metric type names to include in the latest metrics snapshot. Defaults to MRR, Cash Balance, Headcount, Net Burn Rate, and Runway."
|
|
216
|
+
}
|
|
217
|
+
]
|
|
218
|
+
},
|
|
103
219
|
"getCompanyPositions": {
|
|
104
220
|
"method": "GET",
|
|
105
221
|
"path": "/positions/companies/:id",
|
|
106
222
|
"summary": "Get positions for one company",
|
|
107
|
-
"description":
|
|
223
|
+
"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.",
|
|
108
224
|
"exampleCall": "client.positions.getCompanyPositions(123, { currency: 'USD' })",
|
|
109
225
|
"responseType": "PositionsGetCompanyPositionsResponse",
|
|
110
226
|
"pathParams": [
|
|
@@ -150,8 +266,8 @@ const routeManifest = {
|
|
|
150
266
|
"getPortfolioPositions": {
|
|
151
267
|
"method": "GET",
|
|
152
268
|
"path": "/positions/portfolio",
|
|
153
|
-
"summary": "Get portfolio
|
|
154
|
-
"description":
|
|
269
|
+
"summary": "Get aggregated portfolio position totals",
|
|
270
|
+
"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`.",
|
|
155
271
|
"exampleCall": "client.positions.getPortfolioPositions({ currency: 'USD' })",
|
|
156
272
|
"responseType": "PositionsGetPortfolioPositionsResponse",
|
|
157
273
|
"pathParams": [],
|
|
@@ -184,11 +300,70 @@ const routeManifest = {
|
|
|
184
300
|
}
|
|
185
301
|
},
|
|
186
302
|
"transactions": {
|
|
303
|
+
"getSummary": {
|
|
304
|
+
"method": "GET",
|
|
305
|
+
"path": "/transactions/summary",
|
|
306
|
+
"summary": "Get transaction activity summary",
|
|
307
|
+
"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.",
|
|
308
|
+
"exampleCall": "client.transactions.getSummary({ currency: 'USD' })",
|
|
309
|
+
"responseType": "TransactionsGetSummaryResponse",
|
|
310
|
+
"pathParams": [],
|
|
311
|
+
"queryParams": [
|
|
312
|
+
{
|
|
313
|
+
"name": "limit",
|
|
314
|
+
"required": false,
|
|
315
|
+
"type": "number",
|
|
316
|
+
"description": "Maximum items per page. Currently accepted but not enforced; reserved for future pagination."
|
|
317
|
+
},
|
|
318
|
+
{
|
|
319
|
+
"name": "cursor",
|
|
320
|
+
"required": false,
|
|
321
|
+
"type": "string",
|
|
322
|
+
"description": "Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored."
|
|
323
|
+
},
|
|
324
|
+
{
|
|
325
|
+
"name": "companyGroupIds",
|
|
326
|
+
"required": false,
|
|
327
|
+
"type": "number[]",
|
|
328
|
+
"description": "Restrict to companies that belong to any of these company groups."
|
|
329
|
+
},
|
|
330
|
+
{
|
|
331
|
+
"name": "companyIds",
|
|
332
|
+
"required": false,
|
|
333
|
+
"type": "number[]",
|
|
334
|
+
"description": "Restrict to these company identifiers."
|
|
335
|
+
},
|
|
336
|
+
{
|
|
337
|
+
"name": "currency",
|
|
338
|
+
"required": true,
|
|
339
|
+
"type": "string",
|
|
340
|
+
"description": "Reporting currency code (ISO 4217)."
|
|
341
|
+
},
|
|
342
|
+
{
|
|
343
|
+
"name": "groupBy",
|
|
344
|
+
"required": false,
|
|
345
|
+
"type": "\"Month\" | \"Quarter\" | \"Year\"",
|
|
346
|
+
"description": "Group results by this period granularity. When omitted, returns a single summary across all time."
|
|
347
|
+
},
|
|
348
|
+
{
|
|
349
|
+
"name": "from",
|
|
350
|
+
"required": false,
|
|
351
|
+
"type": "string",
|
|
352
|
+
"description": "Lower bound for transaction date (ISO 8601, inclusive)."
|
|
353
|
+
},
|
|
354
|
+
{
|
|
355
|
+
"name": "to",
|
|
356
|
+
"required": false,
|
|
357
|
+
"type": "string",
|
|
358
|
+
"description": "Upper bound for transaction date (ISO 8601, inclusive)."
|
|
359
|
+
}
|
|
360
|
+
]
|
|
361
|
+
},
|
|
187
362
|
"getCompanyTransactions": {
|
|
188
363
|
"method": "GET",
|
|
189
364
|
"path": "/transactions/companies/:id",
|
|
190
365
|
"summary": "Get transactions for one company",
|
|
191
|
-
"description":
|
|
366
|
+
"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.",
|
|
192
367
|
"exampleCall": "client.transactions.getCompanyTransactions(123, { limit: 123 })",
|
|
193
368
|
"responseType": "TransactionsGetCompanyTransactionsResponse",
|
|
194
369
|
"pathParams": [
|
|
@@ -235,7 +410,7 @@ const routeManifest = {
|
|
|
235
410
|
"method": "GET",
|
|
236
411
|
"path": "/transactions",
|
|
237
412
|
"summary": "Get transactions for multiple companies",
|
|
238
|
-
"description":
|
|
413
|
+
"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.",
|
|
239
414
|
"exampleCall": "client.transactions.getTransactions({ limit: 123 })",
|
|
240
415
|
"responseType": "TransactionsGetTransactionsResponse",
|
|
241
416
|
"pathParams": [],
|
|
@@ -284,7 +459,7 @@ const routeManifest = {
|
|
|
284
459
|
"method": "GET",
|
|
285
460
|
"path": "/metrics/types",
|
|
286
461
|
"summary": "List metric types available to the SDK consumer",
|
|
287
|
-
"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
|
|
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.",
|
|
288
463
|
"exampleCall": "client.metrics.getTypes()",
|
|
289
464
|
"responseType": "MetricsGetTypesResponse",
|
|
290
465
|
"pathParams": [],
|
|
@@ -294,11 +469,31 @@ const routeManifest = {
|
|
|
294
469
|
"method": "POST",
|
|
295
470
|
"path": "/metrics",
|
|
296
471
|
"summary": "Read metric values for accessible companies, grouped by company",
|
|
297
|
-
"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.",
|
|
472
|
+
"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.",
|
|
298
473
|
"exampleCall": "client.metrics.search({})",
|
|
299
474
|
"responseType": "MetricsSearchResponse",
|
|
300
475
|
"pathParams": [],
|
|
301
476
|
"queryParams": []
|
|
477
|
+
},
|
|
478
|
+
"compare": {
|
|
479
|
+
"method": "POST",
|
|
480
|
+
"path": "/metrics/compare",
|
|
481
|
+
"summary": "Compare metrics across companies",
|
|
482
|
+
"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.",
|
|
483
|
+
"exampleCall": "client.metrics.compare({ metricTypeIds: [1,7] })",
|
|
484
|
+
"responseType": "MetricsCompareResponse",
|
|
485
|
+
"pathParams": [],
|
|
486
|
+
"queryParams": []
|
|
487
|
+
},
|
|
488
|
+
"aggregate": {
|
|
489
|
+
"method": "POST",
|
|
490
|
+
"path": "/metrics/aggregate",
|
|
491
|
+
"summary": "Aggregate metrics across portfolio companies",
|
|
492
|
+
"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.",
|
|
493
|
+
"exampleCall": "client.metrics.aggregate({ metricTypeIds: [1,7], aggregation: \"SUM\" })",
|
|
494
|
+
"responseType": "MetricsAggregateResponse",
|
|
495
|
+
"pathParams": [],
|
|
496
|
+
"queryParams": []
|
|
302
497
|
}
|
|
303
498
|
},
|
|
304
499
|
"companyReports": {
|
|
@@ -306,7 +501,7 @@ const routeManifest = {
|
|
|
306
501
|
"method": "GET",
|
|
307
502
|
"path": "/company-reports",
|
|
308
503
|
"summary": "List published company reports accessible to the caller (metadata only)",
|
|
309
|
-
"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).",
|
|
504
|
+
"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).",
|
|
310
505
|
"exampleCall": "client.companyReports.list({ limit: 123 })",
|
|
311
506
|
"responseType": "CompanyReportsListResponse",
|
|
312
507
|
"pathParams": [],
|
|
@@ -335,6 +530,12 @@ const routeManifest = {
|
|
|
335
530
|
"type": "number[]",
|
|
336
531
|
"description": "Restrict to companies that belong to any of these company groups."
|
|
337
532
|
},
|
|
533
|
+
{
|
|
534
|
+
"name": "companyNameSearch",
|
|
535
|
+
"required": false,
|
|
536
|
+
"type": "string[]",
|
|
537
|
+
"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`."
|
|
538
|
+
},
|
|
338
539
|
{
|
|
339
540
|
"name": "timeframe",
|
|
340
541
|
"required": false,
|
|
@@ -497,6 +698,8 @@ function createRequester(options) {
|
|
|
497
698
|
|
|
498
699
|
function createCompaniesNamespace(request) {
|
|
499
700
|
return {
|
|
701
|
+
getDashboards: (body, init = {}) => request({ method: "POST", path: "/companies/dashboards", pathParams: undefined, query: undefined, body: body, signal: init.signal }),
|
|
702
|
+
getDashboard: (id, query = {}, init = {}) => request({ method: "GET", path: "/companies/:id/dashboard", pathParams: { id }, query: query, body: undefined, signal: init.signal }),
|
|
500
703
|
getOne: (id, init = {}) => request({ method: "GET", path: "/companies/:id", pathParams: { id }, query: undefined, body: undefined, signal: init.signal }),
|
|
501
704
|
getAll: (query = {}, init = {}) => request({ method: "GET", path: "/companies", pathParams: undefined, query: query, body: undefined, signal: init.signal }),
|
|
502
705
|
}
|
|
@@ -511,6 +714,7 @@ function createCompanyGroupsNamespace(request) {
|
|
|
511
714
|
|
|
512
715
|
function createPositionsNamespace(request) {
|
|
513
716
|
return {
|
|
717
|
+
getPortfolioSummary: (query = {}, init = {}) => request({ method: "GET", path: "/positions/portfolio/summary", pathParams: undefined, query: query, body: undefined, signal: init.signal }),
|
|
514
718
|
getCompanyPositions: (id, query = {}, init = {}) => request({ method: "GET", path: "/positions/companies/:id", pathParams: { id }, query: query, body: undefined, signal: init.signal }),
|
|
515
719
|
getPortfolioPositions: (query = {}, init = {}) => request({ method: "GET", path: "/positions/portfolio", pathParams: undefined, query: query, body: undefined, signal: init.signal }),
|
|
516
720
|
}
|
|
@@ -518,6 +722,7 @@ function createPositionsNamespace(request) {
|
|
|
518
722
|
|
|
519
723
|
function createTransactionsNamespace(request) {
|
|
520
724
|
return {
|
|
725
|
+
getSummary: (query = {}, init = {}) => request({ method: "GET", path: "/transactions/summary", pathParams: undefined, query: query, body: undefined, signal: init.signal }),
|
|
521
726
|
getCompanyTransactions: (id, query = {}, init = {}) => request({ method: "GET", path: "/transactions/companies/:id", pathParams: { id }, query: query, body: undefined, signal: init.signal }),
|
|
522
727
|
getTransactions: (query = {}, init = {}) => request({ method: "GET", path: "/transactions", pathParams: undefined, query: query, body: undefined, signal: init.signal }),
|
|
523
728
|
}
|
|
@@ -527,6 +732,8 @@ function createMetricsNamespace(request) {
|
|
|
527
732
|
return {
|
|
528
733
|
getTypes: (init = {}) => request({ method: "GET", path: "/metrics/types", pathParams: undefined, query: undefined, body: undefined, signal: init.signal }),
|
|
529
734
|
search: (body, init = {}) => request({ method: "POST", path: "/metrics", pathParams: undefined, query: undefined, body: body, signal: init.signal }),
|
|
735
|
+
compare: (body, init = {}) => request({ method: "POST", path: "/metrics/compare", pathParams: undefined, query: undefined, body: body, signal: init.signal }),
|
|
736
|
+
aggregate: (body, init = {}) => request({ method: "POST", path: "/metrics/aggregate", pathParams: undefined, query: undefined, body: body, signal: init.signal }),
|
|
530
737
|
}
|
|
531
738
|
}
|
|
532
739
|
|