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

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

package/src/controlplane/sdk/index.ts

@@ -0,0 +1,5 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export * from "./sdk.js";

package/src/controlplane/sdk/sdk.ts

@@ -0,0 +1,293 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { clearPlaybook } from "../funcs/clear-playbook.js";
+import { createExtractionBinding } from "../funcs/create-extraction-binding.js";
+import { createPlaybook } from "../funcs/create-playbook.js";
+import { deleteExtractionBinding } from "../funcs/delete-extraction-binding.js";
+import { deleteModelCredential } from "../funcs/delete-model-credential.js";
+import { deletePlaybook } from "../funcs/delete-playbook.js";
+import { getExtractionBinding } from "../funcs/get-extraction-binding.js";
+import { getModelCredential } from "../funcs/get-model-credential.js";
+import { getNetworkInfo } from "../funcs/get-network-info.js";
+import { getPlaybook } from "../funcs/get-playbook.js";
+import { listDatabases } from "../funcs/list-databases.js";
+import { listExtractionBindings } from "../funcs/list-extraction-bindings.js";
+import { listExtractionStores } from "../funcs/list-extraction-stores.js";
+import { listModels } from "../funcs/list-models.js";
+import { listPlaybooks } from "../funcs/list-playbooks.js";
+import { putModelCredential } from "../funcs/put-model-credential.js";
+import { updateExtractionBinding } from "../funcs/update-extraction-binding.js";
+import { updatePlaybook } from "../funcs/update-playbook.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as models from "../models/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class AgentPlaybooksService extends ClientSDK {
+  /**
+   * Cloud only: list account databases
+   *
+   * @remarks
+   * Lists account databases using Playbook eligibility. Free plans remain visible even when ineligible or not ready. Requires JSESSIONID and X-CSRF-Token in addition to the operator JWT.
+   */
+  async listDatabases(
+    options?: RequestOptions,
+  ): Promise<models.ListDatabasesResponseContent> {
+    return unwrapAsync(listDatabases(
+      this,
+      options,
+    ));
+  }
+
+  /**
+   * List models supported by this deployment
+   *
+   * @remarks
+   * Lists models supported by this deployment. On-prem returns the configured embedding allowlist; cloud may also advertise extraction models.
+   */
+  async listModels(
+    options?: RequestOptions,
+  ): Promise<models.ListModelsResponseContent> {
+    return unwrapAsync(listModels(
+      this,
+      options,
+    ));
+  }
+
+  /**
+   * Cloud only: get control-plane network information
+   *
+   * @remarks
+   * Returns configured control-plane egress addresses for database allow-listing. Requires operator read authority.
+   */
+  async getNetworkInfo(
+    options?: RequestOptions,
+  ): Promise<models.GetNetworkInfoResponseContent> {
+    return unwrapAsync(getNetworkInfo(
+      this,
+      options,
+    ));
+  }
+
+  /**
+   * Lists the account's Playbooks. Cloud requests require JSESSIONID and X-CSRF-Token in addition to the operator JWT. If a selected database is unavailable, its Playbook remains listed without endpoint, database name or accessCidrs enrichment.
+   */
+  async listPlaybooks(
+    options?: RequestOptions,
+  ): Promise<models.ListPlaybooksResponseContent> {
+    return unwrapAsync(listPlaybooks(
+      this,
+      options,
+    ));
+  }
+
+  /**
+   * Creates and provisions one Playbook. A deployment-configured per-tenant limit applies; the on-prem default is 128. Cloud requests require JSESSIONID and X-CSRF-Token in addition to the operator JWT.
+   */
+  async createPlaybook(
+    request: models.CreatePlaybookRequestContent,
+    options?: RequestOptions,
+  ): Promise<models.CreatePlaybookResponseContent> {
+    return unwrapAsync(createPlaybook(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  async deletePlaybook(
+    playbookId: string,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(deletePlaybook(
+      this,
+      playbookId,
+      options,
+    ));
+  }
+
+  /**
+   * Reads one Playbook. Cloud requests require JSESSIONID and X-CSRF-Token in addition to the operator JWT.
+   */
+  async getPlaybook(
+    playbookId: string,
+    options?: RequestOptions,
+  ): Promise<models.GetPlaybookResponseContent> {
+    return unwrapAsync(getPlaybook(
+      this,
+      playbookId,
+      options,
+    ));
+  }
+
+  /**
+   * Updates mutable Playbook settings. Cloud requests require JSESSIONID and X-CSRF-Token in addition to the operator JWT.
+   */
+  async updatePlaybook(
+    playbookId: string,
+    body?: models.UpdatePlaybookRequestContent | undefined,
+    options?: RequestOptions,
+  ): Promise<models.UpdatePlaybookResponseContent> {
+    return unwrapAsync(updatePlaybook(
+      this,
+      playbookId,
+      body,
+      options,
+    ));
+  }
+
+  /**
+   * Administratively clears all (default), entries, or proposals from a ready Playbook, preserving configuration and index readiness. Requires product_admin or suite_admin. Cleanup is not atomic across content: failures can leave partial progress; retry the same scope after resolving the failure. Without new writes, repeating a successful clear removes no additional entry families.
+   */
+  async clearPlaybook(
+    playbookId: string,
+    scope?: models.ClearScope | undefined,
+    options?: RequestOptions,
+  ): Promise<models.ClearPlaybookResponseContent> {
+    return unwrapAsync(clearPlaybook(
+      this,
+      playbookId,
+      scope,
+      options,
+    ));
+  }
+
+  async listExtractionBindings(
+    playbookId: string,
+    options?: RequestOptions,
+  ): Promise<models.ListExtractionBindingsResponseContent> {
+    return unwrapAsync(listExtractionBindings(
+      this,
+      playbookId,
+      options,
+    ));
+  }
+
+  /**
+   * Registers a client-supplied RAM store reference and FAQ policy. The admin token can bind each store. An OIDC caller can bind a store in the configured store list. With a RAM connection, it can also bind a store on which it has read access in the Identity Service. In other cases, the request fails with 403, and the response does not show whether the store exists. Returns preparing and enabled=false. The control plane asynchronously provisions extraction-worker RAM source read and Playbook destination read/propose grants; both accepted grants make the binding ready, refused grants make it blocked, and dependency outages remain pending for retry. The worker validates live RAM access when extraction runs. Poll GET until ready, then PATCH to enable.
+   */
+  async createExtractionBinding(
+    playbookId: string,
+    body: models.CreateExtractionBindingRequestContent,
+    options?: RequestOptions,
+  ): Promise<models.CreateExtractionBindingResponseContent> {
+    return unwrapAsync(createExtractionBinding(
+      this,
+      playbookId,
+      body,
+      options,
+    ));
+  }
+
+  async deleteExtractionBinding(
+    playbookId: string,
+    bindingId: string,
+    options?: RequestOptions,
+  ): Promise<models.DeleteExtractionBindingResponseContent> {
+    return unwrapAsync(deleteExtractionBinding(
+      this,
+      playbookId,
+      bindingId,
+      options,
+    ));
+  }
+
+  async getExtractionBinding(
+    playbookId: string,
+    bindingId: string,
+    options?: RequestOptions,
+  ): Promise<models.GetExtractionBindingResponseContent> {
+    return unwrapAsync(getExtractionBinding(
+      this,
+      playbookId,
+      bindingId,
+      options,
+    ));
+  }
+
+  /**
+   * Updates FAQ policy or activation using expectedVersion. Supply job or enabled. Enabling requires ready status; pause is allowed while extraction is disabled. The deployment gate blocks policy updates and activation. Source identity is immutable; create a replacement binding to change stores. Stale revisions return conflict.
+   */
+  async updateExtractionBinding(
+    playbookId: string,
+    bindingId: string,
+    body: models.UpdateExtractionBindingRequestContent,
+    options?: RequestOptions,
+  ): Promise<models.UpdateExtractionBindingResponseContent> {
+    return unwrapAsync(updateExtractionBinding(
+      this,
+      playbookId,
+      bindingId,
+      body,
+      options,
+    ));
+  }
+
+  /**
+   * Returns tenant-scoped store suggestions, which may be empty. A suggestion does not approve a store. A client may submit another syntactically valid storeId; CreateExtractionBinding checks the caller's access to the store.
+   */
+  async listExtractionStores(
+    playbookId: string,
+    options?: RequestOptions,
+  ): Promise<models.ListExtractionStoresResponseContent> {
+    return unwrapAsync(listExtractionStores(
+      this,
+      playbookId,
+      options,
+    ));
+  }
+
+  /**
+   * Cloud only: delete a model credential
+   */
+  async deleteModelCredential(
+    playbookId: string,
+    purpose: models.ModelPurpose,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(deleteModelCredential(
+      this,
+      playbookId,
+      purpose,
+      options,
+    ));
+  }
+
+  /**
+   * Cloud only: get model credential status
+   */
+  async getModelCredential(
+    playbookId: string,
+    purpose: models.ModelPurpose,
+    options?: RequestOptions,
+  ): Promise<models.GetModelCredentialResponseContent> {
+    return unwrapAsync(getModelCredential(
+      this,
+      playbookId,
+      purpose,
+      options,
+    ));
+  }
+
+  /**
+   * Cloud only: set or rotate a model credential
+   *
+   * @remarks
+   * Creates or rotates the selected customer-funded provider's credential after account/resource authorization. No secret is returned. Each new attempt reloads credentials; in-flight attempts retain their resolved credential until completion or their configured timeout.
+   */
+  async putModelCredential(
+    playbookId: string,
+    purpose: models.ModelPurpose,
+    body: models.PutModelCredentialRequestContent,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(putModelCredential(
+      this,
+      playbookId,
+      purpose,
+      body,
+      options,
+    ));
+  }
+}

package/src/controlplane/types/async.ts

@@ -0,0 +1,69 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export type APICall =
+  | {
+      status: "complete";
+      request: Request;
+      response: Response;
+    }
+  | {
+      status: "request-error";
+      request: Request;
+      response?: undefined;
+    }
+  | {
+      status: "invalid";
+      request?: undefined;
+      response?: undefined;
+    };
+
+export class APIPromise<T> implements Promise<T> {
+  readonly #promise: Promise<[T, APICall]>;
+  #unwrapped: Promise<T> | null;
+
+  readonly [Symbol.toStringTag] = "APIPromise";
+
+  constructor(p: [T, APICall] | Promise<[T, APICall]>) {
+    this.#promise = p instanceof Promise ? p : Promise.resolve(p);
+    this.#unwrapped = p instanceof Promise ? null : Promise.resolve(p[0]);
+  }
+
+  #getUnwrapped(): Promise<T> {
+    return (this.#unwrapped ??= this.#promise.then(([value]) => value));
+  }
+
+  then<TResult1 = T, TResult2 = never>(
+    onfulfilled?:
+      | ((value: T) => TResult1 | PromiseLike<TResult1>)
+      | null
+      | undefined,
+    onrejected?:
+      | ((reason: any) => TResult2 | PromiseLike<TResult2>)
+      | null
+      | undefined,
+  ): Promise<TResult1 | TResult2> {
+    return this.#promise.then(
+      onfulfilled ? ([value]) => onfulfilled(value) : void 0,
+      onrejected,
+    );
+  }
+
+  catch<TResult = never>(
+    onrejected?:
+      | ((reason: any) => TResult | PromiseLike<TResult>)
+      | null
+      | undefined,
+  ): Promise<T | TResult> {
+    return this.#getUnwrapped().catch(onrejected);
+  }
+
+  finally(onfinally?: (() => void) | null | undefined): Promise<T> {
+    return this.#getUnwrapped().finally(onfinally);
+  }
+
+  $inspect(): Promise<[T, APICall]> {
+    return this.#promise;
+  }
+}

package/src/controlplane/types/blobs.ts

@@ -0,0 +1,32 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export const blobLikeSchema: z.ZodType<Blob, z.ZodTypeDef, Blob> = z.custom<
+  Blob
+>(isBlobLike, {
+  message: "expected a Blob, File or Blob-like object",
+  fatal: true,
+});
+
+export function isBlobLike(val: unknown): val is Blob {
+  if (val instanceof Blob) {
+    return true;
+  }
+
+  if (typeof val !== "object" || val == null || !(Symbol.toStringTag in val)) {
+    return false;
+  }
+
+  const name = val[Symbol.toStringTag];
+  if (typeof name !== "string") {
+    return false;
+  }
+  if (name !== "Blob" && name !== "File") {
+    return false;
+  }
+
+  return "stream" in val && typeof val.stream === "function";
+}

package/src/controlplane/types/const-date-time.ts

@@ -0,0 +1,15 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export function constDateTime(
+  val: string,
+): z.ZodType<string, z.ZodTypeDef, unknown> {
+  return z.custom<string>((v) => {
+    return (
+      typeof v === "string" && new Date(v).getTime() === new Date(val).getTime()
+    );
+  }, `Value must be equivalent to ${val}`);
+}

package/src/controlplane/types/enums.ts

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { Unrecognized, unrecognized } from "./unrecognized.js";
+
+export type ClosedEnum<T extends Readonly<Record<string, string | number>>> =
+  T[keyof T];
+export type OpenEnum<T extends Readonly<Record<string, string | number>>> =
+  | T[keyof T]
+  | Unrecognized<T[keyof T] extends number ? number : string>;
+
+export function inboundSchema<T extends Record<string, string>>(
+  enumObj: T,
+): z.ZodType<OpenEnum<T>, z.ZodTypeDef, unknown> {
+  const options = Object.values(enumObj);
+  return z.union([
+    ...options.map(x => z.literal(x)),
+    z.string().transform(x => unrecognized(x)),
+  ] as any);
+}
+
+export function inboundSchemaInt<T extends Record<string, number | string>>(
+  enumObj: T,
+): z.ZodType<OpenEnum<T>, z.ZodTypeDef, unknown> {
+  // For numeric enums, Object.values returns both numbers and string keys
+  const options = Object.values(enumObj).filter(v => typeof v === "number");
+  return z.union([
+    ...options.map(x => z.literal(x)),
+    z.number().int().transform(x => unrecognized(x)),
+  ] as any);
+}
+
+export function outboundSchema<T extends Record<string, string>>(
+  _: T,
+): z.ZodType<string, z.ZodTypeDef, OpenEnum<T>> {
+  return z.string() as any;
+}
+
+export function outboundSchemaInt<T extends Record<string, number | string>>(
+  _: T,
+): z.ZodType<number, z.ZodTypeDef, OpenEnum<T>> {
+  return z.number().int() as any;
+}

package/src/controlplane/types/fp.ts

@@ -0,0 +1,50 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+/**
+ * A monad that captures the result of a function call or an error if it was not
+ * successful. Railway programming, enabled by this type, can be a nicer
+ * alternative to traditional exception throwing because it allows functions to
+ * declare all _known_ errors with static types and then check for them
+ * exhaustively in application code. Thrown exception have a type of `unknown`
+ * and break out of regular control flow of programs making them harder to
+ * inspect and more verbose work with due to try-catch blocks.
+ */
+export type Result<T, E = unknown> =
+  | { ok: true; value: T; error?: never }
+  | { ok: false; value?: never; error: E };
+
+export function OK<V>(value: V): Result<V, never> {
+  return { ok: true, value };
+}
+
+export function ERR<E>(error: E): Result<never, E> {
+  return { ok: false, error };
+}
+
+/**
+ * unwrap is a convenience function for extracting a value from a result or
+ * throwing if there was an error.
+ */
+export function unwrap<T>(r: Result<T, unknown>): T {
+  if (!r.ok) {
+    throw r.error;
+  }
+  return r.value;
+}
+
+/**
+ * unwrapAsync is a convenience function for resolving a value from a Promise
+ * of a result or rejecting if an error occurred.
+ */
+export async function unwrapAsync<T>(
+  pr: Promise<Result<T, unknown>>,
+): Promise<T> {
+  const r = await pr;
+  if (!r.ok) {
+    throw r.error;
+  }
+
+  return r.value;
+}

package/src/controlplane/types/index.ts

@@ -0,0 +1,11 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export { blobLikeSchema, isBlobLike } from "./blobs.js";
+export type { ClosedEnum, OpenEnum } from "./enums.js";
+export type { Result } from "./fp.js";
+export type { PageIterator, Paginator } from "./operations.js";
+export { createPageIterator } from "./operations.js";
+export { RFCDate } from "./rfcdate.js";
+export * from "./unrecognized.js";