@rundit-sdk/client 0.2.0 → 0.3.0-rc.11

package/AGENTS.md

@@ -2,12 +2,6 @@
 
 This package is generated for agentic and human consumers.
 
-## Status
-
-This is a placeholder package. This package is not in active use yet. It exists to validate the shared SDK generation pipeline and to reserve the future API-key client surface.
-
-Use it as a reference for future API-key client ergonomics, not as the primary SDK recommendation today.
-
 
 
 ## Initialization
@@ -16,8 +10,8 @@ Use it as a reference for future API-key client ergonomics, not as the primary S
 import { createClient, routeManifest } from '@rundit-sdk/client'
 
 const client = createClient({
-  baseUrl: 'https://test.rundit.com/api/v1/sdk',
   apiKey: '<API key>',
+  // baseUrl: 'https://test.rundit.com/api/v2/sdk',
 })
 
 console.log(routeManifest)
@@ -38,14 +32,16 @@ console.log(routeManifest)
   - Returns: `CompaniesGetOneResponse`
   - Params: path: id (number)
 - companies.getAll: List companies available to the SDK consumer
-  - Call: `client.companies.getAll()`
+  - Call: `client.companies.getAll({ limit: 123 })`
   - Returns: `CompaniesGetAllResponse`
+  - Params: query: limit? (number), cursor? (string), companyIds? (number[]), companyGroupIds? (number[])
 
 ## companyGroups
 
 - companyGroups.getAll: List company groups available to the SDK consumer
-  - Call: `client.companyGroups.getAll()`
+  - Call: `client.companyGroups.getAll({ limit: 123 })`
   - Returns: `CompanyGroupsGetAllResponse`
+  - Params: query: limit? (number), cursor? (string), companyGroupIds? (number[])
 - companyGroups.getOne: Get one company group available to the SDK consumer
   - Call: `client.companyGroups.getOne(123)`
   - Returns: `CompanyGroupsGetOneResponse`
@@ -56,19 +52,40 @@ console.log(routeManifest)
 - positions.getCompanyPositions: Get positions for one company
   - Call: `client.positions.getCompanyPositions(123, { currency: 'USD' })`
   - Returns: `PositionsGetCompanyPositionsResponse`
-  - Params: path: id (number); query: companyGroupId? (number), currency (string), date? (string)
+  - Params: path: id (number); query: limit? (number), cursor? (string), companyGroupIds? (number[]), currency (string), date? (string)
 - positions.getPortfolioPositions: Get portfolio positions
   - Call: `client.positions.getPortfolioPositions({ currency: 'USD' })`
   - Returns: `PositionsGetPortfolioPositionsResponse`
-  - Params: query: companyGroupIds? (number[]), currency (string), date? (string)
+  - Params: query: companyGroupIds? (number[]), companyIds? (number[]), currency (string), date? (string)
 
 ## transactions
 
 - transactions.getCompanyTransactions: Get transactions for one company
-  - Call: `client.transactions.getCompanyTransactions(123, { companyGroupIds: [123] })`
+  - Call: `client.transactions.getCompanyTransactions(123, { limit: 123 })`
   - Returns: `TransactionsGetCompanyTransactionsResponse`
-  - Params: path: id (number); query: companyGroupIds? (number[])
+  - Params: path: id (number); query: limit? (number), cursor? (string), companyGroupIds? (number[]), types? (("Auction" | "ConvertibleNote" | "ConvertToEquity" | "Dividend" | "EquityInvestment" | "EquityReceived" | "Extend" | "FutureEquityAgreement" | "Insolvency" | "IPO" | "LimitedAuction" | "OptionsReceived" | "OtherExit" | "OtherInvestment" | "OtherRealization" | "Payback" | "Proprietary" | "TradeSale" | "ValuationChange" | "WriteOff")[]), priorTo? (string)
 - transactions.getTransactions: Get transactions for multiple companies
