@redis-iris/agent-playbook 0.0.0-stage → 0.1.0-alpha.2

package/src/models/proposal-preview.ts

@@ -0,0 +1,83 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 2e46be0c2442
+ */
+
+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 {
+  ProposalActionPreview,
+  ProposalActionPreview$inboundSchema,
+} from "./proposal-action-preview.js";
+import {
+  ProposalStatus,
+  ProposalStatus$inboundSchema,
+} from "./proposal-status.js";
+
+/**
+ * Compact management projection; GET the proposal for the complete candidate.
+ */
+export type ProposalPreview = {
+  proposalId: string;
+  status: ProposalStatus;
+  /**
+   * SHA-256 digest of normalized authored Playbook content in sha256:<lowercase-hex> form. The canonicalization contract is documented as playbook-entry-v1.
+   */
+  contentDigest: string;
+  proposalRevision: number;
+  evidenceCount: number;
+  /**
+   * UTC timestamp resolved to microsecond precision.
+   */
+  createdAt: Date;
+  /**
+   * Last successful candidate replacement, new evidence, dismissal, or restoration
+   *
+   * @remarks
+   * (creation initially). Duplicate evidence, repeated dismissal/restoration, and
+   * time-based expiry do not change it. New evidence, replacement, and restoration
+   * also refresh inbox/purge deadlines.
+   */
+  updatedAt: Date;
+  /**
+   * UTC timestamp resolved to microsecond precision.
+   */
+  inboxExpiresAt: Date;
+  /**
+   * UTC timestamp resolved to microsecond precision.
+   */
+  purgeAt: Date;
+  action: ProposalActionPreview;
+};
+
+/** @internal */
+export const ProposalPreview$inboundSchema: z.ZodType<
+  ProposalPreview,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  proposalId: z.string(),
+  status: ProposalStatus$inboundSchema,
+  contentDigest: z.string(),
+  proposalRevision: z.number().int(),
+  evidenceCount: z.number().int(),
+  createdAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  updatedAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  inboxExpiresAt: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ),
+  purgeAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  action: ProposalActionPreview$inboundSchema,
+});
+
+export function proposalPreviewFromJSON(
+  jsonString: string,
+): SafeParseResult<ProposalPreview, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ProposalPreview$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProposalPreview' from JSON`,
+  );
+}

package/src/models/proposal-sort.ts

@@ -0,0 +1,20 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: e2bc3c070c7d
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../types/enums.js";
+
+export const ProposalSort = {
+  CreatedAt: "createdAt",
+  InboxExpiresAt: "inboxExpiresAt",
+  PurgeAt: "purgeAt",
+  UpdatedAt: "updatedAt",
+  EvidenceCount: "evidenceCount",
+} as const;
+export type ProposalSort = ClosedEnum<typeof ProposalSort>;
+
+/** @internal */
+export const ProposalSort$outboundSchema: z.ZodNativeEnum<typeof ProposalSort> =
+  z.nativeEnum(ProposalSort);

package/src/models/proposal-source.ts

@@ -0,0 +1,63 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 03e088e944d0
+ */
+
+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";
+
+/**
+ * Caller-supplied context for a proposal or supporting evidence, not verified
+ *
+ * @remarks
+ * attribution. Reference and content, when present, are source-specific JSON
+ * objects. Playbook does not interpret their fields.
+ */
+export type ProposalSource = {
+  type: string;
+  reference?: any | undefined;
+  content?: any | undefined;
+};
+
+/** @internal */
+export const ProposalSource$inboundSchema: z.ZodType<
+  ProposalSource,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.string(),
+  reference: z.any().optional(),
+  content: z.any().optional(),
+});
+/** @internal */
+export type ProposalSource$Outbound = {
+  type: string;
+  reference?: any | undefined;
+  content?: any | undefined;
+};
+
+/** @internal */
+export const ProposalSource$outboundSchema: z.ZodType<
+  ProposalSource$Outbound,
+  z.ZodTypeDef,
+  ProposalSource
+> = z.object({
+  type: z.string(),
+  reference: z.any().optional(),
+  content: z.any().optional(),
+});
+
+export function proposalSourceToJSON(proposalSource: ProposalSource): string {
+  return JSON.stringify(ProposalSource$outboundSchema.parse(proposalSource));
+}
+export function proposalSourceFromJSON(
+  jsonString: string,
+): SafeParseResult<ProposalSource, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ProposalSource$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProposalSource' from JSON`,
+  );
+}

