@deepraxis/sdk 0.1.1-dev.ea4a5dd → 0.1.1-dev.eaacee7

package/METHODS.md

@@ -1,6 +1,6 @@
 # SDK methods
 
-Generated by `bun run generate`. 458 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`.
+Generated by `bun run generate`. 567 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`.
 
 `always` returns an AsyncIterable; `optional` streams with `{ stream: true }`; `yes` pagination returns a Page. Only `{ data, next_cursor }` + `cursor` query contracts are automatically paginated.
 
@@ -103,6 +103,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
 | list | GET | `/agent/v1/computers/{computer_id}/files` | no | no |
 | retrieveContent | GET | `/agent/v1/computers/{computer_id}/files/content` | no | no |
 
+### agent.computers.files.convert
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| create | POST | `/agent/v1/computers/{computer_id}/files/convert` | no | no |
+
 ### agent.computers.leases
 
 | Method | HTTP | Path | Streaming | Pagination |
@@ -449,6 +455,14 @@ Multipart request bodies expand plain objects into bracketed fields (for example
 | list | GET | `/automation/v1/scripts/{ns}/{name}/dist-tags` | no | no |
 | set | PUT | `/automation/v1/scripts/{ns}/{name}/dist-tags/{tag}` | no | no |
 
+### automation.scripts.vaults
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| delete | DELETE | `/automation/v1/scripts/{ns}/{name}/vaults/{alias}` | no | no |
+| list | GET | `/automation/v1/scripts/{ns}/{name}/vaults` | no | no |
+| set | PUT | `/automation/v1/scripts/{ns}/{name}/vaults/{alias}` | no | no |
+
 ### automation.scripts.versions
 
 | Method | HTTP | Path | Streaming | Pagination |
@@ -510,6 +524,14 @@ Multipart request bodies expand plain objects into bracketed fields (for example
 | list | GET | `/automation/v1/workflows/{ns}/{name}/dist-tags` | no | no |
 | set | PUT | `/automation/v1/workflows/{ns}/{name}/dist-tags/{tag}` | no | no |
 
+### automation.workflows.vaults
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| delete | DELETE | `/automation/v1/workflows/{ns}/{name}/vaults/{alias}` | no | no |
+| list | GET | `/automation/v1/workflows/{ns}/{name}/vaults` | no | no |
+| set | PUT | `/automation/v1/workflows/{ns}/{name}/vaults/{alias}` | no | no |
+
 ### automation.workflows.versions
 
 | Method | HTTP | Path | Streaming | Pagination |
@@ -589,7 +611,9 @@ Multipart request bodies expand plain objects into bracketed fields (for example
 | delete | DELETE | `/canvas/v1/canvases/{canvas_id}` | no | no |
 | execute | POST | `/canvas/v1/canvases/{canvas_id}:execute` | no | no |
 | list | GET | `/canvas/v1/canvases` | no | yes |
+| restore | POST | `/canvas/v1/canvases/{canvas_id}:restore` | no | no |
 | retrieve | GET | `/canvas/v1/canvases/{canvas_id}` | no | no |
+| update | PATCH | `/canvas/v1/canvases/{canvas_id}` | no | no |
 
 ### canvas.canvases.images
 
@@ -603,6 +627,115 @@ Multipart request bodies expand plain objects into bracketed fields (for example
 |---|---|---|---|---|
 | list | GET | `/canvas/v1/canvases/{canvas_id}/nodes` | no | no |
 
+### canvas.canvases.versions
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| list | GET | `/canvas/v1/canvases/{canvas_id}/versions` | no | no |
+
+### canvas.collections
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| create | POST | `/canvas/v1/collections` | no | no |
+| delete | DELETE | `/canvas/v1/collections/{collection_id}` | no | no |
+| list | GET | `/canvas/v1/collections` | no | no |
+| retrieve | GET | `/canvas/v1/collections/{collection_id}` | no | no |
+| update | PATCH | `/canvas/v1/collections/{collection_id}` | no | no |
+
+## crm
+
+### crm.associations
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| create | PUT | `/crm/v1/objects/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}` | no | no |
+| createDefault | PUT | `/crm/v1/objects/{objectType}/{objectId}/associations/default/{toObjectType}/{toObjectId}` | no | no |
+| list | GET | `/crm/v1/objects/{objectType}/{objectId}/associations/{toObjectType}` | no | no |
+| remove | DELETE | `/crm/v1/objects/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}` | no | no |
+
+### crm.changes
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| revert | POST | `/crm/v1/changes/{changeSetId}:revert` | no | no |
+
+### crm.layouts
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| retrieve | GET | `/crm/v1/layouts/{objectType}` | no | no |
+| update | PUT | `/crm/v1/layouts/{objectType}` | no | no |
+
+### crm.leads
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| qualify | POST | `/crm/v1/leads/{leadId}:qualify` | no | no |
+
+### crm.objects
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| archive | DELETE | `/crm/v1/objects/{objectType}/{objectId}` | no | no |
+| create | POST | `/crm/v1/objects/{objectType}` | no | no |
+| list | GET | `/crm/v1/objects/{objectType}` | no | no |
+| retrieve | GET | `/crm/v1/objects/{objectType}/{objectId}` | no | no |
+| search | POST | `/crm/v1/objects/{objectType}/search` | no | no |
+| update | PATCH | `/crm/v1/objects/{objectType}/{objectId}` | no | no |
+
+### crm.objects.batch
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| archive | POST | `/crm/v1/objects/{objectType}/batch/archive` | no | no |
+| create | POST | `/crm/v1/objects/{objectType}/batch/create` | no | no |
+| read | POST | `/crm/v1/objects/{objectType}/batch/read` | no | no |
+| update | POST | `/crm/v1/objects/{objectType}/batch/update` | no | no |
+| upsert | POST | `/crm/v1/objects/{objectType}/batch/upsert` | no | no |
+
+### crm.pipelines
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| archive | DELETE | `/crm/v1/pipelines/{objectType}/{pipelineId}` | no | no |
+| create | POST | `/crm/v1/pipelines/{objectType}` | no | no |
+| list | GET | `/crm/v1/pipelines/{objectType}` | no | no |
+| retrieve | GET | `/crm/v1/pipelines/{objectType}/{pipelineId}` | no | no |
+| update | PATCH | `/crm/v1/pipelines/{objectType}/{pipelineId}` | no | no |
+
+### crm.pipelines.stages
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| archive | DELETE | `/crm/v1/pipelines/{objectType}/{pipelineId}/stages/{stageId}` | no | no |
+| create | POST | `/crm/v1/pipelines/{objectType}/{pipelineId}/stages` | no | no |
+| update | PATCH | `/crm/v1/pipelines/{objectType}/{pipelineId}/stages/{stageId}` | no | no |
+
+### crm.properties
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| archive | DELETE | `/crm/v1/properties/{objectType}/{propertyName}` | no | no |
+| create | POST | `/crm/v1/properties/{objectType}` | no | no |
+| list | GET | `/crm/v1/properties/{objectType}` | no | no |
+| retrieve | GET | `/crm/v1/properties/{objectType}/{propertyName}` | no | no |
+| update | PATCH | `/crm/v1/properties/{objectType}/{propertyName}` | no | no |
+
+### crm.properties.groups
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| create | POST | `/crm/v1/properties/{objectType}/groups` | no | no |
+| list | GET | `/crm/v1/properties/{objectType}/groups` | no | no |
+
+### crm.schemas
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| create | POST | `/crm/v1/schemas` | no | no |
+| list | GET | `/crm/v1/schemas` | no | no |
+
 ## cut
 
 ### cut.exports
@@ -659,6 +792,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
 |---|---|---|---|---|
 | import | POST | `/cut/v1/projects/{project_id}/media:import` | no | no |
 
+### cut.projects.renders
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| create | POST | `/cut/v1/projects/{project_id}/renders` | no | no |
+
 ### cut.projects.versions
 
 | Method | HTTP | Path | Streaming | Pagination |
@@ -666,6 +805,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
 | create | POST | `/cut/v1/projects/{project_id}/versions` | no | no |
 | list | GET | `/cut/v1/projects/{project_id}/versions` | no | no |
 
+### cut.renders
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| retrieve | GET | `/cut/v1/renders/{render_id}` | no | no |
+
 ### cut.versions
 
 | Method | HTTP | Path | Streaming | Pagination |
@@ -725,6 +870,82 @@ Multipart request bodies expand plain objects into bracketed fields (for example
 | delete | DELETE | `/database/v1/databases/{database_id}/tables/{table}/fields/{field}` | no | no |
 | update | PATCH | `/database/v1/databases/{database_id}/tables/{table}/fields/{field}` | no | no |
 
+## devops
+
+### devops.projects
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| retrieveTestCatalog | GET | `/devops/v1/projects/{project}/test-catalog` | no | no |
+
+### devops.projects.testCases
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| list | GET | `/devops/v1/projects/{project}/test-cases` | no | no |
+
+### devops.projects.testPlans
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| create | POST | `/devops/v1/projects/{project}/test-plans` | no | no |
+| list | GET | `/devops/v1/projects/{project}/test-plans` | no | no |
+
+### devops.projects.testReports
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| create | POST | `/devops/v1/projects/{project}/test-reports` | no | no |
+
+### devops.projects.testRuns
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| create | POST | `/devops/v1/projects/{project}/test-runs` | no | no |
+| list | GET | `/devops/v1/projects/{project}/test-runs` | no | no |
+
+### devops.projects.testSuites
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| list | GET | `/devops/v1/projects/{project}/test-suites` | no | no |
+
+### devops.testCases
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| retrieve | GET | `/devops/v1/test-cases/{id}` | no | no |
+
+### devops.testPlans
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| delete | DELETE | `/devops/v1/test-plans/{id}` | no | no |
+| pause | POST | `/devops/v1/test-plans/{id}:pause` | no | no |
+| resume | POST | `/devops/v1/test-plans/{id}:resume` | no | no |
+| retrieve | GET | `/devops/v1/test-plans/{id}` | no | no |
+| update | PATCH | `/devops/v1/test-plans/{id}` | no | no |
+
+### devops.testRuns
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| cancel | POST | `/devops/v1/test-runs/{id}:cancel` | no | no |
+| retrieve | GET | `/devops/v1/test-runs/{id}` | no | no |
+
+### devops.testRuns.executions
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| list | GET | `/devops/v1/test-runs/{run}/executions` | no | no |
+| retrieve | GET | `/devops/v1/test-runs/{run}/executions/{case}` | no | no |
+
+### devops.testSuites
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| retrieve | GET | `/devops/v1/test-suites/{id}` | no | no |
+
 ## file
 
 ### file.files
@@ -737,6 +958,18 @@ Multipart request bodies expand plain objects into bracketed fields (for example
 | retrieve | GET | `/file/v1/files/{file_id}` | no | no |
 | retrieveContent | GET | `/file/v1/files/{file_id}/content` | no | no |
 
+### file.files.contentLinks
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| revoke | POST | `/file/v1/files/{file_id}/content_links:revoke` | no | no |
+
+### file.files.contentUrl
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| create | POST | `/file/v1/files/{file_id}/content_url` | no | no |
+
 ### file.uploads
 
 | Method | HTTP | Path | Streaming | Pagination |
@@ -744,6 +977,8 @@ Multipart request bodies expand plain objects into bracketed fields (for example
 | cancel | POST | `/file/v1/uploads/{upload_id}/cancel` | no | no |
 | complete | POST | `/file/v1/uploads/{upload_id}/complete` | no | no |
 | create | POST | `/file/v1/uploads` | no | no |
+| createSigned | POST | `/file/v1/uploads/signed` | no | no |
+| retrieve | GET | `/file/v1/uploads/{upload_id}` | no | no |
 
 ### file.uploads.parts
 
@@ -827,6 +1062,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
 
 ## media
 
+### media.generation.capabilities
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| list | GET | `/media/v1/generation/capabilities` | no | no |
+
 ### media.libraries
 
 | Method | HTTP | Path | Streaming | Pagination |
@@ -849,6 +1090,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
 | retrieve | GET | `/media/v1/libraries/{library_id}/assets/{asset_id}` | no | no |
 | update | PATCH | `/media/v1/libraries/{library_id}/assets/{asset_id}` | no | no |
 
+### media.libraries.assets.frames
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| create | POST | `/media/v1/libraries/{library_id}/assets/{asset_id}/frames` | no | no |
+
 ### media.libraries.assets.import
 
 | Method | HTTP | Path | Streaming | Pagination |
@@ -874,6 +1121,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
 | create | POST | `/media/v1/libraries/{library_id}/batches` | no | no |
 | retrieve | GET | `/media/v1/libraries/{library_id}/batches/{job_id}` | no | no |
 
+### media.libraries.deliveryTokens
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| create | POST | `/media/v1/libraries/{library_id}/delivery_tokens` | no | no |
+
 ### media.libraries.events
 
 | Method | HTTP | Path | Streaming | Pagination |
@@ -886,12 +1139,26 @@ Multipart request bodies expand plain objects into bracketed fields (for example
 |---|---|---|---|---|
 | list | GET | `/media/v1/libraries/{library_id}/folders` | no | no |
 
+### media.libraries.generations
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| create | POST | `/media/v1/libraries/{library_id}/generations` | no | no |
+
 ### media.libraries.jobs
 
 | Method | HTTP | Path | Streaming | Pagination |
 |---|---|---|---|---|
+| cancel | POST | `/media/v1/libraries/{library_id}/jobs/{job_id}/cancel` | no | no |
+| list | GET | `/media/v1/libraries/{library_id}/jobs` | no | yes |
 | retrieve | GET | `/media/v1/libraries/{library_id}/jobs/{job_id}` | no | no |
 
+### media.libraries.jobs.outputs.save
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| create | POST | `/media/v1/libraries/{library_id}/jobs/{job_id}/outputs/{index}/save` | no | no |
+
 ### media.libraries.purge
 
 | Method | HTTP | Path | Streaming | Pagination |
@@ -922,6 +1189,13 @@ Multipart request bodies expand plain objects into bracketed fields (for example
 |---|---|---|---|---|
 | create | POST | `/media/v1/libraries/{library_id}/search/visual` | no | no |
 
+### media.libraries.understandings
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| list | GET | `/media/v1/libraries/{library_id}/understandings` | no | yes |
+| retrieveFailureSummary | GET | `/media/v1/libraries/{library_id}/understandings/failure_summary` | no | no |
+
 ## meta
 
 ### meta.docs
@@ -1071,6 +1345,57 @@ Multipart request bodies expand plain objects into bracketed fields (for example
 | retrieve | GET | `/model/v1/videos/{video_id}` | no | no |
 | retrieveContent | GET | `/model/v1/videos/{video_id}/content` | no | no |
 
+## ontology
+
+### ontology.changesets
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| create | POST | `/ontology/v1/changesets` | no | no |
+
+### ontology.nodes
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| create | POST | `/ontology/v1/nodes` | no | no |
+| list | GET | `/ontology/v1/nodes` | no | yes |
+| retrieve | GET | `/ontology/v1/nodes/{node_id}` | no | no |
+| update | PATCH | `/ontology/v1/nodes/{node_id}` | no | no |
+
+### ontology.nodes.merge
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| create | POST | `/ontology/v1/nodes/{node_id}/merge` | no | no |
+
+### ontology.relations
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| create | POST | `/ontology/v1/relations` | no | no |
+| list | GET | `/ontology/v1/relations` | no | yes |
+| retrieve | GET | `/ontology/v1/relations/{relation_id}` | no | no |
+
+### ontology.relations.invalidate
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| create | POST | `/ontology/v1/relations/{relation_id}/invalidate` | no | no |
+
+### ontology.search
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| create | POST | `/ontology/v1/search` | no | no |
+
+### ontology.types
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| create | POST | `/ontology/v1/types` | no | no |
+| list | GET | `/ontology/v1/types` | no | no |
+| retrieve | GET | `/ontology/v1/types/{name}` | no | no |
+
 ## organization
 
 ### organization.charges
@@ -1113,6 +1438,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
 | create | POST | `/organization/v1/feedback/{id}/messages` | no | no |
 | list | GET | `/organization/v1/feedback/{id}/messages` | no | no |
 
+### organization.members
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| list | GET | `/organization/v1/members` | no | no |
+
 ### organization.usage
 
 | Method | HTTP | Path | Streaming | Pagination |
@@ -1195,7 +1526,36 @@ Multipart request bodies expand plain objects into bracketed fields (for example
 
 | Method | HTTP | Path | Streaming | Pagination |
 |---|---|---|---|---|
+| create | POST | `/sandbox/v1/templates` | no | no |
+| delete | DELETE | `/sandbox/v1/templates/{templateID}` | no | no |
 | list | GET | `/sandbox/v1/templates` | no | no |
+| retrieve | GET | `/sandbox/v1/templates/{templateID}` | no | no |
+
+### sandbox.templates.aliases
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| retrieve | GET | `/sandbox/v1/templates/aliases/{alias}` | no | no |
+
+### sandbox.templates.builds
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| update | POST | `/sandbox/v1/templates/{templateID}/builds/{buildID}` | no | no |
+
+### sandbox.templates.builds.status
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| list | GET | `/sandbox/v1/templates/{templateID}/builds/{buildID}/status` | no | no |
+
+### sandbox.templates.tags
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| create | POST | `/sandbox/v1/templates/tags` | no | no |
+| delete | DELETE | `/sandbox/v1/templates/tags` | no | no |
+| list | GET | `/sandbox/v1/templates/{templateID}/tags` | no | no |
 
 ### sandbox.volumes
 
@@ -1445,10 +1805,32 @@ Multipart request bodies expand plain objects into bracketed fields (for example
 | agent.sessions.events.send | Events submit session input; the product verb is send rather than create. |
 | automation.hooks.send | Delivers a payload to a trigger's secret webhook URL; it sends an event rather than updating a hook resource. |
 | automation.scripts.distTags.set | A dist-tag assigns a version to a name; use npm vocabulary set rather than update. |
+| automation.scripts.vaults.set | Assign a whole vault to a definition alias, independently of published versions. |
 | automation.scripts.versions.create / publish | Creating a script version publishes it; publish is a product alias of versions.create. |
 | automation.workflows.distTags.set | Workflow dist-tags use the same npm-style assignment vocabulary as script dist-tags. |
+| automation.workflows.vaults.set | Assign a whole vault to a definition alias, independently of published versions. |
 | automation.workflows.versions.create / publish | Creating a workflow version publishes it; publish is a product alias of versions.create. |
+| crm.objects.list | CRM objectType selects a collection, not an entity; preserve list/create separately from retrieve/update on an identified resource. |
+| crm.objects.create | CRM objectType selects a collection, not an entity; preserve list/create separately from retrieve/update on an identified resource. |
+| crm.objects.batch.create | The terminal batch segment is the requested operation, not another collection; retain its read/create/update/upsert/archive verb. |
+| crm.objects.batch.read | The terminal batch segment is the requested operation, not another collection; retain its read/create/update/upsert/archive verb. |
+| crm.objects.batch.update | The terminal batch segment is the requested operation, not another collection; retain its read/create/update/upsert/archive verb. |
+| crm.objects.batch.upsert | The terminal batch segment is the requested operation, not another collection; retain its read/create/update/upsert/archive verb. |
+| crm.objects.search | The terminal search segment queries records without creating a nested search resource. |
+| crm.objects.archive | CRM DELETE archives the resource rather than permanently deleting it; expose the archive product verb. |
+| crm.associations.createDefault | CRM relationships live below objects in the URL but form the associations SDK resource; distinguish labelled and default creation from record updates. |
+| crm.associations.list | CRM relationships live below objects in the URL but form the associations SDK resource; distinguish labelled and default creation from record updates. |
+| crm.associations.remove | CRM relationships live below objects in the URL but form the associations SDK resource; distinguish labelled and default creation from record updates. |
+| crm.associations.create | CRM relationships live below objects in the URL but form the associations SDK resource; distinguish labelled and default creation from record updates. |
+| crm.pipelines.list | CRM objectType selects a collection, not an entity; preserve list/create separately from retrieve/update on an identified resource. |
+| crm.pipelines.create | CRM objectType selects a collection, not an entity; preserve list/create separately from retrieve/update on an identified resource. |
+| crm.pipelines.archive | CRM DELETE archives the resource rather than permanently deleting it; expose the archive product verb. |
+| crm.pipelines.stages.archive | CRM DELETE archives the resource rather than permanently deleting it; expose the archive product verb. |
+| crm.properties.list | CRM objectType selects a collection, not an entity; preserve list/create separately from retrieve/update on an identified resource. |
+| crm.properties.create | CRM objectType selects a collection, not an entity; preserve list/create separately from retrieve/update on an identified resource. |
+| crm.properties.archive | CRM DELETE archives the resource rather than permanently deleting it; expose the archive product verb. |
 | database.databases.rest.create | The final parameter identifies a table collection; POST inserts rows rather than updating the table. |
+| file.uploads.createSigned | Signed upload creation returns a one-time local PUT URL; ADR-039 names this operation uploads.createSigned. |
 | meta.docs.search | Documentation keyword search is an operation on docs, not a nested collection. |
 | sandbox.sandboxes.commands.run | Sandbox data operations use the E2B SDK verb while preserving URL resource nesting. |
 | sandbox.sandboxes.files.remove | Sandbox data operations use the E2B SDK verb while preserving URL resource nesting. |

package/README.md

@@ -4,7 +4,7 @@
 
 **Models, agents, sandboxes, search, data and automation, typed end to end.**
 
-The official TypeScript SDK for [知行云 Praxis](https://deepraxis.com), the cloud where AI agents are built, run and hosted.
+The official TypeScript SDK for [Praxis](https://deepraxis.com), the cloud where AI agents are built, run and hosted.
 
 [![npm](https://img.shields.io/npm/v/@deepraxis/sdk?label=npm&color=2e8555)](https://www.npmjs.com/package/@deepraxis/sdk)
 [![Bundle size](https://img.shields.io/bundlephobia/minzip/@deepraxis/sdk?color=2e8555)](https://bundlephobia.com/package/@deepraxis/sdk)
@@ -276,5 +276,5 @@ sandboxes, search, data, automation and the rest of the platform.
 
 [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). Copyright 2026 南京深度实践人工智能科技有限公司 (Deepractice).
 
-"Praxis", "知行云" and "Deepraxis" are trademarks of Deepractice; the license does not grant
+"Praxis" and "Deepraxis" are trademarks of Deepractice; the license does not grant
 rights to use them.

package/dist/automation.d.ts

@@ -96,6 +96,33 @@ export declare function createAutomationClient(options: PraxisOptions): {
         restore: (options: import("./core/transport.js").CallOptions<import("./generated/types.gen.js").AutomationScriptsRestoreData>) => Promise<import("./generated/types.gen.js").AutomationDefinition>;
         retrieve: (options: import("./core/transport.js").CallOptions<import("./generated/types.gen.js").AutomationScriptsGetData>) => Promise<import("./generated/types.gen.js").AutomationDefinitionDetail>;
         update: (options: import("./core/transport.js").CallOptions<import("./generated/types.gen.js").AutomationScriptsPatchData>) => Promise<import("./generated/types.gen.js").AutomationDefinitionDetail>;
+        vaults: {
+            delete: (options: import("./core/transport.js").CallOptions<import("./generated/types.gen.js").AutomationScriptsVaultsDeleteData>) => Promise<void>;
+            list: (options: import("./core/transport.js").CallOptions<import("./generated/types.gen.js").AutomationScriptsVaultsListData>) => Promise<{
+                data: Array<{
+                    alias: string;
+                    vault: {
+                        id: string;
+                        name: string;
+                    };
+                    secrets: Array<{
+                        name: string;
+                    }>;
+                    secrets_unavailable?: true;
+                }>;
+            }>;
+            set: (options: import("./core/transport.js").CallOptions<import("./generated/types.gen.js").AutomationScriptsVaultsSetData>) => Promise<{
+                alias: string;
+                vault: {
+                    id: string;
+                    name: string;
+                };
+                secrets: Array<{
+                    name: string;
+                }>;
+                secrets_unavailable?: true;
+            }>;
+        };
         versions: {
             create: (options: import("./core/transport.js").CallOptions<import("./generated/types.gen.js").AutomationScriptsPublishData>) => Promise<import("./generated/types.gen.js").AutomationVersion>;
             deprecate: (options: import("./core/transport.js").CallOptions<import("./generated/types.gen.js").AutomationScriptsDeprecateData>) => Promise<import("./generated/types.gen.js").AutomationVersion>;
@@ -143,6 +170,33 @@ export declare function createAutomationClient(options: PraxisOptions): {
         restore: (options: import("./core/transport.js").CallOptions<import("./generated/types.gen.js").AutomationWorkflowsRestoreData>) => Promise<import("./generated/types.gen.js").AutomationDefinition>;
         retrieve: (options: import("./core/transport.js").CallOptions<import("./generated/types.gen.js").AutomationWorkflowsGetData>) => Promise<import("./generated/types.gen.js").AutomationDefinitionDetail>;
         update: (options: import("./core/transport.js").CallOptions<import("./generated/types.gen.js").AutomationWorkflowsPatchData>) => Promise<import("./generated/types.gen.js").AutomationDefinitionDetail>;
+        vaults: {
+            delete: (options: import("./core/transport.js").CallOptions<import("./generated/types.gen.js").AutomationWorkflowsVaultsDeleteData>) => Promise<void>;
+            list: (options: import("./core/transport.js").CallOptions<import("./generated/types.gen.js").AutomationWorkflowsVaultsListData>) => Promise<{
+                data: Array<{
+                    alias: string;
+                    vault: {
+                        id: string;
+                        name: string;
+                    };
+                    secrets: Array<{
+                        name: string;
+                    }>;
+                    secrets_unavailable?: true;
+                }>;
+            }>;
+            set: (options: import("./core/transport.js").CallOptions<import("./generated/types.gen.js").AutomationWorkflowsVaultsSetData>) => Promise<{
+                alias: string;
+                vault: {
+                    id: string;
+                    name: string;
+                };
+                secrets: Array<{
+                    name: string;
+                }>;
+                secrets_unavailable?: true;
+            }>;
+        };
         versions: {
             create: (options: import("./core/transport.js").CallOptions<import("./generated/types.gen.js").AutomationWorkflowsPublishData>) => Promise<import("./generated/types.gen.js").AutomationVersion>;
             deprecate: (options: import("./core/transport.js").CallOptions<import("./generated/types.gen.js").AutomationWorkflowsDeprecateData>) => Promise<import("./generated/types.gen.js").AutomationVersion>;

package/dist/core/client.d.ts

@@ -1,3 +1,4 @@
+import { type SandboxTemplateBuildInput, type SandboxTemplateBuildResult } from "../helpers/sandbox-templates.js";
 import { type UploadFileOptions, type UploadedFile } from '../helpers/file-upload.js';
 import { resourceFactories } from '../resources.generated.js';
 import { type PraxisOptions } from './transport.js';
@@ -7,7 +8,12 @@ import { type CountInput, type CountResult } from '../helpers/database-count.js'
 type Resources = {
     readonly [K in keyof typeof resourceFactories]: ReturnType<(typeof resourceFactories)[K]>;
 };
-export interface Praxis extends Omit<Resources, 'application' | 'browser' | 'database' | 'file'> {
+export interface Praxis extends Omit<Resources, 'application' | 'browser' | 'database' | 'file' | 'sandbox'> {
+    readonly sandbox: Omit<Resources['sandbox'], 'templates'> & {
+        templates: Resources['sandbox']['templates'] & {
+            build(input: SandboxTemplateBuildInput): Promise<SandboxTemplateBuildResult>;
+        };
+    };
     readonly browser: Resources['browser'] & {
         connect(options?: BrowserConnectOptions): Promise<PraxisBrowser>;
     };

package/dist/core/client.js

@@ -1,3 +1,4 @@
+import { buildSandboxTemplate } from "../helpers/sandbox-templates.js";
 import { uploadFile } from "../helpers/file-upload.js";
 import { resourceFactories } from "../resources.generated.js";
 import { Transport } from "./transport.js";
@@ -10,6 +11,8 @@ export class Praxis {
         for (const [name, create] of Object.entries(resourceFactories)) {
             const resource = create(transport);
             // Assemble before sealing the resource property; never replace a readonly SDK resource.
+            if (name === 'sandbox')
+                Object.assign(resource.templates, { build: (input) => buildSandboxTemplate(this, input) });
             if (name === 'file')
                 Object.assign(resource, { uploadFile: (file, options) => uploadFile(this, file, options) });
             if (name === 'database')

package/dist/core/errors.d.ts

@@ -9,6 +9,9 @@ export interface ProblemDetails {
     requestId?: string;
     message?: string;
     param?: string | null;
+    /** ticket-681 — the documentation page the failure points at, and the exact section to read. */
+    docUrl?: string;
+    describe?: string;
     raw?: unknown;
 }
 /** Pure normalization shared by HTTP clients and the automation call ledger.
@@ -26,6 +29,9 @@ export declare class PraxisError extends Error {
     readonly errors: unknown[];
     readonly requestId?: string;
     readonly param?: string | null;
+    /** ticket-681 — the documented page and the exact section an agent should read to fix the call. */
+    readonly docUrl?: string;
+    readonly describe?: string;
     readonly raw?: unknown;
     constructor(problem?: ProblemDetails, options?: ErrorOptions);
     static fromResponse(response: Response, body: unknown): PraxisError;