@rundit-sdk/embed 0.3.3 → 0.3.4-rc.11

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/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. `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
+ "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). Dashboards come back in the order the `companyIds` were requested, so `limit`/`cursor` paging is stable.",
8
8
  "exampleCall": "client.companies.getDashboards({ companyIds: [123], currency: 'USD' })",
9
9
  "responseType": "CompaniesGetDashboardsResponse",
10
10
  "pathParams": [],
@@ -71,7 +71,7 @@ const routeManifest = {
71
71
  "method": "GET",
72
72
  "path": "/companies",
73
73
  "summary": "List companies available to the SDK consumer",
74
- "description": "Returns the compact form (id, name, currency, type, website, logo) for every company the caller can read. Filter by `companyIds`, `companyGroupIds`, and/or `nameSearch` (case-insensitive substring on display name; accepts an array to resolve multiple companies at once with OR semantics — e.g. `nameSearch=[\"acme\",\"beta\",\"gamma\"]` returns any company whose name contains any of the three substrings). Avoids listing the full portfolio when the agent only knows companies by name.",
74
+ "description": "Returns the compact form (id, name, currency, type, website, logo) for every company the caller can read. Filter by `companyIds`, `companyGroupIds`, and/or `nameSearch` (case-insensitive substring on display name; accepts an array to resolve multiple companies at once with OR semantics — e.g. `nameSearch=[\"acme\",\"beta\",\"gamma\"]` returns any company whose name contains any of the three substrings). Avoids listing the full portfolio when the agent only knows companies by name. Ordered by company id ascending.",
75
75
  "exampleCall": "client.companies.getAll({ limit: 123 })",
76
76
  "responseType": "CompaniesGetAllResponse",
77
77
  "pathParams": [],
@@ -80,13 +80,13 @@ const routeManifest = {
80
80
  "name": "limit",
81
81
  "required": false,
82
82
  "type": "number",
83
- "description": "Maximum items per page. Currently accepted but not enforced; reserved for future pagination."
83
+ "description": "Maximum items per page (1-500). Omit to receive the full result set in one response. Values outside that range are rejected with 422 rather than clamped, so a page is never quietly smaller than requested."
84
84
  },
85
85
  {
86
86
  "name": "cursor",
87
87
  "required": false,
88
88
  "type": "string",
89
- "description": "Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored."
89
+ "description": "Opaque cursor from a previous response's `meta.nextCursor`. Carries the page size it was issued with, so a follow-up call needs only the cursor. Valid solely for the endpoint, filters, and caller that produced it — change any of them and you get 422; start again without a cursor. Paging reflects the data as of each request, so rows added or removed mid-walk can shift positions."
90
90
  },
91
91
  {
92
92
  "name": "companyIds",
@@ -114,7 +114,7 @@ const routeManifest = {
114
114
  "method": "GET",
115
115
  "path": "/company-groups",
116
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\"]`).",
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\"]`). Ordered by fund id ascending.",
118
118
  "exampleCall": "client.companyGroups.getAll({ limit: 123 })",
119
119
  "responseType": "CompanyGroupsGetAllResponse",
120
120
  "pathParams": [],
@@ -123,13 +123,13 @@ const routeManifest = {
123
123
  "name": "limit",
124
124
  "required": false,
125
125
  "type": "number",
126
- "description": "Maximum items per page. Currently accepted but not enforced; reserved for future pagination."
126
+ "description": "Maximum items per page (1-500). Omit to receive the full result set in one response. Values outside that range are rejected with 422 rather than clamped, so a page is never quietly smaller than requested."
127
127
  },
128
128
  {
129
129
  "name": "cursor",
130
130
  "required": false,
131
131
  "type": "string",
132
- "description": "Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored."
132
+ "description": "Opaque cursor from a previous response's `meta.nextCursor`. Carries the page size it was issued with, so a follow-up call needs only the cursor. Valid solely for the endpoint, filters, and caller that produced it — change any of them and you get 422; start again without a cursor. Paging reflects the data as of each request, so rows added or removed mid-walk can shift positions."
133
133
  },
134
134
  {
135
135
  "name": "companyGroupIds",
@@ -167,7 +167,7 @@ const routeManifest = {
167
167
  "method": "GET",
168
168
  "path": "/positions/portfolio/summary",
169
169
  "summary": "Get portfolio summary with positions and key metrics per company",
170
- "description": "Returns one row per company with position data (invested, fair value, multiple, ROI) and latest values for selected metrics. Defaults to MRR, Cash Balance, Headcount, Net Burn Rate, and Runway. Override with `metricTypeNames`. Designed for portfolio overview tables.",
170
+ "description": "Returns one row per company *per fund* — a company held by two funds appears twice, distinguished by `companyGroupId` — 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. Ordered by company id, then fund id.",
171
171
  "exampleCall": "client.positions.getPortfolioSummary({ currency: 'USD' })",
172
172
  "responseType": "PositionsGetPortfolioSummaryResponse",
173
173
  "pathParams": [],
@@ -176,13 +176,13 @@ const routeManifest = {
176
176
  "name": "limit",
177
177
  "required": false,
178
178
  "type": "number",
179
- "description": "Maximum items per page. Currently accepted but not enforced; reserved for future pagination."
179
+ "description": "Maximum items per page (1-500). Omit to receive the full result set in one response. Values outside that range are rejected with 422 rather than clamped, so a page is never quietly smaller than requested."
180
180
  },
181
181
  {
182
182
  "name": "cursor",
183
183
  "required": false,
184
184
  "type": "string",
185
- "description": "Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored."
185
+ "description": "Opaque cursor from a previous response's `meta.nextCursor`. Carries the page size it was issued with, so a follow-up call needs only the cursor. Valid solely for the endpoint, filters, and caller that produced it — change any of them and you get 422; start again without a cursor. Paging reflects the data as of each request, so rows added or removed mid-walk can shift positions."
186
186
  },
187
187
  {
188
188
  "name": "companyGroupIds",
@@ -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": "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.",
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. Ordered by fund id ascending.",
224
224
  "exampleCall": "client.positions.getCompanyPositions(123, { currency: 'USD' })",
225
225
  "responseType": "PositionsGetCompanyPositionsResponse",
226
226
  "pathParams": [
@@ -235,13 +235,13 @@ const routeManifest = {
235
235
  "name": "limit",
236
236
  "required": false,
237
237
  "type": "number",
238
- "description": "Maximum items per page. Currently accepted but not enforced; reserved for future pagination."
238
+ "description": "Maximum items per page (1-500). Omit to receive the full result set in one response. Values outside that range are rejected with 422 rather than clamped, so a page is never quietly smaller than requested."
239
239
  },
240
240
  {
241
241
  "name": "cursor",
242
242
  "required": false,
243
243
  "type": "string",
244
- "description": "Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored."
244
+ "description": "Opaque cursor from a previous response's `meta.nextCursor`. Carries the page size it was issued with, so a follow-up call needs only the cursor. Valid solely for the endpoint, filters, and caller that produced it — change any of them and you get 422; start again without a cursor. Paging reflects the data as of each request, so rows added or removed mid-walk can shift positions."
245
245
  },
246
246
  {
247
247
  "name": "companyGroupIds",
@@ -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, fund (`companyGroupIds`), and date range.",
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. Ordered by period ascending.",
308
308
  "exampleCall": "client.transactions.getSummary({ currency: 'USD' })",
309
309
  "responseType": "TransactionsGetSummaryResponse",
310
310
  "pathParams": [],
@@ -313,13 +313,13 @@ const routeManifest = {
313
313
  "name": "limit",
314
314
  "required": false,
315
315
  "type": "number",
316
- "description": "Maximum items per page. Currently accepted but not enforced; reserved for future pagination."
316
+ "description": "Maximum items per page (1-500). Omit to receive the full result set in one response. Values outside that range are rejected with 422 rather than clamped, so a page is never quietly smaller than requested."
317
317
  },
318
318
  {
319
319
  "name": "cursor",
320
320
  "required": false,
321
321
  "type": "string",
322
- "description": "Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored."
322
+ "description": "Opaque cursor from a previous response's `meta.nextCursor`. Carries the page size it was issued with, so a follow-up call needs only the cursor. Valid solely for the endpoint, filters, and caller that produced it — change any of them and you get 422; start again without a cursor. Paging reflects the data as of each request, so rows added or removed mid-walk can shift positions."
323
323
  },
324
324
  {
325
325
  "name": "companyGroupIds",
@@ -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": "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.",
366
+ "description": "Returns all transactions for a single company, ordered by date descending then id 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": [
@@ -378,13 +378,13 @@ const routeManifest = {
378
378
  "name": "limit",
379
379
  "required": false,
380
380
  "type": "number",
381
- "description": "Maximum items per page. Currently accepted but not enforced; reserved for future pagination."
381
+ "description": "Maximum items per page (1-500). Omit to receive the full result set in one response. Values outside that range are rejected with 422 rather than clamped, so a page is never quietly smaller than requested."
382
382
  },
383
383
  {
384
384
  "name": "cursor",
385
385
  "required": false,
386
386
  "type": "string",
387
- "description": "Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored."
387
+ "description": "Opaque cursor from a previous response's `meta.nextCursor`. Carries the page size it was issued with, so a follow-up call needs only the cursor. Valid solely for the endpoint, filters, and caller that produced it — change any of them and you get 422; start again without a cursor. Paging reflects the data as of each request, so rows added or removed mid-walk can shift positions."
388
388
  },
389
389
  {
390
390
  "name": "companyGroupIds",
@@ -410,7 +410,7 @@ const routeManifest = {
410
410
  "method": "GET",
411
411
  "path": "/transactions",
412
412
  "summary": "Get transactions for multiple companies",
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.",
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. Ordered by date descending, then id descending.",
414
414
  "exampleCall": "client.transactions.getTransactions({ limit: 123 })",
415
415
  "responseType": "TransactionsGetTransactionsResponse",
416
416
  "pathParams": [],
@@ -419,13 +419,13 @@ const routeManifest = {
419
419
  "name": "limit",
420
420
  "required": false,
421
421
  "type": "number",
422
- "description": "Maximum items per page. Currently accepted but not enforced; reserved for future pagination."
422
+ "description": "Maximum items per page (1-500). Omit to receive the full result set in one response. Values outside that range are rejected with 422 rather than clamped, so a page is never quietly smaller than requested."
423
423
  },
424
424
  {
425
425
  "name": "cursor",
426
426
  "required": false,
427
427
  "type": "string",
428
- "description": "Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored."
428
+ "description": "Opaque cursor from a previous response's `meta.nextCursor`. Carries the page size it was issued with, so a follow-up call needs only the cursor. Valid solely for the endpoint, filters, and caller that produced it — change any of them and you get 422; start again without a cursor. Paging reflects the data as of each request, so rows added or removed mid-walk can shift positions."
429
429
  },
430
430
  {
431
431
  "name": "companyGroupIds",
@@ -459,17 +459,30 @@ const routeManifest = {
459
459
  "method": "GET",
460
460
  "path": "/metrics/types",
461
461
  "summary": "List metric types available to the SDK consumer",
462
- "description": "Returns predefined metric types plus user-defined metric types scoped to the caller — VC group custom types for VC users, company custom types for company users. Each entry carries the metric shape needed to interpret values: `valueType` is `\"numeric\"` (read `point.value` as a number; may carry `rangeConfig` with min/max/step for ranged metrics) or `\"option\"` (read `point.optionValue` as a string from `optionConfig.options[]` — this is how boolean / yes-no metrics are encoded, as two options typically labelled \"Yes\"/\"No\"). `unit.unit` describes the measurement (`Currency`, `Percentage`, `Number`, time units, ...); `unit.currencyCode` is intentionally null on this endpoint because monetary types resolve their concrete currency per company — call /metrics to receive `unit.currencyCode` populated with each company's native currency, or pass `currency` to convert all monetary metrics to a chosen target.",
463
- "exampleCall": "client.metrics.getTypes()",
462
+ "description": "Returns predefined metric types plus user-defined metric types scoped to the caller — VC group custom types for VC users, company custom types for company users. Each entry carries the metric shape needed to interpret values: `valueType` is `\"numeric\"` (read `point.value` as a number; may carry `rangeConfig` with min/max/step for ranged metrics) or `\"option\"` (read `point.optionValue` as a string from `optionConfig.options[]` — this is how boolean / yes-no metrics are encoded, as two options typically labelled \"Yes\"/\"No\"). `unit.unit` describes the measurement (`Currency`, `Percentage`, `Number`, time units, ...); `unit.currencyCode` is intentionally null on this endpoint because monetary types resolve their concrete currency per company — call /metrics to receive `unit.currencyCode` populated with each company's native currency, or pass `currency` to convert all monetary metrics to a chosen target. Ordered by metric type id ascending.",
463
+ "exampleCall": "client.metrics.getTypes({ limit: 123 })",
464
464
  "responseType": "MetricsGetTypesResponse",
465
465
  "pathParams": [],
466
- "queryParams": []
466
+ "queryParams": [
467
+ {
468
+ "name": "limit",
469
+ "required": false,
470
+ "type": "number",
471
+ "description": "Maximum items per page (1-500). Omit to receive the full result set in one response. Values outside that range are rejected with 422 rather than clamped, so a page is never quietly smaller than requested."
472
+ },
473
+ {
474
+ "name": "cursor",
475
+ "required": false,
476
+ "type": "string",
477
+ "description": "Opaque cursor from a previous response's `meta.nextCursor`. Carries the page size it was issued with, so a follow-up call needs only the cursor. Valid solely for the endpoint, filters, and caller that produced it — change any of them and you get 422; start again without a cursor. Paging reflects the data as of each request, so rows added or removed mid-walk can shift positions."
478
+ }
479
+ ]
467
480
  },
468
481
  "search": {
469
482
  "method": "POST",
470
483
  "path": "/metrics",
471
484
  "summary": "Read metric values for accessible companies, grouped by company",
472
- "description": "Returns metric data points for companies the caller can access (companies in the caller's VC group portfolio, or the caller's own company for company users). Each entry carries company and metric type references with id and human-readable name. Each point carries both `value` (number, for `valueType === \"numeric\"`, including ranged numerics constrained by the type's `rangeConfig`) and `optionValue` (string, for `valueType === \"option\"`, matching one of `metricType.optionConfig.options[].value` — this is how boolean/yes-no metrics report their reading); read whichever matches the metric type's `valueType`. Filter by company id, company name substring (`companyNameSearch`), company group, metric type id, metric type name (`metricTypeNames`), timeframe, and date range to narrow the response. Pass `currency` (ISO 4217) to FX-convert monetary metrics to that target currency in one call instead of fetching company currencies separately.",
485
+ "description": "Returns metric data points for companies the caller can access (companies in the caller's VC group portfolio, or the caller's own company for company users). Each entry carries company and metric type references with id and human-readable name. Each point carries both `value` (number, for `valueType === \"numeric\"`, including ranged numerics constrained by the type's `rangeConfig`) and `optionValue` (string, for `valueType === \"option\"`, matching one of `metricType.optionConfig.options[].value` — this is how boolean/yes-no metrics report their reading); read whichever matches the metric type's `valueType`. Filter by company id, company name substring (`companyNameSearch`), company group, metric type id, metric type name (`metricTypeNames`), timeframe, and date range to narrow the response. Pass `currency` (ISO 4217) to FX-convert monetary metrics to that target currency in one call instead of fetching company currencies separately. Entries are ordered by company id ascending — one entry per company, so `limit` pages whole companies, never partial metric lists.",
473
486
  "exampleCall": "client.metrics.search({})",
474
487
  "responseType": "MetricsSearchResponse",
475
488
  "pathParams": [],
@@ -489,7 +502,7 @@ const routeManifest = {
489
502
  "method": "POST",
490
503
  "path": "/metrics/aggregate",
491
504
  "summary": "Aggregate metrics across portfolio companies",
492
- "description": "Returns aggregated metric values (SUM, AVG, MEDIAN, MIN, MAX, COUNT) across companies for each reporting period. Pass `metricTypeIds` (resolve from /metrics/types) to select what to aggregate; names are not accepted on this endpoint to keep selection stable. Optionally group results by fund (`companyGroupId`) for fund-level breakdowns. MIN, MAX, and COUNT are always computed. SUM, AVG, and MEDIAN are only produced when the metric type enables them in its `summaryAggregationMethods` configuration; otherwise `point.value` is `null` for that aggregation.",
505
+ "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. Ordered by metric type id, then aggregation, then fund id.",
493
506
  "exampleCall": "client.metrics.aggregate({ metricTypeIds: [1,7], aggregation: \"SUM\" })",
494
507
  "responseType": "MetricsAggregateResponse",
495
508
  "pathParams": [],
@@ -501,7 +514,7 @@ const routeManifest = {
501
514
  "method": "GET",
502
515
  "path": "/company-reports",
503
516
  "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, funds (`companyGroupIds`), company name substring (`companyNameSearch`), and reporting period (timeframe + date range).",
517
+ "description": "Returns lightweight report metadata (id, title, period, publisher company reference). Use GET /company-reports/:id to fetch the full content of a specific report. Visibility is determined by the caller's roles — VC users see reports for managed-portfolio companies, company employees see their own company's reports, portfolio investors see Published reports shared with their visibility groups. Filters narrow the list by company ids, funds (`companyGroupIds`), company name substring (`companyNameSearch`), and reporting period (timeframe + date range). Ordered by report date descending, then id descending — newest first.",
505
518
  "exampleCall": "client.companyReports.list({ limit: 123 })",
506
519
  "responseType": "CompanyReportsListResponse",
507
520
  "pathParams": [],
@@ -510,13 +523,13 @@ const routeManifest = {
510
523
  "name": "limit",
511
524
  "required": false,
512
525
  "type": "number",
513
- "description": "Maximum items per page. Currently accepted but not enforced; reserved for future pagination."
526
+ "description": "Maximum items per page (1-500). Omit to receive the full result set in one response. Values outside that range are rejected with 422 rather than clamped, so a page is never quietly smaller than requested."
514
527
  },
515
528
  {
516
529
  "name": "cursor",
517
530
  "required": false,
518
531
  "type": "string",
519
- "description": "Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored."
532
+ "description": "Opaque cursor from a previous response's `meta.nextCursor`. Carries the page size it was issued with, so a follow-up call needs only the cursor. Valid solely for the endpoint, filters, and caller that produced it — change any of them and you get 422; start again without a cursor. Paging reflects the data as of each request, so rows added or removed mid-walk can shift positions."
520
533
  },
521
534
  {
522
535
  "name": "companyIds",
@@ -730,7 +743,7 @@ function createTransactionsNamespace(request) {
730
743
 
731
744
  function createMetricsNamespace(request) {
732
745
  return {
733
- getTypes: (init = {}) => request({ method: "GET", path: "/metrics/types", pathParams: undefined, query: undefined, body: undefined, signal: init.signal }),
746
+ getTypes: (query = {}, init = {}) => request({ method: "GET", path: "/metrics/types", pathParams: undefined, query: query, body: undefined, signal: init.signal }),
734
747
  search: (body, init = {}) => request({ method: "POST", path: "/metrics", pathParams: undefined, query: undefined, body: body, signal: init.signal }),
735
748
  compare: (body, init = {}) => request({ method: "POST", path: "/metrics/compare", pathParams: undefined, query: undefined, body: body, signal: init.signal }),
736
749
  aggregate: (body, init = {}) => request({ method: "POST", path: "/metrics/aggregate", pathParams: undefined, query: undefined, body: body, signal: init.signal }),