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

package/src/controlplane/models/list-extraction-stores-response-content.ts

@@ -0,0 +1,36 @@
+/*
+ * 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 {
+  ExtractionStore,
+  ExtractionStore$inboundSchema,
+} from "./extraction-store.js";
+
+export type ListExtractionStoresResponseContent = {
+  stores: Array<ExtractionStore>;
+};
+
+/** @internal */
+export const ListExtractionStoresResponseContent$inboundSchema: z.ZodType<
+  ListExtractionStoresResponseContent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  stores: z.array(ExtractionStore$inboundSchema),
+});
+
+export function listExtractionStoresResponseContentFromJSON(
+  jsonString: string,
+): SafeParseResult<ListExtractionStoresResponseContent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListExtractionStoresResponseContent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListExtractionStoresResponseContent' from JSON`,
+  );
+}

package/src/controlplane/models/list-models-response-content.ts

@@ -0,0 +1,35 @@
+/*
+ * 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 {
+  SupportedModel,
+  SupportedModel$inboundSchema,
+} from "./supported-model.js";
+
+export type ListModelsResponseContent = {
+  models: Array<SupportedModel>;
+};
+
+/** @internal */
+export const ListModelsResponseContent$inboundSchema: z.ZodType<
+  ListModelsResponseContent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  models: z.array(SupportedModel$inboundSchema),
+});
+
+export function listModelsResponseContentFromJSON(
+  jsonString: string,
+): SafeParseResult<ListModelsResponseContent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListModelsResponseContent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListModelsResponseContent' from JSON`,
+  );
+}

package/src/controlplane/models/list-playbooks-response-content.ts

@@ -0,0 +1,32 @@
+/*
+ * 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 { Playbook, Playbook$inboundSchema } from "./playbook.js";
+
+export type ListPlaybooksResponseContent = {
+  playbooks: Array<Playbook>;
+};
+
+/** @internal */
+export const ListPlaybooksResponseContent$inboundSchema: z.ZodType<
+  ListPlaybooksResponseContent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  playbooks: z.array(Playbook$inboundSchema),
+});
+
+export function listPlaybooksResponseContentFromJSON(
+  jsonString: string,
+): SafeParseResult<ListPlaybooksResponseContent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListPlaybooksResponseContent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListPlaybooksResponseContent' from JSON`,
+  );
+}

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

@@ -0,0 +1,16 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../types/enums.js";
+
+export const ModelPurpose = {
+  Embedding: "embedding",
+  Extraction: "extraction",
+} as const;
+export type ModelPurpose = ClosedEnum<typeof ModelPurpose>;
+
+/** @internal */
+export const ModelPurpose$outboundSchema: z.ZodNativeEnum<typeof ModelPurpose> =
+  z.nativeEnum(ModelPurpose);

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

@@ -0,0 +1,33 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+/**
+ * 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.
+ */
+export type ModelSelection = {
+  provider: string;
+  model: string;
+};
+
+/** @internal */
+export type ModelSelection$Outbound = {
+  provider: string;
+  model: string;
+};
+
+/** @internal */
+export const ModelSelection$outboundSchema: z.ZodType<
+  ModelSelection$Outbound,
+  z.ZodTypeDef,
+  ModelSelection
+> = z.object({
+  provider: z.string(),
+  model: z.string(),
+});
+
+export function modelSelectionToJSON(modelSelection: ModelSelection): string {
+  return JSON.stringify(ModelSelection$outboundSchema.parse(modelSelection));
+}

package/src/controlplane/models/mutable-playbook-state.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 MutablePlaybookState = {
+  Ready: "ready",
+  Suspended: "suspended",
+} as const;
+export type MutablePlaybookState = ClosedEnum<typeof MutablePlaybookState>;
+
+/** @internal */
+export const MutablePlaybookState$outboundSchema: z.ZodNativeEnum<
+  typeof MutablePlaybookState
+> = z.nativeEnum(MutablePlaybookState);

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

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

