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

package/src/controlplane/lib/url.ts

@@ -0,0 +1,35 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+const hasOwn = Object.prototype.hasOwnProperty;
+
+export type Params = Partial<Record<string, string | number>>;
+
+export function pathToFunc(
+  pathPattern: string,
+  options?: { charEncoding?: "percent" | "none" },
+): (params?: Params) => string {
+  const paramRE = /\{([a-zA-Z0-9_][a-zA-Z0-9_-]*?)\}/g;
+
+  return function buildURLPath(params: Record<string, unknown> = {}): string {
+    return pathPattern
+      .replace(paramRE, function (_, placeholder) {
+        if (!hasOwn.call(params, placeholder)) {
+          throw new Error(`Parameter '${placeholder}' is required`);
+        }
+
+        const value = params[placeholder];
+        if (typeof value !== "string" && typeof value !== "number") {
+          throw new Error(
+            `Parameter '${placeholder}' must be a string or number`,
+          );
+        }
+
+        return options?.charEncoding === "percent"
+          ? encodeURIComponent(`${value}`)
+          : `${value}`;
+      })
+      .replace(/^\/+/, "");
+  };
+}

package/src/controlplane/models/authentication-error-type.ts

@@ -0,0 +1,24 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../types/enums.js";
+
+/**
+ * Problem type URI for authentication errors.
+ */
+export const AuthenticationErrorType = {
+  RootErrorsAuthenticationFailed: "/errors/authentication-failed",
+} as const;
+/**
+ * Problem type URI for authentication errors.
+ */
+export type AuthenticationErrorType = ClosedEnum<
+  typeof AuthenticationErrorType
+>;
+
+/** @internal */
+export const AuthenticationErrorType$inboundSchema: z.ZodNativeEnum<
+  typeof AuthenticationErrorType
+> = z.nativeEnum(AuthenticationErrorType);

package/src/controlplane/models/bad-request-error-type.ts

@@ -0,0 +1,22 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../types/enums.js";
+
+/**
+ * Problem type URI for bad request errors.
+ */
+export const BadRequestErrorType = {
+  RootErrorsInvalidData: "/errors/invalid-data",
+} as const;
+/**
+ * Problem type URI for bad request errors.
+ */
+export type BadRequestErrorType = ClosedEnum<typeof BadRequestErrorType>;
+
+/** @internal */
+export const BadRequestErrorType$inboundSchema: z.ZodNativeEnum<
+  typeof BadRequestErrorType
+> = z.nativeEnum(BadRequestErrorType);

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

@@ -0,0 +1,34 @@
+/*
+ * 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";
+
+export type ClearPlaybookResponseContent = {
+  /**
+   * Entry families removed by this attempt. Proposal-only clear returns zero. Partial failures may already have removed content even though no successful response is returned.
+   */
+  deletedEntriesCount: number;
+};
+
+/** @internal */
+export const ClearPlaybookResponseContent$inboundSchema: z.ZodType<
+  ClearPlaybookResponseContent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  deletedEntriesCount: z.number().int(),
+});
+
+export function clearPlaybookResponseContentFromJSON(
+  jsonString: string,
+): SafeParseResult<ClearPlaybookResponseContent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ClearPlaybookResponseContent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ClearPlaybookResponseContent' from JSON`,
+  );
+}

package/src/controlplane/models/clear-scope.ts

@@ -0,0 +1,17 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../types/enums.js";
+
+export const ClearScope = {
+  All: "all",
+  Entries: "entries",
+  Proposals: "proposals",
+} as const;
+export type ClearScope = ClosedEnum<typeof ClearScope>;
+
+/** @internal */
+export const ClearScope$outboundSchema: z.ZodNativeEnum<typeof ClearScope> = z
+  .nativeEnum(ClearScope);

package/src/controlplane/models/cloud-database.ts

