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

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

@@ -0,0 +1,86 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdk-validation-error.js";
+import {
+  ExtractionBindingSource,
+  ExtractionBindingSource$inboundSchema,
+} from "./extraction-binding-source.js";
+import {
+  ExtractionBindingStatus,
+  ExtractionBindingStatus$inboundSchema,
+} from "./extraction-binding-status.js";
+import {
+  ExtractionJob,
+  ExtractionJob$inboundSchema,
+} 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.
+ */
+export type DeleteExtractionBindingResponseContent = {
+  bindingId: string;
+  /**
+   * Opaque Playbook identifier.
+   */
+  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.
+   */
+  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.
+   */
+  enabled: boolean;
+  /**
+   * Optimistic configuration revision, independent of schedules and job runs.
+   */
+  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.
+   */
+  blockedReason?: string | undefined;
+  /**
+   * UTC timestamp resolved to microsecond precision.
+   */
+  createdAt: Date;
+  /**
+   * UTC timestamp resolved to microsecond precision.
+   */
+  updatedAt: Date;
+};
+
+/** @internal */
+export const DeleteExtractionBindingResponseContent$inboundSchema: z.ZodType<
+  DeleteExtractionBindingResponseContent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  bindingId: z.string(),
+  playbookId: z.string(),
+  source: ExtractionBindingSource$inboundSchema,
+  job: ExtractionJob$inboundSchema,
+  status: ExtractionBindingStatus$inboundSchema,
+  enabled: z.boolean(),
+  version: z.number().int(),
+  blockedReason: z.string().optional(),
+  createdAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  updatedAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+});
+
+export function deleteExtractionBindingResponseContentFromJSON(
+  jsonString: string,
+): SafeParseResult<DeleteExtractionBindingResponseContent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      DeleteExtractionBindingResponseContent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DeleteExtractionBindingResponseContent' from JSON`,
+  );
+}

package/src/controlplane/models/discovery-config.ts

@@ -0,0 +1,67 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdk-validation-error.js";
+
+/**
+ * Playbook-owned discovery policy.
+ */
+export type DiscoveryConfig = {
+  faqMinimumScore: number;
+  skillMinimumScore: number;
+  maxResults: number;
+  /**
+   * Optional estimated discovery-preview token ceiling. Missing or null on create disables budgeting; PATCH omission preserves the value and null clears it. Estimates use o200k_base over compact preview JSON plus fixed allowances, stored at authoring. The ceiling covers one logical discovery payload; model framing, session history and subsequent content loads are excluded.
+   */
+  maxPreviewTokens?: number | null | undefined;
+};
+
+/** @internal */
+export const DiscoveryConfig$inboundSchema: z.ZodType<
+  DiscoveryConfig,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  faqMinimumScore: z.number(),
+  skillMinimumScore: z.number(),
+  maxResults: z.number().int(),
+  maxPreviewTokens: z.nullable(z.number().int()).optional(),
+});
+/** @internal */
+export type DiscoveryConfig$Outbound = {
+  faqMinimumScore: number;
+  skillMinimumScore: number;
+  maxResults: number;
+  maxPreviewTokens?: number | null | undefined;
+};
+
+/** @internal */
+export const DiscoveryConfig$outboundSchema: z.ZodType<
+  DiscoveryConfig$Outbound,
+  z.ZodTypeDef,
+  DiscoveryConfig
+> = z.object({
+  faqMinimumScore: z.number(),
+  skillMinimumScore: z.number(),
+  maxResults: z.number().int(),
+  maxPreviewTokens: z.nullable(z.number().int()).optional(),
+});
+
+export function discoveryConfigToJSON(
+  discoveryConfig: DiscoveryConfig,
+): string {
+  return JSON.stringify(DiscoveryConfig$outboundSchema.parse(discoveryConfig));
+}
+export function discoveryConfigFromJSON(
+  jsonString: string,
+): SafeParseResult<DiscoveryConfig, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DiscoveryConfig$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DiscoveryConfig' from JSON`,
+  );
+}

package/src/controlplane/models/effective-model-selection.ts

