@rundit-sdk/client 0.1.2 → 0.3.0-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/AGENTS.md +32 -15
- package/README.md +65 -17
- package/ai-manifest.json +219 -12
- package/dist/index.d.ts +575 -28
- package/dist/index.js +248 -24
- package/openapi.json +3337 -505
- package/package.json +6 -2
- package/skills/rundit-sdk-client/SKILL.md +4 -5
package/package.json
CHANGED
|
@@ -1,7 +1,11 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@rundit-sdk/client",
|
|
3
|
-
"version": "0.
|
|
4
|
-
"description": "
|
|
3
|
+
"version": "0.3.0-rc.11",
|
|
4
|
+
"description": "Rundit client SDK for third-party integrations authenticated with a Rundit API key.",
|
|
5
|
+
"repository": {
|
|
6
|
+
"type": "git",
|
|
7
|
+
"url": "https://github.com/Rundit/rundit-back.git"
|
|
8
|
+
},
|
|
5
9
|
"type": "module",
|
|
6
10
|
"sideEffects": false,
|
|
7
11
|
"main": "./dist/index.js",
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
|
-
description:
|
|
2
|
+
description: Rundit client SDK for third-party integrations authenticated with a Rundit API key. Preferred skill for third-party server-side and workflow integrations.
|
|
3
3
|
intent:
|
|
4
|
-
- Use when
|
|
4
|
+
- Use when integrating Rundit data into a third-party server, worker, or automation using an API key
|
|
5
5
|
- Use when an agent should prefer generated SDK methods over handwritten fetch calls
|
|
6
6
|
- Use when route discovery, typed path parameters, or typed query parameters are needed
|
|
7
7
|
- Use when a task needs data from @rundit-sdk/client
|
|
@@ -21,8 +21,8 @@ intent:
|
|
|
21
21
|
import { createClient } from '@rundit-sdk/client'
|
|
22
22
|
|
|
23
23
|
const client = createClient({
|
|
24
|
-
baseUrl: 'https://test.rundit.com/api/v1/sdk',
|
|
25
24
|
apiKey: '<API key>',
|
|
25
|
+
// baseUrl: 'https://test.rundit.com/api/v2/sdk',
|
|
26
26
|
})
|
|
27
27
|
|
|
28
28
|
await client.companies.getOne(123)
|
|
@@ -30,8 +30,7 @@ await client.companies.getOne(123)
|
|
|
30
30
|
|
|
31
31
|
## Guidance
|
|
32
32
|
|
|
33
|
-
- Namespaces: companies, companyGroups, positions, transactions
|
|
33
|
+
- Namespaces: companies, companyGroups, positions, transactions, metrics, companyReports
|
|
34
34
|
- Follow the generated DTO types for identifiers; company, company group, and transaction ids are numeric today, while aggregated position summaries do not expose a standalone `id`
|
|
35
35
|
- Positions endpoints require a `currency` query parameter
|
|
36
|
-
- This is a placeholder skill; prefer `@rundit-sdk/embed` for active integrations today
|
|
37
36
|
- Generated package artifacts live under `dist/`; agent skill metadata lives under `skills/`
|