-  - Call: `client.transactions.getTransactions({ companyGroupIds: [123] })`
+  - Call: `client.transactions.getTransactions({ limit: 123 })`
   - Returns: `TransactionsGetTransactionsResponse`
-  - Params: query: companyGroupIds? (number[]), companyIds? (number[])
+  - Params: query: limit? (number), cursor? (string), companyGroupIds? (number[]), types? (("Auction" | "ConvertibleNote" | "ConvertToEquity" | "Dividend" | "EquityInvestment" | "EquityReceived" | "Extend" | "FutureEquityAgreement" | "Insolvency" | "IPO" | "LimitedAuction" | "OptionsReceived" | "OtherExit" | "OtherInvestment" | "OtherRealization" | "Payback" | "Proprietary" | "TradeSale" | "ValuationChange" | "WriteOff")[]), priorTo? (string), companyIds? (number[])
+
+## metrics
+
+- metrics.getTypes: List metric types available to the SDK consumer
+  - Call: `client.metrics.getTypes()`
+  - Returns: `MetricsGetTypesResponse`
+- metrics.search: Read metric values for accessible companies, grouped by company
+  - Call: `client.metrics.search({})`
+  - Returns: `MetricsSearchResponse`
+  - Params: body: MetricsSearchBody
+
+## companyReports
+
+- companyReports.list: List published company reports accessible to the caller (metadata only)
+  - Call: `client.companyReports.list({ limit: 123 })`
+  - Returns: `CompanyReportsListResponse`
+  - Params: query: limit? (number), cursor? (string), companyIds? (number[]), companyGroupIds? (number[]), timeframe? ("Month" | "Quarter" | "Year"), from? (string), to? (string)
+- companyReports.getOne: Fetch the full content of a single company report
+  - Call: `client.companyReports.getOne(123)`
+  - Returns: `CompanyReportsGetOneResponse`
+  - Params: path: id (number)

package/README.md

@@ -1,10 +1,6 @@
 # @rundit-sdk/client
 
-Placeholder Rundit client SDK for future third-party and API-key based consumers.
-
-## Status
-
-> Placeholder package. This package is not in active use yet. It exists to validate the shared SDK generation pipeline and to reserve the future API-key client surface.
+Rundit client SDK for third-party integrations authenticated with a Rundit API key.
 
 
 