@@ -0,0 +1,54 @@
+/*
+ * 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";
+
+/**
+ * Account-owned database metadata. Credentials and Redis URLs are never returned.
+ */
+export type CloudDatabase = {
+  id: string;
+  name: string;
+  subscriptionId?: string | undefined;
+  databaseProvider?: string | undefined;
+  databaseRegion?: string | undefined;
+  planType?: string | undefined;
+  accessCidrs?: Array<string> | undefined;
+  isCPAccessible: boolean;
+  isEligible: boolean;
+  isReady: boolean;
+  tlsEnabled?: boolean | undefined;
+};
+
+/** @internal */
+export const CloudDatabase$inboundSchema: z.ZodType<
+  CloudDatabase,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  name: z.string(),
+  subscriptionId: z.string().optional(),
+  databaseProvider: z.string().optional(),
+  databaseRegion: z.string().optional(),
+  planType: z.string().optional(),
+  accessCidrs: z.array(z.string()).optional(),
+  isCPAccessible: z.boolean(),
+  isEligible: z.boolean(),
+  isReady: z.boolean(),
+  tlsEnabled: z.boolean().optional(),
+});
+
+export function cloudDatabaseFromJSON(
+  jsonString: string,
+): SafeParseResult<CloudDatabase, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CloudDatabase$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CloudDatabase' from JSON`,
+  );
+}

package/src/controlplane/models/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 { ClosedEnum } from "../types/enums.js";
+
+/**
+ * Problem type URI for conflict errors.
+ */
+export const ConflictErrorType = {
+  RootErrorsConflict: "/errors/conflict",
+} as const;
+/**
+ * Problem type URI for conflict errors.
+ */
+export type ConflictErrorType = ClosedEnum<typeof ConflictErrorType>;
+
+/** @internal */
+export const ConflictErrorType$inboundSchema: z.ZodNativeEnum<
+  typeof ConflictErrorType
+> = z.nativeEnum(ConflictErrorType);

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

@@ -0,0 +1,52 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  ExtractionBindingSource,
+  ExtractionBindingSource$Outbound,
+  ExtractionBindingSource$outboundSchema,
+} from "./extraction-binding-source.js";
+import {
+  ExtractionJobConfiguration,
+  ExtractionJobConfiguration$Outbound,
+  ExtractionJobConfiguration$outboundSchema,
+} from "./extraction-job-configuration.js";
+
+export type CreateExtractionBindingRequestContent = {
+  /**
+   * 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;
+  /**
+   * 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.
+   */
+  job: ExtractionJobConfiguration;
+};
+
+/** @internal */
+export type CreateExtractionBindingRequestContent$Outbound = {
+  source: ExtractionBindingSource$Outbound;
+  job: ExtractionJobConfiguration$Outbound;
+};
+
+/** @internal */
+export const CreateExtractionBindingRequestContent$outboundSchema: z.ZodType<
+  CreateExtractionBindingRequestContent$Outbound,
+  z.ZodTypeDef,
+  CreateExtractionBindingRequestContent
+> = z.object({
+  source: ExtractionBindingSource$outboundSchema,
+  job: ExtractionJobConfiguration$outboundSchema,
+});
+
+export function createExtractionBindingRequestContentToJSON(
+  createExtractionBindingRequestContent: CreateExtractionBindingRequestContent,
+): string {
+  return JSON.stringify(
+    CreateExtractionBindingRequestContent$outboundSchema.parse(
+      createExtractionBindingRequestContent,
+    ),
+  );
+}

package/src/controlplane/models/create-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 CreateExtractionBindingResponseContent = {
+  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 CreateExtractionBindingResponseContent$inboundSchema: z.ZodType<
+  CreateExtractionBindingResponseContent,
+  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 createExtractionBindingResponseContentFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateExtractionBindingResponseContent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      CreateExtractionBindingResponseContent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateExtractionBindingResponseContent' from JSON`,
+  );
+}

package/src/controlplane/models/create-playbook-request-content.ts