@@ -0,0 +1,38 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdk-validation-error.js";
+
+/**
+ * Cloud only. Effective extraction model provider and model, including whether the selection is inherited. On-prem responses omit llm.
+ */
+export type EffectiveModelSelection = {
+  provider: string;
+  model: string;
+  inherited: boolean;
+};
+
+/** @internal */
+export const EffectiveModelSelection$inboundSchema: z.ZodType<
+  EffectiveModelSelection,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  provider: z.string(),
+  model: z.string(),
+  inherited: z.boolean(),
+});
+
+export function effectiveModelSelectionFromJSON(
+  jsonString: string,
+): SafeParseResult<EffectiveModelSelection, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EffectiveModelSelection$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EffectiveModelSelection' from JSON`,
+  );
+}

package/src/controlplane/models/embedding-config.ts

@@ -0,0 +1,60 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdk-validation-error.js";
+
+/**
+ * Create-only embedding identity for a Playbook.
+ */
+export type EmbeddingConfig = {
+  provider: string;
+  model: string;
+  dimensions: number;
+};
+
+/** @internal */
+export const EmbeddingConfig$inboundSchema: z.ZodType<
+  EmbeddingConfig,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  provider: z.string(),
+  model: z.string(),
+  dimensions: z.number().int(),
+});
+/** @internal */
+export type EmbeddingConfig$Outbound = {
+  provider: string;
+  model: string;
+  dimensions: number;
+};
+
+/** @internal */
+export const EmbeddingConfig$outboundSchema: z.ZodType<
+  EmbeddingConfig$Outbound,
+  z.ZodTypeDef,
+  EmbeddingConfig
+> = z.object({
+  provider: z.string(),
+  model: z.string(),
+  dimensions: z.number().int(),
+});
+
+export function embeddingConfigToJSON(
+  embeddingConfig: EmbeddingConfig,
+): string {
+  return JSON.stringify(EmbeddingConfig$outboundSchema.parse(embeddingConfig));
+}
+export function embeddingConfigFromJSON(
+  jsonString: string,
+): SafeParseResult<EmbeddingConfig, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EmbeddingConfig$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EmbeddingConfig' from JSON`,
+  );
+}

package/src/controlplane/models/errors/agent-playbooks-service-error.ts

@@ -0,0 +1,35 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+/** The base class for all HTTP error responses */
+export class AgentPlaybooksServiceError extends Error {
+  /** HTTP status code */
+  public readonly statusCode: number;
+  /** HTTP body */
+  public readonly body: string;
+  /** HTTP headers */
+  public readonly headers: Headers;
+  /** HTTP content type */
+  public readonly contentType: string;
+  /** Raw response */
+  public readonly rawResponse: Response;
+
+  constructor(
+    message: string,
+    httpMeta: {
+      response: Response;
+      request: Request;
+      body: string;
+    },
+  ) {
+    super(message);
+    this.statusCode = httpMeta.response.status;
+    this.body = httpMeta.body;
+    this.headers = httpMeta.response.headers;
+    this.contentType = httpMeta.response.headers.get("content-type") || "";
+    this.rawResponse = httpMeta.response;
+
+    this.name = "AgentPlaybooksServiceError";
+  }
+}

package/src/controlplane/models/errors/api-error.ts

@@ -0,0 +1,40 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { AgentPlaybooksServiceError } from "./agent-playbooks-service-error.js";
+
+/** The fallback error class if no more specific error class is matched */
+export class APIError extends AgentPlaybooksServiceError {
+  constructor(
+    message: string,
+    httpMeta: {
+      response: Response;
+      request: Request;
+      body: string;
+    },
+  ) {
+    if (message) {
+      message += `: `;
+    }
+    message += `Status ${httpMeta.response.status}`;
+    const contentType = httpMeta.response.headers.get("content-type") || `""`;
+    if (contentType !== "application/json") {
+      message += ` Content-Type ${
+        contentType.includes(" ") ? `"${contentType}"` : contentType
+      }`;
+    }
+    const body = httpMeta.body || `""`;
+    message += body.length > 100 ? "\n" : ". ";
+    let bodyDisplay = body;
+    if (body.length > 10000) {
+      const truncated = body.substring(0, 10000);
+      const remaining = body.length - 10000;
+      bodyDisplay = `${truncated}...and ${remaining} more chars`;
+    }
+    message += `Body: ${bodyDisplay}`;
+    message = message.trim();
+    super(message, httpMeta);
+    this.name = "APIError";
+  }
+}

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