@@ -20,19 +16,29 @@ npm install @rundit-sdk/client
 import { createClient } from '@rundit-sdk/client'
 
 const client = createClient({
-  baseUrl: 'https://test.rundit.com/api/v1/sdk',
   apiKey: '<API key>',
+  // baseUrl: 'https://test.rundit.com/api/v2/sdk',
 })
 
 await client.companies.getOne(123)
 ```
 
+## Authentication
+
+- Authenticated with a tenant-scoped Rundit API key sent via the `X-API-Key` header
+- API keys are user-scoped: every request resolves to the owning user's roles and company access; the SDK cannot escape those bounds
+- Obtain an API key from your Rundit account settings (personal API keys); rotate or revoke from the same screen
+- Treat keys as secrets: never commit them, prefer environment variables, and use separate keys per integration
+
+
 ## AI Quickstart
 
-- Treat this package as a future-facing placeholder, not the primary SDK for current integrations
-- Prefer `@rundit-sdk/embed` for active embedded integrations today
-- You may still inspect `routeManifest`, `AGENTS.md`, and `ai-manifest.json` to understand the generalized client-generation shape
+- Designed for third-party server-side or workflow integrations using a Rundit API key
+- Use namespace methods such as `client.companies.getAll()` or `client.positions.getPortfolioPositions({ currency: 'USD' })`
+- Inspect `routeManifest` at runtime for a machine-readable map of method paths, parameters, and response types
+- Read `AGENTS.md` or `ai-manifest.json` in this package for AI-focused usage guidance
 - Agent skill metadata is published under `skills/rundit-sdk-client/SKILL.md`
+- Follow the generated DTO types for identifiers; current company, company group, and transaction ids are numeric, while aggregated position summaries do not expose a standalone `id`
 
 
 ## Methods
@@ -52,9 +58,10 @@ Get one company available to the SDK consumer
 
 List companies available to the SDK consumer
 
-- Call: `client.companies.getAll()`
+- Call: `client.companies.getAll({ limit: 123 })`
 - HTTP: `GET /companies`
 - Returns: `CompaniesGetAllResponse`
+- Params: query: limit? (number), cursor? (string), companyIds? (number[]), companyGroupIds? (number[])
 
 ## companyGroups
 
@@ -62,9 +69,10 @@ List companies available to the SDK consumer
 
 List company groups available to the SDK consumer
 
-- Call: `client.companyGroups.getAll()`
+- Call: `client.companyGroups.getAll({ limit: 123 })`
 - HTTP: `GET /company-groups`
 - Returns: `CompanyGroupsGetAllResponse`
+- Params: query: limit? (number), cursor? (string), companyGroupIds? (number[])
 
 ### `companyGroups.getOne`
 
@@ -84,7 +92,7 @@ Get positions for one company
 - Call: `client.positions.getCompanyPositions(123, { currency: 'USD' })`
 - HTTP: `GET /positions/companies/:id`
 - Returns: `PositionsGetCompanyPositionsResponse`
-- Params: path: id (number); query: companyGroupId? (number), currency (string), date? (string)
+- Params: path: id (number); query: limit? (number), cursor? (string), companyGroupIds? (number[]), currency (string), date? (string)
 
 ### `positions.getPortfolioPositions`
 
@@ -93,7 +101,7 @@ Get portfolio positions
 - Call: `client.positions.getPortfolioPositions({ currency: 'USD' })`
 - HTTP: `GET /positions/portfolio`
 - Returns: `PositionsGetPortfolioPositionsResponse`
-- Params: query: companyGroupIds? (number[]), currency (string), date? (string)
+- Params: query: companyGroupIds? (number[]), companyIds? (number[]), currency (string), date? (string)
 
 ## transactions
 
@@ -101,19 +109,58 @@ Get portfolio positions
 
 Get transactions for one company
 
-- Call: `client.transactions.getCompanyTransactions(123, { companyGroupIds: [123] })`
+- Call: `client.transactions.getCompanyTransactions(123, { limit: 123 })`
 - HTTP: `GET /transactions/companies/:id`
 - Returns: `TransactionsGetCompanyTransactionsResponse`
-- Params: path: id (number); query: companyGroupIds? (number[])
+- Params: path: id (number); query: limit? (number), cursor? (string), companyGroupIds? (number[]), types? (("Auction" | "ConvertibleNote" | "ConvertToEquity" | "Dividend" | "EquityInvestment" | "EquityReceived" | "Extend" | "FutureEquityAgreement" | "Insolvency" | "IPO" | "LimitedAuction" | "OptionsReceived" | "OtherExit" | "OtherInvestment" | "OtherRealization" | "Payback" | "Proprietary" | "TradeSale" | "ValuationChange" | "WriteOff")[]), priorTo? (string)
 
 ### `transactions.getTransactions`
 
 Get transactions for multiple companies
 
-- Call: `client.transactions.getTransactions({ companyGroupIds: [123] })`
+- Call: `client.transactions.getTransactions({ limit: 123 })`
 - HTTP: `GET /transactions`
 - Returns: `TransactionsGetTransactionsResponse`
-- Params: query: companyGroupIds? (number[]), companyIds? (number[])
+- Params: query: limit? (number), cursor? (string), companyGroupIds? (number[]), types? (("Auction" | "ConvertibleNote" | "ConvertToEquity" | "Dividend" | "EquityInvestment" | "EquityReceived" | "Extend" | "FutureEquityAgreement" | "Insolvency" | "IPO" | "LimitedAuction" | "OptionsReceived" | "OtherExit" | "OtherInvestment" | "OtherRealization" | "Payback" | "Proprietary" | "TradeSale" | "ValuationChange" | "WriteOff")[]), priorTo? (string), companyIds? (number[])
+
+## metrics
+
+### `metrics.getTypes`
+
+List metric types available to the SDK consumer
+
+- Call: `client.metrics.getTypes()`
+- HTTP: `GET /metrics/types`
+- Returns: `MetricsGetTypesResponse`
+
+### `metrics.search`
+
+Read metric values for accessible companies, grouped by company
+
+- Call: `client.metrics.search({})`
+- HTTP: `POST /metrics`
+- Returns: `MetricsSearchResponse`
+- Params: body: MetricsSearchBody
+
+## companyReports
+
+### `companyReports.list`
+
+List published company reports accessible to the caller (metadata only)
+
+- Call: `client.companyReports.list({ limit: 123 })`
+- HTTP: `GET /company-reports`
+- Returns: `CompanyReportsListResponse`
+- Params: query: limit? (number), cursor? (string), companyIds? (number[]), companyGroupIds? (number[]), timeframe? ("Month" | "Quarter" | "Year"), from? (string), to? (string)
+
+### `companyReports.getOne`
+
+Fetch the full content of a single company report
+
+- Call: `client.companyReports.getOne(123)`
+- HTTP: `GET /company-reports/:id`
+- Returns: `CompanyReportsGetOneResponse`
+- Params: path: id (number)
 
 ## TypeScript
 
@@ -125,4 +172,5 @@ Get transactions for multiple companies
 ## Notes
 
 - This package is generated from `sdk-packages/openapi/sdk.openapi.json`
+- Defaults to `https://api.rundit.com/api/v2/sdk`; pass `baseUrl` to target a different environment such as test
 - Do not edit files under `dist/` manually