@@ -0,0 +1,83 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  DiscoveryConfig,
+  DiscoveryConfig$Outbound,
+  DiscoveryConfig$outboundSchema,
+} from "./discovery-config.js";
+import {
+  EmbeddingConfig,
+  EmbeddingConfig$Outbound,
+  EmbeddingConfig$outboundSchema,
+} from "./embedding-config.js";
+import {
+  ModelSelection,
+  ModelSelection$Outbound,
+  ModelSelection$outboundSchema,
+} from "./model-selection.js";
+import {
+  ProposalPolicy,
+  ProposalPolicy$Outbound,
+  ProposalPolicy$outboundSchema,
+} from "./proposal-policy.js";
+
+export type CreatePlaybookRequestContent = {
+  /**
+   * Existing SM Cloud database ID. Required in Neptune; omitted for on-prem storage.
+   */
+  databaseId?: string | undefined;
+  name: string;
+  /**
+   * Create-only embedding identity for a Playbook.
+   */
+  embedding: EmbeddingConfig;
+  /**
+   * Playbook-owned discovery policy.
+   */
+  discovery?: DiscoveryConfig | undefined;
+  /**
+   * Playbook-owned proposal lifecycle and Inbox policy.
+   */
+  proposalPolicy?: ProposalPolicy | undefined;
+  /**
+   * Cloud only. Extraction model provider and model. Omit llm on create to use the deployment default; omit it on update to preserve the selection. On-prem deployments do not accept this field.
+   */
+  llm?: ModelSelection | undefined;
+};
+
+/** @internal */
+export type CreatePlaybookRequestContent$Outbound = {
+  databaseId?: string | undefined;
+  name: string;
+  embedding: EmbeddingConfig$Outbound;
+  discovery?: DiscoveryConfig$Outbound | undefined;
+  proposalPolicy?: ProposalPolicy$Outbound | undefined;
+  llm?: ModelSelection$Outbound | undefined;
+};
+
+/** @internal */
+export const CreatePlaybookRequestContent$outboundSchema: z.ZodType<
+  CreatePlaybookRequestContent$Outbound,
+  z.ZodTypeDef,
+  CreatePlaybookRequestContent
+> = z.object({
+  databaseId: z.string().optional(),
+  name: z.string(),
+  embedding: EmbeddingConfig$outboundSchema,
+  discovery: DiscoveryConfig$outboundSchema.optional(),
+  proposalPolicy: ProposalPolicy$outboundSchema.optional(),
+  llm: ModelSelection$outboundSchema.optional(),
+});
+
+export function createPlaybookRequestContentToJSON(
+  createPlaybookRequestContent: CreatePlaybookRequestContent,
+): string {
+  return JSON.stringify(
+    CreatePlaybookRequestContent$outboundSchema.parse(
+      createPlaybookRequestContent,
+    ),
+  );
+}

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

