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

package/src/models/errors/{request-validation-error-response-content.ts → bad-request-error-response-content.ts}

@@ -1,6 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- * @generated-id: 8635d587ec8e
+ * @generated-id: d4108bde3db9
  */
 
 import * as z from "zod/v3";
@@ -8,9 +8,9 @@ import * as models from "../index.js";
 import { PlaybookError } from "./playbook-error.js";
 
 /**
- * One HTTP 400 schema preserves every validation problem type in generated clients.
+ * Request validation or input decoding failed.
  */
-export type RequestValidationErrorResponseContentData = {
+export type BadRequestErrorResponseContentData = {
   /**
    * A short, human-readable summary of the problem
    *
@@ -33,19 +33,19 @@ export type RequestValidationErrorResponseContentData = {
    */
   instance?: string | undefined;
   /**
-   * Machine-readable validation failure; SDKs branch on type, never title text.
+   * Problem type URI for bad request errors.
    */
-  type: models.RequestValidationErrorType;
+  type: models.BadRequestErrorType;
   /**
-   * Optional field-level validation details, as in the shared Iris BadRequestError.
+   * Every invalid request member found, when the failure is about members.
    */
-  fields?: Array<models.FieldError> | undefined;
+  errors?: Array<models.FieldError> | undefined;
 };
 
 /**
- * One HTTP 400 schema preserves every validation problem type in generated clients.
+ * Request validation or input decoding failed.
  */
-export class RequestValidationErrorResponseContent extends PlaybookError {
+export class BadRequestErrorResponseContent extends PlaybookError {
   /**
    * A short, human-readable summary of the problem
    *
@@ -68,19 +68,19 @@ export class RequestValidationErrorResponseContent extends PlaybookError {
    */
   instance?: string | undefined;
   /**
-   * Machine-readable validation failure; SDKs branch on type, never title text.
+   * Problem type URI for bad request errors.
    */
-  type: models.RequestValidationErrorType;
+  type: models.BadRequestErrorType;
   /**
-   * Optional field-level validation details, as in the shared Iris BadRequestError.
+   * Every invalid request member found, when the failure is about members.
    */
-  fields?: Array<models.FieldError> | undefined;
+  errors?: Array<models.FieldError> | undefined;
 
   /** The original data that was passed to this error instance. */
-  data$: RequestValidationErrorResponseContentData;
+  data$: BadRequestErrorResponseContentData;
 
   constructor(
-    err: RequestValidationErrorResponseContentData,
+    err: BadRequestErrorResponseContentData,
     httpMeta: { response: Response; request: Request; body: string },
   ) {
     const message = "message" in err && typeof err.message === "string"
@@ -93,15 +93,15 @@ export class RequestValidationErrorResponseContent extends PlaybookError {
     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;
+    if (err.errors != null) this.errors = err.errors;
 
-    this.name = "RequestValidationErrorResponseContent";
+    this.name = "BadRequestErrorResponseContent";
   }
 }
 
 /** @internal */
-export const RequestValidationErrorResponseContent$inboundSchema: z.ZodType<
-  RequestValidationErrorResponseContent,
+export const BadRequestErrorResponseContent$inboundSchema: z.ZodType<
+  BadRequestErrorResponseContent,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -109,14 +109,14 @@ export const RequestValidationErrorResponseContent$inboundSchema: z.ZodType<
   status: z.number().int().default(400),
   detail: z.string().optional(),
   instance: z.string().optional(),
-  type: models.RequestValidationErrorType$inboundSchema,
-  fields: z.array(models.FieldError$inboundSchema).optional(),
+  type: models.BadRequestErrorType$inboundSchema,
+  errors: z.array(models.FieldError$inboundSchema).optional(),
   request$: z.instanceof(Request),
   response$: z.instanceof(Response),
   body$: z.string(),
 })
   .transform((v) => {
-    return new RequestValidationErrorResponseContent(v, {
+    return new BadRequestErrorResponseContent(v, {
       request: v.request$,
       response: v.response$,
       body: v.body$,

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

@@ -0,0 +1,124 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: c84458e674f0
+ */
+
+import * as z from "zod/v3";
+import * as models from "../index.js";
+import { PlaybookError } from "./playbook-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 ID of the existing resource the request collided with, when the conflict names one.
+   */
+  existingId?: string | undefined;
+};
+
+/**
+ * The request conflicts with the current state of the resource.
+ */
+export class ConflictErrorResponseContent extends PlaybookError {
+  /**
+   * 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 ID of the existing resource the request collided with, when the conflict names one.
+   */
+  existingId?: string | undefined;
+
+  /** 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;
+    if (err.existingId != null) this.existingId = err.existingId;
+
+    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,
+  existingId: z.string().optional(),
+  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$,
+    });
+  });

package/src/models/errors/index.ts

@@ -5,18 +5,19 @@
 
 export * from "./api-error.js";
 export * from "./authentication-error-response-content.js";
+export * from "./bad-request-error-response-content.js";
+export * from "./conflict-error-response-content.js";
 export * from "./failed-dependency-error-response-content.js";
 export * from "./forbidden-error-response-content.js";
 export * from "./http-client-errors.js";
 export * from "./not-found-error-response-content.js";
 export * from "./payload-too-large-error-response-content.js";
-export * from "./playbook-conflict-error-response-content.js";
 export * from "./playbook-error.js";
-export * from "./playbook-internal-error-response-content.js";
-export * from "./playbook-service-unavailable-error-response-content.js";
-export * from "./request-validation-error-response-content.js";
+export * from "./precondition-failed-error-response-content.js";
 export * from "./resource-suspended-error-response-content.js";
 export * from "./response-validation-error.js";
 export * from "./sdk-validation-error.js";
+export * from "./service-unavailable-error-response-content.js";
 export * from "./timeout-error-response-content.js";
 export * from "./too-many-requests-error-response-content.js";
+export * from "./unexpected-error-response-content.js";

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

@@ -0,0 +1,124 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: c5a3f951c055
+ */
+
+import * as z from "zod/v3";
+import * as models from "../index.js";
+import { PlaybookError } from "./playbook-error.js";
+
+/**
+ * The write named an expected revision (expectedRevision or If-Match) that is no longer current. Read the resource again and retry.
+ */
+export type PreconditionFailedErrorResponseContentData = {
+  /**
+   * 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 a write whose expected revision is no longer current. A write guarded by an If-Match header on an HTTP entity tag uses a different type; see the Identity Service API.
+   */
+  type: models.PreconditionFailedErrorType;
+  /**
+   * The resource's current revision, when the service reports it. Read the resource again before retrying; do not send this value back without reading.
+   */
+  currentRevision?: string | undefined;
+};
+
+/**
+ * The write named an expected revision (expectedRevision or If-Match) that is no longer current. Read the resource again and retry.
+ */
+export class PreconditionFailedErrorResponseContent extends PlaybookError {
+  /**
+   * 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 a write whose expected revision is no longer current. A write guarded by an If-Match header on an HTTP entity tag uses a different type; see the Identity Service API.
+   */
+  type: models.PreconditionFailedErrorType;
+  /**
+   * The resource's current revision, when the service reports it. Read the resource again before retrying; do not send this value back without reading.
+   */
+  currentRevision?: string | undefined;
+
+  /** The original data that was passed to this error instance. */
+  data$: PreconditionFailedErrorResponseContentData;
+
+  constructor(
+    err: PreconditionFailedErrorResponseContentData,
+    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.currentRevision != null) this.currentRevision = err.currentRevision;
+
+    this.name = "PreconditionFailedErrorResponseContent";
+  }
+}
+
+/** @internal */
+export const PreconditionFailedErrorResponseContent$inboundSchema: z.ZodType<
+  PreconditionFailedErrorResponseContent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  title: z.string(),
+  status: z.number().int().default(412),
+  detail: z.string().optional(),
+  instance: z.string().optional(),
+  type: models.PreconditionFailedErrorType$inboundSchema,
+  currentRevision: z.string().optional(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new PreconditionFailedErrorResponseContent(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });

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

@@ -0,0 +1,102 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 26f7b5cd64d4
+ */
+
+import * as z from "zod/v3";
+import * as models from "../index.js";
+import { PlaybookError } from "./playbook-error.js";
+
+export type ServiceUnavailableErrorResponseContentData = {
+  /**
+   * 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;
+  type: models.ServiceUnavailableErrorType;
+};
+
+export class ServiceUnavailableErrorResponseContent extends PlaybookError {
+  /**
+   * 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;
+  type: models.ServiceUnavailableErrorType;
+
+  /** The original data that was passed to this error instance. */
+  data$: ServiceUnavailableErrorResponseContentData;
+
+  constructor(
+    err: ServiceUnavailableErrorResponseContentData,
+    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 = "ServiceUnavailableErrorResponseContent";
+  }
+}
+
+/** @internal */
+export const ServiceUnavailableErrorResponseContent$inboundSchema: z.ZodType<
+  ServiceUnavailableErrorResponseContent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  title: z.string(),
+  status: z.number().int().default(503),
+  detail: z.string().optional(),
+  instance: z.string().optional(),
+  type: models.ServiceUnavailableErrorType$inboundSchema,
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new ServiceUnavailableErrorResponseContent(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });

package/src/models/errors/{playbook-internal-error-response-content.ts → unexpected-error-response-content.ts}

@@ -1,6 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- * @generated-id: ab8d40558979
+ * @generated-id: 248d261b1057
  */
 
 import * as z from "zod/v3";
@@ -8,12 +8,9 @@ import * as models from "../index.js";
 import { PlaybookError } from "./playbook-error.js";
 
 /**
- * Stored integrity failures require operator investigation; editing or blindly
- *
- * @remarks
- * retrying the request does not repair the stored record.
+ * The service failed with an unexpected internal error.
  */
-export type PlaybookInternalErrorResponseContentData = {
+export type UnexpectedErrorResponseContentData = {
   /**
    * A short, human-readable summary of the problem
    *
@@ -36,18 +33,15 @@ export type PlaybookInternalErrorResponseContentData = {
    */
   instance?: string | undefined;
   /**
-   * Server faults are distinct from correctable resource-state conflicts.
+   * Problem type URI for unexpected internal errors.
    */
-  type: models.PlaybookInternalErrorType;
+  type: models.UnexpectedErrorType;
 };
 
 /**
- * Stored integrity failures require operator investigation; editing or blindly
- *
- * @remarks
- * retrying the request does not repair the stored record.
+ * The service failed with an unexpected internal error.
  */
-export class PlaybookInternalErrorResponseContent extends PlaybookError {
+export class UnexpectedErrorResponseContent extends PlaybookError {
   /**
    * A short, human-readable summary of the problem
    *
@@ -70,15 +64,15 @@ export class PlaybookInternalErrorResponseContent extends PlaybookError {
    */
   instance?: string | undefined;
   /**
-   * Server faults are distinct from correctable resource-state conflicts.
+   * Problem type URI for unexpected internal errors.
    */
-  type: models.PlaybookInternalErrorType;
+  type: models.UnexpectedErrorType;
 
   /** The original data that was passed to this error instance. */
-  data$: PlaybookInternalErrorResponseContentData;
+  data$: UnexpectedErrorResponseContentData;
 
   constructor(
-    err: PlaybookInternalErrorResponseContentData,
+    err: UnexpectedErrorResponseContentData,
     httpMeta: { response: Response; request: Request; body: string },
   ) {
     const message = "message" in err && typeof err.message === "string"
@@ -92,13 +86,13 @@ export class PlaybookInternalErrorResponseContent extends PlaybookError {
     if (err.instance != null) this.instance = err.instance;
     this.type = err.type;
 
-    this.name = "PlaybookInternalErrorResponseContent";
+    this.name = "UnexpectedErrorResponseContent";
   }
 }
 
 /** @internal */
-export const PlaybookInternalErrorResponseContent$inboundSchema: z.ZodType<
-  PlaybookInternalErrorResponseContent,
+export const UnexpectedErrorResponseContent$inboundSchema: z.ZodType<
+  UnexpectedErrorResponseContent,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -106,13 +100,13 @@ export const PlaybookInternalErrorResponseContent$inboundSchema: z.ZodType<
   status: z.number().int().default(500),
   detail: z.string().optional(),
   instance: z.string().optional(),
-  type: models.PlaybookInternalErrorType$inboundSchema,
+  type: models.UnexpectedErrorType$inboundSchema,
   request$: z.instanceof(Request),
   response$: z.instanceof(Response),
   body$: z.string(),
 })
   .transform((v) => {
-    return new PlaybookInternalErrorResponseContent(v, {
+    return new UnexpectedErrorResponseContent(v, {
       request: v.request$,
       response: v.response$,
       body: v.body$,

package/src/models/failed-dependency-error-type.ts

@@ -13,6 +13,8 @@ import { OpenEnum } from "../types/enums.js";
 export const FailedDependencyErrorType = {
   RootErrorsResourceUnavailable: "/errors/resource-unavailable",
   RootErrorsDatabaseOutOfMemory: "/errors/database-out-of-memory",
+  RootErrorsInvalidModelCredentials: "/errors/invalid-model-credentials",
+  RootErrorsModelQuotaExceeded: "/errors/model-quota-exceeded",
 } as const;
 /**
  * Problem type URI for failed-dependency errors.

package/src/models/field-error.ts

@@ -9,21 +9,21 @@ import { Result as SafeParseResult } from "../types/fp.js";
 import { SDKValidationError } from "./errors/sdk-validation-error.js";
 
 /**
- * Validation error details for a single request field.
+ * One invalid request member. A body member is named by `pointer`, a path or query parameter by `parameter`; exactly one of the two is present.
  */
 export type FieldError = {
   /**
-   * Name of the invalid request field.
+   * JSON Pointer (RFC 6901) to the invalid body member, such as `/vectorSpace/dimensions`.
    */
-  field: string;
+  pointer?: string | undefined;
   /**
-   * Validation rule that was violated.
+   * Name of the invalid path or query parameter, such as `limit`.
    */
-  rule: string;
+  parameter?: string | undefined;
   /**
-   * Human-readable validation error message.
+   * What is wrong with the member, in fixed words about the rule it broke, never the rejected value.
    */
-  message: string;
+  detail: string;
 };
 
 /** @internal */
@@ -32,9 +32,9 @@ export const FieldError$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  field: z.string(),
-  rule: z.string(),
-  message: z.string(),
+  pointer: z.string().optional(),
+  parameter: z.string().optional(),
+  detail: z.string(),
 });
 
 export function fieldErrorFromJSON(

package/src/models/get-faq-response-content.ts

@@ -19,7 +19,7 @@ export type GetFaqResponseContent = {
    * Optional Playbook-unique immutable human-readable entry key.
    */
   entryKey?: string | undefined;
-  entryType: EntryType;
+  kind: EntryType;
   /**
    * Newest immutable version number. Versions are append-only, so this also equals the version count.
    */
@@ -43,7 +43,7 @@ export const GetFaqResponseContent$inboundSchema: z.ZodType<
 > = z.object({
   entryId: z.string(),
   entryKey: z.string().optional(),
-  entryType: EntryType$inboundSchema,
+  kind: EntryType$inboundSchema,
   latestVersion: z.number().int(),
   publication: Publication$inboundSchema.optional(),
   createdAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),

package/src/models/get-faq-version-response-content.ts

@@ -18,7 +18,7 @@ export type GetFaqVersionResponseContent = {
    * Opaque stable entry identifier.
    */
   entryId: string;
-  entryType: EntryType;
+  entryKind: EntryType;
   version: number;
   /**
    * UTC timestamp resolved to microsecond precision.
@@ -41,7 +41,7 @@ export const GetFaqVersionResponseContent$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   entryId: z.string(),
-  entryType: EntryType$inboundSchema,
+  entryKind: EntryType$inboundSchema,
   version: z.number().int(),
   createdAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),
   contentDigest: z.string(),