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

package/src/controlplane/models/operations/update-playbook.ts

@@ -0,0 +1,38 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as models from "../index.js";
+
+export type UpdatePlaybookRequest = {
+  /**
+   * Opaque Playbook identifier.
+   */
+  playbookId: string;
+  body?: models.UpdatePlaybookRequestContent | undefined;
+};
+
+/** @internal */
+export type UpdatePlaybookRequest$Outbound = {
+  playbookId: string;
+  body?: models.UpdatePlaybookRequestContent$Outbound | undefined;
+};
+
+/** @internal */
+export const UpdatePlaybookRequest$outboundSchema: z.ZodType<
+  UpdatePlaybookRequest$Outbound,
+  z.ZodTypeDef,
+  UpdatePlaybookRequest
+> = z.object({
+  playbookId: z.string(),
+  body: models.UpdatePlaybookRequestContent$outboundSchema.optional(),
+});
+
+export function updatePlaybookRequestToJSON(
+  updatePlaybookRequest: UpdatePlaybookRequest,
+): string {
+  return JSON.stringify(
+    UpdatePlaybookRequest$outboundSchema.parse(updatePlaybookRequest),
+  );
+}

package/src/controlplane/models/playbook-service-unavailable-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 PlaybookServiceUnavailableErrorType = {
+  RootErrorsServiceUnavailable: "/errors/service-unavailable",
+  RootErrorsPlaybookNotReady: "/errors/playbook-not-ready",
+} as const;
+export type PlaybookServiceUnavailableErrorType = OpenEnum<
+  typeof PlaybookServiceUnavailableErrorType
+>;
+
+/** @internal */
+export const PlaybookServiceUnavailableErrorType$inboundSchema: z.ZodType<
+  PlaybookServiceUnavailableErrorType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PlaybookServiceUnavailableErrorType);

package/src/controlplane/models/playbook-state.ts

@@ -0,0 +1,23 @@
+/*
+ * 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 PlaybookState = {
+  Provisioning: "provisioning",
+  Ready: "ready",
+  Failed: "failed",
+  Suspended: "suspended",
+  Deleting: "deleting",
+} as const;
+export type PlaybookState = OpenEnum<typeof PlaybookState>;
+
+/** @internal */
+export const PlaybookState$inboundSchema: z.ZodType<
+  PlaybookState,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PlaybookState);

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

package/src/controlplane/models/proposal-policy.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";
+
+/**
+ * Playbook-owned proposal lifecycle and Inbox policy.
+ */
+export type ProposalPolicy = {
+  reviewWindowSeconds: number;
+  maxOpenProposals: number;
+};
+
+/** @internal */
+export const ProposalPolicy$inboundSchema: z.ZodType<
+  ProposalPolicy,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  reviewWindowSeconds: z.number().int(),
+  maxOpenProposals: z.number().int(),
+});
+/** @internal */
+export type ProposalPolicy$Outbound = {
+  reviewWindowSeconds: number;
+  maxOpenProposals: number;
+};
+
+/** @internal */
+export const ProposalPolicy$outboundSchema: z.ZodType<
+  ProposalPolicy$Outbound,
+  z.ZodTypeDef,
+  ProposalPolicy
+> = z.object({
+  reviewWindowSeconds: z.number().int(),
+  maxOpenProposals: z.number().int(),
+});
+
+export function proposalPolicyToJSON(proposalPolicy: ProposalPolicy): string {
+  return JSON.stringify(ProposalPolicy$outboundSchema.parse(proposalPolicy));
+}
+export function proposalPolicyFromJSON(
+  jsonString: string,
+): SafeParseResult<ProposalPolicy, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ProposalPolicy$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProposalPolicy' from JSON`,
+  );
+}

package/src/controlplane/models/put-model-credential-request-content.ts

@@ -0,0 +1,33 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type PutModelCredentialRequestContent = {
+  apiKey: string;
+};
+
+/** @internal */
+export type PutModelCredentialRequestContent$Outbound = {
+  apiKey: string;
+};
+
+/** @internal */
+export const PutModelCredentialRequestContent$outboundSchema: z.ZodType<
+  PutModelCredentialRequestContent$Outbound,
+  z.ZodTypeDef,
+  PutModelCredentialRequestContent
+> = z.object({
+  apiKey: z.string(),
+});
+
+export function putModelCredentialRequestContentToJSON(
+  putModelCredentialRequestContent: PutModelCredentialRequestContent,
+): string {
+  return JSON.stringify(
+    PutModelCredentialRequestContent$outboundSchema.parse(
+      putModelCredentialRequestContent,
+    ),
+  );
+}

package/src/controlplane/models/resource-suspended-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 suspended resources.
+ */
+export const ResourceSuspendedErrorType = {
+  RootErrorsResourceSuspended: "/errors/resource-suspended",
+} as const;
+/**
+ * Problem type URI for suspended resources.
+ */
+export type ResourceSuspendedErrorType = ClosedEnum<
+  typeof ResourceSuspendedErrorType
+>;
+
+/** @internal */
+export const ResourceSuspendedErrorType$inboundSchema: z.ZodNativeEnum<
+  typeof ResourceSuspendedErrorType
+> = z.nativeEnum(ResourceSuspendedErrorType);

package/src/controlplane/models/security.ts