@@ -0,0 +1,115 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as models from "../index.js";
+import { AgentPlaybooksServiceError } from "./agent-playbooks-service-error.js";
+
+/**
+ * Authentication credentials are missing, malformed, or invalid.
+ */
+export type AuthenticationErrorResponseContentData = {
+  /**
+   * A short, human-readable summary of the problem
+   *
+   * @remarks
+   *                                       type.  It SHOULD NOT change from occurrence to occurrence of the
+   *                                       problem, except for purposes of localization (e.g., using
+   *                                       proactive content negotiation; see [RFC7231], Section 3.4).
+   */
+  title: string;
+  /**
+   * The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
+   */
+  status?: number | undefined;
+  /**
+   * A human-readable explanation specific to this occurrence of the problem.
+   */
+  detail?: string | undefined;
+  /**
+   * A URI reference that identifies the specific occurrence of the problem.  It may or may not yield further information if dereferenced.
+   */
+  instance?: string | undefined;
+  /**
+   * Problem type URI for authentication errors.
+   */
+  type: models.AuthenticationErrorType;
+};
+
+/**
+ * Authentication credentials are missing, malformed, or invalid.
+ */
+export class AuthenticationErrorResponseContent
+  extends AgentPlaybooksServiceError
+{
+  /**
+   * A short, human-readable summary of the problem
+   *
+   * @remarks
+   *                                       type.  It SHOULD NOT change from occurrence to occurrence of the
+   *                                       problem, except for purposes of localization (e.g., using
+   *                                       proactive content negotiation; see [RFC7231], Section 3.4).
+   */
+  title: string;
+  /**
+   * The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
+   */
+  status?: number | undefined;
+  /**
+   * A human-readable explanation specific to this occurrence of the problem.
+   */
+  detail?: string | undefined;
+  /**
+   * A URI reference that identifies the specific occurrence of the problem.  It may or may not yield further information if dereferenced.
+   */
+  instance?: string | undefined;
+  /**
+   * Problem type URI for authentication errors.
+   */
+  type: models.AuthenticationErrorType;
+
+  /** The original data that was passed to this error instance. */
+  data$: AuthenticationErrorResponseContentData;
+
+  constructor(
+    err: AuthenticationErrorResponseContentData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = "message" in err && typeof err.message === "string"
+      ? err.message
+      : `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+    this.title = err.title;
+    if (err.status != null) this.status = err.status;
+    if (err.detail != null) this.detail = err.detail;
+    if (err.instance != null) this.instance = err.instance;
+    this.type = err.type;
+
+    this.name = "AuthenticationErrorResponseContent";
+  }
+}
+
+/** @internal */
+export const AuthenticationErrorResponseContent$inboundSchema: z.ZodType<
+  AuthenticationErrorResponseContent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  title: z.string(),
+  status: z.number().int().default(401),
+  detail: z.string().optional(),
+  instance: z.string().optional(),
+  type: models.AuthenticationErrorType$inboundSchema,
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new AuthenticationErrorResponseContent(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });

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

@@ -0,0 +1,123 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as models from "../index.js";
+import { AgentPlaybooksServiceError } from "./agent-playbooks-service-error.js";
+
+/**
+ * Request validation or input decoding failed.
+ */
+export type BadRequestErrorResponseContentData = {
+  /**
+   * A short, human-readable summary of the problem
+   *
+   * @remarks
+   *                                       type.  It SHOULD NOT change from occurrence to occurrence of the
+   *                                       problem, except for purposes of localization (e.g., using
+   *                                       proactive content negotiation; see [RFC7231], Section 3.4).
+   */
+  title: string;
+  /**
+   * The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
+   */
+  status?: number | undefined;
+  /**
+   * A human-readable explanation specific to this occurrence of the problem.
+   */
+  detail?: string | undefined;
+  /**
+   * A URI reference that identifies the specific occurrence of the problem.  It may or may not yield further information if dereferenced.
+   */
+  instance?: string | undefined;
+  /**
+   * Problem type URI for bad request errors.
+   */
+  type: models.BadRequestErrorType;
+  /**
+   * Optional field-level validation errors.
+   */
+  fields?: Array<models.FieldError> | undefined;
+};
+
+/**
+ * Request validation or input decoding failed.
+ */
+export class BadRequestErrorResponseContent extends AgentPlaybooksServiceError {
+  /**
+   * A short, human-readable summary of the problem
+   *
+   * @remarks
+   *                                       type.  It SHOULD NOT change from occurrence to occurrence of the
+   *                                       problem, except for purposes of localization (e.g., using
+   *                                       proactive content negotiation; see [RFC7231], Section 3.4).
+   */
+  title: string;
+  /**
+   * The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
+   */
+  status?: number | undefined;
+  /**
+   * A human-readable explanation specific to this occurrence of the problem.
+   */
+  detail?: string | undefined;
+  /**
+   * A URI reference that identifies the specific occurrence of the problem.  It may or may not yield further information if dereferenced.
+   */
+  instance?: string | undefined;
+  /**
+   * Problem type URI for bad request errors.
+   */
+  type: models.BadRequestErrorType;
+  /**
+   * Optional field-level validation errors.
+   */
+  fields?: Array<models.FieldError> | undefined;
+
+  /** The original data that was passed to this error instance. */
+  data$: BadRequestErrorResponseContentData;
+
+  constructor(
+    err: BadRequestErrorResponseContentData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = "message" in err && typeof err.message === "string"
+      ? err.message
+      : `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+    this.title = err.title;
+    if (err.status != null) this.status = err.status;
+    if (err.detail != null) this.detail = err.detail;
+    if (err.instance != null) this.instance = err.instance;
+    this.type = err.type;
+    if (err.fields != null) this.fields = err.fields;
+
+    this.name = "BadRequestErrorResponseContent";
+  }
+}
+
+/** @internal */
+export const BadRequestErrorResponseContent$inboundSchema: z.ZodType<
+  BadRequestErrorResponseContent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  title: z.string(),
+  status: z.number().int().default(400),
+  detail: z.string().optional(),
+  instance: z.string().optional(),
+  type: models.BadRequestErrorType$inboundSchema,
+  fields: z.array(models.FieldError$inboundSchema).optional(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new BadRequestErrorResponseContent(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });

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