@@ -0,0 +1,41 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as models from "../index.js";
+
+export type ClearPlaybookRequest = {
+  /**
+   * Opaque Playbook identifier.
+   */
+  playbookId: string;
+  /**
+   * Content to clear. Omission clears all entries and proposals while preserving the Playbook.
+   */
+  scope?: models.ClearScope | undefined;
+};
+
+/** @internal */
+export type ClearPlaybookRequest$Outbound = {
+  playbookId: string;
+  scope: string;
+};
+
+/** @internal */
+export const ClearPlaybookRequest$outboundSchema: z.ZodType<
+  ClearPlaybookRequest$Outbound,
+  z.ZodTypeDef,
+  ClearPlaybookRequest
+> = z.object({
+  playbookId: z.string(),
+  scope: models.ClearScope$outboundSchema.default("all"),
+});
+
+export function clearPlaybookRequestToJSON(
+  clearPlaybookRequest: ClearPlaybookRequest,
+): string {
+  return JSON.stringify(
+    ClearPlaybookRequest$outboundSchema.parse(clearPlaybookRequest),
+  );
+}

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

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

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

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type DeleteExtractionBindingRequest = {
+  /**
+   * Opaque Playbook identifier.
+   */
+  playbookId: string;
+  bindingId: string;
+};
+
+/** @internal */
+export type DeleteExtractionBindingRequest$Outbound = {
+  playbookId: string;
+  bindingId: string;
+};
+
+/** @internal */
+export const DeleteExtractionBindingRequest$outboundSchema: z.ZodType<
+  DeleteExtractionBindingRequest$Outbound,
+  z.ZodTypeDef,
+  DeleteExtractionBindingRequest
+> = z.object({
+  playbookId: z.string(),
+  bindingId: z.string(),
+});
+
+export function deleteExtractionBindingRequestToJSON(
+  deleteExtractionBindingRequest: DeleteExtractionBindingRequest,
+): string {
+  return JSON.stringify(
+    DeleteExtractionBindingRequest$outboundSchema.parse(
+      deleteExtractionBindingRequest,
+    ),
+  );
+}

package/src/controlplane/models/operations/delete-model-credential.ts

@@ -0,0 +1,40 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as models from "../index.js";
+
+export type DeleteModelCredentialRequest = {
+  /**
+   * Opaque Playbook identifier.
+   */
+  playbookId: string;
+  purpose: models.ModelPurpose;
+};
+
+/** @internal */
+export type DeleteModelCredentialRequest$Outbound = {
+  playbookId: string;
+  purpose: string;
+};
+
+/** @internal */
+export const DeleteModelCredentialRequest$outboundSchema: z.ZodType<
+  DeleteModelCredentialRequest$Outbound,
+  z.ZodTypeDef,
+  DeleteModelCredentialRequest
+> = z.object({
+  playbookId: z.string(),
+  purpose: models.ModelPurpose$outboundSchema,
+});
+
+export function deleteModelCredentialRequestToJSON(
+  deleteModelCredentialRequest: DeleteModelCredentialRequest,
+): string {
+  return JSON.stringify(
+    DeleteModelCredentialRequest$outboundSchema.parse(
+      deleteModelCredentialRequest,
+    ),
+  );
+}

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

