@deepraxis/sdk 0.1.1-dev.d73d5e4 → 0.1.1-dev.d8d3f52
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/METHODS.md +40 -1
- package/README.md +1 -1
- package/dist/generated/index.d.ts +2 -2
- package/dist/generated/index.js +1 -1
- package/dist/generated/sdk.gen.d.ts +90 -6
- package/dist/generated/sdk.gen.js +253 -5
- package/dist/generated/types.gen.d.ts +2178 -190
- package/dist/helpers/browser-actions.d.ts +2 -2
- package/dist/helpers/browser-actions.js +2 -2
- package/dist/helpers/browser-connect.js +2 -1
- package/dist/operations.generated.d.ts +493 -29
- package/dist/operations.generated.js +646 -29
- package/dist/resources.generated.d.ts +22 -0
- package/dist/resources.generated.js +22 -0
- package/package.json +1 -1
package/METHODS.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# SDK methods
|
|
2
2
|
|
|
3
|
-
Generated by `bun run generate`.
|
|
3
|
+
Generated by `bun run generate`. 633 HTTP operations, plus product aliases. Version segments and path parameters are omitted from resource names. Inputs use typed `{ path, query, body, headers }` options. Collections form nested resource objects; POST actions retain their verb. Naming rules are documented in `scripts/resources.ts`; semantic exceptions and aliases with reasons are in `scripts/naming-overrides.ts`.
|
|
4
4
|
|
|
5
5
|
`always` returns an AsyncIterable; `optional` streams with `{ stream: true }`; `yes` pagination returns a Page. Only `{ data, next_cursor }` + `cursor` query contracts are automatically paginated.
|
|
6
6
|
|
|
@@ -1068,12 +1068,25 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
1068
1068
|
|
|
1069
1069
|
## media
|
|
1070
1070
|
|
|
1071
|
+
### media.assets
|
|
1072
|
+
|
|
1073
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1074
|
+
|---|---|---|---|---|
|
|
1075
|
+
| edit | POST | `/media/v1/libraries/{library_id}/assets/{asset_id}/edits` | no | no |
|
|
1076
|
+
| lineage | GET | `/media/v1/libraries/{library_id}/assets/{asset_id}/lineage` | no | no |
|
|
1077
|
+
|
|
1071
1078
|
### media.generation.capabilities
|
|
1072
1079
|
|
|
1073
1080
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
1074
1081
|
|---|---|---|---|---|
|
|
1075
1082
|
| list | GET | `/media/v1/generation/capabilities` | no | no |
|
|
1076
1083
|
|
|
1084
|
+
### media.images
|
|
1085
|
+
|
|
1086
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1087
|
+
|---|---|---|---|---|
|
|
1088
|
+
| generate | POST | `/media/v1/libraries/{library_id}/images/generations` | no | no |
|
|
1089
|
+
|
|
1077
1090
|
### media.libraries
|
|
1078
1091
|
|
|
1079
1092
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -1083,6 +1096,8 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
1083
1096
|
| list | GET | `/media/v1/libraries` | no | yes |
|
|
1084
1097
|
| restore | POST | `/media/v1/libraries/{library_id}/restore` | no | no |
|
|
1085
1098
|
| retrieve | GET | `/media/v1/libraries/{library_id}` | no | no |
|
|
1099
|
+
| retrieveDefault | GET | `/media/v1/libraries/default` | no | no |
|
|
1100
|
+
| setDefault | PUT | `/media/v1/libraries/default` | no | no |
|
|
1086
1101
|
| update | PATCH | `/media/v1/libraries/{library_id}` | no | no |
|
|
1087
1102
|
|
|
1088
1103
|
### media.libraries.assets
|
|
@@ -1366,6 +1381,7 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
1366
1381
|
| create | POST | `/ontology/v1/nodes` | no | no |
|
|
1367
1382
|
| list | GET | `/ontology/v1/nodes` | no | yes |
|
|
1368
1383
|
| retrieve | GET | `/ontology/v1/nodes/{node_id}` | no | no |
|
|
1384
|
+
| retrieveNeighborhood | GET | `/ontology/v1/nodes/{node_id}/neighborhood` | no | no |
|
|
1369
1385
|
| update | PATCH | `/ontology/v1/nodes/{node_id}` | no | no |
|
|
1370
1386
|
|
|
1371
1387
|
### ontology.nodes.merge
|
|
@@ -1687,6 +1703,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
1687
1703
|
| retrieveReview | GET | `/studio/v1/works/{work}/drafts/{draft}/review` | no | no |
|
|
1688
1704
|
| update | PATCH | `/studio/v1/works/{work}/drafts/{draft}` | no | no |
|
|
1689
1705
|
|
|
1706
|
+
### studio.works.drafts.renditions
|
|
1707
|
+
|
|
1708
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1709
|
+
|---|---|---|---|---|
|
|
1710
|
+
| create | POST | `/studio/v1/works/{work}/drafts/{draft}/renditions` | no | no |
|
|
1711
|
+
|
|
1690
1712
|
### studio.works.drafts.status
|
|
1691
1713
|
|
|
1692
1714
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -1701,6 +1723,18 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
1701
1723
|
| batchUpdate | POST | `/studio/v1/works/{work}/drafts/{draft}/units:batchUpdate` | no | no |
|
|
1702
1724
|
| create | POST | `/studio/v1/works/{work}/drafts/{draft}/units` | no | no |
|
|
1703
1725
|
|
|
1726
|
+
### studio.works.renditions
|
|
1727
|
+
|
|
1728
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1729
|
+
|---|---|---|---|---|
|
|
1730
|
+
| delete | DELETE | `/studio/v1/works/{work}/renditions/{rendition}` | no | no |
|
|
1731
|
+
| list | GET | `/studio/v1/works/{work}/renditions` | no | no |
|
|
1732
|
+
| publish | POST | `/studio/v1/works/{work}/renditions/{rendition}:publish` | no | no |
|
|
1733
|
+
| render | POST | `/studio/v1/works/{work}/renditions/{rendition}:render` | no | no |
|
|
1734
|
+
| retrieve | GET | `/studio/v1/works/{work}/renditions/{rendition}` | no | no |
|
|
1735
|
+
| retrieveContent | GET | `/studio/v1/works/{work}/renditions/{rendition}/content` | no | no |
|
|
1736
|
+
| update | PATCH | `/studio/v1/works/{work}/renditions/{rendition}` | no | no |
|
|
1737
|
+
|
|
1704
1738
|
### studio.works.units
|
|
1705
1739
|
|
|
1706
1740
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -1955,6 +1989,11 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
1955
1989
|
| crm.properties.archive | CRM DELETE archives the resource rather than permanently deleting it; expose the archive product verb. |
|
|
1956
1990
|
| database.databases.rest.create | The final parameter identifies a table collection; POST inserts rows rather than updating the table. |
|
|
1957
1991
|
| file.uploads.createSigned | Signed upload creation returns a one-time local PUT URL; ADR-039 names this operation uploads.createSigned. |
|
|
1992
|
+
| media.libraries.retrieveDefault | ADR-094 §9 names the default-library read libraries.retrieveDefault; the URL names a reference rather than an id, so the path-derived name would otherwise read as retrieving a library called default. |
|
|
1993
|
+
| media.libraries.setDefault | ADR-094 §9 names the default-library write libraries.setDefault; the URL has no library id because the organization owns one default library, so the path alone cannot say which. |
|
|
1994
|
+
| media.assets.edit | ADR-094 §9 names the edit write assets.edit; an edit acts on the addressed asset and returns a Job, so the URL nesting under a library is a mount rather than an SDK resource level. |
|
|
1995
|
+
| media.assets.lineage | ADR-094 §9 names the edit-tree read assets.lineage; lineage is the product verb and the URL nesting under a library is a mount, not an SDK resource level. |
|
|
1996
|
+
| media.images.generate | ADR-094 §9 names image generation images.generate; the URL mounts it under a library, but generation is an operation on images and the path alone would derive a generations collection create. |
|
|
1958
1997
|
| meta.docs.search | Documentation keyword search is an operation on docs, not a nested collection. |
|
|
1959
1998
|
| sandbox.sandboxes.commands.run | Sandbox data operations use the E2B SDK verb while preserving URL resource nesting. |
|
|
1960
1999
|
| sandbox.sandboxes.files.remove | Sandbox data operations use the E2B SDK verb while preserving URL resource nesting. |
|
package/README.md
CHANGED
|
@@ -33,7 +33,7 @@ console.log(completion.choices[0]?.message.content);
|
|
|
33
33
|
## Why this SDK
|
|
34
34
|
|
|
35
35
|
- **The whole platform, one client.** About 350 operations across models, agents, sandboxes,
|
|
36
|
-
|
|
36
|
+
browsers, web search, databases, knowledge bases, files, media, automation and hosted
|
|
37
37
|
applications, generated from the same contract as the API.
|
|
38
38
|
- **Types from the contract.** Every path, query, body and response is typed, including the
|
|
39
39
|
events of each stream, so your editor knows what comes back.
|