package/ai-manifest.json

@@ -1,11 +1,11 @@
 {
   "packageName": "@rundit-sdk/client",
-  "description": "Placeholder Rundit client SDK for future third-party and API-key based consumers.",
-  "maturity": "placeholder",
-  "placeholderNotice": "This package is not in active use yet. It exists to validate the shared SDK generation pipeline and to reserve the future API-key client surface.",
+  "description": "Rundit client SDK for third-party integrations authenticated with a Rundit API key.",
+  "maturity": "active",
+  "placeholderNotice": null,
   "factoryName": "createClient",
   "initialization": {
-    "baseUrl": "https://test.rundit.com/api/v1/sdk",
+    "baseUrlDefault": "https://api.rundit.com/api/v2/sdk",
     "authOption": "apiKey",
     "authLabel": "API key"
   },
@@ -43,10 +43,35 @@
         "description": null,
         "method": "GET",
         "path": "/companies",
-        "exampleCall": "client.companies.getAll()",
+        "exampleCall": "client.companies.getAll({ limit: 123 })",
         "responseType": "CompaniesGetAllResponse",
         "pathParams": [],
-        "queryParams": []
+        "queryParams": [
+          {
+            "name": "limit",
+            "required": false,
+            "type": "number",
+            "description": "Maximum items per page. Currently accepted but not enforced; reserved for future pagination."
+          },
+          {
+            "name": "cursor",
+            "required": false,
+            "type": "string",
+            "description": "Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored."
+          },
+          {
+            "name": "companyIds",
+            "required": false,
+            "type": "number[]",
+            "description": "Restrict results to these company identifiers"
+          },
+          {
+            "name": "companyGroupIds",
+            "required": false,
+            "type": "number[]",
+            "description": "Restrict results to companies that belong to any of these company groups"
+          }
+        ]
       }
     ],
     "companyGroups": [
@@ -56,10 +81,29 @@
         "description": null,
         "method": "GET",
         "path": "/company-groups",
-        "exampleCall": "client.companyGroups.getAll()",
+        "exampleCall": "client.companyGroups.getAll({ limit: 123 })",
         "responseType": "CompanyGroupsGetAllResponse",
         "pathParams": [],
-        "queryParams": []
+        "queryParams": [
+          {
+            "name": "limit",
+            "required": false,
+            "type": "number",
+            "description": "Maximum items per page. Currently accepted but not enforced; reserved for future pagination."
+          },
+          {
+            "name": "cursor",
+            "required": false,
+            "type": "string",
+            "description": "Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored."
+          },
+          {
+            "name": "companyGroupIds",
+            "required": false,
+            "type": "number[]",
+            "description": "Restrict results to these company group identifiers"
+          }
+        ]
       },
       {
         "operation": "getOne",
@@ -97,10 +141,22 @@
         ],
         "queryParams": [
           {
-            "name": "companyGroupId",
+            "name": "limit",
             "required": false,
             "type": "number",
-            "description": "Optional company group identifier to filter by"
+            "description": "Maximum items per page. Currently accepted but not enforced; reserved for future pagination."
+          },
+          {
+            "name": "cursor",
+            "required": false,
+            "type": "string",
+            "description": "Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored."
+          },
+          {
+            "name": "companyGroupIds",
+            "required": false,
+            "type": "number[]",
+            "description": "Optional list of company group identifiers to filter the position breakdown"
           },
           {
             "name": "currency",
@@ -132,6 +188,12 @@
             "type": "number[]",
             "description": "Optional list of company group identifiers to filter the portfolio positions"
           },
+          {
+            "name": "companyIds",
+            "required": false,
+            "type": "number[]",
+            "description": "Optional list of company identifiers to narrow the aggregation to"
+          },
           {
             "name": "currency",
             "required": true,
@@ -154,7 +216,7 @@
         "description": null,
         "method": "GET",
         "path": "/transactions/companies/:id",
-        "exampleCall": "client.transactions.getCompanyTransactions(123, { companyGroupIds: [123] })",
+        "exampleCall": "client.transactions.getCompanyTransactions(123, { limit: 123 })",
         "responseType": "TransactionsGetCompanyTransactionsResponse",
         "pathParams": [
           {
@@ -164,11 +226,35 @@
           }
         ],
         "queryParams": [
+          {
+            "name": "limit",
+            "required": false,
+            "type": "number",
+            "description": "Maximum items per page. Currently accepted but not enforced; reserved for future pagination."
+          },
+          {
+            "name": "cursor",
+            "required": false,
+            "type": "string",
+            "description": "Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored."
+          },
           {
             "name": "companyGroupIds",
             "required": false,
             "type": "number[]",
             "description": "Optional company group identifiers to filter transactions by"
+          },
+          {
+            "name": "types",
+            "required": false,
+            "type": "(\"Auction\" | \"ConvertibleNote\" | \"ConvertToEquity\" | \"Dividend\" | \"EquityInvestment\" | \"EquityReceived\" | \"Extend\" | \"FutureEquityAgreement\" | \"Insolvency\" | \"IPO\" | \"LimitedAuction\" | \"OptionsReceived\" | \"OtherExit\" | \"OtherInvestment\" | \"OtherRealization\" | \"Payback\" | \"Proprietary\" | \"TradeSale\" | \"ValuationChange\" | \"WriteOff\")[]",
+            "description": "Restrict results to these transaction types"
+          },
+          {
+            "name": "priorTo",
+            "required": false,
+            "type": "string",
+            "description": "Exclude transactions on or after this ISO 8601 date (cut-off filter)"
           }
         ]
       },
@@ -178,16 +264,40 @@
         "description": null,
         "method": "GET",
         "path": "/transactions",
-        "exampleCall": "client.transactions.getTransactions({ companyGroupIds: [123] })",
+        "exampleCall": "client.transactions.getTransactions({ limit: 123 })",
         "responseType": "TransactionsGetTransactionsResponse",
         "pathParams": [],
         "queryParams": [
+          {
+            "name": "limit",
+            "required": false,
+            "type": "number",
+            "description": "Maximum items per page. Currently accepted but not enforced; reserved for future pagination."
+          },
+          {
+            "name": "cursor",
+            "required": false,
+            "type": "string",
+            "description": "Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored."
+          },
           {
             "name": "companyGroupIds",
             "required": false,
             "type": "number[]",
             "description": "Optional company group identifiers to filter transactions by"
           },
+          {
+            "name": "types",
+            "required": false,
+            "type": "(\"Auction\" | \"ConvertibleNote\" | \"ConvertToEquity\" | \"Dividend\" | \"EquityInvestment\" | \"EquityReceived\" | \"Extend\" | \"FutureEquityAgreement\" | \"Insolvency\" | \"IPO\" | \"LimitedAuction\" | \"OptionsReceived\" | \"OtherExit\" | \"OtherInvestment\" | \"OtherRealization\" | \"Payback\" | \"Proprietary\" | \"TradeSale\" | \"ValuationChange\" | \"WriteOff\")[]",
+            "description": "Restrict results to these transaction types"
+          },
+          {
+            "name": "priorTo",
+            "required": false,
+            "type": "string",
+            "description": "Exclude transactions on or after this ISO 8601 date (cut-off filter)"
+          },
           {
             "name": "companyIds",
             "required": false,
@@ -196,6 +306,103 @@
           }
         ]
       }
