@rundit-sdk/embed 0.2.1-rc.18 → 0.2.1-rc.20
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 +3 -3
- package/ai-manifest.json +23 -5
- package/dist/index.d.ts +47 -11
- package/dist/index.js +23 -5
- package/openapi.json +139 -7
- package/package.json +1 -1
package/AGENTS.md
CHANGED
|
@@ -34,14 +34,14 @@ console.log(routeManifest)
|
|
|
34
34
|
- companies.getAll: List companies available to the SDK consumer
|
|
35
35
|
- Call: `client.companies.getAll({ limit: 123 })`
|
|
36
36
|
- Returns: `CompaniesGetAllResponse`
|
|
37
|
-
- Params: query: limit? (number), cursor? (string), companyIds? (number[]), companyGroupIds? (number[])
|
|
37
|
+
- Params: query: limit? (number), cursor? (string), companyIds? (number[]), companyGroupIds? (number[]), nameSearch? (string)
|
|
38
38
|
|
|
39
39
|
## companyGroups
|
|
40
40
|
|
|
41
41
|
- companyGroups.getAll: List company groups available to the SDK consumer
|
|
42
42
|
- Call: `client.companyGroups.getAll({ limit: 123 })`
|
|
43
43
|
- Returns: `CompanyGroupsGetAllResponse`
|
|
44
|
-
- Params: query: limit? (number), cursor? (string), companyGroupIds? (number[])
|
|
44
|
+
- Params: query: limit? (number), cursor? (string), companyGroupIds? (number[]), nameSearch? (string)
|
|
45
45
|
- companyGroups.getOne: Get one company group available to the SDK consumer
|
|
46
46
|
- Call: `client.companyGroups.getOne(123)`
|
|
47
47
|
- Returns: `CompanyGroupsGetOneResponse`
|
|
@@ -84,7 +84,7 @@ console.log(routeManifest)
|
|
|
84
84
|
- companyReports.list: List published company reports accessible to the caller (metadata only)
|
|
85
85
|
- Call: `client.companyReports.list({ limit: 123 })`
|
|
86
86
|
- Returns: `CompanyReportsListResponse`
|
|
87
|
-
- Params: query: limit? (number), cursor? (string), companyIds? (number[]), companyGroupIds? (number[]), timeframe? ("Month" | "Quarter" | "Year"), from? (string), to? (string)
|
|
87
|
+
- Params: query: limit? (number), cursor? (string), companyIds? (number[]), companyGroupIds? (number[]), companyNameSearch? (string), timeframe? ("Month" | "Quarter" | "Year"), from? (string), to? (string)
|
|
88
88
|
- companyReports.getOne: Fetch the full content of a single company report
|
|
89
89
|
- Call: `client.companyReports.getOne(123)`
|
|
90
90
|
- Returns: `CompanyReportsGetOneResponse`
|
package/README.md
CHANGED
|
@@ -60,7 +60,7 @@ List companies available to the SDK consumer
|
|
|
60
60
|
- Call: `client.companies.getAll({ limit: 123 })`
|
|
61
61
|
- HTTP: `GET /companies`
|
|
62
62
|
- Returns: `CompaniesGetAllResponse`
|
|
63
|
-
- Params: query: limit? (number), cursor? (string), companyIds? (number[]), companyGroupIds? (number[])
|
|
63
|
+
- Params: query: limit? (number), cursor? (string), companyIds? (number[]), companyGroupIds? (number[]), nameSearch? (string)
|
|
64
64
|
|
|
65
65
|
## companyGroups
|
|
66
66
|
|
|
@@ -71,7 +71,7 @@ List company groups available to the SDK consumer
|
|
|
71
71
|
- Call: `client.companyGroups.getAll({ limit: 123 })`
|
|
72
72
|
- HTTP: `GET /company-groups`
|
|
73
73
|
- Returns: `CompanyGroupsGetAllResponse`
|
|
74
|
-
- Params: query: limit? (number), cursor? (string), companyGroupIds? (number[])
|
|
74
|
+
- Params: query: limit? (number), cursor? (string), companyGroupIds? (number[]), nameSearch? (string)
|
|
75
75
|
|
|
76
76
|
### `companyGroups.getOne`
|
|
77
77
|
|
|
@@ -150,7 +150,7 @@ List published company reports accessible to the caller (metadata only)
|
|
|
150
150
|
- Call: `client.companyReports.list({ limit: 123 })`
|
|
151
151
|
- HTTP: `GET /company-reports`
|
|
152
152
|
- Returns: `CompanyReportsListResponse`
|
|
153
|
-
- Params: query: limit? (number), cursor? (string), companyIds? (number[]), companyGroupIds? (number[]), timeframe? ("Month" | "Quarter" | "Year"), from? (string), to? (string)
|
|
153
|
+
- Params: query: limit? (number), cursor? (string), companyIds? (number[]), companyGroupIds? (number[]), companyNameSearch? (string), timeframe? ("Month" | "Quarter" | "Year"), from? (string), to? (string)
|
|
154
154
|
|
|
155
155
|
### `companyReports.getOne`
|
|
156
156
|
|
package/ai-manifest.json
CHANGED
|
@@ -40,7 +40,7 @@
|
|
|
40
40
|
{
|
|
41
41
|
"operation": "getAll",
|
|
42
42
|
"summary": "List companies available to the SDK consumer",
|
|
43
|
-
"description":
|
|
43
|
+
"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) to locate companies in one round trip — avoids listing the full portfolio when the agent only knows the company by name.",
|
|
44
44
|
"method": "GET",
|
|
45
45
|
"path": "/companies",
|
|
46
46
|
"exampleCall": "client.companies.getAll({ limit: 123 })",
|
|
@@ -70,6 +70,12 @@
|
|
|
70
70
|
"required": false,
|
|
71
71
|
"type": "number[]",
|
|
72
72
|
"description": "Restrict results to companies that belong to any of these company groups"
|
|
73
|
+
},
|
|
74
|
+
{
|
|
75
|
+
"name": "nameSearch",
|
|
76
|
+
"required": false,
|
|
77
|
+
"type": "string",
|
|
78
|
+
"description": "Case-insensitive substring match on company display name. Combine with companyIds/companyGroupIds to find a company without first listing the entire portfolio."
|
|
73
79
|
}
|
|
74
80
|
]
|
|
75
81
|
}
|
|
@@ -78,7 +84,7 @@
|
|
|
78
84
|
{
|
|
79
85
|
"operation": "getAll",
|
|
80
86
|
"summary": "List company groups available to the SDK consumer",
|
|
81
|
-
"description":
|
|
87
|
+
"description": "Returns compact company group metadata (id, name, demo flag, color, member company ids). Filter by `companyGroupIds` and/or `nameSearch` (case-insensitive substring on name) to look up a specific fund or visibility group in one round trip.",
|
|
82
88
|
"method": "GET",
|
|
83
89
|
"path": "/company-groups",
|
|
84
90
|
"exampleCall": "client.companyGroups.getAll({ limit: 123 })",
|
|
@@ -102,6 +108,12 @@
|
|
|
102
108
|
"required": false,
|
|
103
109
|
"type": "number[]",
|
|
104
110
|
"description": "Restrict results to these company group identifiers"
|
|
111
|
+
},
|
|
112
|
+
{
|
|
113
|
+
"name": "nameSearch",
|
|
114
|
+
"required": false,
|
|
115
|
+
"type": "string",
|
|
116
|
+
"description": "Case-insensitive substring match on company group display name. Useful for finding a fund or visibility group by name without first listing all groups."
|
|
105
117
|
}
|
|
106
118
|
]
|
|
107
119
|
},
|
|
@@ -311,7 +323,7 @@
|
|
|
311
323
|
{
|
|
312
324
|
"operation": "getTypes",
|
|
313
325
|
"summary": "List metric types available to the SDK consumer",
|
|
314
|
-
"description": "Returns predefined metric types plus user-defined metric types scoped to the caller — VC group custom types for VC users, company custom types for company users. Each entry
|
|
326
|
+
"description": "Returns predefined metric types plus user-defined metric types scoped to the caller — VC group custom types for VC users, company custom types for company users. Each entry carries the metric shape needed to interpret values: `valueType` is `\"numeric\"` (read `point.value` as a number; may carry `rangeConfig` with min/max/step for ranged metrics) or `\"option\"` (read `point.optionValue` as a string from `optionConfig.options[]` — this is how boolean / yes-no metrics are encoded, as two options typically labelled \"Yes\"/\"No\"). `unit.unit` describes the measurement (`Currency`, `Percentage`, `Number`, time units, ...); `unit.currencyCode` is intentionally null on this endpoint because monetary types resolve their concrete currency per company — call /metrics to receive `unit.currencyCode` populated with each company's native currency, or pass `currency` to convert all monetary metrics to a chosen target.",
|
|
315
327
|
"method": "GET",
|
|
316
328
|
"path": "/metrics/types",
|
|
317
329
|
"exampleCall": "client.metrics.getTypes()",
|
|
@@ -322,7 +334,7 @@
|
|
|
322
334
|
{
|
|
323
335
|
"operation": "search",
|
|
324
336
|
"summary": "Read metric values for accessible companies, grouped by company",
|
|
325
|
-
"description": "Returns metric data points for companies the caller can access (companies in the caller's VC group portfolio, or the caller's own company for company users). Each entry carries company and metric type references with id and human-readable name. Filter by company, company group, metric type, timeframe, and date range to narrow the response.",
|
|
337
|
+
"description": "Returns metric data points for companies the caller can access (companies in the caller's VC group portfolio, or the caller's own company for company users). Each entry carries company and metric type references with id and human-readable name. Each point carries both `value` (number, for `valueType === \"numeric\"`, including ranged numerics constrained by the type's `rangeConfig`) and `optionValue` (string, for `valueType === \"option\"`, matching one of `metricType.optionConfig.options[].value` — this is how boolean/yes-no metrics report their reading); read whichever matches the metric type's `valueType`. Filter by company id, company name substring (`companyNameSearch`), company group, metric type id, metric type name (`metricTypeNames`), timeframe, and date range to narrow the response. Pass `currency` (ISO 4217) to FX-convert monetary metrics to that target currency in one call instead of fetching company currencies separately.",
|
|
326
338
|
"method": "POST",
|
|
327
339
|
"path": "/metrics",
|
|
328
340
|
"exampleCall": "client.metrics.search({})",
|
|
@@ -335,7 +347,7 @@
|
|
|
335
347
|
{
|
|
336
348
|
"operation": "list",
|
|
337
349
|
"summary": "List published company reports accessible to the caller (metadata only)",
|
|
338
|
-
"description": "Returns lightweight report metadata (id, title, period, publisher company reference). Use GET /company-reports/:id to fetch the full content of a specific report. Visibility is determined by the caller's roles — VC users see reports for managed-portfolio companies, company employees see their own company's reports, portfolio investors see Published reports shared with their visibility groups. Filters narrow the list by company ids and reporting period (timeframe + date range).",
|
|
350
|
+
"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, company groups, company name substring (`companyNameSearch`), and reporting period (timeframe + date range).",
|
|
339
351
|
"method": "GET",
|
|
340
352
|
"path": "/company-reports",
|
|
341
353
|
"exampleCall": "client.companyReports.list({ limit: 123 })",
|
|
@@ -366,6 +378,12 @@
|
|
|
366
378
|
"type": "number[]",
|
|
367
379
|
"description": "Restrict to companies that belong to any of these company groups."
|
|
368
380
|
},
|
|
381
|
+
{
|
|
382
|
+
"name": "companyNameSearch",
|
|
383
|
+
"required": false,
|
|
384
|
+
"type": "string",
|
|
385
|
+
"description": "Case-insensitive substring match on the reporting company name. Intersects with `companyIds`/`companyGroupIds` to fetch reports by company name without a separate companies lookup."
|
|
386
|
+
},
|
|
369
387
|
{
|
|
370
388
|
"name": "timeframe",
|
|
371
389
|
"required": false,
|
package/dist/index.d.ts
CHANGED
|
@@ -443,6 +443,21 @@ export interface SdkMetricUnitDto {
|
|
|
443
443
|
currencyCode?: string | null
|
|
444
444
|
}
|
|
445
445
|
|
|
446
|
+
export interface SdkMetricTypeOptionDto {
|
|
447
|
+
value: string
|
|
448
|
+
isPositive: boolean
|
|
449
|
+
}
|
|
450
|
+
|
|
451
|
+
export interface SdkMetricTypeOptionConfigDto {
|
|
452
|
+
options: SdkMetricTypeOptionDto[]
|
|
453
|
+
}
|
|
454
|
+
|
|
455
|
+
export interface SdkMetricTypeRangeConfigDto {
|
|
456
|
+
min: number
|
|
457
|
+
max: number
|
|
458
|
+
step: number
|
|
459
|
+
}
|
|
460
|
+
|
|
446
461
|
export interface SdkMetricTypeDto {
|
|
447
462
|
id: number
|
|
448
463
|
name: string
|
|
@@ -452,6 +467,8 @@ export interface SdkMetricTypeDto {
|
|
|
452
467
|
aggMethod: { }
|
|
453
468
|
valueType?: { }
|
|
454
469
|
unit?: SdkMetricUnitDto
|
|
470
|
+
optionConfig?: SdkMetricTypeOptionConfigDto
|
|
471
|
+
rangeConfig?: SdkMetricTypeRangeConfigDto
|
|
455
472
|
}
|
|
456
473
|
|
|
457
474
|
export interface SdkMetricTypesListResponseDto {
|
|
@@ -463,6 +480,7 @@ export interface SdkMetricPointDto {
|
|
|
463
480
|
date: string
|
|
464
481
|
timeframe: { }
|
|
465
482
|
value: number | null
|
|
483
|
+
optionValue: string | null
|
|
466
484
|
valueError?: string | null
|
|
467
485
|
aggregated?: boolean
|
|
468
486
|
}
|
|
@@ -488,11 +506,15 @@ export interface MetricSearchDto {
|
|
|
488
506
|
limit?: number
|
|
489
507
|
cursor?: string
|
|
490
508
|
companyIds?: number[]
|
|
509
|
+
companyNameSearch?: string
|
|
491
510
|
companyGroupIds?: number[]
|
|
492
511
|
metricTypeIds?: number[]
|
|
512
|
+
metricTypeNames?: string[]
|
|
493
513
|
timeframe?: "Month" | "Quarter" | "Year"
|
|
494
514
|
from?: string
|
|
495
515
|
to?: string
|
|
516
|
+
currency?: string
|
|
517
|
+
conversionStrategy?: "LATEST_FX_RATE" | "ENTITY_DATE_RATE"
|
|
496
518
|
}
|
|
497
519
|
|
|
498
520
|
export interface SdkCompanyReportSummaryDto {
|
|
@@ -585,6 +607,10 @@ export interface CompaniesGetAllQuery {
|
|
|
585
607
|
* Restrict results to companies that belong to any of these company groups
|
|
586
608
|
*/
|
|
587
609
|
companyGroupIds?: number[]
|
|
610
|
+
/**
|
|
611
|
+
* Case-insensitive substring match on company display name. Combine with companyIds/companyGroupIds to find a company without first listing the entire portfolio.
|
|
612
|
+
*/
|
|
613
|
+
nameSearch?: string
|
|
588
614
|
}
|
|
589
615
|
|
|
590
616
|
export interface CompanyGroupsGetAllQuery {
|
|
@@ -600,6 +626,10 @@ export interface CompanyGroupsGetAllQuery {
|
|
|
600
626
|
* Restrict results to these company group identifiers
|
|
601
627
|
*/
|
|
602
628
|
companyGroupIds?: number[]
|
|
629
|
+
/**
|
|
630
|
+
* Case-insensitive substring match on company group display name. Useful for finding a fund or visibility group by name without first listing all groups.
|
|
631
|
+
*/
|
|
632
|
+
nameSearch?: string
|
|
603
633
|
}
|
|
604
634
|
|
|
605
635
|
export interface PositionsGetCompanyPositionsQuery {
|
|
@@ -711,6 +741,10 @@ export interface CompanyReportsListQuery {
|
|
|
711
741
|
* Restrict to companies that belong to any of these company groups.
|
|
712
742
|
*/
|
|
713
743
|
companyGroupIds?: number[]
|
|
744
|
+
/**
|
|
745
|
+
* Case-insensitive substring match on the reporting company name. Intersects with `companyIds`/`companyGroupIds` to fetch reports by company name without a separate companies lookup.
|
|
746
|
+
*/
|
|
747
|
+
companyNameSearch?: string
|
|
714
748
|
/**
|
|
715
749
|
* Restrict to a reporting period granularity (Month, Quarter, Year).
|
|
716
750
|
*/
|
|
@@ -734,7 +768,8 @@ export interface CompaniesNamespace {
|
|
|
734
768
|
getOne(id: number, init?: RequestOptions): Promise<CompaniesGetOneResponse>
|
|
735
769
|
/**
|
|
736
770
|
* List companies available to the SDK consumer
|
|
737
|
-
*
|
|
771
|
+
* 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) to locate companies in one round trip — avoids listing the full portfolio when the agent only knows the company by name.
|
|
772
|
+
* Parameters: query: limit? (number), cursor? (string), companyIds? (number[]), companyGroupIds? (number[]), nameSearch? (string)
|
|
738
773
|
* Returns: CompaniesGetAllResponse
|
|
739
774
|
*/
|
|
740
775
|
getAll(query?: CompaniesGetAllQuery, init?: RequestOptions): Promise<CompaniesGetAllResponse>
|
|
@@ -743,7 +778,8 @@ export interface CompaniesNamespace {
|
|
|
743
778
|
export interface CompanyGroupsNamespace {
|
|
744
779
|
/**
|
|
745
780
|
* List company groups available to the SDK consumer
|
|
746
|
-
*
|
|
781
|
+
* Returns compact company group metadata (id, name, demo flag, color, member company ids). Filter by `companyGroupIds` and/or `nameSearch` (case-insensitive substring on name) to look up a specific fund or visibility group in one round trip.
|
|
782
|
+
* Parameters: query: limit? (number), cursor? (string), companyGroupIds? (number[]), nameSearch? (string)
|
|
747
783
|
* Returns: CompanyGroupsGetAllResponse
|
|
748
784
|
*/
|
|
749
785
|
getAll(query?: CompanyGroupsGetAllQuery, init?: RequestOptions): Promise<CompanyGroupsGetAllResponse>
|
|
@@ -788,13 +824,13 @@ export interface TransactionsNamespace {
|
|
|
788
824
|
export interface MetricsNamespace {
|
|
789
825
|
/**
|
|
790
826
|
* List metric types available to the SDK consumer
|
|
791
|
-
* 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
|
|
827
|
+
* 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.
|
|
792
828
|
* Returns: MetricsGetTypesResponse
|
|
793
829
|
*/
|
|
794
830
|
getTypes(init?: RequestOptions): Promise<MetricsGetTypesResponse>
|
|
795
831
|
/**
|
|
796
832
|
* Read metric values for accessible companies, grouped by company
|
|
797
|
-
* 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.
|
|
833
|
+
* 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.
|
|
798
834
|
* Parameters: body: MetricsSearchBody
|
|
799
835
|
* Returns: MetricsSearchResponse
|
|
800
836
|
*/
|
|
@@ -804,8 +840,8 @@ export interface MetricsNamespace {
|
|
|
804
840
|
export interface CompanyReportsNamespace {
|
|
805
841
|
/**
|
|
806
842
|
* List published company reports accessible to the caller (metadata only)
|
|
807
|
-
* 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).
|
|
808
|
-
* Parameters: query: limit? (number), cursor? (string), companyIds? (number[]), companyGroupIds? (number[]), timeframe? ("Month" | "Quarter" | "Year"), from? (string), to? (string)
|
|
843
|
+
* 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, company groups, company name substring (`companyNameSearch`), and reporting period (timeframe + date range).
|
|
844
|
+
* Parameters: query: limit? (number), cursor? (string), companyIds? (number[]), companyGroupIds? (number[]), companyNameSearch? (string), timeframe? ("Month" | "Quarter" | "Year"), from? (string), to? (string)
|
|
809
845
|
* Returns: CompanyReportsListResponse
|
|
810
846
|
*/
|
|
811
847
|
list(query?: CompanyReportsListQuery, init?: RequestOptions): Promise<CompanyReportsListResponse>
|
|
@@ -832,10 +868,10 @@ export declare function createEmbedClient(options: CreateEmbedClientOptions): Em
|
|
|
832
868
|
export declare const routeManifest: {
|
|
833
869
|
companies: {
|
|
834
870
|
getOne: { method: "GET"; path: "/companies/:id"; summary: "Get one company available to the SDK consumer"; description: null; 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 }[] }
|
|
835
|
-
getAll: { method: "GET"; path: "/companies"; summary: "List companies available to the SDK consumer"; description:
|
|
871
|
+
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) to locate companies in one round trip — avoids listing the full portfolio when the agent only knows the company 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 }[] }
|
|
836
872
|
}
|
|
837
873
|
companyGroups: {
|
|
838
|
-
getAll: { method: "GET"; path: "/company-groups"; summary: "List company groups available to the SDK consumer"; description:
|
|
874
|
+
getAll: { method: "GET"; path: "/company-groups"; summary: "List company groups available to the SDK consumer"; description: "Returns compact company group metadata (id, name, demo flag, color, member company ids). Filter by `companyGroupIds` and/or `nameSearch` (case-insensitive substring on name) to look up a specific fund or visibility group in one round trip."; 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 }[] }
|
|
839
875
|
getOne: { method: "GET"; path: "/company-groups/:id"; summary: "Get one company group available to the SDK consumer"; description: null; 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 }[] }
|
|
840
876
|
}
|
|
841
877
|
positions: {
|
|
@@ -847,11 +883,11 @@ export declare const routeManifest: {
|
|
|
847
883
|
getTransactions: { method: "GET"; path: "/transactions"; summary: "Get transactions for multiple companies"; description: null; 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 }[] }
|
|
848
884
|
}
|
|
849
885
|
metrics: {
|
|
850
|
-
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
|
|
851
|
-
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. Filter by company, company group, metric type, timeframe, and date range to narrow the response."; exampleCall: "client.metrics.search({})"; responseType: "MetricsSearchResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
|
|
886
|
+
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 }[] }
|
|
887
|
+
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 }[] }
|
|
852
888
|
}
|
|
853
889
|
companyReports: {
|
|
854
|
-
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 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 }[] }
|
|
890
|
+
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, company groups, 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 }[] }
|
|
855
891
|
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 }[] }
|
|
856
892
|
}
|
|
857
893
|
}
|
package/dist/index.js
CHANGED
|
@@ -20,7 +20,7 @@ const routeManifest = {
|
|
|
20
20
|
"method": "GET",
|
|
21
21
|
"path": "/companies",
|
|
22
22
|
"summary": "List companies available to the SDK consumer",
|
|
23
|
-
"description":
|
|
23
|
+
"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) to locate companies in one round trip — avoids listing the full portfolio when the agent only knows the company by name.",
|
|
24
24
|
"exampleCall": "client.companies.getAll({ limit: 123 })",
|
|
25
25
|
"responseType": "CompaniesGetAllResponse",
|
|
26
26
|
"pathParams": [],
|
|
@@ -48,6 +48,12 @@ const routeManifest = {
|
|
|
48
48
|
"required": false,
|
|
49
49
|
"type": "number[]",
|
|
50
50
|
"description": "Restrict results to companies that belong to any of these company groups"
|
|
51
|
+
},
|
|
52
|
+
{
|
|
53
|
+
"name": "nameSearch",
|
|
54
|
+
"required": false,
|
|
55
|
+
"type": "string",
|
|
56
|
+
"description": "Case-insensitive substring match on company display name. Combine with companyIds/companyGroupIds to find a company without first listing the entire portfolio."
|
|
51
57
|
}
|
|
52
58
|
]
|
|
53
59
|
}
|
|
@@ -57,7 +63,7 @@ const routeManifest = {
|
|
|
57
63
|
"method": "GET",
|
|
58
64
|
"path": "/company-groups",
|
|
59
65
|
"summary": "List company groups available to the SDK consumer",
|
|
60
|
-
"description":
|
|
66
|
+
"description": "Returns compact company group metadata (id, name, demo flag, color, member company ids). Filter by `companyGroupIds` and/or `nameSearch` (case-insensitive substring on name) to look up a specific fund or visibility group in one round trip.",
|
|
61
67
|
"exampleCall": "client.companyGroups.getAll({ limit: 123 })",
|
|
62
68
|
"responseType": "CompanyGroupsGetAllResponse",
|
|
63
69
|
"pathParams": [],
|
|
@@ -79,6 +85,12 @@ const routeManifest = {
|
|
|
79
85
|
"required": false,
|
|
80
86
|
"type": "number[]",
|
|
81
87
|
"description": "Restrict results to these company group identifiers"
|
|
88
|
+
},
|
|
89
|
+
{
|
|
90
|
+
"name": "nameSearch",
|
|
91
|
+
"required": false,
|
|
92
|
+
"type": "string",
|
|
93
|
+
"description": "Case-insensitive substring match on company group display name. Useful for finding a fund or visibility group by name without first listing all groups."
|
|
82
94
|
}
|
|
83
95
|
]
|
|
84
96
|
},
|
|
@@ -284,7 +296,7 @@ const routeManifest = {
|
|
|
284
296
|
"method": "GET",
|
|
285
297
|
"path": "/metrics/types",
|
|
286
298
|
"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
|
|
299
|
+
"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
300
|
"exampleCall": "client.metrics.getTypes()",
|
|
289
301
|
"responseType": "MetricsGetTypesResponse",
|
|
290
302
|
"pathParams": [],
|
|
@@ -294,7 +306,7 @@ const routeManifest = {
|
|
|
294
306
|
"method": "POST",
|
|
295
307
|
"path": "/metrics",
|
|
296
308
|
"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.",
|
|
309
|
+
"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
310
|
"exampleCall": "client.metrics.search({})",
|
|
299
311
|
"responseType": "MetricsSearchResponse",
|
|
300
312
|
"pathParams": [],
|
|
@@ -306,7 +318,7 @@ const routeManifest = {
|
|
|
306
318
|
"method": "GET",
|
|
307
319
|
"path": "/company-reports",
|
|
308
320
|
"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).",
|
|
321
|
+
"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, company groups, company name substring (`companyNameSearch`), and reporting period (timeframe + date range).",
|
|
310
322
|
"exampleCall": "client.companyReports.list({ limit: 123 })",
|
|
311
323
|
"responseType": "CompanyReportsListResponse",
|
|
312
324
|
"pathParams": [],
|
|
@@ -335,6 +347,12 @@ const routeManifest = {
|
|
|
335
347
|
"type": "number[]",
|
|
336
348
|
"description": "Restrict to companies that belong to any of these company groups."
|
|
337
349
|
},
|
|
350
|
+
{
|
|
351
|
+
"name": "companyNameSearch",
|
|
352
|
+
"required": false,
|
|
353
|
+
"type": "string",
|
|
354
|
+
"description": "Case-insensitive substring match on the reporting company name. Intersects with `companyIds`/`companyGroupIds` to fetch reports by company name without a separate companies lookup."
|
|
355
|
+
},
|
|
338
356
|
{
|
|
339
357
|
"name": "timeframe",
|
|
340
358
|
"required": false,
|
package/openapi.json
CHANGED
|
@@ -52,6 +52,7 @@
|
|
|
52
52
|
},
|
|
53
53
|
"/api/v2/sdk/companies": {
|
|
54
54
|
"get": {
|
|
55
|
+
"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) to locate companies in one round trip — avoids listing the full portfolio when the agent only knows the company by name.",
|
|
55
56
|
"operationId": "companies.getAll",
|
|
56
57
|
"parameters": [
|
|
57
58
|
{
|
|
@@ -95,6 +96,15 @@
|
|
|
95
96
|
"type": "number"
|
|
96
97
|
}
|
|
97
98
|
}
|
|
99
|
+
},
|
|
100
|
+
{
|
|
101
|
+
"name": "nameSearch",
|
|
102
|
+
"required": false,
|
|
103
|
+
"in": "query",
|
|
104
|
+
"description": "Case-insensitive substring match on company display name. Combine with companyIds/companyGroupIds to find a company without first listing the entire portfolio.",
|
|
105
|
+
"schema": {
|
|
106
|
+
"type": "string"
|
|
107
|
+
}
|
|
98
108
|
}
|
|
99
109
|
],
|
|
100
110
|
"responses": {
|
|
@@ -134,6 +144,7 @@
|
|
|
134
144
|
},
|
|
135
145
|
"/api/v2/sdk/company-groups": {
|
|
136
146
|
"get": {
|
|
147
|
+
"description": "Returns compact company group metadata (id, name, demo flag, color, member company ids). Filter by `companyGroupIds` and/or `nameSearch` (case-insensitive substring on name) to look up a specific fund or visibility group in one round trip.",
|
|
137
148
|
"operationId": "companyGroups.getAll",
|
|
138
149
|
"parameters": [
|
|
139
150
|
{
|
|
@@ -165,6 +176,15 @@
|
|
|
165
176
|
"type": "number"
|
|
166
177
|
}
|
|
167
178
|
}
|
|
179
|
+
},
|
|
180
|
+
{
|
|
181
|
+
"name": "nameSearch",
|
|
182
|
+
"required": false,
|
|
183
|
+
"in": "query",
|
|
184
|
+
"description": "Case-insensitive substring match on company group display name. Useful for finding a fund or visibility group by name without first listing all groups.",
|
|
185
|
+
"schema": {
|
|
186
|
+
"type": "string"
|
|
187
|
+
}
|
|
168
188
|
}
|
|
169
189
|
],
|
|
170
190
|
"responses": {
|
|
@@ -679,7 +699,7 @@
|
|
|
679
699
|
},
|
|
680
700
|
"/api/v2/sdk/metrics/types": {
|
|
681
701
|
"get": {
|
|
682
|
-
"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
|
|
702
|
+
"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.",
|
|
683
703
|
"operationId": "metrics.getTypes",
|
|
684
704
|
"parameters": [],
|
|
685
705
|
"responses": {
|
|
@@ -719,7 +739,7 @@
|
|
|
719
739
|
},
|
|
720
740
|
"/api/v2/sdk/metrics": {
|
|
721
741
|
"post": {
|
|
722
|
-
"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.",
|
|
742
|
+
"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.",
|
|
723
743
|
"operationId": "metrics.search",
|
|
724
744
|
"parameters": [],
|
|
725
745
|
"requestBody": {
|
|
@@ -769,7 +789,7 @@
|
|
|
769
789
|
},
|
|
770
790
|
"/api/v2/sdk/company-reports": {
|
|
771
791
|
"get": {
|
|
772
|
-
"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).",
|
|
792
|
+
"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, company groups, company name substring (`companyNameSearch`), and reporting period (timeframe + date range).",
|
|
773
793
|
"operationId": "companyReports.list",
|
|
774
794
|
"parameters": [
|
|
775
795
|
{
|
|
@@ -814,6 +834,15 @@
|
|
|
814
834
|
}
|
|
815
835
|
}
|
|
816
836
|
},
|
|
837
|
+
{
|
|
838
|
+
"name": "companyNameSearch",
|
|
839
|
+
"required": false,
|
|
840
|
+
"in": "query",
|
|
841
|
+
"description": "Case-insensitive substring match on the reporting company name. Intersects with `companyIds`/`companyGroupIds` to fetch reports by company name without a separate companies lookup.",
|
|
842
|
+
"schema": {
|
|
843
|
+
"type": "string"
|
|
844
|
+
}
|
|
845
|
+
},
|
|
817
846
|
{
|
|
818
847
|
"name": "timeframe",
|
|
819
848
|
"required": false,
|
|
@@ -3618,7 +3647,7 @@
|
|
|
3618
3647
|
},
|
|
3619
3648
|
"currencyCode": {
|
|
3620
3649
|
"type": "string",
|
|
3621
|
-
"description": "
|
|
3650
|
+
"description": "ISO 4217 currency code, only populated when the unit is \"Currency\" *and* a per-company context is known. On /metrics this reflects the company's native currency (or the requested `currency` target when FX-converted). On /metrics/types it is always null — the type is shared across companies, so no single code applies; resolve it via /metrics.",
|
|
3622
3651
|
"nullable": true
|
|
3623
3652
|
}
|
|
3624
3653
|
},
|
|
@@ -3626,6 +3655,60 @@
|
|
|
3626
3655
|
"unit"
|
|
3627
3656
|
]
|
|
3628
3657
|
},
|
|
3658
|
+
"SdkMetricTypeOptionDto": {
|
|
3659
|
+
"type": "object",
|
|
3660
|
+
"properties": {
|
|
3661
|
+
"value": {
|
|
3662
|
+
"type": "string",
|
|
3663
|
+
"description": "Allowed option value as it appears in `points[].optionValue`. For boolean (yes/no) metrics the options are typically \"Yes\" and \"No\"."
|
|
3664
|
+
},
|
|
3665
|
+
"isPositive": {
|
|
3666
|
+
"type": "boolean",
|
|
3667
|
+
"description": "Whether this option counts as a positive outcome (e.g. \"Yes\" is usually positive)."
|
|
3668
|
+
}
|
|
3669
|
+
},
|
|
3670
|
+
"required": [
|
|
3671
|
+
"value",
|
|
3672
|
+
"isPositive"
|
|
3673
|
+
]
|
|
3674
|
+
},
|
|
3675
|
+
"SdkMetricTypeOptionConfigDto": {
|
|
3676
|
+
"type": "object",
|
|
3677
|
+
"properties": {
|
|
3678
|
+
"options": {
|
|
3679
|
+
"description": "Allowed values for option-valued metrics. Each point's `optionValue` must match one of these. Boolean metrics surface here as two options (commonly \"Yes\"/\"No\").",
|
|
3680
|
+
"type": "array",
|
|
3681
|
+
"items": {
|
|
3682
|
+
"$ref": "#/components/schemas/SdkMetricTypeOptionDto"
|
|
3683
|
+
}
|
|
3684
|
+
}
|
|
3685
|
+
},
|
|
3686
|
+
"required": [
|
|
3687
|
+
"options"
|
|
3688
|
+
]
|
|
3689
|
+
},
|
|
3690
|
+
"SdkMetricTypeRangeConfigDto": {
|
|
3691
|
+
"type": "object",
|
|
3692
|
+
"properties": {
|
|
3693
|
+
"min": {
|
|
3694
|
+
"type": "number",
|
|
3695
|
+
"description": "Inclusive lower bound for valid numeric values."
|
|
3696
|
+
},
|
|
3697
|
+
"max": {
|
|
3698
|
+
"type": "number",
|
|
3699
|
+
"description": "Inclusive upper bound for valid numeric values."
|
|
3700
|
+
},
|
|
3701
|
+
"step": {
|
|
3702
|
+
"type": "number",
|
|
3703
|
+
"description": "Step / increment between valid values."
|
|
3704
|
+
}
|
|
3705
|
+
},
|
|
3706
|
+
"required": [
|
|
3707
|
+
"min",
|
|
3708
|
+
"max",
|
|
3709
|
+
"step"
|
|
3710
|
+
]
|
|
3711
|
+
},
|
|
3629
3712
|
"SdkMetricTypeDto": {
|
|
3630
3713
|
"type": "object",
|
|
3631
3714
|
"properties": {
|
|
@@ -3657,7 +3740,7 @@
|
|
|
3657
3740
|
},
|
|
3658
3741
|
"valueType": {
|
|
3659
3742
|
"type": "object",
|
|
3660
|
-
"description": "
|
|
3743
|
+
"description": "Shape of each point's value: `\"numeric\"` — read `points[].value` as a number; `\"option\"` — read `points[].optionValue` as a string from `optionConfig.options[]` (this is how boolean / yes-no metrics are encoded — two options, typically \"Yes\"/\"No\"). Numeric metrics may additionally carry a `rangeConfig` constraining `value` to [min, max] with a `step`."
|
|
3661
3744
|
},
|
|
3662
3745
|
"unit": {
|
|
3663
3746
|
"description": "Unit of measurement.",
|
|
@@ -3668,6 +3751,26 @@
|
|
|
3668
3751
|
"$ref": "#/components/schemas/SdkMetricUnitDto"
|
|
3669
3752
|
}
|
|
3670
3753
|
]
|
|
3754
|
+
},
|
|
3755
|
+
"optionConfig": {
|
|
3756
|
+
"description": "Allowed values when `valueType === \"option\"`. Each point reports its choice in `optionValue`. Boolean (yes/no) metrics surface here as two options.",
|
|
3757
|
+
"nullable": true,
|
|
3758
|
+
"type": "object",
|
|
3759
|
+
"allOf": [
|
|
3760
|
+
{
|
|
3761
|
+
"$ref": "#/components/schemas/SdkMetricTypeOptionConfigDto"
|
|
3762
|
+
}
|
|
3763
|
+
]
|
|
3764
|
+
},
|
|
3765
|
+
"rangeConfig": {
|
|
3766
|
+
"description": "Bounds for ranged numeric metrics: each point's `value` is constrained to `[min, max]` with the given `step`. Absent when the metric is unbounded.",
|
|
3767
|
+
"nullable": true,
|
|
3768
|
+
"type": "object",
|
|
3769
|
+
"allOf": [
|
|
3770
|
+
{
|
|
3771
|
+
"$ref": "#/components/schemas/SdkMetricTypeRangeConfigDto"
|
|
3772
|
+
}
|
|
3773
|
+
]
|
|
3671
3774
|
}
|
|
3672
3775
|
},
|
|
3673
3776
|
"required": [
|
|
@@ -3712,6 +3815,10 @@
|
|
|
3712
3815
|
"type": "number"
|
|
3713
3816
|
}
|
|
3714
3817
|
},
|
|
3818
|
+
"companyNameSearch": {
|
|
3819
|
+
"type": "string",
|
|
3820
|
+
"description": "Resolve companies by case-insensitive substring match on their display name and intersect with `companyIds`/`companyGroupIds`. Use this to skip the separate companies lookup when the agent only knows the company by name."
|
|
3821
|
+
},
|
|
3715
3822
|
"companyGroupIds": {
|
|
3716
3823
|
"description": "Restrict to companies that belong to any of these company groups.",
|
|
3717
3824
|
"type": "array",
|
|
@@ -3726,6 +3833,13 @@
|
|
|
3726
3833
|
"type": "number"
|
|
3727
3834
|
}
|
|
3728
3835
|
},
|
|
3836
|
+
"metricTypeNames": {
|
|
3837
|
+
"description": "Resolve metric types by case-insensitive exact match on their display name and intersect with `metricTypeIds`. Lets the agent fetch by metric name (e.g. \"Revenue\") without first listing /metrics/types.",
|
|
3838
|
+
"type": "array",
|
|
3839
|
+
"items": {
|
|
3840
|
+
"type": "string"
|
|
3841
|
+
}
|
|
3842
|
+
},
|
|
3729
3843
|
"timeframe": {
|
|
3730
3844
|
"type": "string",
|
|
3731
3845
|
"description": "Restrict to a reporting period granularity.",
|
|
@@ -3742,6 +3856,18 @@
|
|
|
3742
3856
|
"to": {
|
|
3743
3857
|
"type": "string",
|
|
3744
3858
|
"description": "Upper bound for point date (ISO 8601, inclusive)."
|
|
3859
|
+
},
|
|
3860
|
+
"currency": {
|
|
3861
|
+
"type": "string",
|
|
3862
|
+
"description": "ISO 4217 currency code (e.g. USD, EUR). When set, monetary metrics are FX-converted to this currency and the metric type unit reports the target currency. Non-monetary metrics are unaffected."
|
|
3863
|
+
},
|
|
3864
|
+
"conversionStrategy": {
|
|
3865
|
+
"type": "string",
|
|
3866
|
+
"description": "FX rate selection when `currency` is set. `LATEST_FX_RATE` (default) uses the most recent rate; `ENTITY_DATE_RATE` uses the rate on each point's date. Ignored when `currency` is omitted.",
|
|
3867
|
+
"enum": [
|
|
3868
|
+
"LATEST_FX_RATE",
|
|
3869
|
+
"ENTITY_DATE_RATE"
|
|
3870
|
+
]
|
|
3745
3871
|
}
|
|
3746
3872
|
}
|
|
3747
3873
|
},
|
|
@@ -3758,7 +3884,12 @@
|
|
|
3758
3884
|
},
|
|
3759
3885
|
"value": {
|
|
3760
3886
|
"type": "number",
|
|
3761
|
-
"description": "
|
|
3887
|
+
"description": "Numeric value for the period. Populated when the parent metric type has `valueType === \"numeric\"` (including ranged numerics). Null for option-valued metrics — read `optionValue` instead — or when the numeric value could not be computed.",
|
|
3888
|
+
"nullable": true
|
|
3889
|
+
},
|
|
3890
|
+
"optionValue": {
|
|
3891
|
+
"type": "string",
|
|
3892
|
+
"description": "String value for option-valued metrics (`valueType === \"option\"`). Matches one of the entries in the metric type's `optionConfig.options[].value` — e.g. \"Yes\"/\"No\" for boolean metrics. Null for numeric metrics or when no choice has been reported for the period.",
|
|
3762
3893
|
"nullable": true
|
|
3763
3894
|
},
|
|
3764
3895
|
"valueError": {
|
|
@@ -3774,7 +3905,8 @@
|
|
|
3774
3905
|
"required": [
|
|
3775
3906
|
"date",
|
|
3776
3907
|
"timeframe",
|
|
3777
|
-
"value"
|
|
3908
|
+
"value",
|
|
3909
|
+
"optionValue"
|
|
3778
3910
|
]
|
|
3779
3911
|
},
|
|
3780
3912
|
"SdkCompanyMetricDto": {
|