@@ -0,0 +1,113 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as models from "../index.js";
+import { AgentPlaybooksServiceError } from "./agent-playbooks-service-error.js";
+
+/**
+ * The request conflicts with the current state of the resource.
+ */
+export type ConflictErrorResponseContentData = {
+  /**
+   * A short, human-readable summary of the problem
+   *
+   * @remarks
+   *                                       type.  It SHOULD NOT change from occurrence to occurrence of the
+   *                                       problem, except for purposes of localization (e.g., using
+   *                                       proactive content negotiation; see [RFC7231], Section 3.4).
+   */
+  title: string;
+  /**
+   * The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
+   */
+  status?: number | undefined;
+  /**
+   * A human-readable explanation specific to this occurrence of the problem.
+   */
+  detail?: string | undefined;
+  /**
+   * A URI reference that identifies the specific occurrence of the problem.  It may or may not yield further information if dereferenced.
+   */
+  instance?: string | undefined;
+  /**
+   * Problem type URI for conflict errors.
+   */
+  type: models.ConflictErrorType;
+};
+
+/**
+ * The request conflicts with the current state of the resource.
+ */
+export class ConflictErrorResponseContent extends AgentPlaybooksServiceError {
+  /**
+   * A short, human-readable summary of the problem
+   *
+   * @remarks
+   *                                       type.  It SHOULD NOT change from occurrence to occurrence of the
+   *                                       problem, except for purposes of localization (e.g., using
+   *                                       proactive content negotiation; see [RFC7231], Section 3.4).
+   */
+  title: string;
+  /**
+   * The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
+   */
+  status?: number | undefined;
+  /**
+   * A human-readable explanation specific to this occurrence of the problem.
+   */
+  detail?: string | undefined;
+  /**
+   * A URI reference that identifies the specific occurrence of the problem.  It may or may not yield further information if dereferenced.
+   */
+  instance?: string | undefined;
+  /**
+   * Problem type URI for conflict errors.
+   */
+  type: models.ConflictErrorType;
+
+  /** The original data that was passed to this error instance. */
+  data$: ConflictErrorResponseContentData;
+
+  constructor(
+    err: ConflictErrorResponseContentData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = "message" in err && typeof err.message === "string"
+      ? err.message
+      : `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+    this.title = err.title;
+    if (err.status != null) this.status = err.status;
+    if (err.detail != null) this.detail = err.detail;
+    if (err.instance != null) this.instance = err.instance;
+    this.type = err.type;
+
+    this.name = "ConflictErrorResponseContent";
+  }
+}
+
+/** @internal */
+export const ConflictErrorResponseContent$inboundSchema: z.ZodType<
+  ConflictErrorResponseContent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  title: z.string(),
+  status: z.number().int().default(409),
+  detail: z.string().optional(),
+  instance: z.string().optional(),
+  type: models.ConflictErrorType$inboundSchema,
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new ConflictErrorResponseContent(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });