@deepraxis/sdk 0.1.1-dev.b176367 → 0.1.1-dev.bdcd5e6

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,7 +218,27 @@ 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
+});
+/**
+ * Get agent appearance
+ *
+ * Read the saved chat appearance of a service agent.
+ *
+ * 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 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
 });
 /**
@@ -226,7 +246,7 @@ export const unblockEndUser = (options) => (options.client ?? client).post({
  *
  * 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_cents, 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"}.
+ * 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: [{
@@ -300,100 +320,6 @@ export const deleteCurrentCustomerAccessToken = (options) => (options.client ??
     url: '/agent/v1/agents/{agent_id}/customers/auth/access_tokens/current',
     ...options
 });
-/**
- * Exchange Hosted Code
- *
- * Redeem a single-use hosted link credential for an end-user token.
- *
- * 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>"}.
- */
-export const exchangeEmbedCode = (options) => (options.client ?? client).post({
-    url: '/agent/v1/embed/exchange',
-    ...options,
-    headers: {
-        'Content-Type': 'application/json',
-        ...options.headers
-    }
-});
-/**
- * Issue anonymous visitor token
- *
- * Obtain a short-lived embedding token for a visitor without an account using the agent owner's publishable key.
- *
- * 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"}.
- */
-export const createAnonymousEmbedToken = (options) => (options.client ?? client).post({
-    url: '/agent/v1/embed_tokens/anonymous',
-    ...options,
-    headers: {
-        'Content-Type': 'application/json',
-        ...options.headers
-    }
-});
-/**
- * List Embed Tokens
- *
- * List embed token issuance records in your organization.
- *
- * 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.
- */
-export const listEmbedTokens = (options) => (options?.client ?? client).get({
-    security: [{
-            key: 'BearerAuth',
-            scheme: 'bearer',
-            type: 'http'
-        }, {
-            key: 'ApiKeyAuth',
-            name: 'X-API-Key',
-            type: 'apiKey'
-        }],
-    url: '/agent/v1/embed_tokens',
-    ...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
- *
- * Revoke an embed token and close its open event streams.
- *
- * 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.
- */
-export const revokeEmbedToken = (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/{id}/revoke',
-    ...options
-});
 /**
  * List Computers
  *
@@ -839,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
  *