@rundit-sdk/embed 0.3.3 → 0.3.4

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/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. `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).",
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). Dashboards come back in the order the `companyIds` were requested, so `limit`/`cursor` paging is stable.",
7
7
  "operationId": "companies.getDashboards",
8
8
  "parameters": [],
9
9
  "requestBody": {
@@ -191,15 +191,17 @@
191
191
  },
192
192
  "/api/v2/sdk/companies": {
193
193
  "get": {
194
- "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.",
194
+ "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.",
195
195
  "operationId": "companies.getAll",
196
196
  "parameters": [
197
197
  {
198
198
  "name": "limit",
199
199
  "required": false,
200
200
  "in": "query",
201
- "description": "Maximum items per page. Currently accepted but not enforced; reserved for future pagination.",
201
+ "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.",
202
202
  "schema": {
203
+ "minimum": 1,
204
+ "maximum": 500,
203
205
  "type": "number"
204
206
  }
205
207
  },
@@ -207,7 +209,7 @@
207
209
  "name": "cursor",
208
210
  "required": false,
209
211
  "in": "query",
210
- "description": "Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored.",
212
+ "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.",
211
213
  "schema": {
212
214
  "type": "string"
213
215
  }
@@ -286,15 +288,17 @@
286
288
  },
287
289
  "/api/v2/sdk/company-groups": {
288
290
  "get": {
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\"]`).",
291
+ "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.",
290
292
  "operationId": "companyGroups.getAll",
291
293
  "parameters": [
292
294
  {
293
295
  "name": "limit",
294
296
  "required": false,
295
297
  "in": "query",
296
- "description": "Maximum items per page. Currently accepted but not enforced; reserved for future pagination.",
298
+ "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.",
297
299
  "schema": {
300
+ "minimum": 1,
301
+ "maximum": 500,
298
302
  "type": "number"
299
303
  }
300
304
  },
@@ -302,7 +306,7 @@
302
306
  "name": "cursor",
303
307
  "required": false,
304
308
  "in": "query",
305
- "description": "Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored.",
309
+ "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.",
306
310
  "schema": {
307
311
  "type": "string"
308
312
  }
@@ -419,15 +423,17 @@
419
423
  },
