@deepraxis/sdk 0.1.0 → 0.1.1-dev.1538445

package/dist/generated/sdk.gen.js

@@ -82,13 +82,13 @@ export const setRunFeedback = (options) => (options.client ?? client).post({
     }
 });
 /**
- * List End Users
+ * List customers
  *
- * List users who have sessions or token issuance history on a service agent.
+ * List the customers of a service agent, identified and anonymous, most recently seen first.
  *
- * Ordered by last_active_at and external_user_id descending. q is a case-sensitive literal prefix, including underscores. limit is 1–100, default 20. Reuse next_page with the same organization, agent, q and limit. Preemptively blocked users without history do not appear. End-user credentials and inaccessible or personal agents return 404.
+ * Call this from your backend with your API key, or from the console. Customers follow Shopify Admin customers (list, retrieve, block, sign-out and data deletion of the people who use your storefront), so that experience applies. The list includes customers who signed in but have not started a session yet, and customers recorded under your own ids by embed tokens before customer sign-in existed; an id first seen that way is identified unless it starts with anon_. Unlike Shopify, a customer can be anonymous: a visitor admitted with the publishable key gets an anon_ id, and when it later signs in with anonymous_access_token it is merged: merged_into names the identified customer, and its sessions count toward that customer. Filter with q (a case-sensitive customer id prefix), type (identified or anonymous) and blocked (true or false). limit is 1 to 100, default 20; reuse next_page with the same filters and limit. A customer access token gets 404. Example: GET /agent/v1/agents/agent_example/customers?type=identified&blocked=false&limit=50.
  */
