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

package/src/controlplane/models/errors/resource-suspended-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 { PlaybookServiceError } from "./playbook-service-error.js";
+
+/**
+ * The requested resource exists but is suspended by an administrator.
+ */
+export type ResourceSuspendedErrorResponseContentData = {
+  /**
+   * 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 suspended resources.
+   */
+  type: models.ResourceSuspendedErrorType;
+};
+
+/**
+ * The requested resource exists but is suspended by an administrator.
+ */
+export class ResourceSuspendedErrorResponseContent
+  extends PlaybookServiceError
+{
+  /**
+   * 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 suspended resources.
+   */
+  type: models.ResourceSuspendedErrorType;
+
+  /** The original data that was passed to this error instance. */
+  data$: ResourceSuspendedErrorResponseContentData;
+
+  constructor(
+    err: ResourceSuspendedErrorResponseContentData,
+    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 = "ResourceSuspendedErrorResponseContent";
+  }
+}
+
+/** @internal */
+export const ResourceSuspendedErrorResponseContent$inboundSchema: z.ZodType<
+  ResourceSuspendedErrorResponseContent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  title: z.string(),
+  status: z.number().int().default(423),
+  detail: z.string().optional(),
+  instance: z.string().optional(),
+  type: models.ResourceSuspendedErrorType$inboundSchema,
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new ResourceSuspendedErrorResponseContent(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });

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

@@ -0,0 +1,50 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { PlaybookServiceError } from "./playbook-service-error.js";
+import { formatZodError } from "./sdk-validation-error.js";
+
+export class ResponseValidationError extends PlaybookServiceError {
+  /**
+   * The raw value that failed validation.
+   */
+  public readonly rawValue: unknown;
+
+  /**
+   * The raw message that failed validation.
+   */
+  public readonly rawMessage: unknown;
+
+  constructor(
+    message: string,
+    extra: {
+      response: Response;
+      request: Request;
+      body: string;
+      cause: unknown;
+      rawValue: unknown;
+      rawMessage: unknown;
+    },
+  ) {
+    super(message, extra);
+    this.name = "ResponseValidationError";
+    this.cause = extra.cause;
+    this.rawValue = extra.rawValue;
+    this.rawMessage = extra.rawMessage;
+  }
+
+  /**
+   * Return a pretty-formatted error message if the underlying validation error
+   * is a ZodError or some other recognized error type, otherwise return the
+   * default error message.
+   */
+  public pretty(): string {
+    if (this.cause instanceof z.ZodError) {
+      return `${this.rawMessage}\n${formatZodError(this.cause)}`;
+    } else {
+      return this.toString();
+    }
+  }
+}

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

