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

package/src/models/proposal-payload.ts

@@ -0,0 +1,82 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 9229af89ba92
+ */
+
+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 { FaqContent, FaqContent$inboundSchema } from "./faq-content.js";
+import {
+  ProposalSkillContent,
+  ProposalSkillContent$inboundSchema,
+} from "./proposal-skill-content.js";
+
+export type ProposalPayloadSkill = {
+  skill: ProposalSkillContent;
+};
+
+export type ProposalPayloadFaq = {
+  faq: FaqContent;
+};
+
+export type ProposalPayload = ProposalPayloadFaq | ProposalPayloadSkill;
+
+/** @internal */
+export const ProposalPayloadSkill$inboundSchema: z.ZodType<
+  ProposalPayloadSkill,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  skill: ProposalSkillContent$inboundSchema,
+});
+
+export function proposalPayloadSkillFromJSON(
+  jsonString: string,
+): SafeParseResult<ProposalPayloadSkill, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ProposalPayloadSkill$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProposalPayloadSkill' from JSON`,
+  );
+}
+
+/** @internal */
+export const ProposalPayloadFaq$inboundSchema: z.ZodType<
+  ProposalPayloadFaq,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  faq: FaqContent$inboundSchema,
+});
+
+export function proposalPayloadFaqFromJSON(
+  jsonString: string,
+): SafeParseResult<ProposalPayloadFaq, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ProposalPayloadFaq$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProposalPayloadFaq' from JSON`,
+  );
+}
+
+/** @internal */
+export const ProposalPayload$inboundSchema: z.ZodType<
+  ProposalPayload,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  z.lazy(() => ProposalPayloadFaq$inboundSchema),
+  z.lazy(() => ProposalPayloadSkill$inboundSchema),
+]);
+
+export function proposalPayloadFromJSON(
+  jsonString: string,
+): SafeParseResult<ProposalPayload, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ProposalPayload$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProposalPayload' from JSON`,
+  );
+}

package/src/models/proposal-resource.ts

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: e5e3820cfb48
+ */
+
+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 ProposalResource = {
+  resourceId: string;
+  path: string;
+  /**
+   * SHA-256 digest of exact resource bytes in sha256:<lowercase-hex> form.
+   */
+  digest: string;
+  sizeBytes: number;
+  mimeType: string;
+  executable: boolean;
+};
+
+/** @internal */
+export const ProposalResource$inboundSchema: z.ZodType<
+  ProposalResource,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  resourceId: z.string(),
+  path: z.string(),
+  digest: z.string(),
+  sizeBytes: z.number().int(),
+  mimeType: z.string(),
+  executable: z.boolean(),
+});
+
+export function proposalResourceFromJSON(
+  jsonString: string,
+): SafeParseResult<ProposalResource, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ProposalResource$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProposalResource' from JSON`,
+  );
+}

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,9 +16,8 @@ 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 = {
   kind: string;

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

@@ -78,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;
   /**

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

@@ -78,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;
   /**

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/skill-candidate-preview.ts

@@ -0,0 +1,34 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 8a5cd58120cb
+ */
+
+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 SkillCandidatePreview = {
+  name: string;
+  description: string;
+};
+
+/** @internal */
+export const SkillCandidatePreview$inboundSchema: z.ZodType<
+  SkillCandidatePreview,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  description: z.string(),
+});
+
+export function skillCandidatePreviewFromJSON(
+  jsonString: string,
+): SafeParseResult<SkillCandidatePreview, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SkillCandidatePreview$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SkillCandidatePreview' from JSON`,
+  );
+}

package/src/models/submit-proposal-evidence-request-content.ts

@@ -35,9 +35,8 @@ export type SubmitProposalEvidenceRequestContent = {
    * 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;
 };

package/src/sdk/sdk.ts

@@ -19,7 +19,10 @@ import { getFaqVersion } from "../funcs/get-faq-version.js";
 import { getFaq } from "../funcs/get-faq.js";
 import { getPlaybookHealth } from "../funcs/get-playbook-health.js";
 import { getPlaybookStats } from "../funcs/get-playbook-stats.js";
+import { getProposalResource } from "../funcs/get-proposal-resource.js";
 import { getProposal } from "../funcs/get-proposal.js";
+import { getServiceLiveness } from "../funcs/get-service-liveness.js";
+import { getServiceReadiness } from "../funcs/get-service-readiness.js";
 import { getSkillResource } from "../funcs/get-skill-resource.js";
 import { getSkillVersion } from "../funcs/get-skill-version.js";
 import { getSkill } from "../funcs/get-skill.js";
@@ -46,6 +49,30 @@ import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
 export class Playbook extends ClientSDK {
+  /**
+   * Reports that this API process can answer requests, independently of downstream dependencies.
+   */
+  async getServiceLiveness(
+    options?: RequestOptions,
+  ): Promise<models.GetServiceLivenessResponseContent> {
+    return unwrapAsync(getServiceLiveness(
+      this,
+      options,
+    ));
+  }
+
+  /**
+   * Evaluates the same serving dependencies as the operational readiness probe. Returns 503 without dependency details when the service cannot serve requests.
+   */
+  async getServiceReadiness(
+    options?: RequestOptions,
+  ): Promise<models.GetServiceReadinessResponseContent> {
+    return unwrapAsync(getServiceReadiness(
+      this,
+      options,
+    ));
+  }
+
   async discoverEntries(
     request: models.DiscoverEntriesRequestContent,
     options?: RequestOptions,
@@ -261,6 +288,9 @@ export class Playbook extends ClientSDK {
     ));
   }
 
+  /**
+   * Submit an FAQ or complete Skill package for human review. Extraction and agent submissions share proposalPolicy.maxOpenProposals. When the Inbox is full, HTTP 409 content-limit-exceeded identifies the configured limit and observed open count; the proposal was not saved. Review/dismiss existing proposals or ask an administrator to increase the configured limit before retrying. Capacity is advisory because Search is eventually consistent.
+   */
   async createProposal(
     request: models.CreateProposalRequestContent,
     options?: RequestOptions,
@@ -376,6 +406,24 @@ export class Playbook extends ClientSDK {
     ));
   }
 
+  /**
+   * Returns exact candidate file bytes for the requested proposal revision. A stale revision returns HTTP 412 /errors/revision-conflict; responses must not be cached.
+   */
+  async getProposalResource(
+    proposalId: string,
+    resourceId: string,
+    expectedRevision: string,
+    options?: RequestOptions,
+  ): Promise<operations.GetProposalResourceResponse> {
+    return unwrapAsync(getProposalResource(
+      this,
+      proposalId,
+      resourceId,
+      expectedRevision,
+      options,
+    ));
+  }
+
   async listSkills(
     sortBy?: models.EntrySort | undefined,
     sortOrder?: models.SortOrder | undefined,