@redis-iris/agent-playbook 0.1.0-beta.2 → 1.0.0-beta.2

package/src/models/proposal-skill-content.ts

@@ -0,0 +1,47 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: d32e54021122
+ */
+
+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 {
+  ProposalResource,
+  ProposalResource$inboundSchema,
+} from "./proposal-resource.js";
+import { SkillFormat, SkillFormat$inboundSchema } from "./skill-format.js";
+import {
+  SkillManifest,
+  SkillManifest$inboundSchema,
+} from "./skill-manifest.js";
+
+export type ProposalSkillContent = {
+  format: SkillFormat;
+  manifest: SkillManifest;
+  instructions: string;
+  resources: Array<ProposalResource>;
+};
+
+/** @internal */
+export const ProposalSkillContent$inboundSchema: z.ZodType<
+  ProposalSkillContent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  format: SkillFormat$inboundSchema,
+  manifest: SkillManifest$inboundSchema,
+  instructions: z.string(),
+  resources: z.array(ProposalResource$inboundSchema),
+});
+
+export function proposalSkillContentFromJSON(
+  jsonString: string,
+): SafeParseResult<ProposalSkillContent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ProposalSkillContent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProposalSkillContent' from JSON`,
+  );
+}

package/src/models/proposal-skill-package.ts

@@ -0,0 +1,32 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 855ff7a45dcb
+ */
+
+import * as z from "zod/v3";
+
+export type ProposalSkillPackage = {
+  packageBase64: string;
+};
+
+/** @internal */
+export type ProposalSkillPackage$Outbound = {
+  packageBase64: string;
+};
+
+/** @internal */
+export const ProposalSkillPackage$outboundSchema: z.ZodType<
+  ProposalSkillPackage$Outbound,
+  z.ZodTypeDef,
+  ProposalSkillPackage
+> = z.object({
+  packageBase64: z.string(),
+});
+
+export function proposalSkillPackageToJSON(
+  proposalSkillPackage: ProposalSkillPackage,
+): string {
+  return JSON.stringify(
+    ProposalSkillPackage$outboundSchema.parse(proposalSkillPackage),
+  );
+}

package/src/models/proposal-source.ts

@@ -16,12 +16,11 @@ import { SDKValidationError } from "./errors/sdk-validation-error.js";
  * On evidence this describes an additional observation relevant to the same need.
  * Reference locates the input; content preserves the submitter's observation or
  * excerpt. Both, when present, must be JSON objects. Their fields are source-specific.
- * RAM extraction uses agent-memory-session or agent-memory-summary references and
+ * Agent Memory extraction uses agent-memory-session or agent-memory-summary references and
  * questionAnswer content; its question/answer are model-derived, not verbatim events.
- * See docs/specs/MOD-18196-playbook-extraction-readiness-follow-up.md for that contract.
  */
 export type ProposalSource = {
-  type: string;
+  kind: string;
   reference?: any | undefined;
   content?: any | undefined;
 };
@@ -32,13 +31,13 @@ export const ProposalSource$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  type: z.string(),
+  kind: z.string(),
   reference: z.any().optional(),
   content: z.any().optional(),
 });
 /** @internal */
 export type ProposalSource$Outbound = {
-  type: string;
+  kind: string;
   reference?: any | undefined;
   content?: any | undefined;
 };
@@ -49,7 +48,7 @@ export const ProposalSource$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   ProposalSource
 > = z.object({
-  type: z.string(),
+  kind: z.string(),
   reference: z.any().optional(),
   content: z.any().optional(),
 });

package/src/models/proposal-state.ts

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

package/src/models/proposal-stats.ts

