@rundit-sdk/embed 0.3.0-rc.26 → 0.3.1-rc.5
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 +3 -3
- package/README.md +5 -5
- package/ai-manifest.json +14 -14
- package/dist/index.d.ts +70 -29
- package/dist/index.js +14 -14
- package/openapi.json +249 -37
- package/package.json +3 -2
package/AGENTS.md
CHANGED
|
@@ -46,11 +46,11 @@ console.log(routeManifest)
|
|
|
46
46
|
|
|
47
47
|
## companyGroups
|
|
48
48
|
|
|
49
|
-
- companyGroups.getAll: List
|
|
49
|
+
- companyGroups.getAll: List funds available to the SDK consumer
|
|
50
50
|
- Call: `client.companyGroups.getAll({ limit: 123 })`
|
|
51
51
|
- Returns: `CompanyGroupsGetAllResponse`
|
|
52
52
|
- Params: query: limit? (number), cursor? (string), companyGroupIds? (number[]), nameSearch? (string[])
|
|
53
|
-
- companyGroups.getOne: Get one
|
|
53
|
+
- companyGroups.getOne: Get one fund available to the SDK consumer
|
|
54
54
|
- Call: `client.companyGroups.getOne(123)`
|
|
55
55
|
- Returns: `CompanyGroupsGetOneResponse`
|
|
56
56
|
- Params: path: id (number)
|
|
@@ -65,7 +65,7 @@ console.log(routeManifest)
|
|
|
65
65
|
- Call: `client.positions.getCompanyPositions(123, { currency: 'USD' })`
|
|
66
66
|
- Returns: `PositionsGetCompanyPositionsResponse`
|
|
67
67
|
- Params: path: id (number); query: limit? (number), cursor? (string), companyGroupIds? (number[]), currency (string), date? (string)
|
|
68
|
-
- positions.getPortfolioPositions: Get portfolio
|
|
68
|
+
- positions.getPortfolioPositions: Get aggregated portfolio position totals
|
|
69
69
|
- Call: `client.positions.getPortfolioPositions({ currency: 'USD' })`
|
|
70
70
|
- Returns: `PositionsGetPortfolioPositionsResponse`
|
|
71
71
|
- Params: query: companyGroupIds? (number[]), companyIds? (number[]), currency (string), date? (string)
|
package/README.md
CHANGED
|
@@ -84,7 +84,7 @@ List companies available to the SDK consumer
|
|
|
84
84
|
|
|
85
85
|
### `companyGroups.getAll`
|
|
86
86
|
|
|
87
|
-
List
|
|
87
|
+
List funds available to the SDK consumer
|
|
88
88
|
|
|
89
89
|
- Call: `client.companyGroups.getAll({ limit: 123 })`
|
|
90
90
|
- HTTP: `GET /company-groups`
|
|
@@ -93,7 +93,7 @@ List company groups available to the SDK consumer
|
|
|
93
93
|
|
|
94
94
|
### `companyGroups.getOne`
|
|
95
95
|
|
|
96
|
-
Get one
|
|
96
|
+
Get one fund available to the SDK consumer
|
|
97
97
|
|
|
98
98
|
- Call: `client.companyGroups.getOne(123)`
|
|
99
99
|
- HTTP: `GET /company-groups/:id`
|
|
@@ -122,7 +122,7 @@ Get positions for one company
|
|
|
122
122
|
|
|
123
123
|
### `positions.getPortfolioPositions`
|
|
124
124
|
|
|
125
|
-
Get portfolio
|
|
125
|
+
Get aggregated portfolio position totals
|
|
126
126
|
|
|
127
127
|
- Call: `client.positions.getPortfolioPositions({ currency: 'USD' })`
|
|
128
128
|
- HTTP: `GET /positions/portfolio`
|
|
@@ -218,12 +218,12 @@ Fetch the full content of a single company report
|
|
|
218
218
|
## TypeScript
|
|
219
219
|
|
|
220
220
|
- This package ships generated `.d.ts` files
|
|
221
|
-
- Public DTOs, response aliases, and query parameter types are generated from `
|
|
221
|
+
- Public DTOs, response aliases, and query parameter types are generated from `spec/sdk.openapi.json`
|
|
222
222
|
- Generated methods and query types include JSDoc summaries for editor and agent consumption
|
|
223
223
|
- Agent skill metadata is published under `skills/rundit-sdk-embed/SKILL.md`
|
|
224
224
|
|
|
225
225
|
## Notes
|
|
226
226
|
|
|
227
|
-
- This package is generated from `
|
|
227
|
+
- This package is generated from `spec/sdk.openapi.json`
|
|
228
228
|
- Defaults to `https://api.rundit.com/api/v2/sdk`; pass `baseUrl` to target a different environment such as test
|
|
229
229
|
- Do not edit files under `dist/` manually
|
package/ai-manifest.json
CHANGED
|
@@ -23,7 +23,7 @@
|
|
|
23
23
|
{
|
|
24
24
|
"operation": "getDashboards",
|
|
25
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
|
|
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
27
|
"method": "POST",
|
|
28
28
|
"path": "/companies/dashboards",
|
|
29
29
|
"exampleCall": "client.companies.getDashboards({ companyIds: [123], currency: 'USD' })",
|
|
@@ -76,7 +76,7 @@
|
|
|
76
76
|
{
|
|
77
77
|
"operation": "getOne",
|
|
78
78
|
"summary": "Get one company available to the SDK consumer",
|
|
79
|
-
"description":
|
|
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.",
|
|
80
80
|
"method": "GET",
|
|
81
81
|
"path": "/companies/:id",
|
|
82
82
|
"exampleCall": "client.companies.getOne(123)",
|
|
@@ -136,8 +136,8 @@
|
|
|
136
136
|
"companyGroups": [
|
|
137
137
|
{
|
|
138
138
|
"operation": "getAll",
|
|
139
|
-
"summary": "List
|
|
140
|
-
"description": "Returns compact
|
|
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\"]`).",
|
|
141
141
|
"method": "GET",
|
|
142
142
|
"path": "/company-groups",
|
|
143
143
|
"exampleCall": "client.companyGroups.getAll({ limit: 123 })",
|
|
@@ -172,8 +172,8 @@
|
|
|
172
172
|
},
|
|
173
173
|
{
|
|
174
174
|
"operation": "getOne",
|
|
175
|
-
"summary": "Get one
|
|
176
|
-
"description":
|
|
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.",
|
|
177
177
|
"method": "GET",
|
|
178
178
|
"path": "/company-groups/:id",
|
|
179
179
|
"exampleCall": "client.companyGroups.getOne(123)",
|
|
@@ -246,7 +246,7 @@
|
|
|
246
246
|
{
|
|
247
247
|
"operation": "getCompanyPositions",
|
|
248
248
|
"summary": "Get positions for one company",
|
|
249
|
-
"description":
|
|
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.",
|
|
250
250
|
"method": "GET",
|
|
251
251
|
"path": "/positions/companies/:id",
|
|
252
252
|
"exampleCall": "client.positions.getCompanyPositions(123, { currency: 'USD' })",
|
|
@@ -293,8 +293,8 @@
|
|
|
293
293
|
},
|
|
294
294
|
{
|
|
295
295
|
"operation": "getPortfolioPositions",
|
|
296
|
-
"summary": "Get portfolio
|
|
297
|
-
"description":
|
|
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`.",
|
|
298
298
|
"method": "GET",
|
|
299
299
|
"path": "/positions/portfolio",
|
|
300
300
|
"exampleCall": "client.positions.getPortfolioPositions({ currency: 'USD' })",
|
|
@@ -332,7 +332,7 @@
|
|
|
332
332
|
{
|
|
333
333
|
"operation": "getSummary",
|
|
334
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,
|
|
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
336
|
"method": "GET",
|
|
337
337
|
"path": "/transactions/summary",
|
|
338
338
|
"exampleCall": "client.transactions.getSummary({ currency: 'USD' })",
|
|
@@ -392,7 +392,7 @@
|
|
|
392
392
|
{
|
|
393
393
|
"operation": "getCompanyTransactions",
|
|
394
394
|
"summary": "Get transactions for one company",
|
|
395
|
-
"description":
|
|
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.",
|
|
396
396
|
"method": "GET",
|
|
397
397
|
"path": "/transactions/companies/:id",
|
|
398
398
|
"exampleCall": "client.transactions.getCompanyTransactions(123, { limit: 123 })",
|
|
@@ -440,7 +440,7 @@
|
|
|
440
440
|
{
|
|
441
441
|
"operation": "getTransactions",
|
|
442
442
|
"summary": "Get transactions for multiple companies",
|
|
443
|
-
"description":
|
|
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.",
|
|
444
444
|
"method": "GET",
|
|
445
445
|
"path": "/transactions",
|
|
446
446
|
"exampleCall": "client.transactions.getTransactions({ limit: 123 })",
|
|
@@ -523,7 +523,7 @@
|
|
|
523
523
|
{
|
|
524
524
|
"operation": "aggregate",
|
|
525
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
|
|
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
527
|
"method": "POST",
|
|
528
528
|
"path": "/metrics/aggregate",
|
|
529
529
|
"exampleCall": "client.metrics.aggregate({ metricTypeIds: [1,7], aggregation: \"SUM\" })",
|
|
@@ -536,7 +536,7 @@
|
|
|
536
536
|
{
|
|
537
537
|
"operation": "list",
|
|
538
538
|
"summary": "List published company reports accessible to the caller (metadata only)",
|
|
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,
|
|
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).",
|
|
540
540
|
"method": "GET",
|
|
541
541
|
"path": "/company-reports",
|
|
542
542
|
"exampleCall": "client.companyReports.list({ limit: 123 })",
|
package/dist/index.d.ts
CHANGED
|
@@ -359,7 +359,7 @@ export interface SdkCompanyReportSummaryDto {
|
|
|
359
359
|
title: string
|
|
360
360
|
date: string
|
|
361
361
|
timeframe: { }
|
|
362
|
-
publishedAt
|
|
362
|
+
publishedAt: string | null
|
|
363
363
|
company: SdkCompanyReferenceDto
|
|
364
364
|
}
|
|
365
365
|
|
|
@@ -698,20 +698,55 @@ export interface SdkUserReferenceDto {
|
|
|
698
698
|
name: string
|
|
699
699
|
}
|
|
700
700
|
|
|
701
|
+
export type SdkReportSectionType = "text"
|
|
702
|
+
|
|
703
|
+
export interface SdkTextReportSectionDto {
|
|
704
|
+
id: number
|
|
705
|
+
type: SdkReportSectionType
|
|
706
|
+
order: number
|
|
707
|
+
title: string
|
|
708
|
+
content: string | null
|
|
709
|
+
}
|
|
710
|
+
|
|
711
|
+
export interface SdkMarkdownReportSectionDto {
|
|
712
|
+
id: number
|
|
713
|
+
type: SdkReportSectionType
|
|
714
|
+
order: number
|
|
715
|
+
title: string
|
|
716
|
+
content: string | null
|
|
717
|
+
}
|
|
718
|
+
|
|
701
719
|
export interface SdkCompanyReportAttachmentDto {
|
|
702
720
|
id: number
|
|
703
721
|
name: string
|
|
704
|
-
url
|
|
722
|
+
url: string | null
|
|
723
|
+
}
|
|
724
|
+
|
|
725
|
+
export interface SdkImageReportSectionDto {
|
|
726
|
+
id: number
|
|
727
|
+
type: SdkReportSectionType
|
|
728
|
+
order: number
|
|
729
|
+
title: string
|
|
730
|
+
imageUrl: string | null
|
|
731
|
+
file: SdkCompanyReportAttachmentDto
|
|
732
|
+
}
|
|
733
|
+
|
|
734
|
+
export interface SdkSingleChoiceReportSectionDto {
|
|
735
|
+
id: number
|
|
736
|
+
type: SdkReportSectionType
|
|
737
|
+
order: number
|
|
738
|
+
title: string
|
|
739
|
+
options: string[]
|
|
740
|
+
selectedOptions: string[]
|
|
705
741
|
}
|
|
706
742
|
|
|
707
|
-
export interface
|
|
743
|
+
export interface SdkMultiChoiceReportSectionDto {
|
|
708
744
|
id: number
|
|
709
|
-
type:
|
|
745
|
+
type: SdkReportSectionType
|
|
710
746
|
order: number
|
|
711
747
|
title: string
|
|
712
|
-
|
|
713
|
-
|
|
714
|
-
imageUrl?: string | null
|
|
748
|
+
options: string[]
|
|
749
|
+
selectedOptions: string[]
|
|
715
750
|
}
|
|
716
751
|
|
|
717
752
|
export interface SdkCompanyReportDto {
|
|
@@ -719,10 +754,10 @@ export interface SdkCompanyReportDto {
|
|
|
719
754
|
title: string
|
|
720
755
|
date: string
|
|
721
756
|
timeframe: { }
|
|
722
|
-
publishedAt
|
|
757
|
+
publishedAt: string | null
|
|
723
758
|
company: SdkCompanyReferenceDto
|
|
724
|
-
createdBy
|
|
725
|
-
sections:
|
|
759
|
+
createdBy: SdkUserReferenceDto
|
|
760
|
+
sections: (SdkTextReportSectionDto | SdkMarkdownReportSectionDto | SdkImageReportSectionDto | SdkSingleChoiceReportSectionDto | SdkMultiChoiceReportSectionDto)[]
|
|
726
761
|
attachments: SdkCompanyReportAttachmentDto[]
|
|
727
762
|
}
|
|
728
763
|
|
|
@@ -1027,7 +1062,7 @@ export interface CompanyReportsListQuery {
|
|
|
1027
1062
|
export interface CompaniesNamespace {
|
|
1028
1063
|
/**
|
|
1029
1064
|
* PREFERRED tool for multi-company analysis — full dashboards for many companies in one call
|
|
1030
|
-
* 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
|
|
1065
|
+
* 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).
|
|
1031
1066
|
* Parameters: body: CompaniesGetDashboardsBody
|
|
1032
1067
|
* Returns: CompaniesGetDashboardsResponse
|
|
1033
1068
|
*/
|
|
@@ -1041,6 +1076,7 @@ export interface CompaniesNamespace {
|
|
|
1041
1076
|
getDashboard(id: number, query?: CompaniesGetDashboardQuery, init?: RequestOptions): Promise<CompaniesGetDashboardResponse>
|
|
1042
1077
|
/**
|
|
1043
1078
|
* Get one company available to the SDK consumer
|
|
1079
|
+
* 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.
|
|
1044
1080
|
* Parameters: path: id (number)
|
|
1045
1081
|
* Returns: CompaniesGetOneResponse
|
|
1046
1082
|
*/
|
|
@@ -1056,14 +1092,15 @@ export interface CompaniesNamespace {
|
|
|
1056
1092
|
|
|
1057
1093
|
export interface CompanyGroupsNamespace {
|
|
1058
1094
|
/**
|
|
1059
|
-
* List
|
|
1060
|
-
* Returns compact
|
|
1095
|
+
* List funds available to the SDK consumer
|
|
1096
|
+
* 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"]`).
|
|
1061
1097
|
* Parameters: query: limit? (number), cursor? (string), companyGroupIds? (number[]), nameSearch? (string[])
|
|
1062
1098
|
* Returns: CompanyGroupsGetAllResponse
|
|
1063
1099
|
*/
|
|
1064
1100
|
getAll(query?: CompanyGroupsGetAllQuery, init?: RequestOptions): Promise<CompanyGroupsGetAllResponse>
|
|
1065
1101
|
/**
|
|
1066
|
-
* Get one
|
|
1102
|
+
* Get one fund available to the SDK consumer
|
|
1103
|
+
* 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.
|
|
1067
1104
|
* Parameters: path: id (number)
|
|
1068
1105
|
* Returns: CompanyGroupsGetOneResponse
|
|
1069
1106
|
*/
|
|
@@ -1080,12 +1117,14 @@ export interface PositionsNamespace {
|
|
|
1080
1117
|
getPortfolioSummary(query?: PositionsGetPortfolioSummaryQuery, init?: RequestOptions): Promise<PositionsGetPortfolioSummaryResponse>
|
|
1081
1118
|
/**
|
|
1082
1119
|
* Get positions for one company
|
|
1120
|
+
* 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.
|
|
1083
1121
|
* Parameters: path: id (number); query: limit? (number), cursor? (string), companyGroupIds? (number[]), currency (string), date? (string)
|
|
1084
1122
|
* Returns: PositionsGetCompanyPositionsResponse
|
|
1085
1123
|
*/
|
|
1086
1124
|
getCompanyPositions(id: number, query?: PositionsGetCompanyPositionsQuery, init?: RequestOptions): Promise<PositionsGetCompanyPositionsResponse>
|
|
1087
1125
|
/**
|
|
1088
|
-
* Get portfolio
|
|
1126
|
+
* Get aggregated portfolio position totals
|
|
1127
|
+
* 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`.
|
|
1089
1128
|
* Parameters: query: companyGroupIds? (number[]), companyIds? (number[]), currency (string), date? (string)
|
|
1090
1129
|
* Returns: PositionsGetPortfolioPositionsResponse
|
|
1091
1130
|
*/
|
|
@@ -1095,19 +1134,21 @@ export interface PositionsNamespace {
|
|
|
1095
1134
|
export interface TransactionsNamespace {
|
|
1096
1135
|
/**
|
|
1097
1136
|
* Get transaction activity summary
|
|
1098
|
-
* 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,
|
|
1137
|
+
* 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.
|
|
1099
1138
|
* Parameters: query: limit? (number), cursor? (string), companyGroupIds? (number[]), companyIds? (number[]), currency (string), groupBy? ("Month" | "Quarter" | "Year"), from? (string), to? (string)
|
|
1100
1139
|
* Returns: TransactionsGetSummaryResponse
|
|
1101
1140
|
*/
|
|
1102
1141
|
getSummary(query?: TransactionsGetSummaryQuery, init?: RequestOptions): Promise<TransactionsGetSummaryResponse>
|
|
1103
1142
|
/**
|
|
1104
1143
|
* Get transactions for one company
|
|
1144
|
+
* 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.
|
|
1105
1145
|
* 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)
|
|
1106
1146
|
* Returns: TransactionsGetCompanyTransactionsResponse
|
|
1107
1147
|
*/
|
|
1108
1148
|
getCompanyTransactions(id: number, query?: TransactionsGetCompanyTransactionsQuery, init?: RequestOptions): Promise<TransactionsGetCompanyTransactionsResponse>
|
|
1109
1149
|
/**
|
|
1110
1150
|
* Get transactions for multiple companies
|
|
1151
|
+
* 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.
|
|
1111
1152
|
* 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[])
|
|
1112
1153
|
* Returns: TransactionsGetTransactionsResponse
|
|
1113
1154
|
*/
|
|
@@ -1137,7 +1178,7 @@ export interface MetricsNamespace {
|
|
|
1137
1178
|
compare(body: MetricsCompareBody, init?: RequestOptions): Promise<MetricsCompareResponse>
|
|
1138
1179
|
/**
|
|
1139
1180
|
* Aggregate metrics across portfolio companies
|
|
1140
|
-
* 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
|
|
1181
|
+
* 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.
|
|
1141
1182
|
* Parameters: body: MetricsAggregateBody
|
|
1142
1183
|
* Returns: MetricsAggregateResponse
|
|
1143
1184
|
*/
|
|
@@ -1147,7 +1188,7 @@ export interface MetricsNamespace {
|
|
|
1147
1188
|
export interface CompanyReportsNamespace {
|
|
1148
1189
|
/**
|
|
1149
1190
|
* List published company reports accessible to the caller (metadata only)
|
|
1150
|
-
* 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,
|
|
1191
|
+
* 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).
|
|
1151
1192
|
* Parameters: query: limit? (number), cursor? (string), companyIds? (number[]), companyGroupIds? (number[]), companyNameSearch? (string[]), timeframe? ("Month" | "Quarter" | "Year"), from? (string), to? (string)
|
|
1152
1193
|
* Returns: CompanyReportsListResponse
|
|
1153
1194
|
*/
|
|
@@ -1174,33 +1215,33 @@ export declare function createEmbedClient(options: CreateEmbedClientOptions): Em
|
|
|
1174
1215
|
|
|
1175
1216
|
export declare const routeManifest: {
|
|
1176
1217
|
companies: {
|
|
1177
|
-
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
|
|
1218
|
+
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 }[] }
|
|
1178
1219
|
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 }[] }
|
|
1179
|
-
getOne: { method: "GET"; path: "/companies/:id"; summary: "Get one company available to the SDK consumer"; description:
|
|
1220
|
+
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 }[] }
|
|
1180
1221
|
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 }[] }
|
|
1181
1222
|
}
|
|
1182
1223
|
companyGroups: {
|
|
1183
|
-
getAll: { method: "GET"; path: "/company-groups"; summary: "List
|
|
1184
|
-
getOne: { method: "GET"; path: "/company-groups/:id"; summary: "Get one
|
|
1224
|
+
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 }[] }
|
|
1225
|
+
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 }[] }
|
|
1185
1226
|
}
|
|
1186
1227
|
positions: {
|
|
1187
1228
|
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 }[] }
|
|
1188
|
-
getCompanyPositions: { method: "GET"; path: "/positions/companies/:id"; summary: "Get positions for one company"; description:
|
|
1189
|
-
getPortfolioPositions: { method: "GET"; path: "/positions/portfolio"; summary: "Get portfolio
|
|
1229
|
+
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 }[] }
|
|
1230
|
+
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 }[] }
|
|
1190
1231
|
}
|
|
1191
1232
|
transactions: {
|
|
1192
|
-
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,
|
|
1193
|
-
getCompanyTransactions: { method: "GET"; path: "/transactions/companies/:id"; summary: "Get transactions for one company"; description:
|
|
1194
|
-
getTransactions: { method: "GET"; path: "/transactions"; summary: "Get transactions for multiple companies"; description:
|
|
1233
|
+
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 }[] }
|
|
1234
|
+
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 }[] }
|
|
1235
|
+
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 }[] }
|
|
1195
1236
|
}
|
|
1196
1237
|
metrics: {
|
|
1197
1238
|
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 }[] }
|
|
1198
1239
|
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 }[] }
|
|
1199
1240
|
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 }[] }
|
|
1200
|
-
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
|
|
1241
|
+
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 }[] }
|
|
1201
1242
|
}
|
|
1202
1243
|
companyReports: {
|
|
1203
|
-
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,
|
|
1244
|
+
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 }[] }
|
|
1204
1245
|
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 }[] }
|
|
1205
1246
|
}
|
|
1206
1247
|
}
|
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` to scope the returned metrics
|
|
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
8
|
"exampleCall": "client.companies.getDashboards({ companyIds: [123], currency: 'USD' })",
|
|
9
9
|
"responseType": "CompaniesGetDashboardsResponse",
|
|
10
10
|
"pathParams": [],
|
|
@@ -55,7 +55,7 @@ const routeManifest = {
|
|
|
55
55
|
"method": "GET",
|
|
56
56
|
"path": "/companies/:id",
|
|
57
57
|
"summary": "Get one company available to the SDK consumer",
|
|
58
|
-
"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.",
|
|
59
59
|
"exampleCall": "client.companies.getOne(123)",
|
|
60
60
|
"responseType": "CompaniesGetOneResponse",
|
|
61
61
|
"pathParams": [
|
|
@@ -113,8 +113,8 @@ const routeManifest = {
|
|
|
113
113
|
"getAll": {
|
|
114
114
|
"method": "GET",
|
|
115
115
|
"path": "/company-groups",
|
|
116
|
-
"summary": "List
|
|
117
|
-
"description": "Returns compact
|
|
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\"]`).",
|
|
118
118
|
"exampleCall": "client.companyGroups.getAll({ limit: 123 })",
|
|
119
119
|
"responseType": "CompanyGroupsGetAllResponse",
|
|
120
120
|
"pathParams": [],
|
|
@@ -148,8 +148,8 @@ const routeManifest = {
|
|
|
148
148
|
"getOne": {
|
|
149
149
|
"method": "GET",
|
|
150
150
|
"path": "/company-groups/:id",
|
|
151
|
-
"summary": "Get one
|
|
152
|
-
"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.",
|
|
153
153
|
"exampleCall": "client.companyGroups.getOne(123)",
|
|
154
154
|
"responseType": "CompanyGroupsGetOneResponse",
|
|
155
155
|
"pathParams": [
|
|
@@ -220,7 +220,7 @@ const routeManifest = {
|
|
|
220
220
|
"method": "GET",
|
|
221
221
|
"path": "/positions/companies/:id",
|
|
222
222
|
"summary": "Get positions for one company",
|
|
223
|
-
"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.",
|
|
224
224
|
"exampleCall": "client.positions.getCompanyPositions(123, { currency: 'USD' })",
|
|
225
225
|
"responseType": "PositionsGetCompanyPositionsResponse",
|
|
226
226
|
"pathParams": [
|
|
@@ -266,8 +266,8 @@ const routeManifest = {
|
|
|
266
266
|
"getPortfolioPositions": {
|
|
267
267
|
"method": "GET",
|
|
268
268
|
"path": "/positions/portfolio",
|
|
269
|
-
"summary": "Get portfolio
|
|
270
|
-
"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`.",
|
|
271
271
|
"exampleCall": "client.positions.getPortfolioPositions({ currency: 'USD' })",
|
|
272
272
|
"responseType": "PositionsGetPortfolioPositionsResponse",
|
|
273
273
|
"pathParams": [],
|
|
@@ -304,7 +304,7 @@ const routeManifest = {
|
|
|
304
304
|
"method": "GET",
|
|
305
305
|
"path": "/transactions/summary",
|
|
306
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,
|
|
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
308
|
"exampleCall": "client.transactions.getSummary({ currency: 'USD' })",
|
|
309
309
|
"responseType": "TransactionsGetSummaryResponse",
|
|
310
310
|
"pathParams": [],
|
|
@@ -363,7 +363,7 @@ const routeManifest = {
|
|
|
363
363
|
"method": "GET",
|
|
364
364
|
"path": "/transactions/companies/:id",
|
|
365
365
|
"summary": "Get transactions for one company",
|
|
366
|
-
"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.",
|
|
367
367
|
"exampleCall": "client.transactions.getCompanyTransactions(123, { limit: 123 })",
|
|
368
368
|
"responseType": "TransactionsGetCompanyTransactionsResponse",
|
|
369
369
|
"pathParams": [
|
|
@@ -410,7 +410,7 @@ const routeManifest = {
|
|
|
410
410
|
"method": "GET",
|
|
411
411
|
"path": "/transactions",
|
|
412
412
|
"summary": "Get transactions for multiple companies",
|
|
413
|
-
"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.",
|
|
414
414
|
"exampleCall": "client.transactions.getTransactions({ limit: 123 })",
|
|
415
415
|
"responseType": "TransactionsGetTransactionsResponse",
|
|
416
416
|
"pathParams": [],
|
|
@@ -489,7 +489,7 @@ const routeManifest = {
|
|
|
489
489
|
"method": "POST",
|
|
490
490
|
"path": "/metrics/aggregate",
|
|
491
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
|
|
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
493
|
"exampleCall": "client.metrics.aggregate({ metricTypeIds: [1,7], aggregation: \"SUM\" })",
|
|
494
494
|
"responseType": "MetricsAggregateResponse",
|
|
495
495
|
"pathParams": [],
|
|
@@ -501,7 +501,7 @@ const routeManifest = {
|
|
|
501
501
|
"method": "GET",
|
|
502
502
|
"path": "/company-reports",
|
|
503
503
|
"summary": "List published company reports accessible to the caller (metadata only)",
|
|
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,
|
|
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).",
|
|
505
505
|
"exampleCall": "client.companyReports.list({ limit: 123 })",
|
|
506
506
|
"responseType": "CompanyReportsListResponse",
|
|
507
507
|
"pathParams": [],
|
package/openapi.json
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
"paths": {
|
|
4
4
|
"/api/v2/sdk/companies/dashboards": {
|
|
5
5
|
"post": {
|
|
6
|
-
"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
|
|
6
|
+
"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).",
|
|
7
7
|
"operationId": "companies.getDashboards",
|
|
8
8
|
"parameters": [],
|
|
9
9
|
"requestBody": {
|
|
@@ -141,6 +141,7 @@
|
|
|
141
141
|
},
|
|
142
142
|
"/api/v2/sdk/companies/{id}": {
|
|
143
143
|
"get": {
|
|
144
|
+
"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.",
|
|
144
145
|
"operationId": "companies.getOne",
|
|
145
146
|
"parameters": [
|
|
146
147
|
{
|
|
@@ -285,7 +286,7 @@
|
|
|
285
286
|
},
|
|
286
287
|
"/api/v2/sdk/company-groups": {
|
|
287
288
|
"get": {
|
|
288
|
-
"description": "Returns compact
|
|
289
|
+
"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\"]`).",
|
|
289
290
|
"operationId": "companyGroups.getAll",
|
|
290
291
|
"parameters": [
|
|
291
292
|
{
|
|
@@ -354,7 +355,7 @@
|
|
|
354
355
|
"sdk-client-api-key": []
|
|
355
356
|
}
|
|
356
357
|
],
|
|
357
|
-
"summary": "List
|
|
358
|
+
"summary": "List funds available to the SDK consumer",
|
|
358
359
|
"tags": [
|
|
359
360
|
"sdk-company-groups"
|
|
360
361
|
],
|
|
@@ -368,6 +369,7 @@
|
|
|
368
369
|
},
|
|
369
370
|
"/api/v2/sdk/company-groups/{id}": {
|
|
370
371
|
"get": {
|
|
372
|
+
"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.",
|
|
371
373
|
"operationId": "companyGroups.getOne",
|
|
372
374
|
"parameters": [
|
|
373
375
|
{
|
|
@@ -403,7 +405,7 @@
|
|
|
403
405
|
"sdk-client-api-key": []
|
|
404
406
|
}
|
|
405
407
|
],
|
|
406
|
-
"summary": "Get one
|
|
408
|
+
"summary": "Get one fund available to the SDK consumer",
|
|
407
409
|
"tags": [
|
|
408
410
|
"sdk-company-groups"
|
|
409
411
|
],
|
|
@@ -530,6 +532,7 @@
|
|
|
530
532
|
},
|
|
531
533
|
"/api/v2/sdk/positions/companies/{id}": {
|
|
532
534
|
"get": {
|
|
535
|
+
"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.",
|
|
533
536
|
"operationId": "positions.getCompanyPositions",
|
|
534
537
|
"parameters": [
|
|
535
538
|
{
|
|
@@ -627,6 +630,7 @@
|
|
|
627
630
|
},
|
|
628
631
|
"/api/v2/sdk/positions/portfolio": {
|
|
629
632
|
"get": {
|
|
633
|
+
"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`.",
|
|
630
634
|
"operationId": "positions.getPortfolioPositions",
|
|
631
635
|
"parameters": [
|
|
632
636
|
{
|
|
@@ -695,7 +699,7 @@
|
|
|
695
699
|
"sdk-client-api-key": []
|
|
696
700
|
}
|
|
697
701
|
],
|
|
698
|
-
"summary": "Get portfolio
|
|
702
|
+
"summary": "Get aggregated portfolio position totals",
|
|
699
703
|
"tags": [
|
|
700
704
|
"sdk-positions"
|
|
701
705
|
],
|
|
@@ -709,7 +713,7 @@
|
|
|
709
713
|
},
|
|
710
714
|
"/api/v2/sdk/transactions/summary": {
|
|
711
715
|
"get": {
|
|
712
|
-
"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,
|
|
716
|
+
"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.",
|
|
713
717
|
"operationId": "transactions.getSummary",
|
|
714
718
|
"parameters": [
|
|
715
719
|
{
|
|
@@ -833,6 +837,7 @@
|
|
|
833
837
|
},
|
|
834
838
|
"/api/v2/sdk/transactions/companies/{id}": {
|
|
835
839
|
"get": {
|
|
840
|
+
"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.",
|
|
836
841
|
"operationId": "transactions.getCompanyTransactions",
|
|
837
842
|
"parameters": [
|
|
838
843
|
{
|
|
@@ -955,6 +960,7 @@
|
|
|
955
960
|
},
|
|
956
961
|
"/api/v2/sdk/transactions": {
|
|
957
962
|
"get": {
|
|
963
|
+
"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.",
|
|
958
964
|
"operationId": "transactions.getTransactions",
|
|
959
965
|
"parameters": [
|
|
960
966
|
{
|
|
@@ -1220,7 +1226,7 @@
|
|
|
1220
1226
|
},
|
|
1221
1227
|
"/api/v2/sdk/metrics/aggregate": {
|
|
1222
1228
|
"post": {
|
|
1223
|
-
"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
|
|
1229
|
+
"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.",
|
|
1224
1230
|
"operationId": "metrics.aggregate",
|
|
1225
1231
|
"parameters": [],
|
|
1226
1232
|
"requestBody": {
|
|
@@ -1270,7 +1276,7 @@
|
|
|
1270
1276
|
},
|
|
1271
1277
|
"/api/v2/sdk/company-reports": {
|
|
1272
1278
|
"get": {
|
|
1273
|
-
"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,
|
|
1279
|
+
"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).",
|
|
1274
1280
|
"operationId": "companyReports.list",
|
|
1275
1281
|
"parameters": [
|
|
1276
1282
|
{
|
|
@@ -1448,7 +1454,7 @@
|
|
|
1448
1454
|
},
|
|
1449
1455
|
"info": {
|
|
1450
1456
|
"title": "SDK API",
|
|
1451
|
-
"description": "SDK API documentation for embedded and API key clients",
|
|
1457
|
+
"description": "SDK API documentation for embedded and API key clients.\n\n**Terminology note:** Throughout this API, \"funds\" and \"company groups\" refer to the same concept — an investment vehicle (fund, SPV, or similar) that holds positions in portfolio companies. The internal data model uses the term `companyGroup` / `companyGroupId` in all parameter and field names; the human-readable descriptions use \"fund\" for clarity.",
|
|
1452
1458
|
"version": "v2",
|
|
1453
1459
|
"contact": {}
|
|
1454
1460
|
},
|
|
@@ -2386,6 +2392,7 @@
|
|
|
2386
2392
|
"title",
|
|
2387
2393
|
"date",
|
|
2388
2394
|
"timeframe",
|
|
2395
|
+
"publishedAt",
|
|
2389
2396
|
"company"
|
|
2390
2397
|
]
|
|
2391
2398
|
},
|
|
@@ -5380,39 +5387,85 @@
|
|
|
5380
5387
|
"meta"
|
|
5381
5388
|
]
|
|
5382
5389
|
},
|
|
5383
|
-
"
|
|
5390
|
+
"SdkReportSectionType": {
|
|
5391
|
+
"type": "string",
|
|
5392
|
+
"enum": [
|
|
5393
|
+
"text"
|
|
5394
|
+
],
|
|
5395
|
+
"description": "Plain-text section."
|
|
5396
|
+
},
|
|
5397
|
+
"SdkTextReportSectionDto": {
|
|
5384
5398
|
"type": "object",
|
|
5385
5399
|
"properties": {
|
|
5386
|
-
"
|
|
5387
|
-
"type": "
|
|
5388
|
-
"
|
|
5389
|
-
"$ref": "#/components/schemas/SdkCompanyReportSummaryDto"
|
|
5390
|
-
}
|
|
5400
|
+
"id": {
|
|
5401
|
+
"type": "number",
|
|
5402
|
+
"description": "Section identifier."
|
|
5391
5403
|
},
|
|
5392
|
-
"
|
|
5393
|
-
"
|
|
5404
|
+
"type": {
|
|
5405
|
+
"description": "Plain-text section.",
|
|
5406
|
+
"allOf": [
|
|
5407
|
+
{
|
|
5408
|
+
"$ref": "#/components/schemas/SdkReportSectionType"
|
|
5409
|
+
}
|
|
5410
|
+
]
|
|
5411
|
+
},
|
|
5412
|
+
"order": {
|
|
5413
|
+
"type": "number",
|
|
5414
|
+
"description": "Position of the section within the report (0-based)."
|
|
5415
|
+
},
|
|
5416
|
+
"title": {
|
|
5417
|
+
"type": "string",
|
|
5418
|
+
"description": "Section title."
|
|
5419
|
+
},
|
|
5420
|
+
"content": {
|
|
5421
|
+
"type": "string",
|
|
5422
|
+
"description": "Plain-text body.",
|
|
5423
|
+
"nullable": true
|
|
5394
5424
|
}
|
|
5395
5425
|
},
|
|
5396
5426
|
"required": [
|
|
5397
|
-
"
|
|
5398
|
-
"
|
|
5427
|
+
"id",
|
|
5428
|
+
"type",
|
|
5429
|
+
"order",
|
|
5430
|
+
"title",
|
|
5431
|
+
"content"
|
|
5399
5432
|
]
|
|
5400
5433
|
},
|
|
5401
|
-
"
|
|
5434
|
+
"SdkMarkdownReportSectionDto": {
|
|
5402
5435
|
"type": "object",
|
|
5403
5436
|
"properties": {
|
|
5404
5437
|
"id": {
|
|
5405
5438
|
"type": "number",
|
|
5406
|
-
"description": "
|
|
5439
|
+
"description": "Section identifier."
|
|
5407
5440
|
},
|
|
5408
|
-
"
|
|
5441
|
+
"type": {
|
|
5442
|
+
"description": "Markdown section.",
|
|
5443
|
+
"allOf": [
|
|
5444
|
+
{
|
|
5445
|
+
"$ref": "#/components/schemas/SdkReportSectionType"
|
|
5446
|
+
}
|
|
5447
|
+
]
|
|
5448
|
+
},
|
|
5449
|
+
"order": {
|
|
5450
|
+
"type": "number",
|
|
5451
|
+
"description": "Position of the section within the report (0-based)."
|
|
5452
|
+
},
|
|
5453
|
+
"title": {
|
|
5409
5454
|
"type": "string",
|
|
5410
|
-
"description": "
|
|
5455
|
+
"description": "Section title."
|
|
5456
|
+
},
|
|
5457
|
+
"content": {
|
|
5458
|
+
"type": "string",
|
|
5459
|
+
"description": "Markdown body.",
|
|
5460
|
+
"nullable": true
|
|
5411
5461
|
}
|
|
5412
5462
|
},
|
|
5413
5463
|
"required": [
|
|
5414
5464
|
"id",
|
|
5415
|
-
"
|
|
5465
|
+
"type",
|
|
5466
|
+
"order",
|
|
5467
|
+
"title",
|
|
5468
|
+
"content"
|
|
5416
5469
|
]
|
|
5417
5470
|
},
|
|
5418
5471
|
"SdkCompanyReportAttachmentDto": {
|
|
@@ -5434,10 +5487,11 @@
|
|
|
5434
5487
|
},
|
|
5435
5488
|
"required": [
|
|
5436
5489
|
"id",
|
|
5437
|
-
"name"
|
|
5490
|
+
"name",
|
|
5491
|
+
"url"
|
|
5438
5492
|
]
|
|
5439
5493
|
},
|
|
5440
|
-
"
|
|
5494
|
+
"SdkImageReportSectionDto": {
|
|
5441
5495
|
"type": "object",
|
|
5442
5496
|
"properties": {
|
|
5443
5497
|
"id": {
|
|
@@ -5445,8 +5499,12 @@
|
|
|
5445
5499
|
"description": "Section identifier."
|
|
5446
5500
|
},
|
|
5447
5501
|
"type": {
|
|
5448
|
-
"
|
|
5449
|
-
"
|
|
5502
|
+
"description": "Image section.",
|
|
5503
|
+
"allOf": [
|
|
5504
|
+
{
|
|
5505
|
+
"$ref": "#/components/schemas/SdkReportSectionType"
|
|
5506
|
+
}
|
|
5507
|
+
]
|
|
5450
5508
|
},
|
|
5451
5509
|
"order": {
|
|
5452
5510
|
"type": "number",
|
|
@@ -5456,13 +5514,13 @@
|
|
|
5456
5514
|
"type": "string",
|
|
5457
5515
|
"description": "Section title."
|
|
5458
5516
|
},
|
|
5459
|
-
"
|
|
5517
|
+
"imageUrl": {
|
|
5460
5518
|
"type": "string",
|
|
5461
|
-
"description": "
|
|
5519
|
+
"description": "Pre-signed, time-limited link to the image.",
|
|
5462
5520
|
"nullable": true
|
|
5463
5521
|
},
|
|
5464
5522
|
"file": {
|
|
5465
|
-
"description": "
|
|
5523
|
+
"description": "The underlying uploaded image file.",
|
|
5466
5524
|
"nullable": true,
|
|
5467
5525
|
"type": "object",
|
|
5468
5526
|
"allOf": [
|
|
@@ -5470,18 +5528,144 @@
|
|
|
5470
5528
|
"$ref": "#/components/schemas/SdkCompanyReportAttachmentDto"
|
|
5471
5529
|
}
|
|
5472
5530
|
]
|
|
5531
|
+
}
|
|
5532
|
+
},
|
|
5533
|
+
"required": [
|
|
5534
|
+
"id",
|
|
5535
|
+
"type",
|
|
5536
|
+
"order",
|
|
5537
|
+
"title",
|
|
5538
|
+
"imageUrl",
|
|
5539
|
+
"file"
|
|
5540
|
+
]
|
|
5541
|
+
},
|
|
5542
|
+
"SdkSingleChoiceReportSectionDto": {
|
|
5543
|
+
"type": "object",
|
|
5544
|
+
"properties": {
|
|
5545
|
+
"id": {
|
|
5546
|
+
"type": "number",
|
|
5547
|
+
"description": "Section identifier."
|
|
5473
5548
|
},
|
|
5474
|
-
"
|
|
5549
|
+
"type": {
|
|
5550
|
+
"description": "Single-choice section.",
|
|
5551
|
+
"allOf": [
|
|
5552
|
+
{
|
|
5553
|
+
"$ref": "#/components/schemas/SdkReportSectionType"
|
|
5554
|
+
}
|
|
5555
|
+
]
|
|
5556
|
+
},
|
|
5557
|
+
"order": {
|
|
5558
|
+
"type": "number",
|
|
5559
|
+
"description": "Position of the section within the report (0-based)."
|
|
5560
|
+
},
|
|
5561
|
+
"title": {
|
|
5475
5562
|
"type": "string",
|
|
5476
|
-
"description": "
|
|
5477
|
-
|
|
5563
|
+
"description": "Section title."
|
|
5564
|
+
},
|
|
5565
|
+
"options": {
|
|
5566
|
+
"description": "All selectable option labels, in human-readable form.",
|
|
5567
|
+
"type": "array",
|
|
5568
|
+
"items": {
|
|
5569
|
+
"type": "string"
|
|
5570
|
+
}
|
|
5571
|
+
},
|
|
5572
|
+
"selectedOptions": {
|
|
5573
|
+
"description": "The selected option label(s), in human-readable form.",
|
|
5574
|
+
"type": "array",
|
|
5575
|
+
"items": {
|
|
5576
|
+
"type": "string"
|
|
5577
|
+
}
|
|
5478
5578
|
}
|
|
5479
5579
|
},
|
|
5480
5580
|
"required": [
|
|
5481
5581
|
"id",
|
|
5482
5582
|
"type",
|
|
5483
5583
|
"order",
|
|
5484
|
-
"title"
|
|
5584
|
+
"title",
|
|
5585
|
+
"options",
|
|
5586
|
+
"selectedOptions"
|
|
5587
|
+
]
|
|
5588
|
+
},
|
|
5589
|
+
"SdkMultiChoiceReportSectionDto": {
|
|
5590
|
+
"type": "object",
|
|
5591
|
+
"properties": {
|
|
5592
|
+
"id": {
|
|
5593
|
+
"type": "number",
|
|
5594
|
+
"description": "Section identifier."
|
|
5595
|
+
},
|
|
5596
|
+
"type": {
|
|
5597
|
+
"description": "Multi-choice section.",
|
|
5598
|
+
"allOf": [
|
|
5599
|
+
{
|
|
5600
|
+
"$ref": "#/components/schemas/SdkReportSectionType"
|
|
5601
|
+
}
|
|
5602
|
+
]
|
|
5603
|
+
},
|
|
5604
|
+
"order": {
|
|
5605
|
+
"type": "number",
|
|
5606
|
+
"description": "Position of the section within the report (0-based)."
|
|
5607
|
+
},
|
|
5608
|
+
"title": {
|
|
5609
|
+
"type": "string",
|
|
5610
|
+
"description": "Section title."
|
|
5611
|
+
},
|
|
5612
|
+
"options": {
|
|
5613
|
+
"description": "All selectable option labels, in human-readable form.",
|
|
5614
|
+
"type": "array",
|
|
5615
|
+
"items": {
|
|
5616
|
+
"type": "string"
|
|
5617
|
+
}
|
|
5618
|
+
},
|
|
5619
|
+
"selectedOptions": {
|
|
5620
|
+
"description": "The selected option label(s), in human-readable form.",
|
|
5621
|
+
"type": "array",
|
|
5622
|
+
"items": {
|
|
5623
|
+
"type": "string"
|
|
5624
|
+
}
|
|
5625
|
+
}
|
|
5626
|
+
},
|
|
5627
|
+
"required": [
|
|
5628
|
+
"id",
|
|
5629
|
+
"type",
|
|
5630
|
+
"order",
|
|
5631
|
+
"title",
|
|
5632
|
+
"options",
|
|
5633
|
+
"selectedOptions"
|
|
5634
|
+
]
|
|
5635
|
+
},
|
|
5636
|
+
"SdkCompanyReportsListResponseDto": {
|
|
5637
|
+
"type": "object",
|
|
5638
|
+
"properties": {
|
|
5639
|
+
"data": {
|
|
5640
|
+
"type": "array",
|
|
5641
|
+
"items": {
|
|
5642
|
+
"$ref": "#/components/schemas/SdkCompanyReportSummaryDto"
|
|
5643
|
+
}
|
|
5644
|
+
},
|
|
5645
|
+
"meta": {
|
|
5646
|
+
"$ref": "#/components/schemas/SdkPaginationMetaDto"
|
|
5647
|
+
}
|
|
5648
|
+
},
|
|
5649
|
+
"required": [
|
|
5650
|
+
"data",
|
|
5651
|
+
"meta"
|
|
5652
|
+
]
|
|
5653
|
+
},
|
|
5654
|
+
"SdkUserReferenceDto": {
|
|
5655
|
+
"type": "object",
|
|
5656
|
+
"properties": {
|
|
5657
|
+
"id": {
|
|
5658
|
+
"type": "number",
|
|
5659
|
+
"description": "User identifier."
|
|
5660
|
+
},
|
|
5661
|
+
"name": {
|
|
5662
|
+
"type": "string",
|
|
5663
|
+
"description": "User display name (first + last name)."
|
|
5664
|
+
}
|
|
5665
|
+
},
|
|
5666
|
+
"required": [
|
|
5667
|
+
"id",
|
|
5668
|
+
"name"
|
|
5485
5669
|
]
|
|
5486
5670
|
},
|
|
5487
5671
|
"SdkCompanyReportDto": {
|
|
@@ -5527,10 +5711,36 @@
|
|
|
5527
5711
|
]
|
|
5528
5712
|
},
|
|
5529
5713
|
"sections": {
|
|
5530
|
-
"description": "Structured sections that compose the report body.",
|
|
5531
5714
|
"type": "array",
|
|
5715
|
+
"description": "Structured sections that compose the report body. Each element is a section variant; narrow via its `type` field.",
|
|
5532
5716
|
"items": {
|
|
5533
|
-
"
|
|
5717
|
+
"oneOf": [
|
|
5718
|
+
{
|
|
5719
|
+
"$ref": "#/components/schemas/SdkTextReportSectionDto"
|
|
5720
|
+
},
|
|
5721
|
+
{
|
|
5722
|
+
"$ref": "#/components/schemas/SdkMarkdownReportSectionDto"
|
|
5723
|
+
},
|
|
5724
|
+
{
|
|
5725
|
+
"$ref": "#/components/schemas/SdkImageReportSectionDto"
|
|
5726
|
+
},
|
|
5727
|
+
{
|
|
5728
|
+
"$ref": "#/components/schemas/SdkSingleChoiceReportSectionDto"
|
|
5729
|
+
},
|
|
5730
|
+
{
|
|
5731
|
+
"$ref": "#/components/schemas/SdkMultiChoiceReportSectionDto"
|
|
5732
|
+
}
|
|
5733
|
+
],
|
|
5734
|
+
"discriminator": {
|
|
5735
|
+
"propertyName": "type",
|
|
5736
|
+
"mapping": {
|
|
5737
|
+
"text": "#/components/schemas/SdkTextReportSectionDto",
|
|
5738
|
+
"markdown": "#/components/schemas/SdkMarkdownReportSectionDto",
|
|
5739
|
+
"image": "#/components/schemas/SdkImageReportSectionDto",
|
|
5740
|
+
"single-choice": "#/components/schemas/SdkSingleChoiceReportSectionDto",
|
|
5741
|
+
"multi-choice": "#/components/schemas/SdkMultiChoiceReportSectionDto"
|
|
5742
|
+
}
|
|
5743
|
+
}
|
|
5534
5744
|
}
|
|
5535
5745
|
},
|
|
5536
5746
|
"attachments": {
|
|
@@ -5546,7 +5756,9 @@
|
|
|
5546
5756
|
"title",
|
|
5547
5757
|
"date",
|
|
5548
5758
|
"timeframe",
|
|
5759
|
+
"publishedAt",
|
|
5549
5760
|
"company",
|
|
5761
|
+
"createdBy",
|
|
5550
5762
|
"sections",
|
|
5551
5763
|
"attachments"
|
|
5552
5764
|
]
|
package/package.json
CHANGED
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@rundit-sdk/embed",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.1-rc.5",
|
|
4
4
|
"description": "Public Rundit embed SDK for iframe and embedded module consumers.",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
7
|
-
"url": "https://github.com/Rundit/rundit-
|
|
7
|
+
"url": "git+https://github.com/Rundit/rundit-sdk.git",
|
|
8
|
+
"directory": "packages/embed"
|
|
8
9
|
},
|
|
9
10
|
"type": "module",
|
|
10
11
|
"sideEffects": false,
|