@@ -0,0 +1,34 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type DeletePlaybookRequest = {
+  /**
+   * Opaque Playbook identifier.
+   */
+  playbookId: string;
+};
+
+/** @internal */
+export type DeletePlaybookRequest$Outbound = {
+  playbookId: string;
+};
+
+/** @internal */
+export const DeletePlaybookRequest$outboundSchema: z.ZodType<
+  DeletePlaybookRequest$Outbound,
+  z.ZodTypeDef,
+  DeletePlaybookRequest
+> = z.object({
+  playbookId: z.string(),
+});
+
+export function deletePlaybookRequestToJSON(
+  deletePlaybookRequest: DeletePlaybookRequest,
+): string {
+  return JSON.stringify(
+    DeletePlaybookRequest$outboundSchema.parse(deletePlaybookRequest),
+  );
+}

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

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type GetExtractionBindingRequest = {
+  /**
+   * Opaque Playbook identifier.
+   */
+  playbookId: string;
+  bindingId: string;
+};
+
+/** @internal */
+export type GetExtractionBindingRequest$Outbound = {
+  playbookId: string;
+  bindingId: string;
+};
+
+/** @internal */
+export const GetExtractionBindingRequest$outboundSchema: z.ZodType<
+  GetExtractionBindingRequest$Outbound,
+  z.ZodTypeDef,
+  GetExtractionBindingRequest
+> = z.object({
+  playbookId: z.string(),
+  bindingId: z.string(),
+});
+
+export function getExtractionBindingRequestToJSON(
+  getExtractionBindingRequest: GetExtractionBindingRequest,
+): string {
+  return JSON.stringify(
+    GetExtractionBindingRequest$outboundSchema.parse(
+      getExtractionBindingRequest,
+    ),
+  );
+}

package/src/controlplane/models/operations/get-model-credential.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 GetModelCredentialRequest = {
+  /**
+   * Opaque Playbook identifier.
+   */
+  playbookId: string;
+  purpose: models.ModelPurpose;
+};
+
+/** @internal */
+export type GetModelCredentialRequest$Outbound = {
+  playbookId: string;
+  purpose: string;
+};
+
+/** @internal */
+export const GetModelCredentialRequest$outboundSchema: z.ZodType<
+  GetModelCredentialRequest$Outbound,
+  z.ZodTypeDef,
+  GetModelCredentialRequest
+> = z.object({
+  playbookId: z.string(),
+  purpose: models.ModelPurpose$outboundSchema,
+});
+
+export function getModelCredentialRequestToJSON(
+  getModelCredentialRequest: GetModelCredentialRequest,
+): string {
+  return JSON.stringify(
+    GetModelCredentialRequest$outboundSchema.parse(getModelCredentialRequest),
+  );
+}

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

@@ -0,0 +1,34 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type GetPlaybookRequest = {
+  /**
+   * Opaque Playbook identifier.
+   */
+  playbookId: string;
+};
+
+/** @internal */
+export type GetPlaybookRequest$Outbound = {
+  playbookId: string;
+};
+
+/** @internal */
+export const GetPlaybookRequest$outboundSchema: z.ZodType<
+  GetPlaybookRequest$Outbound,
+  z.ZodTypeDef,
+  GetPlaybookRequest
+> = z.object({
+  playbookId: z.string(),
+});
+
+export function getPlaybookRequestToJSON(
+  getPlaybookRequest: GetPlaybookRequest,
+): string {
+  return JSON.stringify(
+    GetPlaybookRequest$outboundSchema.parse(getPlaybookRequest),
+  );
+}

package/src/controlplane/models/operations/index.ts

@@ -0,0 +1,17 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export * from "./clear-playbook.js";
+export * from "./create-extraction-binding.js";
+export * from "./delete-extraction-binding.js";
+export * from "./delete-model-credential.js";
+export * from "./delete-playbook.js";
+export * from "./get-extraction-binding.js";
+export * from "./get-model-credential.js";
+export * from "./get-playbook.js";
+export * from "./list-extraction-bindings.js";
+export * from "./list-extraction-stores.js";
+export * from "./put-model-credential.js";
+export * from "./update-extraction-binding.js";
+export * from "./update-playbook.js";

package/src/controlplane/models/operations/list-extraction-bindings.ts