@@ -0,0 +1,105 @@
+/*
+ * 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 {
+  DataPlaneEndpoint,
+  DataPlaneEndpoint$inboundSchema,
+} from "./data-plane-endpoint.js";
+import {
+  DatabaseBinding,
+  DatabaseBinding$inboundSchema,
+} from "./database-binding.js";
+import {
+  DiscoveryConfig,
+  DiscoveryConfig$inboundSchema,
+} from "./discovery-config.js";
+import {
+  EffectiveModelSelection,
+  EffectiveModelSelection$inboundSchema,
+} from "./effective-model-selection.js";
+import {
+  EmbeddingConfig,
+  EmbeddingConfig$inboundSchema,
+} from "./embedding-config.js";
+import { SDKValidationError } from "./errors/sdk-validation-error.js";
+import {
+  PlaybookState,
+  PlaybookState$inboundSchema,
+} from "./playbook-state.js";
+import {
+  ProposalPolicy,
+  ProposalPolicy$inboundSchema,
+} from "./proposal-policy.js";
+
+export type CreatePlaybookResponseContent = {
+  endpoints?: Array<DataPlaneEndpoint> | undefined;
+  /**
+   * Cloud only. Effective extraction model provider and model, including whether the selection is inherited. On-prem responses omit llm.
+   */
+  llm?: EffectiveModelSelection | undefined;
+  /**
+   * Create-only SM database identity. Connection endpoints and credentials remain internal.
+   */
+  databaseBinding?: DatabaseBinding | undefined;
+  /**
+   * Opaque Playbook identifier.
+   */
+  playbookId: string;
+  tenantId: string;
+  name: string;
+  state: PlaybookState;
+  /**
+   * Create-only embedding identity for a Playbook.
+   */
+  embedding: EmbeddingConfig;
+  /**
+   * Playbook-owned discovery policy.
+   */
+  discovery: DiscoveryConfig;
+  /**
+   * Playbook-owned proposal lifecycle and Inbox policy.
+   */
+  proposalPolicy: ProposalPolicy;
+  /**
+   * UTC timestamp resolved to microsecond precision.
+   */
+  createdAt: Date;
+  /**
+   * UTC timestamp resolved to microsecond precision.
+   */
+  updatedAt: Date;
+};
+
+/** @internal */
+export const CreatePlaybookResponseContent$inboundSchema: z.ZodType<
+  CreatePlaybookResponseContent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  endpoints: z.array(DataPlaneEndpoint$inboundSchema).optional(),
+  llm: EffectiveModelSelection$inboundSchema.optional(),
+  databaseBinding: DatabaseBinding$inboundSchema.optional(),
+  playbookId: z.string(),
+  tenantId: z.string(),
+  name: z.string(),
+  state: PlaybookState$inboundSchema,
+  embedding: EmbeddingConfig$inboundSchema,
+  discovery: DiscoveryConfig$inboundSchema,
+  proposalPolicy: ProposalPolicy$inboundSchema,
+  createdAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  updatedAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+});
+
+export function createPlaybookResponseContentFromJSON(
+  jsonString: string,
+): SafeParseResult<CreatePlaybookResponseContent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreatePlaybookResponseContent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreatePlaybookResponseContent' from JSON`,
+  );
+}

package/src/controlplane/models/data-plane-endpoint.ts

@@ -0,0 +1,42 @@
+/*
+ * 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";
+
+/**
+ * A public data plane API endpoint and its database network accessibility.
+ */
+export type DataPlaneEndpoint = {
+  url: string;
+  provider: string;
+  region: string;
+  egressIps?: Array<string> | undefined;
+  isAccessible: boolean;
+};
+
+/** @internal */
+export const DataPlaneEndpoint$inboundSchema: z.ZodType<
+  DataPlaneEndpoint,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  url: z.string(),
+  provider: z.string(),
+  region: z.string(),
+  egressIps: z.array(z.string()).optional(),
+  isAccessible: z.boolean(),
+});
+
+export function dataPlaneEndpointFromJSON(
+  jsonString: string,
+): SafeParseResult<DataPlaneEndpoint, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DataPlaneEndpoint$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DataPlaneEndpoint' from JSON`,
+  );
+}

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

@@ -0,0 +1,44 @@
+/*
+ * 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 SM database identity. Connection endpoints and credentials remain internal.
+ */
+export type DatabaseBinding = {
+  name?: string | undefined;
+  accessCidrs?: Array<string> | undefined;
+  subscriptionId: string;
+  databaseId: string;
+  provider: string;
+  region: string;
+};
+
+/** @internal */
+export const DatabaseBinding$inboundSchema: z.ZodType<
+  DatabaseBinding,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string().optional(),
+  accessCidrs: z.array(z.string()).optional(),
+  subscriptionId: z.string(),
+  databaseId: z.string(),
+  provider: z.string(),
+  region: z.string(),
+});
+
+export function databaseBindingFromJSON(
+  jsonString: string,
+): SafeParseResult<DatabaseBinding, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DatabaseBinding$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DatabaseBinding' from JSON`,
+  );
+}