package/src/models/proposal-status.ts

@@ -0,0 +1,23 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: aa780a9ea259
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../types/enums.js";
+import { OpenEnum } from "../types/enums.js";
+
+export const ProposalStatus = {
+  Open: "open",
+  Trashed: "trashed",
+  Promoting: "promoting",
+  Promoted: "promoted",
+} as const;
+export type ProposalStatus = OpenEnum<typeof ProposalStatus>;
+
+/** @internal */
+export const ProposalStatus$inboundSchema: z.ZodType<
+  ProposalStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ProposalStatus);

package/src/models/proposal-target-input.ts

@@ -0,0 +1,62 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 85e00030dd66
+ */
+
+import * as z from "zod/v3";
+import {
+  NewEntryTarget,
+  NewEntryTarget$Outbound,
+  NewEntryTarget$outboundSchema,
+} from "./new-entry-target.js";
+
+export type ProposalTargetInputNewEntry = {
+  newEntry: NewEntryTarget;
+};
+
+/**
+ * Exactly one target. Request clients must send only a supported member.
+ */
+export type ProposalTargetInput = ProposalTargetInputNewEntry;
+
+/** @internal */
+export type ProposalTargetInputNewEntry$Outbound = {
+  newEntry: NewEntryTarget$Outbound;
+};
+
+/** @internal */
+export const ProposalTargetInputNewEntry$outboundSchema: z.ZodType<
+  ProposalTargetInputNewEntry$Outbound,
+  z.ZodTypeDef,
+  ProposalTargetInputNewEntry
+> = z.object({
+  newEntry: NewEntryTarget$outboundSchema,
+});
+
+export function proposalTargetInputNewEntryToJSON(
+  proposalTargetInputNewEntry: ProposalTargetInputNewEntry,
+): string {
+  return JSON.stringify(
+    ProposalTargetInputNewEntry$outboundSchema.parse(
+      proposalTargetInputNewEntry,
+    ),
+  );
+}
+
+/** @internal */
+export type ProposalTargetInput$Outbound = ProposalTargetInputNewEntry$Outbound;
+
+/** @internal */
+export const ProposalTargetInput$outboundSchema: z.ZodType<
+  ProposalTargetInput$Outbound,
+  z.ZodTypeDef,
+  ProposalTargetInput
+> = z.lazy(() => ProposalTargetInputNewEntry$outboundSchema);
+
+export function proposalTargetInputToJSON(
+  proposalTargetInput: ProposalTargetInput,
+): string {
+  return JSON.stringify(
+    ProposalTargetInput$outboundSchema.parse(proposalTargetInput),
+  );
+}

package/src/models/proposal-target.ts

@@ -0,0 +1,58 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 8a5d10f04c93
+ */
+
+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 {
+  NewEntryTarget,
+  NewEntryTarget$inboundSchema,
+} from "./new-entry-target.js";
+
+export type ProposalTargetNewEntry = {
+  newEntry: NewEntryTarget;
+};
+
+/**
+ * Exactly one target. Launch supports creating a new entry.
+ */
+export type ProposalTarget = ProposalTargetNewEntry;
+
+/** @internal */
+export const ProposalTargetNewEntry$inboundSchema: z.ZodType<
+  ProposalTargetNewEntry,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  newEntry: NewEntryTarget$inboundSchema,
+});
+
+export function proposalTargetNewEntryFromJSON(
+  jsonString: string,
+): SafeParseResult<ProposalTargetNewEntry, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ProposalTargetNewEntry$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProposalTargetNewEntry' from JSON`,
+  );
+}
+
+/** @internal */
+export const ProposalTarget$inboundSchema: z.ZodType<
+  ProposalTarget,
+  z.ZodTypeDef,
+  unknown
+> = z.lazy(() => ProposalTargetNewEntry$inboundSchema);
+
+export function proposalTargetFromJSON(
+  jsonString: string,
+): SafeParseResult<ProposalTarget, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ProposalTarget$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProposalTarget' from JSON`,
+  );
+}