420
424
  "/api/v2/sdk/positions/portfolio/summary": {
421
425
  "get": {
422
- "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.",
426
+ "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.",
423
427
  "operationId": "positions.getPortfolioSummary",
424
428
  "parameters": [
425
429
  {
426
430
  "name": "limit",
427
431
  "required": false,
428
432
  "in": "query",
429
- "description": "Maximum items per page. Currently accepted but not enforced; reserved for future pagination.",
433
+ "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.",
430
434
  "schema": {
435
+ "minimum": 1,
436
+ "maximum": 500,
431
437
  "type": "number"
432
438
  }
433
439
  },
@@ -435,7 +441,7 @@
435
441
  "name": "cursor",
436
442
  "required": false,
437
443
  "in": "query",
438
- "description": "Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored.",
444
+ "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.",
439
445
  "schema": {
440
446
  "type": "string"
441
447
  }
@@ -532,7 +538,7 @@
532
538
  },
533
539
  "/api/v2/sdk/positions/companies/{id}": {
534
540
  "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.",
541
+ "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.",
536
542
  "operationId": "positions.getCompanyPositions",
537
543
  "parameters": [
538
544
  {
@@ -548,8 +554,10 @@
548
554
  "name": "limit",
549
555
  "required": false,
550
556
  "in": "query",
551
- "description": "Maximum items per page. Currently accepted but not enforced; reserved for future pagination.",
557
+ "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.",
552
558
  "schema": {
559
+ "minimum": 1,
560
+ "maximum": 500,
553
561
  "type": "number"
554
562
  }
555
563
  },
@@ -557,7 +565,7 @@
557
565
  "name": "cursor",
558
566
  "required": false,
559
567
  "in": "query",
560
- "description": "Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored.",
568
+ "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.",
561
569
  "schema": {
562
570
  "type": "string"
563
571
  }
@@ -713,15 +721,17 @@
713
721
  },
714
722
  "/api/v2/sdk/transactions/summary": {
715
723
  "get": {
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.",
724
+ "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.",
717
725
  "operationId": "transactions.getSummary",
718
726
  "parameters": [
719
727
  {
720
728
  "name": "limit",
721
729
  "required": false,
722
730
  "in": "query",
723
- "description": "Maximum items per page. Currently accepted but not enforced; reserved for future pagination.",
731
+ "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.",
724
732
  "schema": {
733
+ "minimum": 1,
734
+ "maximum": 500,
725
735
  "type": "number"
726
736
  }
727
737
  },
@@ -729,7 +739,7 @@
729
739
  "name": "cursor",
730
740
  "required": false,
731
741
  "in": "query",
732
- "description": "Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored.",
742
+ "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.",
733
743
  "schema": {
734
744
  "type": "string"
735
745
  }
@@ -837,7 +847,7 @@
837
847
  },
838
848
  "/api/v2/sdk/transactions/companies/{id}": {
839
849
  "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.",
850
+ "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.",
841
851
  "operationId": "transactions.getCompanyTransactions",
842
852
  "parameters": [
843
853
  {
@@ -853,8 +863,10 @@
853
863
  "name": "limit",
854
864
  "required": false,
855
865
  "in": "query",
856
- "description": "Maximum items per page. Currently accepted but not enforced; reserved for future pagination.",
866
+ "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.",
857
867
  "schema": {
868
+ "minimum": 1,
869
+ "maximum": 500,
858
870
  "type": "number"
859
871
  }
860
872
  },
@@ -862,7 +874,7 @@
862
874
  "name": "cursor",
863
875
  "required": false,
864
876
  "in": "query",
865
- "description": "Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored.",
877
+ "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.",
866
878
  "schema": {
867
879
  "type": "string"
868
880
  }
@@ -960,15 +972,17 @@
960
972
  },
961
973
  "/api/v2/sdk/transactions": {
962
974
  "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.",
975
+ "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.",
964
976
  "operationId": "transactions.getTransactions",
965
977
  "parameters": [
966
978
  {
967
979
  "name": "limit",
968
980
  "required": false,
969
981
  "in": "query",
970
- "description": "Maximum items per page. Currently accepted but not enforced; reserved for future pagination.",
982
+ "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.",
971
983
  "schema": {
984
+ "minimum": 1,
985
+ "maximum": 500,
972
986
  "type": "number"
973
987
  }
974
988
  },
@@ -976,7 +990,7 @@
976
990
  "name": "cursor",
977
991
  "required": false,
978
992
  "in": "query",
979
- "description": "Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored.",
993
+ "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.",
980
994
  "schema": {
981
995
  "type": "string"
982
996
  }
@@ -1086,9 +1100,30 @@
1086
1100
  },
1087
1101
  "/api/v2/sdk/metrics/types": {
1088
1102
  "get": {
1089
- "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.",
1103
+ "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.",
1090
1104
  "operationId": "metrics.getTypes",
1091
- "parameters": [],
1105
+ "parameters": [
1106
+ {
1107
+ "name": "limit",
1108
+ "required": false,
1109
+ "in": "query",
1110
+ "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.",
1111
+ "schema": {
1112
+ "minimum": 1,
1113
+ "maximum": 500,
1114
+ "type": "number"
1115
+ }
1116
+ },
1117
+ {
1118
+ "name": "cursor",
1119
+ "required": false,
1120
+ "in": "query",
1121
+ "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.",
1122
+ "schema": {
1123
+ "type": "string"
1124
+ }
1125
+ }
1126
+ ],
1092
1127
  "responses": {
1093
1128
  "200": {
1094
1129
  "description": "",
@@ -1126,7 +1161,7 @@
1126
1161
  },
1127
1162
  "/api/v2/sdk/metrics": {
1128
1163
  "post": {
1129
- "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.",
1164
+ "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.",
1130
1165
  "operationId": "metrics.search",
1131
1166
  "parameters": [],
1132
1167
  "requestBody": {
@@ -1226,7 +1261,7 @@
1226
1261
  },
1227
1262
  "/api/v2/sdk/metrics/aggregate": {
1228
1263
  "post": {
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.",
1264
+ "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.",
1230
1265
  "operationId": "metrics.aggregate",
1231
1266
  "parameters": [],
1232
1267
  "requestBody": {
@@ -1276,15 +1311,17 @@
1276
1311
  },
1277
1312
  "/api/v2/sdk/company-reports": {
1278
1313
  "get": {
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).",
1314
+ "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.",
1280
1315
  "operationId": "companyReports.list",
1281
1316
  "parameters": [
1282
1317
  {
1283
1318
  "name": "limit",
1284
1319
  "required": false,
1285
1320
  "in": "query",
1286
- "description": "Maximum items per page. Currently accepted but not enforced; reserved for future pagination.",
1321
+ "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.",
1287
1322
  "schema": {
1323
+ "minimum": 1,
1324
+ "maximum": 500,
1288
1325
  "type": "number"
1289
1326
  }
1290
1327
  },
@@ -1292,7 +1329,7 @@
1292
1329
  "name": "cursor",
1293
1330
  "required": false,
1294
1331
  "in": "query",
1295
- "description": "Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored.",
1332
+ "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.",
1296
1333
  "schema": {
1297
1334
  "type": "string"
1298
1335
  }
@@ -1479,6 +1516,16 @@
1479
1516
  "GetBatchDashboardBodyDto": {
1480
1517
  "type": "object",
1481
1518
  "properties": {
1519
+ "limit": {
1520
+ "type": "number",
1521
+ "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.",
1522
+ "minimum": 1,
1523
+ "maximum": 500
1524
+ },
1525
+ "cursor": {
1526
+ "type": "string",
1527
+ "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."
1528
+ },
1482
1529
  "companyIds": {
1483
1530
  "description": "Company identifiers to include in the batch.",
1484
1531
  "type": "array",
@@ -2508,7 +2555,7 @@
2508
2555
  "properties": {
2509
2556
  "nextCursor": {
2510
2557
  "type": "string",
2511
- "description": "Cursor for the next page; null when no more pages are available",
2558
+ "description": "Cursor for the next page; null when no more pages are available. Every list is returned in a stable, documented order, so walking the cursors over an unchanged result set visits each row exactly once. Rows inserted or removed between page fetches shift the ones after them, which can duplicate or skip a row at the boundary — re-run the walk if you need a consistent snapshot.",
2512
2559
  "nullable": true
2513
2560
  }
2514
2561
  },
@@ -4879,11 +4926,13 @@
4879
4926
  "properties": {
4880
4927
  "limit": {
4881
4928
  "type": "number",
4882
- "description": "Maximum items per page. Currently accepted but not enforced; reserved for future pagination."
4929
+ "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.",
4930
+ "minimum": 1,
4931
+ "maximum": 500
4883
4932
  },
4884
4933
  "cursor": {
4885
4934
  "type": "string",
4886
- "description": "Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored."
4935
+ "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."
4887
4936
  },
4888
4937
  "companyIds": {
4889
4938
  "description": "Restrict results to these companies. Defaults to all companies the caller can access.",
@@ -5001,14 +5050,6 @@
5001
5050
  "MetricCompareDto": {
5002
5051
  "type": "object",
5003
5052
  "properties": {
5004
- "limit": {
5005
- "type": "number",
5006
- "description": "Maximum items per page. Currently accepted but not enforced; reserved for future pagination."
5007
- },
5008
- "cursor": {
5009
- "type": "string",
5010
- "description": "Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored."
5011
- },
5012
5053
  "metricTypeIds": {
5013
5054
  "description": "Metric type identifiers to compare (resolve names to ids via /metrics/types). When multiple ids are provided, the response contains one entry per metric type.",
5014
5055
  "example": [
@@ -5211,11 +5252,13 @@
5211
5252
  "properties": {
5212
5253
  "limit": {
5213
5254
  "type": "number",
5214
- "description": "Maximum items per page. Currently accepted but not enforced; reserved for future pagination."
5255
+ "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.",
5256
+ "minimum": 1,
5257
+ "maximum": 500
5215
5258
  },
5216
5259
  "cursor": {
5217
5260
  "type": "string",
5218
- "description": "Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored."
5261
+ "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."
5219
5262
  },
5220
5263
  "metricTypeIds": {
5221
5264
  "description": "Metric type identifiers to aggregate. Resolve names to ids via /metrics/types.",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rundit-sdk/embed",
3
- "version": "0.3.3",
3
+ "version": "0.3.4",
4
4
  "description": "Public Rundit embed SDK for iframe and embedded module consumers.",
5
5
  "repository": {
6
6
  "type": "git",