@@ -0,0 +1,36 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type ListExtractionBindingsRequest = {
+  /**
+   * Opaque Playbook identifier.
+   */
+  playbookId: string;
+};
+
+/** @internal */
+export type ListExtractionBindingsRequest$Outbound = {
+  playbookId: string;
+};
+
+/** @internal */
+export const ListExtractionBindingsRequest$outboundSchema: z.ZodType<
+  ListExtractionBindingsRequest$Outbound,
+  z.ZodTypeDef,
+  ListExtractionBindingsRequest
+> = z.object({
+  playbookId: z.string(),
+});
+
+export function listExtractionBindingsRequestToJSON(
+  listExtractionBindingsRequest: ListExtractionBindingsRequest,
+): string {
+  return JSON.stringify(
+    ListExtractionBindingsRequest$outboundSchema.parse(
+      listExtractionBindingsRequest,
+    ),
+  );
+}

package/src/controlplane/models/operations/list-extraction-stores.ts

@@ -0,0 +1,36 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type ListExtractionStoresRequest = {
+  /**
+   * Opaque Playbook identifier.
+   */
+  playbookId: string;
+};
+
+/** @internal */
+export type ListExtractionStoresRequest$Outbound = {
+  playbookId: string;
+};
+
+/** @internal */
+export const ListExtractionStoresRequest$outboundSchema: z.ZodType<
+  ListExtractionStoresRequest$Outbound,
+  z.ZodTypeDef,
+  ListExtractionStoresRequest
+> = z.object({
+  playbookId: z.string(),
+});
+
+export function listExtractionStoresRequestToJSON(
+  listExtractionStoresRequest: ListExtractionStoresRequest,
+): string {
+  return JSON.stringify(
+    ListExtractionStoresRequest$outboundSchema.parse(
+      listExtractionStoresRequest,
+    ),
+  );
+}

package/src/controlplane/models/operations/put-model-credential.ts

@@ -0,0 +1,41 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as models from "../index.js";
+
+export type PutModelCredentialRequest = {
+  /**
+   * Opaque Playbook identifier.
+   */
+  playbookId: string;
+  purpose: models.ModelPurpose;
+  body: models.PutModelCredentialRequestContent;
+};
+
+/** @internal */
+export type PutModelCredentialRequest$Outbound = {
+  playbookId: string;
+  purpose: string;
+  body: models.PutModelCredentialRequestContent$Outbound;
+};
+
+/** @internal */
+export const PutModelCredentialRequest$outboundSchema: z.ZodType<
+  PutModelCredentialRequest$Outbound,
+  z.ZodTypeDef,
+  PutModelCredentialRequest
+> = z.object({
+  playbookId: z.string(),
+  purpose: models.ModelPurpose$outboundSchema,
+  body: models.PutModelCredentialRequestContent$outboundSchema,
+});
+
+export function putModelCredentialRequestToJSON(
+  putModelCredentialRequest: PutModelCredentialRequest,
+): string {
+  return JSON.stringify(
+    PutModelCredentialRequest$outboundSchema.parse(putModelCredentialRequest),
+  );
+}

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

@@ -0,0 +1,43 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as models from "../index.js";
+
+export type UpdateExtractionBindingRequest = {
+  /**
+   * Opaque Playbook identifier.
+   */
+  playbookId: string;
+  bindingId: string;
+  body: models.UpdateExtractionBindingRequestContent;
+};
+
+/** @internal */
+export type UpdateExtractionBindingRequest$Outbound = {
+  playbookId: string;
+  bindingId: string;
+  body: models.UpdateExtractionBindingRequestContent$Outbound;
+};
+
+/** @internal */
+export const UpdateExtractionBindingRequest$outboundSchema: z.ZodType<
+  UpdateExtractionBindingRequest$Outbound,
+  z.ZodTypeDef,
+  UpdateExtractionBindingRequest
+> = z.object({
+  playbookId: z.string(),
+  bindingId: z.string(),
+  body: models.UpdateExtractionBindingRequestContent$outboundSchema,
+});
+
+export function updateExtractionBindingRequestToJSON(
+  updateExtractionBindingRequest: UpdateExtractionBindingRequest,
+): string {
+  return JSON.stringify(
+    UpdateExtractionBindingRequest$outboundSchema.parse(
+      updateExtractionBindingRequest,
+    ),
+  );
+}