+    ],
+    "metrics": [
+      {
+        "operation": "getTypes",
+        "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 includes a numeric id and a human-readable name suitable for display or LLM context.",
+        "method": "GET",
+        "path": "/metrics/types",
+        "exampleCall": "client.metrics.getTypes()",
+        "responseType": "MetricsGetTypesResponse",
+        "pathParams": [],
+        "queryParams": []
+      },
+      {
+        "operation": "search",
+        "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.",
+        "method": "POST",
+        "path": "/metrics",
+        "exampleCall": "client.metrics.search({})",
+        "responseType": "MetricsSearchResponse",
+        "pathParams": [],
+        "queryParams": []
+      }
+    ],
+    "companyReports": [
+      {
+        "operation": "list",
+        "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).",
+        "method": "GET",
+        "path": "/company-reports",
+        "exampleCall": "client.companyReports.list({ limit: 123 })",
+        "responseType": "CompanyReportsListResponse",
+        "pathParams": [],
+        "queryParams": [
+          {
+            "name": "limit",
+            "required": false,
+            "type": "number",
+            "description": "Maximum items per page. Currently accepted but not enforced; reserved for future pagination."
+          },
+          {
+            "name": "cursor",
+            "required": false,
+            "type": "string",
+            "description": "Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored."
+          },
+          {
+            "name": "companyIds",
+            "required": false,
+            "type": "number[]",
+            "description": "Restrict results to these companies. Defaults to all companies the caller can access."
+          },
+          {
+            "name": "companyGroupIds",
+            "required": false,
+            "type": "number[]",
+            "description": "Restrict to companies that belong to any of these company groups."
+          },
+          {
+            "name": "timeframe",
+            "required": false,
+            "type": "\"Month\" | \"Quarter\" | \"Year\"",
+            "description": "Restrict to a reporting period granularity (Month, Quarter, Year)."
+          },
+          {
+            "name": "from",
+            "required": false,
+            "type": "string",
+            "description": "Lower bound for the reporting period date (ISO 8601, inclusive)."
+          },
+          {
+            "name": "to",
+            "required": false,
+            "type": "string",
+            "description": "Upper bound for the reporting period date (ISO 8601, inclusive)."
+          }
+        ]
+      },
+      {
+        "operation": "getOne",
+        "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.",
+        "method": "GET",
+        "path": "/company-reports/:id",
+        "exampleCall": "client.companyReports.getOne(123)",
+        "responseType": "CompanyReportsGetOneResponse",
+        "pathParams": [
+          {
+            "name": "id",
+            "type": "number",
+            "description": "Report identifier"
+          }
+        ],
+        "queryParams": []
+      }
     ]
   }
 }