package/src/models/proposal-view.ts

@@ -0,0 +1,17 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: b1f21fa4d758
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../types/enums.js";
+
+export const ProposalView = {
+  Inbox: "inbox",
+  Trash: "trash",
+} as const;
+export type ProposalView = ClosedEnum<typeof ProposalView>;
+
+/** @internal */
+export const ProposalView$outboundSchema: z.ZodNativeEnum<typeof ProposalView> =
+  z.nativeEnum(ProposalView);

package/src/models/publication.ts

@@ -0,0 +1,49 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 44abdb452514
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import {
+  ContentPreview,
+  ContentPreview$inboundSchema,
+} from "./content-preview.js";
+import { SDKValidationError } from "./errors/sdk-validation-error.js";
+
+export type Publication = {
+  version: number;
+  /**
+   * UTC timestamp resolved to microsecond precision.
+   */
+  at: Date;
+  /**
+   * Compact published content shared by management entries and serving previews.
+   *
+   * @remarks
+   * FAQ answers are included; Skill instructions and resource descriptors require a Version read.
+   */
+  content: ContentPreview;
+};
+
+/** @internal */
+export const Publication$inboundSchema: z.ZodType<
+  Publication,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  version: z.number().int(),
+  at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  content: ContentPreview$inboundSchema,
+});
+
+export function publicationFromJSON(
+  jsonString: string,
+): SafeParseResult<Publication, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Publication$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Publication' from JSON`,
+  );
+}

package/src/models/publish-faq-request-content.ts

@@ -0,0 +1,32 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 4b4169b4c26e
+ */
+
+import * as z from "zod/v3";
+
+export type PublishFaqRequestContent = {
+  version: number;
+};
+
+/** @internal */
+export type PublishFaqRequestContent$Outbound = {
+  version: number;
+};
+
+/** @internal */
+export const PublishFaqRequestContent$outboundSchema: z.ZodType<
+  PublishFaqRequestContent$Outbound,
+  z.ZodTypeDef,
+  PublishFaqRequestContent
+> = z.object({
+  version: z.number().int(),
+});
+
+export function publishFaqRequestContentToJSON(
+  publishFaqRequestContent: PublishFaqRequestContent,
+): string {
+  return JSON.stringify(
+    PublishFaqRequestContent$outboundSchema.parse(publishFaqRequestContent),
+  );
+}

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

@@ -0,0 +1,61 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: be671b2c74fc
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { EntryType, EntryType$inboundSchema } from "./entry-type.js";
+import { SDKValidationError } from "./errors/sdk-validation-error.js";
+import { Publication, Publication$inboundSchema } from "./publication.js";
+
+export type PublishFaqResponseContent = {
+  /**
+   * Opaque stable entry identifier.
+   */
+  entryId: string;
+  /**
+   * Optional Playbook-unique immutable human-readable entry key.
+   */
+  entryKey?: string | undefined;
+  entryType: EntryType;
+  /**
+   * Newest immutable version number. Versions are append-only, so this also equals the version count.
+   */
+  latestVersion: number;
+  publication?: Publication | undefined;
+  /**
+   * UTC timestamp resolved to microsecond precision.
+   */
+  createdAt: Date;
+  /**
+   * Last create, append, publication change, or withdrawal of an existing publication. Repeating the current publication, already-unpublished withdrawal, and reads leave it unchanged. Publication/append updates never move this timestamp backwards.
+   */
+  updatedAt: Date;
+};
+
+/** @internal */
+export const PublishFaqResponseContent$inboundSchema: z.ZodType<
+  PublishFaqResponseContent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  entryId: z.string(),
+  entryKey: z.string().optional(),
+  entryType: EntryType$inboundSchema,
+  latestVersion: z.number().int(),
+  publication: Publication$inboundSchema.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 publishFaqResponseContentFromJSON(
+  jsonString: string,
+): SafeParseResult<PublishFaqResponseContent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PublishFaqResponseContent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PublishFaqResponseContent' from JSON`,
+  );
+}

package/src/models/publish-skill-request-content.ts