@@ -0,0 +1,109 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export class SDKValidationError extends Error {
+  /**
+   * The raw value that failed validation.
+   */
+  public readonly rawValue: unknown;
+
+  /**
+   * The raw message that failed validation.
+   */
+  public readonly rawMessage: unknown;
+
+  // Allows for backwards compatibility for `instanceof` checks of `ResponseValidationError`
+  static override [Symbol.hasInstance](
+    instance: unknown,
+  ): instance is SDKValidationError {
+    if (!(instance instanceof Error)) return false;
+    if (!("rawValue" in instance)) return false;
+    if (!("rawMessage" in instance)) return false;
+    if (!("pretty" in instance)) return false;
+    if (typeof instance.pretty !== "function") return false;
+    return true;
+  }
+
+  constructor(message: string, cause: unknown, rawValue: unknown) {
+    super(`${message}: ${cause}`);
+    this.name = "SDKValidationError";
+    this.cause = cause;
+    this.rawValue = rawValue;
+    this.rawMessage = message;
+  }
+
+  /**
+   * Return a pretty-formatted error message if the underlying validation error
+   * is a ZodError or some other recognized error type, otherwise return the
+   * default error message.
+   */
+  public pretty(): string {
+    if (this.cause instanceof z.ZodError) {
+      return `${this.rawMessage}\n${formatZodError(this.cause)}`;
+    } else {
+      return this.toString();
+    }
+  }
+}
+
+export function formatZodError(err: z.ZodError, level = 0): string {
+  let pre = "  ".repeat(level);
+  pre = level > 0 ? `│${pre}` : pre;
+  pre += " ".repeat(level);
+
+  let message = "";
+  const append = (str: string) => (message += `\n${pre}${str}`);
+
+  const len = err.issues.length;
+  const headline = len === 1 ? `${len} issue found` : `${len} issues found`;
+
+  if (len) {
+    append(`┌ ${headline}:`);
+  }
+
+  for (const issue of err.issues) {
+    let path = issue.path.join(".");
+    path = path ? `<root>.${path}` : "<root>";
+    append(`│ • [${path}]: ${issue.message} (${issue.code})`);
+    switch (issue.code) {
+      case "invalid_literal":
+      case "invalid_type": {
+        append(`│     Want: ${issue.expected}`);
+        append(`│      Got: ${issue.received}`);
+        break;
+      }
+      case "unrecognized_keys": {
+        append(`│     Keys: ${issue.keys.join(", ")}`);
+        break;
+      }
+      case "invalid_enum_value": {
+        append(`│     Allowed: ${issue.options.join(", ")}`);
+        append(`│         Got: ${issue.received}`);
+        break;
+      }
+      case "invalid_union_discriminator": {
+        append(`│     Allowed: ${issue.options.join(", ")}`);
+        break;
+      }
+      case "invalid_union": {
+        const len = issue.unionErrors.length;
+        append(
+          `│   ✖︎ Attemped to deserialize into one of ${len} union members:`,
+        );
+        issue.unionErrors.forEach((err, i) => {
+          append(`│   ✖︎ Member ${i + 1} of ${len}`);
+          append(`${formatZodError(err, level + 1)}`);
+        });
+      }
+    }
+  }
+
+  if (err.issues.length) {
+    append(`└─*`);
+  }
+
+  return message.slice(1);
+}

package/src/controlplane/models/errors/timeout-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 { PlaybookServiceError } from "./playbook-service-error.js";
+
+/**
+ * The request timed out before the service could complete it.
+ */
+export type TimeoutErrorResponseContentData = {
+  /**
+   * 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 timeout errors.
+   */
+  type: models.TimeoutErrorType;
+};
+
+/**
+ * The request timed out before the service could complete it.
+ */
+export class TimeoutErrorResponseContent extends PlaybookServiceError {
+  /**
+   * 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 timeout errors.
+   */
+  type: models.TimeoutErrorType;
+
+  /** The original data that was passed to this error instance. */
+  data$: TimeoutErrorResponseContentData;
+
+  constructor(
+    err: TimeoutErrorResponseContentData,
+    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 = "TimeoutErrorResponseContent";
+  }
+}
+
+/** @internal */
+export const TimeoutErrorResponseContent$inboundSchema: z.ZodType<
+  TimeoutErrorResponseContent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  title: z.string(),
+  status: z.number().int().default(408),
+  detail: z.string().optional(),
+  instance: z.string().optional(),
+  type: models.TimeoutErrorType$inboundSchema,
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new TimeoutErrorResponseContent(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });

package/src/controlplane/models/errors/unexpected-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 { PlaybookServiceError } from "./playbook-service-error.js";
+
+/**
+ * The service failed with an unexpected internal error.
+ */
+export type UnexpectedErrorResponseContentData = {
+  /**
+   * 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 unexpected internal errors.
+   */
+  type: models.UnexpectedErrorType;
+};
+
+/**
+ * The service failed with an unexpected internal error.
+ */
+export class UnexpectedErrorResponseContent extends PlaybookServiceError {
+  /**
+   * 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 unexpected internal errors.
+   */
+  type: models.UnexpectedErrorType;
+
+  /** The original data that was passed to this error instance. */
+  data$: UnexpectedErrorResponseContentData;
+
+  constructor(
+    err: UnexpectedErrorResponseContentData,
+    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 = "UnexpectedErrorResponseContent";
+  }
+}
+
+/** @internal */
+export const UnexpectedErrorResponseContent$inboundSchema: z.ZodType<
+  UnexpectedErrorResponseContent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  title: z.string(),
+  status: z.number().int().default(500),
+  detail: z.string().optional(),
+  instance: z.string().optional(),
+  type: models.UnexpectedErrorType$inboundSchema,
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new UnexpectedErrorResponseContent(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });

package/src/controlplane/models/extraction-binding-source.ts

@@ -0,0 +1,63 @@
+/*
+ * 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 {
+  ExtractionSourceType,
+  ExtractionSourceType$inboundSchema,
+  ExtractionSourceType$outboundSchema,
+} from "./extraction-source-type.js";
+
+/**
+ * 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.
+ */
+export type ExtractionBindingSource = {
+  storeId: string;
+  type: ExtractionSourceType;
+};
+
+/** @internal */
+export const ExtractionBindingSource$inboundSchema: z.ZodType<
+  ExtractionBindingSource,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  storeId: z.string(),
+  type: ExtractionSourceType$inboundSchema,
+});
+/** @internal */
+export type ExtractionBindingSource$Outbound = {
+  storeId: string;
+  type: string;
+};
+
+/** @internal */
+export const ExtractionBindingSource$outboundSchema: z.ZodType<
+  ExtractionBindingSource$Outbound,
+  z.ZodTypeDef,
+  ExtractionBindingSource
+> = z.object({
+  storeId: z.string(),
+  type: ExtractionSourceType$outboundSchema,
+});
+
+export function extractionBindingSourceToJSON(
+  extractionBindingSource: ExtractionBindingSource,
+): string {
+  return JSON.stringify(
+    ExtractionBindingSource$outboundSchema.parse(extractionBindingSource),
+  );
+}
+export function extractionBindingSourceFromJSON(
+  jsonString: string,
+): SafeParseResult<ExtractionBindingSource, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ExtractionBindingSource$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ExtractionBindingSource' from JSON`,
+  );
+}

package/src/controlplane/models/extraction-binding-status.ts

@@ -0,0 +1,22 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../types/enums.js";
+import { OpenEnum } from "../types/enums.js";
+
+export const ExtractionBindingStatus = {
+  Preparing: "preparing",
+  Ready: "ready",
+  Blocked: "blocked",
+  Deleting: "deleting",
+} as const;
+export type ExtractionBindingStatus = OpenEnum<typeof ExtractionBindingStatus>;
+
+/** @internal */
+export const ExtractionBindingStatus$inboundSchema: z.ZodType<
+  ExtractionBindingStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ExtractionBindingStatus);

package/src/controlplane/models/extraction-binding.ts

@@ -0,0 +1,85 @@
+/*
+ * 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 ExtractionBinding = {
+  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 ExtractionBinding$inboundSchema: z.ZodType<
+  ExtractionBinding,
+  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 extractionBindingFromJSON(
+  jsonString: string,
+): SafeParseResult<ExtractionBinding, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ExtractionBinding$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ExtractionBinding' from JSON`,
+  );
+}

package/src/controlplane/models/extraction-conflict-error-type.ts

@@ -0,0 +1,22 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../types/enums.js";
+import { OpenEnum } from "../types/enums.js";
+
+export const ExtractionConflictErrorType = {
+  RootErrorsConflict: "/errors/conflict",
+  RootErrorsExtractionDisabled: "/errors/extraction-disabled",
+} as const;
+export type ExtractionConflictErrorType = OpenEnum<
+  typeof ExtractionConflictErrorType
+>;
+
+/** @internal */
+export const ExtractionConflictErrorType$inboundSchema: z.ZodType<
+  ExtractionConflictErrorType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ExtractionConflictErrorType);