@@ -0,0 +1,50 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 998ba7578c2e
+ */
+
+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 {
+  ObservedCount,
+  ObservedCount$inboundSchema,
+} from "./observed-count.js";
+
+export type ProposalStats = {
+  /**
+   * A successful empty query has available=true and value=0. Failed, timed-out,
+   *
+   * @remarks
+   * partial or malformed counts have available=false and no value.
+   */
+  inbox?: ObservedCount | undefined;
+  /**
+   * A successful empty query has available=true and value=0. Failed, timed-out,
+   *
+   * @remarks
+   * partial or malformed counts have available=false and no value.
+   */
+  trash?: ObservedCount | undefined;
+};
+
+/** @internal */
+export const ProposalStats$inboundSchema: z.ZodType<
+  ProposalStats,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  inbox: ObservedCount$inboundSchema.optional(),
+  trash: ObservedCount$inboundSchema.optional(),
+});
+
+export function proposalStatsFromJSON(
+  jsonString: string,
+): SafeParseResult<ProposalStats, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ProposalStats$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProposalStats' from JSON`,
+  );
+}

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

@@ -31,7 +31,7 @@ export const ProposalTargetInputNewEntry$outboundSchema: z.ZodType<
   ProposalTargetInputNewEntry
 > = z.object({
   newEntry: NewEntryTarget$outboundSchema,
-});
+}).strict();
 
 export function proposalTargetInputNewEntryToJSON(
   proposalTargetInputNewEntry: ProposalTargetInputNewEntry,

package/src/models/proposal-version-created.ts

@@ -14,7 +14,7 @@ export type ProposalVersionCreated = {
    * Opaque stable entry identifier.
    */
   entryId: string;
-  entryType: EntryType;
+  entryKind: EntryType;
   version: number;
   /**
    * SHA-256 digest of normalized authored Playbook content in sha256:<lowercase-hex> form. The canonicalization contract is documented as playbook-entry-v1.
@@ -29,7 +29,7 @@ export const ProposalVersionCreated$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   entryId: z.string(),
-  entryType: EntryType$inboundSchema,
+  entryKind: EntryType$inboundSchema,
   version: z.number().int(),
   contentDigest: z.string(),
 });

package/src/models/proposal-view.ts

@@ -7,8 +7,8 @@ import * as z from "zod/v3";
 import { ClosedEnum } from "../types/enums.js";
 
 export const ProposalView = {
-  Inbox: "inbox",
-  Trash: "trash",
+  Inbox: "INBOX",
+  Trash: "TRASH",
 } as const;
 export type ProposalView = ClosedEnum<typeof ProposalView>;
 

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

@@ -19,7 +19,7 @@ export type PublishFaqResponseContent = {
    * Optional Playbook-unique immutable human-readable entry key.
    */
   entryKey?: string | undefined;
-  entryType: EntryType;
+  kind: EntryType;
   /**
    * Newest immutable version number. Versions are append-only, so this also equals the version count.
    */
@@ -43,7 +43,7 @@ export const PublishFaqResponseContent$inboundSchema: z.ZodType<
 > = z.object({
   entryId: z.string(),
   entryKey: z.string().optional(),
-  entryType: EntryType$inboundSchema,
+  kind: EntryType$inboundSchema,
   latestVersion: z.number().int(),
   publication: Publication$inboundSchema.optional(),
   createdAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),

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

@@ -19,7 +19,7 @@ export type PublishSkillResponseContent = {
    * Optional Playbook-unique immutable human-readable entry key.
    */
   entryKey?: string | undefined;
-  entryType: EntryType;
+  kind: EntryType;
   /**
    * Newest immutable version number. Versions are append-only, so this also equals the version count.
    */
@@ -43,7 +43,7 @@ export const PublishSkillResponseContent$inboundSchema: z.ZodType<
 > = z.object({
   entryId: z.string(),
   entryKey: z.string().optional(),
-  entryType: EntryType$inboundSchema,
+  kind: EntryType$inboundSchema,
   latestVersion: z.number().int(),
   publication: Publication$inboundSchema.optional(),
   createdAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),

package/src/models/ready-status.ts

@@ -7,7 +7,7 @@ import * as z from "zod/v3";
 import { ClosedEnum } from "../types/enums.js";
 
 export const ReadyStatus = {
-  Ready: "ready",
+  Ready: "READY",
 } as const;
 export type ReadyStatus = ClosedEnum<typeof ReadyStatus>;
 

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

@@ -12,13 +12,22 @@ import {
 
 export type ReplaceProposalRequestContent = {
   action: ProposalActionInput;
-  expectedProposalRevision: number;
+  /**
+   * Resource revision. Opaque: each change to a resource's own configuration writes a
+   *
+   * @remarks
+   * new value, and a resource never gets a value it had before. Compare for equality
+   * only; its format is the service's, so only its length is constrained. Returned as
+   * `revision`; sent back as `expectedRevision` to make a write conditional. Omitting
+   * `expectedRevision` makes the write unconditional.
+   */
+  expectedRevision: string;
 };
 
 /** @internal */
 export type ReplaceProposalRequestContent$Outbound = {
   action: ProposalActionInput$Outbound;
-  expectedProposalRevision: number;
+  expectedRevision: string;
 };
 
 /** @internal */
@@ -28,7 +37,7 @@ export const ReplaceProposalRequestContent$outboundSchema: z.ZodType<
   ReplaceProposalRequestContent
 > = z.object({
   action: ProposalActionInput$outboundSchema,
-  expectedProposalRevision: z.number().int(),
+  expectedRevision: z.string(),
 });
 
 export function replaceProposalRequestContentToJSON(

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

@@ -24,18 +24,27 @@ import {
   ProposalSource$inboundSchema,
 } from "./proposal-source.js";
 import {
-  ProposalStatus,
-  ProposalStatus$inboundSchema,
-} from "./proposal-status.js";
+  ProposalState,
+  ProposalState$inboundSchema,
+} from "./proposal-state.js";
 
 export type ReplaceProposalResponseContent = {
   proposalId: string;
-  status: ProposalStatus;
+  state: ProposalState;
   /**
    * Present for actions that author content; absent for candidate-free actions.
    */
   contentDigest?: string | undefined;
-  proposalRevision: number;
+  /**
+   * Resource revision. Opaque: each change to a resource's own configuration writes a
+   *
+   * @remarks
+   * new value, and a resource never gets a value it had before. Compare for equality
+   * only; its format is the service's, so only its length is constrained. Returned as
+   * `revision`; sent back as `expectedRevision` to make a write conditional. Omitting
+   * `expectedRevision` makes the write unconditional.
+   */
+  revision: string;
   /**
    * Attached records only, excluding creation source; not distinct sessions or confidence.
    */
@@ -69,9 +78,8 @@ export type ReplaceProposalResponseContent = {
    * On evidence this describes an additional observation relevant to the same need.
    * Reference locates the input; content preserves the submitter's observation or
    * excerpt. Both, when present, must be JSON objects. Their fields are source-specific.
-   * RAM extraction uses agent-memory-session or agent-memory-summary references and
+   * Agent Memory extraction uses agent-memory-session or agent-memory-summary references and
    * questionAnswer content; its question/answer are model-derived, not verbatim events.
-   * See docs/specs/MOD-18196-playbook-extraction-readiness-follow-up.md for that contract.
    */
   source?: ProposalSource | undefined;
   /**
@@ -92,9 +100,9 @@ export const ReplaceProposalResponseContent$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   proposalId: z.string(),
-  status: ProposalStatus$inboundSchema,
+  state: ProposalState$inboundSchema,
   contentDigest: z.string().optional(),
-  proposalRevision: z.number().int(),
+  revision: z.string(),
   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)),

package/src/models/restore-proposal-response-content.ts

@@ -24,18 +24,27 @@ import {
   ProposalSource$inboundSchema,
 } from "./proposal-source.js";
 import {
-  ProposalStatus,
-  ProposalStatus$inboundSchema,
-} from "./proposal-status.js";
+  ProposalState,
+  ProposalState$inboundSchema,
+} from "./proposal-state.js";
 
 export type RestoreProposalResponseContent = {
   proposalId: string;
-  status: ProposalStatus;
+  state: ProposalState;
   /**
    * Present for actions that author content; absent for candidate-free actions.
    */
   contentDigest?: string | undefined;
-  proposalRevision: number;
+  /**
+   * Resource revision. Opaque: each change to a resource's own configuration writes a
+   *
+   * @remarks
+   * new value, and a resource never gets a value it had before. Compare for equality
+   * only; its format is the service's, so only its length is constrained. Returned as
+   * `revision`; sent back as `expectedRevision` to make a write conditional. Omitting
+   * `expectedRevision` makes the write unconditional.
+   */
+  revision: string;
   /**
    * Attached records only, excluding creation source; not distinct sessions or confidence.
    */
@@ -69,9 +78,8 @@ export type RestoreProposalResponseContent = {
    * On evidence this describes an additional observation relevant to the same need.
    * Reference locates the input; content preserves the submitter's observation or
    * excerpt. Both, when present, must be JSON objects. Their fields are source-specific.
-   * RAM extraction uses agent-memory-session or agent-memory-summary references and
+   * Agent Memory extraction uses agent-memory-session or agent-memory-summary references and
    * questionAnswer content; its question/answer are model-derived, not verbatim events.
-   * See docs/specs/MOD-18196-playbook-extraction-readiness-follow-up.md for that contract.
    */
   source?: ProposalSource | undefined;
   /**
@@ -92,9 +100,9 @@ export const RestoreProposalResponseContent$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   proposalId: z.string(),
-  status: ProposalStatus$inboundSchema,
+  state: ProposalState$inboundSchema,
   contentDigest: z.string().optional(),
-  proposalRevision: z.number().int(),
+  revision: z.string(),
   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)),

package/src/models/scored-proposal-preview.ts

@@ -17,6 +17,12 @@ export type ScoredProposalPreview = {
    * Compact management projection; GET the proposal for the complete candidate.
    */
   proposal: ProposalPreview;
+  /**
+   * A relevance score in [0, 1]. Higher is closer, and every threshold in the API
+   *
+   * @remarks
+   * (`minScore`) points the same way: higher is stricter.
+   */
   score: number;
 };
 

package/src/models/search-faqs-request-content.ts

@@ -15,7 +15,7 @@ export type SearchFaqsRequestContent = {
   /**
    * Normalized cosine similarity floor applied to this request. Omission uses the corresponding FAQ or Skill discovery threshold.
    */
-  minimumScore?: number | undefined;
+  minScore?: number | undefined;
   /**
    * Caller-controlled top K. Omission uses discovery.maxResults; an explicit value is not capped by discovery policy.
    */
@@ -26,7 +26,7 @@ export type SearchFaqsRequestContent = {
 export type SearchFaqsRequestContent$Outbound = {
   query: string;
   filter?: Filter$Outbound | undefined;
-  minimumScore?: number | undefined;
+  minScore?: number | undefined;
   limit?: number | undefined;
 };
 
@@ -38,7 +38,7 @@ export const SearchFaqsRequestContent$outboundSchema: z.ZodType<
 > = z.object({
   query: z.string(),
   filter: Filter$outboundSchema.optional(),
-  minimumScore: z.number().optional(),
+  minScore: z.number().optional(),
   limit: z.number().int().optional(),
 });
 

package/src/models/search-faqs-response-content.ts

@@ -13,7 +13,7 @@ import {
 import { SDKValidationError } from "./errors/sdk-validation-error.js";
 
 export type SearchFaqsResponseContent = {
-  matches: Array<DiscoveredPlaybookPreviewEntry>;
+  items: Array<DiscoveredPlaybookPreviewEntry>;
 };
 
 /** @internal */
@@ -22,7 +22,7 @@ export const SearchFaqsResponseContent$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  matches: z.array(DiscoveredPlaybookPreviewEntry$inboundSchema),
+  items: z.array(DiscoveredPlaybookPreviewEntry$inboundSchema),
 });
 
 export function searchFaqsResponseContentFromJSON(

package/src/models/search-proposals-request-content.ts

@@ -12,9 +12,15 @@ import {
 
 export type SearchProposalsRequestContent = {
   actionType?: ProposalActionType | undefined;
-  entryType?: EntryType | undefined;
+  entryKind?: EntryType | undefined;
   query: string;
-  minimumScore?: number | undefined;
+  /**
+   * A relevance score in [0, 1]. Higher is closer, and every threshold in the API
+   *
+   * @remarks
+   * (`minScore`) points the same way: higher is stricter.
+   */
+  minScore?: number | undefined;
   /**
    * Maximum result count. Omission uses 10.
    */
@@ -24,9 +30,9 @@ export type SearchProposalsRequestContent = {
 /** @internal */
 export type SearchProposalsRequestContent$Outbound = {
   actionType?: string | undefined;
-  entryType?: string | undefined;
+  entryKind?: string | undefined;
   query: string;
-  minimumScore?: number | undefined;
+  minScore?: number | undefined;
   limit: number;
 };
 
@@ -37,9 +43,9 @@ export const SearchProposalsRequestContent$outboundSchema: z.ZodType<
   SearchProposalsRequestContent
 > = z.object({
   actionType: ProposalActionType$outboundSchema.optional(),
-  entryType: EntryType$outboundSchema.optional(),
+  entryKind: EntryType$outboundSchema.optional(),
   query: z.string(),
-  minimumScore: z.number().optional(),
+  minScore: z.number().optional(),
   limit: z.number().int().default(10),
 });
 

package/src/models/search-proposals-response-content.ts

@@ -13,7 +13,7 @@ import {
 } from "./scored-proposal-preview.js";
 
 export type SearchProposalsResponseContent = {
-  matches: Array<ScoredProposalPreview>;
+  items: Array<ScoredProposalPreview>;
 };
 
 /** @internal */
@@ -22,7 +22,7 @@ export const SearchProposalsResponseContent$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  matches: z.array(ScoredProposalPreview$inboundSchema),
+  items: z.array(ScoredProposalPreview$inboundSchema),
 });
 
 export function searchProposalsResponseContentFromJSON(

package/src/models/search-skills-request-content.ts

@@ -15,7 +15,7 @@ export type SearchSkillsRequestContent = {
   /**
    * Normalized cosine similarity floor applied to this request. Omission uses the corresponding FAQ or Skill discovery threshold.
    */
-  minimumScore?: number | undefined;
+  minScore?: number | undefined;
   /**
    * Caller-controlled top K. Omission uses discovery.maxResults; an explicit value is not capped by discovery policy.
    */
@@ -26,7 +26,7 @@ export type SearchSkillsRequestContent = {
 export type SearchSkillsRequestContent$Outbound = {
   query: string;
   filter?: Filter$Outbound | undefined;
-  minimumScore?: number | undefined;
+  minScore?: number | undefined;
   limit?: number | undefined;
 };
 
@@ -38,7 +38,7 @@ export const SearchSkillsRequestContent$outboundSchema: z.ZodType<
 > = z.object({
   query: z.string(),
   filter: Filter$outboundSchema.optional(),
-  minimumScore: z.number().optional(),
+  minScore: z.number().optional(),
   limit: z.number().int().optional(),
 });
 

package/src/models/search-skills-response-content.ts

@@ -13,7 +13,7 @@ import {
 import { SDKValidationError } from "./errors/sdk-validation-error.js";
 
 export type SearchSkillsResponseContent = {
-  matches: Array<DiscoveredPlaybookPreviewEntry>;
+  items: Array<DiscoveredPlaybookPreviewEntry>;
 };
 
 /** @internal */
@@ -22,7 +22,7 @@ export const SearchSkillsResponseContent$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  matches: z.array(DiscoveredPlaybookPreviewEntry$inboundSchema),
+  items: z.array(DiscoveredPlaybookPreviewEntry$inboundSchema),
 });
 
 export function searchSkillsResponseContentFromJSON(

package/src/models/service-health-status.ts

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

package/src/models/service-unavailable-error-type.ts

@@ -0,0 +1,24 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 3f974feacf6d
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../types/enums.js";
+import { OpenEnum } from "../types/enums.js";
+
+export const ServiceUnavailableErrorType = {
+  RootErrorsServiceUnavailable: "/errors/service-unavailable",
+  RootErrorsPlaybookNotReady: "/errors/playbook-not-ready",
+  RootErrorsResourceUnavailable: "/errors/resource-unavailable",
+} as const;
+export type ServiceUnavailableErrorType = OpenEnum<
+  typeof ServiceUnavailableErrorType
+>;
+
+/** @internal */
+export const ServiceUnavailableErrorType$inboundSchema: z.ZodType<
+  ServiceUnavailableErrorType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ServiceUnavailableErrorType);