@@ -0,0 +1,32 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 06c3365d9e52
+ */
+
+import * as z from "zod/v3";
+
+export type PublishSkillRequestContent = {
+  version: number;
+};
+
+/** @internal */
+export type PublishSkillRequestContent$Outbound = {
+  version: number;
+};
+
+/** @internal */
+export const PublishSkillRequestContent$outboundSchema: z.ZodType<
+  PublishSkillRequestContent$Outbound,
+  z.ZodTypeDef,
+  PublishSkillRequestContent
+> = z.object({
+  version: z.number().int(),
+});
+
+export function publishSkillRequestContentToJSON(
+  publishSkillRequestContent: PublishSkillRequestContent,
+): string {
+  return JSON.stringify(
+    PublishSkillRequestContent$outboundSchema.parse(publishSkillRequestContent),
+  );
+}

package/src/models/publish-skill-response-content.ts

@@ -0,0 +1,61 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 467ebd651848
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { EntryType, EntryType$inboundSchema } from "./entry-type.js";
+import { SDKValidationError } from "./errors/sdk-validation-error.js";
+import { Publication, Publication$inboundSchema } from "./publication.js";
+
+export type PublishSkillResponseContent = {
+  /**
+   * Opaque stable entry identifier.
+   */
+  entryId: string;
+  /**
+   * Optional Playbook-unique immutable human-readable entry key.
+   */
+  entryKey?: string | undefined;
+  entryType: EntryType;
+  /**
+   * Newest immutable version number. Versions are append-only, so this also equals the version count.
+   */
+  latestVersion: number;
+  publication?: Publication | undefined;
+  /**
+   * UTC timestamp resolved to microsecond precision.
+   */
+  createdAt: Date;
+  /**
+   * Last create, append, publication change, or withdrawal of an existing publication. Repeating the current publication, already-unpublished withdrawal, and reads leave it unchanged. Publication/append updates never move this timestamp backwards.
+   */
+  updatedAt: Date;
+};
+
+/** @internal */
+export const PublishSkillResponseContent$inboundSchema: z.ZodType<
+  PublishSkillResponseContent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  entryId: z.string(),
+  entryKey: z.string().optional(),
+  entryType: EntryType$inboundSchema,
+  latestVersion: z.number().int(),
+  publication: Publication$inboundSchema.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 publishSkillResponseContentFromJSON(
+  jsonString: string,
+): SafeParseResult<PublishSkillResponseContent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PublishSkillResponseContent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PublishSkillResponseContent' from JSON`,
+  );
+}

package/src/models/ready-status.ts

@@ -0,0 +1,16 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 3d957f27af3a
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../types/enums.js";
+
+export const ReadyStatus = {
+  Ready: "ready",
+} as const;
+export type ReadyStatus = ClosedEnum<typeof ReadyStatus>;
+
+/** @internal */
+export const ReadyStatus$inboundSchema: z.ZodNativeEnum<typeof ReadyStatus> = z
+  .nativeEnum(ReadyStatus);

package/src/models/replace-proposal-request-content.ts

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 722c3d89c908
+ */
+
+import * as z from "zod/v3";
+import {
+  ProposalActionInput,
+  ProposalActionInput$Outbound,
+  ProposalActionInput$outboundSchema,
+} from "./proposal-action-input.js";
+
+export type ReplaceProposalRequestContent = {
+  action: ProposalActionInput;
+  expectedProposalRevision: number;
+};
+
+/** @internal */
+export type ReplaceProposalRequestContent$Outbound = {
+  action: ProposalActionInput$Outbound;
+  expectedProposalRevision: number;
+};
+
+/** @internal */
+export const ReplaceProposalRequestContent$outboundSchema: z.ZodType<
+  ReplaceProposalRequestContent$Outbound,
+  z.ZodTypeDef,
+  ReplaceProposalRequestContent
+> = z.object({
+  action: ProposalActionInput$outboundSchema,
+  expectedProposalRevision: z.number().int(),
+});
+
+export function replaceProposalRequestContentToJSON(
+  replaceProposalRequestContent: ReplaceProposalRequestContent,
+): string {
+  return JSON.stringify(
+    ReplaceProposalRequestContent$outboundSchema.parse(
+      replaceProposalRequestContent,
+    ),
+  );
+}