@@ -0,0 +1,27 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type Security = {
+  token?: string | undefined;
+};
+
+/** @internal */
+export type Security$Outbound = {
+  token?: string | undefined;
+};
+
+/** @internal */
+export const Security$outboundSchema: z.ZodType<
+  Security$Outbound,
+  z.ZodTypeDef,
+  Security
+> = z.object({
+  token: z.string().optional(),
+});
+
+export function securityToJSON(security: Security): string {
+  return JSON.stringify(Security$outboundSchema.parse(security));
+}

package/src/controlplane/models/supported-model.ts

@@ -0,0 +1,41 @@
+/*
+ * 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 SupportedModel = {
+  provider: string;
+  model: string;
+  purpose: string;
+  dimensions?: number | undefined;
+  credentialsRequired: boolean;
+  funding: string;
+};
+
+/** @internal */
+export const SupportedModel$inboundSchema: z.ZodType<
+  SupportedModel,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  provider: z.string(),
+  model: z.string(),
+  purpose: z.string(),
+  dimensions: z.number().int().optional(),
+  credentialsRequired: z.boolean(),
+  funding: z.string(),
+});
+
+export function supportedModelFromJSON(
+  jsonString: string,
+): SafeParseResult<SupportedModel, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SupportedModel$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SupportedModel' from JSON`,
+  );
+}

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

package/src/controlplane/models/unexpected-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 unexpected internal errors.
+ */
+export const UnexpectedErrorType = {
+  RootErrorsUnexpectedError: "/errors/unexpected-error",
+} as const;
+/**
+ * Problem type URI for unexpected internal errors.
+ */
+export type UnexpectedErrorType = ClosedEnum<typeof UnexpectedErrorType>;
+
+/** @internal */
+export const UnexpectedErrorType$inboundSchema: z.ZodNativeEnum<
+  typeof UnexpectedErrorType
+> = z.nativeEnum(UnexpectedErrorType);

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

@@ -0,0 +1,47 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  ExtractionJobConfiguration,
+  ExtractionJobConfiguration$Outbound,
+  ExtractionJobConfiguration$outboundSchema,
+} from "./extraction-job-configuration.js";
+
+export type UpdateExtractionBindingRequestContent = {
+  expectedVersion: number;
+  /**
+   * 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 | undefined;
+  enabled?: boolean | undefined;
+};
+
+/** @internal */
+export type UpdateExtractionBindingRequestContent$Outbound = {
+  expectedVersion: number;
+  job?: ExtractionJobConfiguration$Outbound | undefined;
+  enabled?: boolean | undefined;
+};
+
+/** @internal */
+export const UpdateExtractionBindingRequestContent$outboundSchema: z.ZodType<
+  UpdateExtractionBindingRequestContent$Outbound,
+  z.ZodTypeDef,
+  UpdateExtractionBindingRequestContent
+> = z.object({
+  expectedVersion: z.number().int(),
+  job: ExtractionJobConfiguration$outboundSchema.optional(),
+  enabled: z.boolean().optional(),
+});
+
+export function updateExtractionBindingRequestContentToJSON(
+  updateExtractionBindingRequestContent: UpdateExtractionBindingRequestContent,
+): string {
+  return JSON.stringify(
+    UpdateExtractionBindingRequestContent$outboundSchema.parse(
+      updateExtractionBindingRequestContent,
+    ),
+  );
+}

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

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

@@ -0,0 +1,73 @@
+/*
+ * 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 {
+  ModelSelection,
+  ModelSelection$Outbound,
+  ModelSelection$outboundSchema,
+} from "./model-selection.js";
+import {
+  MutablePlaybookState,
+  MutablePlaybookState$outboundSchema,
+} from "./mutable-playbook-state.js";
+import {
+  ProposalPolicy,
+  ProposalPolicy$Outbound,
+  ProposalPolicy$outboundSchema,
+} from "./proposal-policy.js";
+
+export type UpdatePlaybookRequestContent = {
+  name?: string | undefined;
+  state?: MutablePlaybookState | undefined;
+  /**
+   * 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 UpdatePlaybookRequestContent$Outbound = {
+  name?: string | undefined;
+  state?: string | undefined;
+  discovery?: DiscoveryConfig$Outbound | undefined;
+  proposalPolicy?: ProposalPolicy$Outbound | undefined;
+  llm?: ModelSelection$Outbound | undefined;
+};
+
+/** @internal */
+export const UpdatePlaybookRequestContent$outboundSchema: z.ZodType<
+  UpdatePlaybookRequestContent$Outbound,
+  z.ZodTypeDef,
+  UpdatePlaybookRequestContent
+> = z.object({
+  name: z.string().optional(),
+  state: MutablePlaybookState$outboundSchema.optional(),
+  discovery: DiscoveryConfig$outboundSchema.optional(),
+  proposalPolicy: ProposalPolicy$outboundSchema.optional(),
+  llm: ModelSelection$outboundSchema.optional(),
+});
+
+export function updatePlaybookRequestContentToJSON(
+  updatePlaybookRequestContent: UpdatePlaybookRequestContent,
+): string {
+  return JSON.stringify(
+    UpdatePlaybookRequestContent$outboundSchema.parse(
+      updatePlaybookRequestContent,
+    ),
+  );
+}