-export const listEndUsers = (options) => (options.client ?? client).get({
+export const listCustomers = (options) => (options.client ?? client).get({
     security: [{
             key: 'BearerAuth',
             scheme: 'bearer',
@@ -98,17 +98,17 @@ export const listEndUsers = (options) => (options.client ?? client).get({
             name: 'X-API-Key',
             type: 'apiKey'
         }],
-    url: '/agent/v1/agents/{agent_id}/end_users',
+    url: '/agent/v1/agents/{agent_id}/customers',
     ...options
 });
 /**
- * Delete end-user data
+ * Delete customer data
  *
- * Delete a host application's end-user data from one service agent after explicit confirmation.
+ * Delete a customer's data from one service agent after explicit confirmation.
  *
- * Develop only. Set confirm to the exact external_user_id; missing or mismatched confirmation returns 400. Returns 202 with a pending task id, not completion. Poll the deletion endpoint. Concurrent requests reuse the unfinished task; retry DELETE after failure to resume it. Tokens are revoked and the user is blocked before a seven-day recovery snapshot is verified. Sessions including child sessions, conversation data, grants and feedback are then removed. A pre-existing block remains; a temporary block is removed on success. Attachment metadata is recorded and File attachments are retained. No charge is introduced by this operation. Example: DELETE /agent/v1/agents/agent_example/end_users/customer_123?confirm=customer_123.
+ * Develop only. Set confirm to the exact customer id; a missing or different confirm returns 400 naming the value to send. Returns 202 with a pending task id; poll the deletion endpoint. Concurrent requests reuse the unfinished task; retry DELETE after failure to resume it. Tokens are revoked and the customer is blocked before a seven-day recovery snapshot is verified; sessions including child sessions, conversation data, grants and feedback are then removed. A block that existed before stays; a temporary block is removed on success. File attachments are retained. Example: DELETE /agent/v1/agents/agent_example/customers/cus_8f2a91?confirm=cus_8f2a91.
  */
-export const deleteEndUser = (options) => (options.client ?? client).delete({
+export const deleteCustomer = (options) => (options.client ?? client).delete({
     security: [{
             key: 'BearerAuth',
             scheme: 'bearer',
@@ -118,17 +118,17 @@ export const deleteEndUser = (options) => (options.client ?? client).delete({
             name: 'X-API-Key',
             type: 'apiKey'
         }],
-    url: '/agent/v1/agents/{agent_id}/end_users/{external_user_id}',
+    url: '/agent/v1/agents/{agent_id}/customers/{customer_id}',
     ...options
 });
 /**
- * Get End User
+ * Get customer
  *
- * Inspect one end user and their twenty most recently updated sessions.
+ * Retrieve one customer of a service agent with its twenty most recently updated sessions.
  *
- * Use external_user_id from listing or your host application. Users without session or issuance history return 404, including preemptively blocked users. End-user credentials and inaccessible or personal agents return 404.
+ * Use the customer id from the list or your own customer_id. An unknown customer returns 404 CUSTOMER_NOT_FOUND, and so does a customer access token. Unlike Shopify, an identified customer's session_count, cost and recent_sessions include the sessions of anonymous customers merged into it; the merged anonymous customer still shows its own sessions and its merged_into.
  */
-export const getEndUser = (options) => (options.client ?? client).get({
+export const getCustomer = (options) => (options.client ?? client).get({
     security: [{
             key: 'BearerAuth',
             scheme: 'bearer',
@@ -138,17 +138,17 @@ export const getEndUser = (options) => (options.client ?? client).get({
             name: 'X-API-Key',
             type: 'apiKey'
         }],
-    url: '/agent/v1/agents/{agent_id}/end_users/{external_user_id}',
+    url: '/agent/v1/agents/{agent_id}/customers/{customer_id}',
     ...options
 });
 /**
- * Get end-user deletion
+ * Get customer deletion
  *
- * Poll the latest deletion task for an end user, including after the user data has been removed.
+ * Poll the latest deletion task of a customer, including after its data has been removed.
  *
- * Use the same agent_id and external_user_id as the confirmed DELETE. Status is pending, snapshotting, deleting, done or failed. Counts are empty until a verified snapshot exists. A failed task remains blocked and resumes when DELETE is retried with matching confirmation. snapshot_key is an operator recovery reference retained for seven days, not a public download URL. End-user credentials, inaccessible or personal agents, and missing tasks return 404. This read does not create a task or charge usage.
+ * Use the same agent_id and customer id as the confirmed DELETE. Status is pending, snapshotting, deleting, done or failed. Counts are empty until a verified snapshot exists. snapshot_key is an operator recovery reference retained for seven days, not a download URL. A customer access token and a missing task return 404.
  */
-export const getEndUserDeletion = (options) => (options.client ?? client).get({
+export const getCustomerDeletion = (options) => (options.client ?? client).get({
     security: [{
             key: 'BearerAuth',
             scheme: 'bearer',
@@ -158,17 +158,17 @@ export const getEndUserDeletion = (options) => (options.client ?? client).get({
             name: 'X-API-Key',
             type: 'apiKey'
         }],
-    url: '/agent/v1/agents/{agent_id}/end_users/{external_user_id}/deletion',
+    url: '/agent/v1/agents/{agent_id}/customers/{customer_id}/deletion',
     ...options
 });
 /**
- * Revoke End User Tokens
+ * Block customer
  *
- * Revoke all issued tokens for an end user and terminate their open embed streams.
+ * Block a customer and end every sign-in it has on this agent.
  *
- * Revokes credentials before marking grants revoked. Upstream failure returns 502 without changing grant revocation timestamps. Returns the count of newly revoked grants; a repeat without new grants returns zero. Does not block future issuance. End-user credentials and inaccessible or personal agents return 404.
+ * Blocks the customer, then ends every live sign-in the way logout does: each access token is revoked and its open event streams close. From then on grant_codes, access_tokens, renew and new sessions for this customer return CUSTOMER_BLOCKED until you unblock it. Idempotent: a repeat keeps the first block time and revokes whatever is still live. If credential revocation fails the request returns 502 and the customer stays blocked; retry to finish. An unknown customer returns 404 CUSTOMER_NOT_FOUND.
  */
-export const revokeEndUserTokens = (options) => (options.client ?? client).post({
+export const blockCustomer = (options) => (options.client ?? client).post({
     security: [{
             key: 'BearerAuth',
             scheme: 'bearer',
@@ -178,17 +178,17 @@ export const revokeEndUserTokens = (options) => (options.client ?? client).post(
             name: 'X-API-Key',
             type: 'apiKey'
         }],
-    url: '/agent/v1/agents/{agent_id}/end_users/{external_user_id}/revoke_tokens',
+    url: '/agent/v1/agents/{agent_id}/customers/{customer_id}/block',
     ...options
 });
 /**
- * Block End User
+ * Unblock customer
  *
- * Block token issuance and session creation, then revoke existing tokens for an end user.
+ * Allow a blocked customer to sign in and start sessions again.
  *
- * May block a user before any history exists; timestamps are then null and counts and cost are zero. Requires an embed policy, otherwise returns 409 with setup guidance. Deduplicates the policy blocklist and retains its 1000-user maximum. If revocation returns 502, the user remains blocked; retry to finish revocation. Repeats keep the user blocked and revoke any remaining grants. End-user credentials and inaccessible or personal agents return 404.
+ * Idempotent. Access tokens revoked while the customer was blocked stay revoked; sign the customer in again with a new grant code. An unknown customer returns 404 CUSTOMER_NOT_FOUND.
  */
-export const blockEndUser = (options) => (options.client ?? client).post({
+export const unblockCustomer = (options) => (options.client ?? client).post({
     security: [{
             key: 'BearerAuth',
             scheme: 'bearer',
@@ -198,17 +198,17 @@ export const blockEndUser = (options) => (options.client ?? client).post({
             name: 'X-API-Key',
             type: 'apiKey'
         }],
-    url: '/agent/v1/agents/{agent_id}/end_users/{external_user_id}/block',
+    url: '/agent/v1/agents/{agent_id}/customers/{customer_id}/unblock',
     ...options
 });
 /**
- * Unblock End User
+ * Revoke customer tokens
  *
- * Allow an end user to receive new tokens and create new sessions again.
+ * Sign a customer out everywhere without blocking it.
  *
- * Removes the user from the blocklist; previously revoked tokens stay revoked. Idempotent. Requires an embed policy, otherwise returns 409 with setup guidance. Returns null timestamps and zero counts and cost when no session or issuance history exists. End-user credentials and inaccessible or personal agents return 404.
+ * Ends every live sign-in of the customer, revoking each access token and closing its open event streams; the customer can sign in again right away. Returns the number of access tokens this request revoked; a repeat returns 0. Credential revocation failure returns 502; retry to finish. An unknown customer returns 404 CUSTOMER_NOT_FOUND.
  */
-export const unblockEndUser = (options) => (options.client ?? client).post({
+export const revokeCustomerTokens = (options) => (options.client ?? client).post({
     security: [{
             key: 'BearerAuth',
             scheme: 'bearer',
@@ -218,18 +218,47 @@ export const unblockEndUser = (options) => (options.client ?? client).post({
             name: 'X-API-Key',
             type: 'apiKey'
         }],
-    url: '/agent/v1/agents/{agent_id}/end_users/{external_user_id}/unblock',
+    url: '/agent/v1/agents/{agent_id}/customers/{customer_id}/revoke_tokens',
     ...options
 });
 /**
- * Exchange Hosted Code
+ * Get agent appearance
  *
- * Redeem a single-use hosted link credential for an end-user token.
+ * Read the saved chat appearance of a service agent.
  *
- * Read code from the c fragment parameter of hosted_url returned by embed token creation with hosted true, then remove the fragment before exchanging. No Authorization header is required; the code authenticates this request. The code expires after 60 seconds and is consumed atomically on exchange, so concurrent attempts have only one winner. Expired, used and unknown codes return the same 404 body. Keep the token in memory and return to the host website for a fresh link when it expires; exchange cannot refresh it. Requests are IP limited per minute using the anonymous entrypoint budget (default 20). Example body is {"code":"<code from hosted_url>"}.
+ * Agent Kit calls this from the page with a customer access token of this agent; your API key and console members can read it too. A token of another agent returns 404. The body is the same as the embed appearance read; a missing appearance returns the agent's own name and avatar only. Responses are private and cacheable for 60 seconds.
  */
-export const exchangeEmbedCode = (options) => (options.client ?? client).post({
-    url: '/agent/v1/embed/exchange',
+export const getAgentAppearance = (options) => (options.client ?? client).get({
+    security: [{
+            key: 'BearerAuth',
+            scheme: 'bearer',
+            type: 'http'
+        }, {
+            key: 'ApiKeyAuth',
+            name: 'X-API-Key',
+            type: 'apiKey'
+        }],
+    url: '/agent/v1/agents/{agent_id}/appearance',
+    ...options
+});
+/**
+ * Create customer grant code
+ *
+ * Sign your logged-in customer in to a service agent from your backend with a one-time grant code that Agent Kit exchanges for a customer access token.
+ *
+ * Call this from your backend with your API key after your own login succeeds, then pass the returned code to Agent Kit in the browser; never call it from the browser. Customer authorization follows Shopify Storefront customer access tokens (Multipass-style sign-in, a short-lived token, renewal and logout), so that experience applies. customer_id is your own identifier for the customer: use an opaque id such as your database user id, not an email address or phone number. The value auth is reserved, and ids starting with anon_ are reserved for anonymous customers. The code works once and expires after expires_in seconds (default 900). The sign-in it starts lasts max_session_seconds (default 7 days); version, budget (US dollars, at most 2 decimals), system_message, agent_override and metadata apply to every token of the sign-in. Unlike Shopify, origin binds the whole sign-in to one page origin, and anonymous_access_token merges the conversations of the anonymous visitor who chatted before signing in into this customer. Example body: {"customer_id":"cus_8f2a91","origin":"https://shop.example.com"}.
+ */
+export const createCustomerGrantCode = (options) => (options.client ?? client).post({
+    security: [{
+            key: 'BearerAuth',
+            scheme: 'bearer',
+            type: 'http'
+        }, {
+            key: 'ApiKeyAuth',
+            name: 'X-API-Key',
+            type: 'apiKey'
+        }],
+    url: '/agent/v1/agents/{agent_id}/customers/auth/grant_codes',
     ...options,
     headers: {
         'Content-Type': 'application/json',
@@ -237,14 +266,14 @@ export const exchangeEmbedCode = (options) => (options.client ?? client).post({
     }
 });
 /**
- * Issue anonymous visitor token
+ * Create customer access token
  *
- * Obtain a short-lived embedding token for a visitor without an account using the agent owner's publishable key.
+ * Exchange a grant code, or the agent's publishable key for an anonymous visitor, for a customer access token that authorizes the agent's embedded sessions.
  *
- * No Authorization header is required. Send the browser Origin allowed by the agent policy. Save a returned visitor_secret and reuse it for refreshes; only new visitors receive one. Unknown secrets create new visitors, and extra fields including visitor_id return 400. Issuance uses the key creator's organization membership, the key session budget and the smaller of the policy TTL maximum and 3600 seconds. IP requests are limited per minute (default 20); UTC daily session and spending caps are checked across the key's primary sessions created that day. Token issuance itself does not create a session or charge usage; subsequent sessions bill the host organization. Example body: {"publishable_key":"pk_praxis_example"}.
+ * No Authorization header is required: the grant code or the publishable key is the credential. Agent Kit calls this from the browser, so send the page Origin. With grant_code, the code is consumed atomically: concurrent attempts have exactly one winner, and unknown, used, expired and other-agent codes all return the same 401 GRANT_CODE_INVALID. The sign-in starts now and lasts the code's max_session_seconds. Unlike Shopify, a visitor without an account gets a token too: send publishable_key instead and a new anonymous customer (anon_…) is created, bound to the request Origin, for 7 days. The access token lasts at most two hours and never outlives the sign-in; renew it with access_tokens/renew before expires_at. Both forms share the per-IP minute limit of anonymous issuance (default 20). Example body: {"grant_code":"cgc_…"}.
  */
-export const createAnonymousEmbedToken = (options) => (options.client ?? client).post({
-    url: '/agent/v1/embed_tokens/anonymous',
+export const createCustomerAccessToken = (options) => (options.client ?? client).post({
+    url: '/agent/v1/agents/{agent_id}/customers/auth/access_tokens',
     ...options,
     headers: {
         'Content-Type': 'application/json',
@@ -252,13 +281,13 @@ export const createAnonymousEmbedToken = (options) => (options.client ?? client)
     }
 });
 /**
- * List Embed Tokens
+ * Renew customer access token
  *
- * List embed token issuance records in your organization.
+ * Get a fresh customer access token in the same sign-in, authenticated with the current one.
  *
- * Includes expired and revoked grants; returns neither token nor token_id. Sorts by created_at, then grant id, both descending. agent_id accepts agent_ or agt_; external_user_id matches exactly. limit is 1–100 (default 20). Reuse next_page as page with the same filters and organization; a mismatch returns 400. End-user credentials return 404.
+ * Send the current customer access token as the Bearer credential, with no body, a few minutes before expires_at. The new token keeps the version, budget, context, metadata and origin binding of the sign-in and lasts at most two hours, never past session_expires_at. Unlike Shopify, renewal does not revoke the presented token: it stays valid until its own expiry, so a reply that is streaming on it is not cut off. When less than 60 seconds of the sign-in remain, renewal returns 401 CUSTOMER_SESSION_EXPIRED; sign the customer in again with a new grant code from your backend. A token that was logged out or merged returns 401 ACCESS_TOKEN_REVOKED.
  */
-export const listEmbedTokens = (options) => (options?.client ?? client).get({
+export const renewCustomerAccessToken = (options) => (options.client ?? client).post({
     security: [{
             key: 'BearerAuth',
             scheme: 'bearer',
@@ -268,41 +297,17 @@ export const listEmbedTokens = (options) => (options?.client ?? client).get({
             name: 'X-API-Key',
             type: 'apiKey'
         }],
-    url: '/agent/v1/embed_tokens',
+    url: '/agent/v1/agents/{agent_id}/customers/auth/access_tokens/renew',
     ...options
 });
 /**
- * Create Embed Token
- *
- * Issue a short-lived credential on your backend for an end user of a service agent.
- *
- * Requires an active service agent in your organization with an embed policy. Pins the requested version or the latest version and snapshots the policy environment, vaults and resources; metadata comes from the request. Blocked users cannot receive tokens. Keep your API key on the backend and pass only the returned token to the frontend. Every call creates a new grant; issuance is not idempotent. Set hosted to true to also receive hosted_url; redirect the user there within 60 seconds. The agent must have an identity_number. The URL fragment contains a single-use exchange credential, not the token. Omit hosted or set false for ordinary token issuance.
- */
-export const createEmbedToken = (options) => (options.client ?? client).post({
-    security: [{
-            key: 'BearerAuth',
-            scheme: 'bearer',
-            type: 'http'
-        }, {
-            key: 'ApiKeyAuth',
-            name: 'X-API-Key',
-            type: 'apiKey'
-        }],
-    url: '/agent/v1/embed_tokens',
-    ...options,
-    headers: {
-        'Content-Type': 'application/json',
-        ...options.headers
-    }
-});
-/**
- * Revoke Embed Token
+ * Log out customer
  *
- * Revoke an embed token and close its open event streams.
+ * Log the customer out by revoking the sign-in of the presented access token and every token issued in it.
  *
- * Use an id from issuance or listing. Revokes the credential before setting revoked_at; upstream failure leaves it unset. Streams receive session.error (EMBED_TOKEN_REVOKED), then close immediately; other credentials are unaffected. Idempotent; repeats return the original revoked record without another revocation or audit. Missing or foreign grants and end-user credentials return 404.
+ * Send the current customer access token as the Bearer credential, with no body, when the customer logs out of your site. Every token of the sign-in, including renewed ones, stops working, and their live event streams close; the customer's conversations are kept. Returns 204. Calling it again with the same token returns 401 ACCESS_TOKEN_REVOKED, so treat that as already logged out.
  */
-export const revokeEmbedToken = (options) => (options.client ?? client).post({
+export const deleteCurrentCustomerAccessToken = (options) => (options.client ?? client).delete({
     security: [{
             key: 'BearerAuth',
             scheme: 'bearer',
@@ -312,13 +317,13 @@ export const revokeEmbedToken = (options) => (options.client ?? client).post({
             name: 'X-API-Key',
             type: 'apiKey'
         }],
-    url: '/agent/v1/embed_tokens/{id}/revoke',
+    url: '/agent/v1/agents/{agent_id}/customers/auth/access_tokens/current',
     ...options
 });
 /**
- * ComputersList
+ * List Computers
  *
- * Tenant-owned durable computer resource.
+ * List the computers of your organization, archived ones included.
  *
  * Praxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. Archived files remain readable, but new sessions cannot bind them. environment_id is an optional recipe reference; computers start with a light sandbox and expose the public SDK sandbox_id. Lists include archived computers.
  */
@@ -336,9 +341,9 @@ export const computersList = (options) => (options?.client ?? client).get({
     ...options
 });
 /**
- * ComputersCreate
+ * Create Computer
  *
- * Tenant-owned durable computer resource.
+ * Create a durable computer: a named machine whose files outlive sessions, for personal agents.
  *
  * Praxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. Archived files remain readable, but new sessions cannot bind them. environment_id is an optional recipe reference; computers start with a light sandbox and expose the public SDK sandbox_id. Lists include archived computers.
  */
@@ -380,9 +385,9 @@ export const computersDelete = (options) => (options.client ?? client).delete({
     ...options
 });
 /**
- * ComputersRetrieve
+ * Get Computer
  *
- * Tenant-owned durable computer resource.
+ * Read one computer's status, storage use and sandbox id.
  *
  * Praxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. Archived files remain readable, but new sessions cannot bind them. environment_id is an optional recipe reference; computers start with a light sandbox and expose the public SDK sandbox_id. Lists include archived computers.
  */
@@ -400,9 +405,9 @@ export const computersRetrieve = (options) => (options.client ?? client).get({
     ...options
 });
 /**
- * ComputersUpdate
+ * Update Computer
  *
- * Tenant-owned durable computer resource.
+ * Rename a computer.
  *
  * Praxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. Archived files remain readable, but new sessions cannot bind them. environment_id is an optional recipe reference; computers start with a light sandbox and expose the public SDK sandbox_id. Lists include archived computers.
  */
@@ -424,9 +429,9 @@ export const computersUpdate = (options) => (options.client ?? client).post({
     }
 });
 /**
- * ComputersArchive
+ * Archive Computer
  *
- * Tenant-owned durable computer resource.
+ * Archive a computer: its files stay readable but new sessions cannot use it.
  *
  * Praxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. Archived files remain readable, but new sessions cannot bind them. environment_id is an optional recipe reference; computers start with a light sandbox and expose the public SDK sandbox_id. Lists include archived computers.
  */
@@ -469,9 +474,9 @@ export const computersAttachmentsCreate = (options) => (options.client ?? client
     }
 });
 /**
- * ComputersFilesList
+ * List Computer Files
  *
- * Tenant-owned durable computer resource.
+ * List the entries of one directory on a computer.
  *
  * Praxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. Archived files remain readable, but new sessions cannot bind them. environment_id is an optional recipe reference; computers start with a light sandbox and expose the public SDK sandbox_id. Lists include archived computers.
  */
@@ -489,9 +494,9 @@ export const computersFilesList = (options) => (options.client ?? client).get({
     ...options
 });
 /**
- * ComputersFilesContent
+ * Get Computer File Content
  *
- * Tenant-owned durable computer resource.
+ * Download the bytes of one file on a computer, up to 16 MiB, with single-range support.
  *
  * Praxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. Archived files remain readable, but new sessions cannot bind them. environment_id is an optional recipe reference; computers start with a light sandbox and expose the public SDK sandbox_id. Lists include archived computers.
  */
@@ -760,20 +765,6 @@ export const listSessionCompactions = (options) => (options.client ?? client).ge
     url: '/agent/v1/sessions/{session_id}/compactions',
     ...options
 });
-/**
- * Read chat appearance
- *
- * Load saved appearance for an iframe or Hosted chat page. Supply an end-user embed token as Bearer authorization, or a console-issued publishable key in Praxis-Publishable-Key before anonymous token issuance. The credential selects the agent; identity_number and agent_id query parameters are rejected with 400. Missing appearance returns an empty object. Kit option names retain camelCase. Responses are private and cacheable for 60 seconds. Component hosts configure Kit in their own code instead.
- */
-export const getEmbedAppearance = (options) => (options?.client ?? client).get({
-    security: [{
-            key: 'BearerAuth',
-            scheme: 'bearer',
-            type: 'http'
-        }, { name: 'Praxis-Publishable-Key', type: 'apiKey' }],
-    url: '/agent/v1/embed/appearance',
-    ...options
-});
 /**
  * Generate speech
  *
@@ -2479,7 +2470,7 @@ export const agentsList = (options) => (options?.client ?? client).get({
 /**
  * Create agent
  *
- * Create a reusable agent definition, then pass its returned id to sessions.create to start a conversation. The definition includes model, system prompt, tools, MCP servers and an optional multiagent roster. It is saved as version 1; real updates create new versions. Unlike Anthropic Managed Agents, nonempty skills attachments return 400; the native skill tool is separate from the skills field. Use tools: [{type: "agent_toolset_20260401"}] for built-in tools including codemode, skill and agent; inspect toolsets.list for names and schemas, and keep bash enabled for native additions. To offer only some tools, set default_config: {enabled: false} and list the tools to keep in configs, e.g. tools: [{type: "agent_toolset_20260401", default_config: {enabled: false}, configs: [{name: "codemode", enabled: true}, {name: "bash", enabled: true, permission_policy: {type: "always_ask"}}]}]; every tool not listed, including todo_write, enter_plan_mode, ask_user_question and goal_read, follows default_config, and the response echoes it. codemode runs through bash, so enabling codemode while bash is disabled returns 400. Optional mcp_toolset entries pair with mcp_servers. model accepts platform model IDs such as deepseek-flash, not only the Claude IDs in the protocol examples. model.settings.reasoning sets default thinking; other extra model controls return 400. Example: {"name":"helper","model":{"id":"deepseek-flash"},"tools":[{"type":"agent_toolset_20260401"}]}.
+ * Create a reusable agent definition, then pass its returned id to sessions.create to start a conversation. The definition includes model, system prompt, tools, MCP servers and an optional multiagent roster. It is saved as version 1; real updates create new versions. skills attaches uploaded custom skills as [{type: "custom", skill_id, version?}] (skill_id from skills.create or skills.list; at most 20, no repeated skill_id). Omit version, or send "latest", to use the skill's newest version when a session starts. type anthropic returns 400. Use tools: [{type: "agent_toolset_20260401"}] for built-in tools including codemode, skill and agent; inspect toolsets.list for names and schemas, and keep bash enabled for native additions. To offer only some tools, set default_config: {enabled: false} and list the tools to keep in configs, e.g. tools: [{type: "agent_toolset_20260401", default_config: {enabled: false}, configs: [{name: "codemode", enabled: true}, {name: "bash", enabled: true, permission_policy: {type: "always_ask"}}]}]; every tool not listed, including todo_write, enter_plan_mode, ask_user_question and goal_read, follows default_config, and the response echoes it. codemode runs through bash, so enabling codemode while bash is disabled returns 400. Optional mcp_toolset entries pair with mcp_servers. model accepts platform model IDs such as deepseek-flash, not only the Claude IDs in the protocol examples. model.settings.reasoning sets default thinking; other extra model controls return 400. model and every models.allowed entry must be a catalog model that can run an agent: an unknown id returns 400 "model <id> is not in the model catalog" and an embedding, image or speech model returns 400 "model <id> cannot run an agent". name is a label, not a unique key: 1 to 256 characters after trimming, no NUL or line breaks. avatar is trimmed, must not contain spaces or point at a loopback, private or internal host, and its scheme is stored in lowercase. script and workflow binding ids are stored in lowercase, the form automation matches; bindings together with environment_id null return 400 because bindings need a machine. Example: {"name":"helper","model":{"id":"deepseek-flash"},"tools":[{"type":"agent_toolset_20260401"}]}.
  */
 export const agentsCreate = (options) => (options.client ?? client).post({
     security: [{
@@ -2501,7 +2492,7 @@ export const agentsCreate = (options) => (options.client ?? client).post({
 /**
  * Get agent
  *
- * Read one agent by id, at its latest version or, with version, at a specific earlier version. The response lists every native tool with its resolved configuration in one agent_toolset_20260401 entry, so it can be sent back unchanged to agents.update. Use agents.versions.list to enumerate versions.
+ * Read one agent by id. The top level is the latest saved version, the editable head whose version you send back for optimistic concurrency; after a save with apply false it differs from active_version, and new sessions use active_version, which you read with version=active. With version, read a specific saved version. The response lists every native tool with its resolved configuration in one agent_toolset_20260401 entry, so it can be sent back unchanged to agents.update. Use agents.versions.list to enumerate versions.
  */
 export const agentsRetrieve = (options) => (options.client ?? client).get({
     security: [{
@@ -2519,7 +2510,7 @@ export const agentsRetrieve = (options) => (options.client ?? client).get({
 /**
  * Update agent
  *
- * Update an agent. Send the current version in the body for optimistic concurrency: a stale version returns 409, and an update that changes nothing keeps the version number. Any real change saves a new version. apply defaults to true and moves active_version to the new version, or to the latest when configuration is unchanged; apply false saves without applying. version_note optionally records up to 280 characters on a newly created version. Existing sessions and tokens keep their version. Omitted fields keep their value. multiagent takes null or a coordinator roster; subagent_model keeps its value when omitted and is cleared by null. Archived agents cannot be updated. Unlike Anthropic Managed Agents, nonempty skills attachments return 400; use the native skill tool for available runtime skills.
+ * Update an agent. Send the current version in the body for optimistic concurrency: a stale version returns 409, and an update that changes nothing keeps the version number. Any real change saves a new version. apply defaults to true and moves active_version to the new version, or to the latest when configuration is unchanged; apply false saves without applying. version_note optionally records up to 280 characters on a newly created version; null means no note, and a note sent when the request changes nothing else returns 400 because a note is stored only with a new version. Existing sessions and tokens keep their version. Omitted fields keep their value. multiagent takes null or a coordinator roster; subagent_model keeps its value when omitted and is cleared by null. Archived agents cannot be updated. tools: [] removes every tool, while tools: null returns 400 (tools cannot be null; send [] to remove every tool). On update, omit skills to keep them, send an array to replace them, or send [] or null to clear them. skills attaches uploaded custom skills as [{type: "custom", skill_id, version?}] (skill_id from skills.create or skills.list; at most 20, no repeated skill_id). Omit version, or send "latest", to use the skill's newest version when a session starts. type anthropic returns 400.
  */
 export const agentsUpdate = (options) => (options.client ?? client).post({
     security: [{
@@ -2559,7 +2550,7 @@ export const agentsArchive = (options) => (options.client ?? client).post({
 /**
  * List agent versions
  *
- * List the saved versions of one agent, in pages of at most 100 (default 20). Each item is the full agent definition at that version, so you can compare what changed between versions. Use agents.retrieve with version to read a single one; agent_id comes from agents.list or agents.create.
+ * List the saved versions of one agent, in pages of at most 100 (default 20). Each item is the full agent definition at that version, so you can compare what changed between versions. active is true only for the item that new sessions use; active_version on each item is the agent-level value, kept for compatibility. Use agents.retrieve with version to read a single one; agent_id comes from agents.list or agents.create.
  */
 export const agentsVersionsList = (options) => (options.client ?? client).get({
     security: [{
@@ -2577,7 +2568,7 @@ export const agentsVersionsList = (options) => (options.client ?? client).get({
 /**
  * List sessions
  *
- * List sessions of the workspace behind your API key, newest first, in pages of at most 100 (default 20). Unlike Anthropic Managed Agents, only limit, page, agent_id and deployment_id are honored; the other filters declared here (agent_version, created_at ranges, memory_store_id, include_archived, order, statuses) are not supported and return 400. Use the returned id with sessions.retrieve or sessions.events.list; pass next_page as page for the next page.
+ * List sessions of the workspace behind your API key, newest first, in pages of at most 100 (default 20). Archived sessions are hidden unless include_archived is true. Unlike Anthropic Managed Agents, only limit, page, agent_id, deployment_id and include_archived are honored; the other filters declared here (agent_version, created_at ranges, memory_store_id, order, statuses) are not supported and return 400. Use the returned id with sessions.retrieve or sessions.events.list; pass next_page as page for the next page.
  */
 export const sessionsList = (options) => (options?.client ?? client).get({
     security: [{
@@ -2595,7 +2586,7 @@ export const sessionsList = (options) => (options?.client ?? client).get({
 /**
  * Create session
  *
- * Create a session: one conversation with an agent. Pass agent as an agent id (active_version) or {id, version, type:"agent"}. Unlike Anthropic Managed Agents, omit environment_id to get a light machine, unless computer_id (explicit, or the agent's default) selects a Computer; pass an environment id for a sandbox recipe. For service agents, omission returns environment_id=light; explicit null allocates no machine, so codemode, bash and other machine tools are unavailable. Optional model must be one of the agent's allowed models; optional thinking is {effort: low|medium|high|xhigh|max|none} or null, where null inherits the agent default and then the model default (none requires the model to allow disabling thinking). Selections are saved before initial_events run; invalid ones return 400 invalid_request_error. Inline agent overrides are not supported. Supports vault_ids, up to 50, owned by the current organization and not archived; credential injection is deferred to a later version. Omitted budget defaults to USD 20; null removes the limit, and a limit object uses a positive integer string of USD cents. Up to 500 file resources can be attached. Use initial_events to send a first user.message in this request, or send messages afterwards with sessions.events.send. The returned status can still be idle before initial events run; read agent.message and the subsequent session.status_idle event to confirm completion.
+ * Create a session: one conversation with an agent. Pass agent as an agent id or {type:"agent", id, version?}; an id alone, or an object without version, pins the agent's active_version (the version chosen with agents.versions.apply, not necessarily the newest saved one). Unlike Anthropic Managed Agents, omit environment_id to use the default environment saved in the agent version (light for a new agent), unless computer_id (explicit, or the agent's default) selects a Computer; pass an environment id for a sandbox recipe. For service agents, explicit null allocates no machine, so codemode, bash and other machine tools are unavailable. Optional model must be one of the agent's allowed models; optional thinking is {effort: low|medium|high|xhigh|max|none} or null, where null inherits the agent default and then the model default (none requires the model to allow disabling thinking). Selections are saved before initial_events run; invalid ones return 400 invalid_request_error. Unlike Anthropic Managed Agents, the only inline agent override is system ({type:"agent_with_overrides", id, system}); to change the model, tools, MCP servers or skills, save a version instead. Supports vault_ids, up to 50, owned by the current organization and not archived; credential injection is deferred to a later version. budget is {type:"limit", max_list_cost:{amount, currency:"USD"}} where amount is a positive integer string of US cents ("2000" is USD 20.00); omitted budget defaults to "2000" and null removes the limit. Up to 500 file resources can be attached. Use initial_events to send a first user.message in this request, or send messages afterwards with sessions.events.send. The returned status can still be idle before initial events run; read agent.message and the subsequent session.status_idle event to confirm completion.
  */
 export const sessionsCreate = (options) => (options.client ?? client).post({
     security: [{
@@ -2801,7 +2792,7 @@ export const environmentsRetrieve = (options) => (options.client ?? client).get(
 /**
  * Update environment
  *
- * Update the configuration of a tenant-owned cloud environment. Built-in environments are read-only. Package installation and limited networking are applied when a session's sandbox is created. Omitted fields keep their value.
+ * Update the configuration of a tenant-owned cloud environment. Built-in environments are read-only. Package installation and limited networking are applied when a session's sandbox is created. Omitted fields keep their value. A changed config.template must name an available sandbox template, otherwise 400 lists the available ones.
  */
 export const environmentsUpdate = (options) => (options.client ?? client).post({
     security: [{
@@ -2823,7 +2814,7 @@ export const environmentsUpdate = (options) => (options.client ?? client).post({
 /**
  * Archive environment
  *
- * Soft-archive a tenant-owned cloud environment so it can no longer be used to create new sessions. Built-in environments are read-only and cannot be archived.
+ * Soft-archive a tenant-owned cloud environment so it can no longer be used to create new sessions. Built-in environments are read-only and cannot be archived. An environment that the active version of a non-archived agent uses as environment_id returns 409 RESOURCE_IN_USE naming the agents; point them at another environment first.
  */
 export const environmentsArchive = (options) => (options.client ?? client).post({
     security: [{
@@ -2859,7 +2850,7 @@ export const environmentsList = (options) => (options?.client ?? client).get({
 /**
  * Create environment
  *
- * Create a tenant-owned cloud environment: a sandbox recipe (packages to install and networking policy) that sessions can select through environment_id. Package installation happens when the session's sandbox is created; a failed install terminates that session with ENVIRONMENT_PACKAGE_INSTALL_FAILED. Limited networking is applied at sandbox creation. Unlike Anthropic Managed Agents, self_hosted environments, scope and cross-session package caching are not supported.
+ * Create a tenant-owned cloud environment: a sandbox recipe (packages to install and networking policy) that sessions can select through environment_id. Package installation happens when the session's sandbox is created; a failed install terminates that session with ENVIRONMENT_PACKAGE_INSTALL_FAILED. Limited networking is applied at sandbox creation. Unlike Anthropic Managed Agents, self_hosted environments, scope and cross-session package caching are not supported. config.template must name an available sandbox template, otherwise 400 lists the available ones.
  */
 export const environmentsCreate = (options) => (options.client ?? client).post({
     security: [{
@@ -3163,7 +3154,7 @@ export const skillsList = (options) => (options?.client ?? client).get({
 /**
  * Create skill
  *
- * Upload a skill: a directory that contains SKILL.md, which the agent reads when it needs the skill. Send multipart/form-data with one files part per file, each file name being its path under one top-level directory (pdf/SKILL.md, pdf/scripts/run.py), and an optional display_name. SKILL.md frontmatter needs a description; name defaults to the directory name. Limits: 8 MB in total, at most 200 files, no .. segments, absolute paths or empty names; a violation returns 400 naming the path or field. The upload creates the skill and its first version, and versions are immutable. Attach the skill to an agent with `skills` on the agent.
+ * Upload a skill: a directory that contains SKILL.md, which the agent reads when it needs the skill. Send multipart/form-data with one files part per file, each file name being its path under one top-level directory (pdf/SKILL.md, pdf/scripts/run.py), and an optional display_name. SKILL.md frontmatter needs a description; name defaults to the directory name and must be one folder name (1-255 characters, no "/", backslash or NUL, not "." or ".."), otherwise the upload returns 400 stating the allowed form. Limits: 8 MB in total, at most 200 files, no .. segments, absolute paths or empty names; a violation returns 400 naming the path or field. The upload creates the skill and its first version, and versions are immutable. Attach the skill to an agent with `skills` on the agent.
  */
 export const skillsCreate = (options) => (options.client ?? client).post({
     ...formDataBodySerializer,
@@ -3186,7 +3177,7 @@ export const skillsCreate = (options) => (options.client ?? client).post({
 /**
  * Delete skill
  *
- * Delete a skill that has no live versions. A skill that still has versions returns 409 Delete all versions first; remove each with skills.versions.delete, then call this. Returns {id, type: skill_deleted}. skill_id comes from skills.create or skills.list.
+ * Delete a skill together with all of its versions. A skill that is still attached to an agent returns 409 RESOURCE_IN_USE naming up to 10 agent ids (the active or latest version of a non-archived agent counts); remove it from those agents first. Returns {id, type: skill_deleted}. skill_id comes from skills.create or skills.list.
  */
 export const skillsDelete = (options) => (options.client ?? client).delete({
     security: [{
@@ -3263,7 +3254,7 @@ export const skillsVersionsCreate = (options) => (options.client ?? client).post
 /**
  * Delete skill version
  *
- * Soft-delete one version of a skill so it can no longer be read or downloaded; latest_version_id of the skill falls back to the newest remaining version. Returns {id, type: skill_version_deleted}. A skill can be deleted only after all of its versions are deleted.
+ * Soft-delete one version of a skill so it can no longer be read or downloaded; latest_version_id of the skill falls back to the newest remaining version. Returns {id, type: skill_version_deleted}. A skill keeps at least one version: deleting the last remaining version returns 409 SKILL_LAST_VERSION (delete the skill instead), so latest_version_id is never null. A version that a non-archived agent pins returns 409 RESOURCE_IN_USE naming the agents.
  */
 export const skillsVersionsDelete = (options) => (options.client ?? client).delete({
     security: [{