@redis-iris/agent-playbook 0.1.0-beta.1 → 0.1.0-beta.2

package/src/controlplane/models/playbook-state.ts

@@ -6,13 +6,20 @@ import * as z from "zod/v3";
 import * as openEnums from "../types/enums.js";
 import { OpenEnum } from "../types/enums.js";
 
+/**
+ * Effective read state. Cloud reads can report unavailable when live database metadata cannot be obtained; this state is never persisted and cannot be submitted in a mutation.
+ */
 export const PlaybookState = {
   Provisioning: "provisioning",
   Ready: "ready",
   Failed: "failed",
   Suspended: "suspended",
   Deleting: "deleting",
+  Unavailable: "unavailable",
 } as const;
+/**
+ * Effective read state. Cloud reads can report unavailable when live database metadata cannot be obtained; this state is never persisted and cannot be submitted in a mutation.
+ */
 export type PlaybookState = OpenEnum<typeof PlaybookState>;
 
 /** @internal */

package/src/controlplane/models/playbook.ts

@@ -51,6 +51,9 @@ export type Playbook = {
   playbookId: string;
   tenantId: string;
   name: string;
+  /**
+   * Effective read state. Cloud reads can report unavailable when live database metadata cannot be obtained; this state is never persisted and cannot be submitted in a mutation.
+   */
   state: PlaybookState;
   /**
    * Create-only embedding identity for a Playbook.

package/src/controlplane/models/update-extraction-binding-request-content.ts

@@ -12,7 +12,7 @@ import {
 export type UpdateExtractionBindingRequestContent = {
   expectedVersion: number;
   /**
-   * One extraction kind and its user-owned policy. Scan cadence is fixed at 300 seconds and is not accepted in requests. Omitted idleWindowSeconds defaults to 1800 on create and retains its existing value on update. Idle bounds are 60–86400 seconds. Model context and output budgets are deployment-owned worker settings rather than binding fields. Job type is immutable; changing extraction kind requires a new binding. Policy changes advance the binding version and do not reset completed-source deduplication.
+   * One extraction kind and its user-owned policy. Scan cadence is deployment-owned worker configuration and is not accepted in requests or returned on bindings. Omitted idleWindowSeconds defaults to 1800 on create and retains its existing value on update. Idle bounds are 60–86400 seconds. Model context and output budgets are deployment-owned worker settings rather than binding fields. Job type is immutable; changing extraction kind requires a new binding. Policy changes advance the binding version and do not reset completed-source deduplication.
    */
   job?: ExtractionJobConfiguration | undefined;
   enabled?: boolean | undefined;

package/src/controlplane/models/update-extraction-binding-response-content.ts

@@ -20,7 +20,7 @@ import {
 } from "./extraction-job.js";
 
 /**
- * Durable tenant-owned metadata for one Playbook, one RAM store, and one FAQ policy. Ready means the configured extraction-worker grants were accepted; the worker validates live RAM access during execution. Without a configured RAM connection, preparation remains pending and cannot be enabled. This release has no extraction worker. Activation requires a separate PATCH after readiness.
+ * Durable tenant-owned metadata for one Playbook, one RAM store, and one FAQ policy. Creation synchronously validates caller consent and exact RAM source ownership, returning ready and disabled. Every explicit enable revalidates with the current caller. Consent is durable account-owned configuration.
  */
 export type UpdateExtractionBindingResponseContent = {
   bindingId: string;
@@ -29,13 +29,13 @@ export type UpdateExtractionBindingResponseContent = {
    */
   playbookId: string;
   /**
-   * Typed RAM store reference. This release accepts only redis_agent_memory and a client-supplied storeId. The source is implicitly whole-store. When the deployment enables the RAM connection, server-side preparation verifies store access. Namespace selection and extraction workers arrive later; credentials are never accepted here. Unknown fields are rejected.
+   * Typed RAM store reference. Only redis_agent_memory with a client-supplied storeId is supported. The source is implicitly whole-store. The control plane verifies source consent and same-account/tenant RAM ownership on create and every explicit enable. Namespace selection is not supported. Credentials are never accepted here. Unknown fields are rejected.
    */
   source: ExtractionBindingSource;
   job: ExtractionJob;
   status: ExtractionBindingStatus;
   /**
-   * Activation intent. Creation is disabled; enabling requires ready status and a separate PATCH. Pausing clears intent and retains prepared source/destination grants.
+   * Activation intent. Creation is disabled. A separate enable PATCH revalidates current source consent and ownership, and can recover a blocked binding. Pausing clears intent without a RAM request or source permission.
    */
   enabled: boolean;
   /**
@@ -43,7 +43,7 @@ export type UpdateExtractionBindingResponseContent = {
    */
   version: number;
   /**
-   * Machine-readable source preparation or execution failure reason, such as source_grant_refused, source_not_found, or source_access_denied. Clients must tolerate unknown reasons.
+   * Machine-readable runtime failure reason, such as source_not_found or source_access_denied. Clients must tolerate unknown reasons.
    */
   blockedReason?: string | undefined;
   /**

package/src/controlplane/models/update-playbook-response-content.ts

@@ -51,6 +51,9 @@ export type UpdatePlaybookResponseContent = {
   playbookId: string;
   tenantId: string;
   name: string;
+  /**
+   * Effective read state. Cloud reads can report unavailable when live database metadata cannot be obtained; this state is never persisted and cannot be submitted in a mutation.
+   */
   state: PlaybookState;
   /**
    * Create-only embedding identity for a Playbook.

package/src/controlplane/sdk/sdk.ts

@@ -71,7 +71,7 @@ export class AgentPlaybooksService extends ClientSDK {
   }
 
   /**
-   * Lists the account's Playbooks. Cloud requests require JSESSIONID and X-CSRF-Token in addition to the operator JWT. If a selected database is unavailable, its Playbook remains listed without endpoint, database name or accessCidrs enrichment.
+   * Lists the account's Playbooks. Cloud requests require JSESSIONID and X-CSRF-Token in addition to the operator JWT. If a selected database is unavailable, its Playbook remains listed with state=unavailable and without endpoint, database name or accessCidrs enrichment for recognized missing/deleted database or metadata connection failures. Other inventory enrichment failures retain the saved state.
    */
   async listPlaybooks(
     options?: RequestOptions,
@@ -108,7 +108,7 @@ export class AgentPlaybooksService extends ClientSDK {
   }
 
   /**
-   * Reads one Playbook. Cloud requests require JSESSIONID and X-CSRF-Token in addition to the operator JWT.
+   * Reads one Playbook. Cloud requests require JSESSIONID and X-CSRF-Token in addition to the operator JWT. A missing or deleted database, or a recognized metadata connection failure, returns saved configuration with state=unavailable and without endpoints, databaseBinding.name, or databaseBinding.accessCidrs. This effective read state is not persisted and is not a mutation input. It reports unavailable live database information, not confirmed deletion or a content Redis health probe. Authorization, certificate-verification, cancellation/deadline, malformed-response, and unrelated service errors still fail the request.
    */
   async getPlaybook(
     playbookId: string,
@@ -165,7 +165,7 @@ export class AgentPlaybooksService extends ClientSDK {
   }
 
   /**
-   * Registers a client-supplied RAM store reference and FAQ policy. The admin token can bind each store. An OIDC caller can bind a store in the configured store list. With a RAM connection, it can also bind a store on which it has read access in the Identity Service. In other cases, the request fails with 403, and the response does not show whether the store exists. Returns preparing and enabled=false. The control plane asynchronously provisions extraction-worker RAM source read and Playbook destination read/propose grants; both accepted grants make the binding ready, refused grants make it blocked, and dependency outages remain pending for retry. The worker validates live RAM access when extraction runs. Poll GET until ready, then PATCH to enable.
+   * Validates caller management consent, exact same-account RAM source ownership, destination readiness and execution scope synchronously. Success returns ready and enabled=false. Every explicit enable revalidates with the current caller. Pause/delete require destination management only and make no source or grant-administration request. A foreign or missing source is refused without revealing its metadata.
    */
   async createExtractionBinding(
     playbookId: string,

package/src/lib/config.ts

@@ -49,8 +49,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "1.0.0",
-  sdkVersion: "0.1.0-beta.1",
+  sdkVersion: "0.1.0-beta.2",
   genVersion: "2.948.4",
   userAgent:
-    "speakeasy-sdk/typescript 0.1.0-beta.1 2.948.4 1.0.0 @redis-iris/agent-playbook",
+    "speakeasy-sdk/typescript 0.1.0-beta.2 2.948.4 1.0.0 @redis-iris/agent-playbook",
 } as const;