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

package/src/controlplane/models/errors/bad-request-error-response-content.ts

@@ -4,7 +4,7 @@
 
 import * as z from "zod/v3";
 import * as models from "../index.js";
-import { PlaybookServiceError } from "./playbook-service-error.js";
+import { AgentPlaybooksServiceError } from "./agent-playbooks-service-error.js";
 
 /**
  * Request validation or input decoding failed.
@@ -44,7 +44,7 @@ export type BadRequestErrorResponseContentData = {
 /**
  * Request validation or input decoding failed.
  */
-export class BadRequestErrorResponseContent extends PlaybookServiceError {
+export class BadRequestErrorResponseContent extends AgentPlaybooksServiceError {
   /**
    * A short, human-readable summary of the problem
    *

package/src/controlplane/models/errors/conflict-error-response-content.ts

@@ -4,7 +4,7 @@
 
 import * as z from "zod/v3";
 import * as models from "../index.js";
-import { PlaybookServiceError } from "./playbook-service-error.js";
+import { AgentPlaybooksServiceError } from "./agent-playbooks-service-error.js";
 
 /**
  * The request conflicts with the current state of the resource.
@@ -40,7 +40,7 @@ export type ConflictErrorResponseContentData = {
 /**
  * The request conflicts with the current state of the resource.
  */
-export class ConflictErrorResponseContent extends PlaybookServiceError {
+export class ConflictErrorResponseContent extends AgentPlaybooksServiceError {
   /**
    * A short, human-readable summary of the problem
    *

package/src/controlplane/models/errors/extraction-conflict-error-response-content.ts

@@ -4,7 +4,7 @@
 
 import * as z from "zod/v3";
 import * as models from "../index.js";
-import { PlaybookServiceError } from "./playbook-service-error.js";
+import { AgentPlaybooksServiceError } from "./agent-playbooks-service-error.js";
 
 /**
  * Binding version/state conflict, or extraction disabled by deployment configuration. Disabled extraction still permits inspection, pause and deletion.
@@ -38,7 +38,7 @@ export type ExtractionConflictErrorResponseContentData = {
  * Binding version/state conflict, or extraction disabled by deployment configuration. Disabled extraction still permits inspection, pause and deletion.
  */
 export class ExtractionConflictErrorResponseContent
-  extends PlaybookServiceError
+  extends AgentPlaybooksServiceError
 {
   /**
    * A short, human-readable summary of the problem

package/src/controlplane/models/errors/extraction-forbidden-error-response-content.ts

@@ -4,7 +4,7 @@
 
 import * as z from "zod/v3";
 import * as models from "../index.js";
-import { PlaybookServiceError } from "./playbook-service-error.js";
+import { AgentPlaybooksServiceError } from "./agent-playbooks-service-error.js";
 
 /**
  * Caller authorization failure.
@@ -38,7 +38,7 @@ export type ExtractionForbiddenErrorResponseContentData = {
  * Caller authorization failure.
  */
 export class ExtractionForbiddenErrorResponseContent
-  extends PlaybookServiceError
+  extends AgentPlaybooksServiceError
 {
   /**
    * A short, human-readable summary of the problem

package/src/controlplane/models/errors/failed-dependency-error-response-content.ts

@@ -4,7 +4,7 @@
 
 import * as z from "zod/v3";
 import * as models from "../index.js";
-import { PlaybookServiceError } from "./playbook-service-error.js";
+import { AgentPlaybooksServiceError } from "./agent-playbooks-service-error.js";
 
 /**
  * A dependent resource required to process the request is unavailable or unhealthy.
@@ -40,7 +40,9 @@ export type FailedDependencyErrorResponseContentData = {
 /**
  * A dependent resource required to process the request is unavailable or unhealthy.
  */
-export class FailedDependencyErrorResponseContent extends PlaybookServiceError {
+export class FailedDependencyErrorResponseContent
+  extends AgentPlaybooksServiceError
+{
   /**
    * A short, human-readable summary of the problem
    *

package/src/controlplane/models/errors/index.ts

@@ -2,6 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+export * from "./agent-playbooks-service-error.js";
 export * from "./api-error.js";
 export * from "./authentication-error-response-content.js";
 export * from "./bad-request-error-response-content.js";
@@ -11,7 +12,6 @@ export * from "./extraction-forbidden-error-response-content.js";
 export * from "./failed-dependency-error-response-content.js";
 export * from "./http-client-errors.js";
 export * from "./not-found-error-response-content.js";
-export * from "./playbook-service-error.js";
 export * from "./playbook-service-unavailable-error-response-content.js";
 export * from "./resource-suspended-error-response-content.js";
 export * from "./response-validation-error.js";

package/src/controlplane/models/errors/not-found-error-response-content.ts

@@ -4,7 +4,7 @@
 
 import * as z from "zod/v3";
 import * as models from "../index.js";
-import { PlaybookServiceError } from "./playbook-service-error.js";
+import { AgentPlaybooksServiceError } from "./agent-playbooks-service-error.js";
 
 /**
  * The requested resource does not exist.
@@ -40,7 +40,7 @@ export type NotFoundErrorResponseContentData = {
 /**
  * The requested resource does not exist.
  */
-export class NotFoundErrorResponseContent extends PlaybookServiceError {
+export class NotFoundErrorResponseContent extends AgentPlaybooksServiceError {
   /**
    * A short, human-readable summary of the problem
    *

package/src/controlplane/models/errors/playbook-service-unavailable-error-response-content.ts

@@ -4,7 +4,7 @@
 
 import * as z from "zod/v3";
 import * as models from "../index.js";
-import { PlaybookServiceError } from "./playbook-service-error.js";
+import { AgentPlaybooksServiceError } from "./agent-playbooks-service-error.js";
 
 export type PlaybookServiceUnavailableErrorResponseContentData = {
   /**
@@ -32,7 +32,7 @@ export type PlaybookServiceUnavailableErrorResponseContentData = {
 };
 
 export class PlaybookServiceUnavailableErrorResponseContent
-  extends PlaybookServiceError
+  extends AgentPlaybooksServiceError
 {
   /**
    * A short, human-readable summary of the problem

package/src/controlplane/models/errors/resource-suspended-error-response-content.ts

@@ -4,7 +4,7 @@
 
 import * as z from "zod/v3";
 import * as models from "../index.js";
-import { PlaybookServiceError } from "./playbook-service-error.js";
+import { AgentPlaybooksServiceError } from "./agent-playbooks-service-error.js";
 
 /**
  * The requested resource exists but is suspended by an administrator.
@@ -41,7 +41,7 @@ export type ResourceSuspendedErrorResponseContentData = {
  * The requested resource exists but is suspended by an administrator.
  */
 export class ResourceSuspendedErrorResponseContent
-  extends PlaybookServiceError
+  extends AgentPlaybooksServiceError
 {
   /**
    * A short, human-readable summary of the problem

package/src/controlplane/models/errors/response-validation-error.ts

@@ -3,10 +3,10 @@
  */
 
 import * as z from "zod/v3";
-import { PlaybookServiceError } from "./playbook-service-error.js";
+import { AgentPlaybooksServiceError } from "./agent-playbooks-service-error.js";
 import { formatZodError } from "./sdk-validation-error.js";
 
-export class ResponseValidationError extends PlaybookServiceError {
+export class ResponseValidationError extends AgentPlaybooksServiceError {
   /**
    * The raw value that failed validation.
    */

package/src/controlplane/models/errors/timeout-error-response-content.ts

@@ -4,7 +4,7 @@
 
 import * as z from "zod/v3";
 import * as models from "../index.js";
-import { PlaybookServiceError } from "./playbook-service-error.js";
+import { AgentPlaybooksServiceError } from "./agent-playbooks-service-error.js";
 
 /**
  * The request timed out before the service could complete it.
@@ -40,7 +40,7 @@ export type TimeoutErrorResponseContentData = {
 /**
  * The request timed out before the service could complete it.
  */
-export class TimeoutErrorResponseContent extends PlaybookServiceError {
+export class TimeoutErrorResponseContent extends AgentPlaybooksServiceError {
   /**
    * A short, human-readable summary of the problem
    *

package/src/controlplane/models/errors/unexpected-error-response-content.ts

@@ -4,7 +4,7 @@
 
 import * as z from "zod/v3";
 import * as models from "../index.js";
-import { PlaybookServiceError } from "./playbook-service-error.js";
+import { AgentPlaybooksServiceError } from "./agent-playbooks-service-error.js";
 
 /**
  * The service failed with an unexpected internal error.
@@ -40,7 +40,7 @@ export type UnexpectedErrorResponseContentData = {
 /**
  * The service failed with an unexpected internal error.
  */
-export class UnexpectedErrorResponseContent extends PlaybookServiceError {
+export class UnexpectedErrorResponseContent extends AgentPlaybooksServiceError {
   /**
    * A short, human-readable summary of the problem
    *

package/src/controlplane/sdk/sdk.ts

@@ -24,7 +24,7 @@ import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as models from "../models/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
-export class PlaybookService extends ClientSDK {
+export class AgentPlaybooksService extends ClientSDK {
   /**
    * Cloud only: list account databases
    *
@@ -165,7 +165,7 @@ export class PlaybookService extends ClientSDK {
   }
 
   /**
-   * Registers a client-supplied RAM store reference and FAQ policy. 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.
+   * 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.
    */
   async createExtractionBinding(
     playbookId: string,
@@ -225,7 +225,7 @@ export class PlaybookService extends ClientSDK {
   }
 
   /**
-   * Returns tenant-scoped deployment-configured store suggestions, which may be empty. A client may submit another syntactically valid storeId. No RAM call or approval check occurs.
+   * Returns tenant-scoped store suggestions, which may be empty. A suggestion does not approve a store. A client may submit another syntactically valid storeId; CreateExtractionBinding checks the caller's access to the store.
    */
   async listExtractionStores(
     playbookId: string,

package/src/index.ts

@@ -5,5 +5,5 @@ export * as files from "./lib/files.js";
 export { HTTPClient } from "./lib/http.js";
 export type { Fetcher, HTTPClientOptions } from "./lib/http.js";
 export * from "./sdk/sdk.js";
-export { PlaybookService } from "./controlplane/sdk/sdk.js";
-export type { SDKOptions as PlaybookServiceOptions } from "./controlplane/lib/config.js";
+export { AgentPlaybooksService } from "./controlplane/sdk/sdk.js";
+export type { SDKOptions as AgentPlaybooksServiceOptions } from "./controlplane/lib/config.js";

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-alpha.4",
+  sdkVersion: "0.1.0-beta.1",
   genVersion: "2.948.4",
   userAgent:
-    "speakeasy-sdk/typescript 0.1.0-alpha.4 2.948.4 1.0.0 @redis-iris/agent-playbook",
+    "speakeasy-sdk/typescript 0.1.0-beta.1 2.948.4 1.0.0 @redis-iris/agent-playbook",
 } as const;

package/src/lib/env.ts

@@ -7,22 +7,22 @@ import * as z from "zod/v3";
 import { SDKOptions } from "./config.js";
 
 export interface Env {
-  PLAYBOOK_API_KEY?: string | undefined;
+  AGENT_PLAYBOOKS_API_KEY?: string | undefined;
 
   /**
    * Sets the playbookId parameter for all supported operations
    */
-  PLAYBOOK_PLAYBOOK_ID?: string | undefined;
+  AGENT_PLAYBOOKS_PLAYBOOK_ID?: string | undefined;
 
-  PLAYBOOK_DEBUG?: boolean | undefined;
+  AGENT_PLAYBOOKS_DEBUG?: boolean | undefined;
 }
 
 export const envSchema: z.ZodType<Env, z.ZodTypeDef, unknown> = z.object({
-  PLAYBOOK_API_KEY: z.string().optional(),
+  AGENT_PLAYBOOKS_API_KEY: z.string().optional(),
 
-  PLAYBOOK_PLAYBOOK_ID: z.string().optional(),
+  AGENT_PLAYBOOKS_PLAYBOOK_ID: z.string().optional(),
 
-  PLAYBOOK_DEBUG: z.coerce.boolean().optional(),
+  AGENT_PLAYBOOKS_DEBUG: z.coerce.boolean().optional(),
 });
 
 /**
@@ -58,7 +58,13 @@ export function env(): Env {
     envObject = globals.process?.env ?? {};
   }
 
-  envMemo = envSchema.parse(envObject);
+  // Current names take precedence over legacy aliases, including empty values.
+  envMemo = envSchema.parse({
+    ...envObject,
+    AGENT_PLAYBOOKS_API_KEY: envObject["AGENT_PLAYBOOKS_API_KEY"] ?? envObject["PLAYBOOK_API_KEY"],
+    AGENT_PLAYBOOKS_PLAYBOOK_ID: envObject["AGENT_PLAYBOOKS_PLAYBOOK_ID"] ?? envObject["PLAYBOOK_PLAYBOOK_ID"],
+    AGENT_PLAYBOOKS_DEBUG: envObject["AGENT_PLAYBOOKS_DEBUG"] ?? envObject["PLAYBOOK_DEBUG"],
+  });
   return envMemo;
 }
 
@@ -77,8 +83,8 @@ export function fillGlobals(options: SDKOptions): SDKOptions {
 
   const envVars = env();
 
-  if (typeof envVars.PLAYBOOK_PLAYBOOK_ID !== "undefined") {
-    clone.playbookId ??= envVars.PLAYBOOK_PLAYBOOK_ID;
+  if (typeof envVars.AGENT_PLAYBOOKS_PLAYBOOK_ID !== "undefined") {
+    clone.playbookId ??= envVars.AGENT_PLAYBOOKS_PLAYBOOK_ID;
   }
 
   return clone;

package/src/lib/sdks.ts

@@ -112,7 +112,7 @@ export class ClientSDK {
     this._options = { ...fillGlobals(options), hooks: this.#hooks };
 
     this.#logger = this._options.debugLogger;
-    if (!this.#logger && env().PLAYBOOK_DEBUG) {
+    if (!this.#logger && env().AGENT_PLAYBOOKS_DEBUG) {
       this.#logger = console;
     }
   }

package/src/lib/security.ts

@@ -253,7 +253,7 @@ export function resolveGlobalSecurity(
       {
         fieldName: "Authorization",
         type: "http:bearer",
-        value: security?.apiKey ?? env().PLAYBOOK_API_KEY,
+        value: security?.apiKey ?? env().AGENT_PLAYBOOKS_API_KEY,
       },
     ],
   ];

package/dist/commonjs/controlplane/models/errors/playbook-service-error.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"playbook-service-error.d.ts","sourceRoot":"","sources":["../../../../../src/controlplane/models/errors/playbook-service-error.ts"],"names":[],"mappings":"AAIA,kDAAkD;AAClD,qBAAa,oBAAqB,SAAQ,KAAK;IAC7C,uBAAuB;IACvB,SAAgB,UAAU,EAAE,MAAM,CAAC;IACnC,gBAAgB;IAChB,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,mBAAmB;IACnB,SAAgB,OAAO,EAAE,OAAO,CAAC;IACjC,wBAAwB;IACxB,SAAgB,WAAW,EAAE,MAAM,CAAC;IACpC,mBAAmB;IACnB,SAAgB,WAAW,EAAE,QAAQ,CAAC;IAEtC,YACE,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE;QACR,QAAQ,EAAE,QAAQ,CAAC;QACnB,OAAO,EAAE,OAAO,CAAC;QACjB,IAAI,EAAE,MAAM,CAAC;KACd,EAUF;CACF"}

package/dist/commonjs/controlplane/models/errors/playbook-service-error.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"playbook-service-error.js","sourceRoot":"","sources":["../../../../../src/controlplane/models/errors/playbook-service-error.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,kDAAkD;AAClD,0BAAkC,SAAQ,KAAK;IAC7C,uBAAuB;IACP,UAAU,CAAS;IACnC,gBAAgB;IACA,IAAI,CAAS;IAC7B,mBAAmB;IACH,OAAO,CAAU;IACjC,wBAAwB;IACR,WAAW,CAAS;IACpC,mBAAmB;IACH,WAAW,CAAW;IAEtC,YACE,OAAe,EACf,QAIC,EACD;QACA,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,UAAU,GAAG,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC;QAC3C,IAAI,CAAC,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;QAC1B,IAAI,CAAC,OAAO,GAAG,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC;QACzC,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC;QACvE,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAC,QAAQ,CAAC;QAErC,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAC;IAAA,CACpC;CACF"}

package/dist/esm/controlplane/models/errors/playbook-service-error.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"playbook-service-error.d.ts","sourceRoot":"","sources":["../../../../../src/controlplane/models/errors/playbook-service-error.ts"],"names":[],"mappings":"AAIA,kDAAkD;AAClD,qBAAa,oBAAqB,SAAQ,KAAK;IAC7C,uBAAuB;IACvB,SAAgB,UAAU,EAAE,MAAM,CAAC;IACnC,gBAAgB;IAChB,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,mBAAmB;IACnB,SAAgB,OAAO,EAAE,OAAO,CAAC;IACjC,wBAAwB;IACxB,SAAgB,WAAW,EAAE,MAAM,CAAC;IACpC,mBAAmB;IACnB,SAAgB,WAAW,EAAE,QAAQ,CAAC;IAEtC,YACE,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE;QACR,QAAQ,EAAE,QAAQ,CAAC;QACnB,OAAO,EAAE,OAAO,CAAC;QACjB,IAAI,EAAE,MAAM,CAAC;KACd,EAUF;CACF"}

package/dist/esm/controlplane/models/errors/playbook-service-error.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"playbook-service-error.js","sourceRoot":"","sources":["../../../../../src/controlplane/models/errors/playbook-service-error.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,kDAAkD;AAClD,MAAM,OAAO,oBAAqB,SAAQ,KAAK;IAC7C,uBAAuB;IACP,UAAU,CAAS;IACnC,gBAAgB;IACA,IAAI,CAAS;IAC7B,mBAAmB;IACH,OAAO,CAAU;IACjC,wBAAwB;IACR,WAAW,CAAS;IACpC,mBAAmB;IACH,WAAW,CAAW;IAEtC,YACE,OAAe,EACf,QAIC,EACD;QACA,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,UAAU,GAAG,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC;QAC3C,IAAI,CAAC,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;QAC1B,IAAI,CAAC,OAAO,GAAG,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC;QACzC,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC;QACvE,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAC,QAAQ,CAAC;QAErC,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAC;IAAA,CACpC;CACF"}