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

package/src/models/get-playbook-stats-response-content.ts

@@ -0,0 +1,58 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 6d3794548754
+ */
+
+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 {
+  InventoryStats,
+  InventoryStats$inboundSchema,
+} from "./inventory-stats.js";
+import {
+  ProposalStats,
+  ProposalStats$inboundSchema,
+} from "./proposal-stats.js";
+
+export type GetPlaybookStatsResponseContent = {
+  /**
+   * Observation start in UTC, also used to evaluate proposal lifecycle deadlines.
+   *
+   * @remarks
+   * Individual queries may complete later; this does not imply snapshot isolation.
+   */
+  observedAt: Date;
+  /**
+   * Each bucket intersects all requested inventory filters.
+   */
+  faqs: InventoryStats;
+  /**
+   * Each bucket intersects all requested inventory filters.
+   */
+  skills: InventoryStats;
+  proposals: ProposalStats;
+};
+
+/** @internal */
+export const GetPlaybookStatsResponseContent$inboundSchema: z.ZodType<
+  GetPlaybookStatsResponseContent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  observedAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  faqs: InventoryStats$inboundSchema,
+  skills: InventoryStats$inboundSchema,
+  proposals: ProposalStats$inboundSchema,
+});
+
+export function getPlaybookStatsResponseContentFromJSON(
+  jsonString: string,
+): SafeParseResult<GetPlaybookStatsResponseContent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetPlaybookStatsResponseContent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetPlaybookStatsResponseContent' from JSON`,
+  );
+}

package/src/models/get-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 GetProposalResponseContent = {
   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.
    */
@@ -92,9 +101,9 @@ export const GetProposalResponseContent$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/get-skill-response-content.ts

@@ -19,7 +19,7 @@ export type GetSkillResponseContent = {
    * 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 GetSkillResponseContent$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/get-skill-version-response-content.ts

@@ -18,7 +18,7 @@ export type GetSkillVersionResponseContent = {
    * Opaque stable entry identifier.
    */
   entryId: string;
-  entryType: EntryType;
+  entryKind: EntryType;
   version: number;
   /**
    * UTC timestamp resolved to microsecond precision.
@@ -41,7 +41,7 @@ export const GetSkillVersionResponseContent$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   entryId: z.string(),
-  entryType: EntryType$inboundSchema,
+  entryKind: EntryType$inboundSchema,
   version: z.number().int(),
   createdAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),
   contentDigest: z.string(),

package/src/models/index.ts

@@ -14,8 +14,11 @@ export * from "./append-skill-version-request-content.js";
 export * from "./append-skill-version-response-content.js";
 export * from "./authentication-error-type.js";
 export * from "./authored-content.js";
+export * from "./bad-request-error-type.js";
+export * from "./bulk-delete-entry-error.js";
 export * from "./candidate-preview-content.js";
 export * from "./candidate-preview-payload.js";
+export * from "./conflict-error-type.js";
 export * from "./content-metadata.js";
 export * from "./content-preview.js";
 export * from "./create-faq-request-content.js";
@@ -54,9 +57,11 @@ export * from "./found-entry-lookup-result.js";
 export * from "./get-faq-response-content.js";
 export * from "./get-faq-version-response-content.js";
 export * from "./get-playbook-health-response-content.js";
+export * from "./get-playbook-stats-response-content.js";
 export * from "./get-proposal-response-content.js";
 export * from "./get-skill-response-content.js";
 export * from "./get-skill-version-response-content.js";
+export * from "./inventory-stats.js";
 export * from "./list-faq-versions-response-content.js";
 export * from "./list-faqs-response-content.js";
 export * from "./list-proposals-response-content.js";
@@ -67,11 +72,10 @@ export * from "./lookup-entries-response-content.js";
 export * from "./missing-entry-lookup-result.js";
 export * from "./new-entry-target.js";
 export * from "./not-found-error-type.js";
+export * from "./observed-count.js";
 export * from "./payload-too-large-error-type.js";
 export * from "./pinned-playbook-preview-entry.js";
-export * from "./playbook-conflict-error-type.js";
-export * from "./playbook-internal-error-type.js";
-export * from "./playbook-service-unavailable-error-type.js";
+export * from "./precondition-failed-error-type.js";
 export * from "./preview-payload.js";
 export * from "./proposal-acceptance-result.js";
 export * from "./proposal-action-input.js";
@@ -88,7 +92,8 @@ export * from "./proposal-input-payload.js";
 export * from "./proposal-preview.js";
 export * from "./proposal-sort.js";
 export * from "./proposal-source.js";
-export * from "./proposal-status.js";
+export * from "./proposal-state.js";
+export * from "./proposal-stats.js";
 export * from "./proposal-target-input.js";
 export * from "./proposal-target.js";
 export * from "./proposal-version-created.js";
@@ -101,7 +106,6 @@ export * from "./publish-skill-response-content.js";
 export * from "./ready-status.js";
 export * from "./replace-proposal-request-content.js";
 export * from "./replace-proposal-response-content.js";
-export * from "./request-validation-error-type.js";
 export * from "./resource-descriptor.js";
 export * from "./resource-suspended-error-type.js";
 export * from "./restore-proposal-response-content.js";
@@ -113,6 +117,7 @@ export * from "./search-proposals-response-content.js";
 export * from "./search-skills-request-content.js";
 export * from "./search-skills-response-content.js";
 export * from "./security.js";
+export * from "./service-unavailable-error-type.js";
 export * from "./skill-content.js";
 export * from "./skill-format.js";
 export * from "./skill-manifest.js";
@@ -123,6 +128,7 @@ export * from "./submit-proposal-evidence-request-content.js";
 export * from "./submit-proposal-evidence-response-content.js";
 export * from "./timeout-error-type.js";
 export * from "./too-many-requests-error-type.js";
+export * from "./unexpected-error-type.js";
 export * from "./version.js";
 export * from "./withdraw-faq-response-content.js";
 export * from "./withdraw-skill-response-content.js";

package/src/models/inventory-stats.ts

@@ -0,0 +1,61 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 7181156aeaba
+ */
+
+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";
+
+/**
+ * Each bucket intersects all requested inventory filters.
+ */
+export type InventoryStats = {
+  /**
+   * A successful empty query has available=true and value=0. Failed, timed-out,
+   *
+   * @remarks
+   * partial or malformed counts have available=false and no value.
+   */
+  total: ObservedCount;
+  /**
+   * A successful empty query has available=true and value=0. Failed, timed-out,
+   *
+   * @remarks
+   * partial or malformed counts have available=false and no value.
+   */
+  published: ObservedCount;
+  /**
+   * A successful empty query has available=true and value=0. Failed, timed-out,
+   *
+   * @remarks
+   * partial or malformed counts have available=false and no value.
+   */
+  unpublished: ObservedCount;
+};
+
+/** @internal */
+export const InventoryStats$inboundSchema: z.ZodType<
+  InventoryStats,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  total: ObservedCount$inboundSchema,
+  published: ObservedCount$inboundSchema,
+  unpublished: ObservedCount$inboundSchema,
+});
+
+export function inventoryStatsFromJSON(
+  jsonString: string,
+): SafeParseResult<InventoryStats, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => InventoryStats$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'InventoryStats' from JSON`,
+  );
+}

package/src/models/list-faq-versions-response-content.ts

@@ -10,7 +10,10 @@ import { SDKValidationError } from "./errors/sdk-validation-error.js";
 import { Version, Version$inboundSchema } from "./version.js";
 
 export type ListFaqVersionsResponseContent = {
-  versions: Array<Version>;
+  items: Array<Version>;
+  /**
+   * Opaque position in a list, returned as `nextCursor` and passed back as `cursor`.
+   */
   nextCursor?: string | undefined;
 };
 
@@ -20,7 +23,7 @@ export const ListFaqVersionsResponseContent$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  versions: z.array(Version$inboundSchema),
+  items: z.array(Version$inboundSchema),
   nextCursor: z.string().optional(),
 });
 

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

@@ -17,14 +17,7 @@ export type ListFaqsResponseContent = {
    * Live updates/indexing delay can repeat or skip moved items; this is not a snapshot.
    */
   nextCursor?: string | undefined;
-  /**
-   * First-page count matching the original filters at count-query time. Omitted on
-   *
-   * @remarks
-   * cursored requests or when counting is unavailable; absence means unknown, not zero.
-   */
-  total?: number | undefined;
-  faqs: Array<StableEntry>;
+  items: Array<StableEntry>;
 };
 
 /** @internal */
@@ -34,8 +27,7 @@ export const ListFaqsResponseContent$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   nextCursor: z.string().optional(),
-  total: z.number().int().optional(),
-  faqs: z.array(StableEntry$inboundSchema),
+  items: z.array(StableEntry$inboundSchema),
 });
 
 export function listFaqsResponseContentFromJSON(

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

@@ -20,14 +20,7 @@ export type ListProposalsResponseContent = {
    * Live updates/indexing delay can repeat or skip moved items; this is not a snapshot.
    */
   nextCursor?: string | undefined;
-  /**
-   * First-page count matching the original filters at count-query time. Omitted on
-   *
-   * @remarks
-   * cursored requests or when counting is unavailable; absence means unknown, not zero.
-   */
-  total?: number | undefined;
-  proposals: Array<ProposalPreview>;
+  items: Array<ProposalPreview>;
 };
 
 /** @internal */
@@ -37,8 +30,7 @@ export const ListProposalsResponseContent$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   nextCursor: z.string().optional(),
-  total: z.number().int().optional(),
-  proposals: z.array(ProposalPreview$inboundSchema),
+  items: z.array(ProposalPreview$inboundSchema),
 });
 
 export function listProposalsResponseContentFromJSON(

package/src/models/list-skill-versions-response-content.ts

@@ -10,7 +10,10 @@ import { SDKValidationError } from "./errors/sdk-validation-error.js";
 import { Version, Version$inboundSchema } from "./version.js";
 
 export type ListSkillVersionsResponseContent = {
-  versions: Array<Version>;
+  items: Array<Version>;
+  /**
+   * Opaque position in a list, returned as `nextCursor` and passed back as `cursor`.
+   */
   nextCursor?: string | undefined;
 };
 
@@ -20,7 +23,7 @@ export const ListSkillVersionsResponseContent$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  versions: z.array(Version$inboundSchema),
+  items: z.array(Version$inboundSchema),
   nextCursor: z.string().optional(),
 });
 

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

@@ -17,14 +17,7 @@ export type ListSkillsResponseContent = {
    * Live updates/indexing delay can repeat or skip moved items; this is not a snapshot.
    */
   nextCursor?: string | undefined;
-  /**
-   * First-page count matching the original filters at count-query time. Omitted on
-   *
-   * @remarks
-   * cursored requests or when counting is unavailable; absence means unknown, not zero.
-   */
-  total?: number | undefined;
-  skills: Array<StableEntry>;
+  items: Array<StableEntry>;
 };
 
 /** @internal */
@@ -34,8 +27,7 @@ export const ListSkillsResponseContent$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   nextCursor: z.string().optional(),
-  total: z.number().int().optional(),
-  skills: z.array(StableEntry$inboundSchema),
+  items: z.array(StableEntry$inboundSchema),
 });
 
 export function listSkillsResponseContentFromJSON(

package/src/models/lookup-entries-response-content.ts

@@ -13,7 +13,7 @@ import {
 import { SDKValidationError } from "./errors/sdk-validation-error.js";
 
 export type LookupEntriesResponseContent = {
-  results: Array<EntryLookupResult>;
+  items: Array<EntryLookupResult>;
   maxVersions: number;
 };
 
@@ -23,7 +23,7 @@ export const LookupEntriesResponseContent$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  results: z.array(EntryLookupResult$inboundSchema),
+  items: z.array(EntryLookupResult$inboundSchema),
   maxVersions: z.number().int(),
 });
 

package/src/models/not-found-error-type.ts

@@ -4,20 +4,25 @@
  */
 
 import * as z from "zod/v3";
-import { ClosedEnum } from "../types/enums.js";
+import * as openEnums from "../types/enums.js";
+import { OpenEnum } from "../types/enums.js";
 
 /**
  * Problem type URI for not-found errors.
  */
 export const NotFoundErrorType = {
   RootErrorsResourceNotFound: "/errors/resource-not-found",
+  RootErrorsGatewayNotFound: "/errors/gateway-not-found",
+  RootErrorsUpstreamNotFound: "/errors/upstream-not-found",
 } as const;
 /**
  * Problem type URI for not-found errors.
  */
-export type NotFoundErrorType = ClosedEnum<typeof NotFoundErrorType>;
+export type NotFoundErrorType = OpenEnum<typeof NotFoundErrorType>;
 
 /** @internal */
-export const NotFoundErrorType$inboundSchema: z.ZodNativeEnum<
-  typeof NotFoundErrorType
-> = z.nativeEnum(NotFoundErrorType);
+export const NotFoundErrorType$inboundSchema: z.ZodType<
+  NotFoundErrorType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(NotFoundErrorType);

package/src/models/observed-count.ts

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

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

@@ -0,0 +1,70 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: ebeeeda763e4
+ */
+
+import * as z from "zod/v3";
+import * as models from "../index.js";
+
+export type GetPlaybookStatsGlobals = {
+  playbookId?: string | undefined;
+};
+
+export type GetPlaybookStatsRequest = {
+  /**
+   * Applies only to FAQ/Skill inventory. Intersects each publication bucket.
+   */
+  published?: boolean | undefined;
+  /**
+   * Applies only to FAQ/Skill inventory; exclusive microsecond bound.
+   */
+  createdAfter?: Date | undefined;
+  /**
+   * Applies only to FAQ/Skill inventory; exclusive microsecond bound.
+   */
+  createdBefore?: Date | undefined;
+  /**
+   * Applies only to proposals. Omit to observe both Inbox and Trash.
+   */
+  view?: models.ProposalView | undefined;
+  /**
+   * Applies only to proposals, matching ListProposals selectors.
+   */
+  actionType?: models.ProposalActionType | undefined;
+  /**
+   * Applies only to proposals, matching ListProposals selectors.
+   */
+  entryKind?: models.EntryType | undefined;
+};
+
+/** @internal */
+export type GetPlaybookStatsRequest$Outbound = {
+  published?: boolean | undefined;
+  createdAfter?: string | undefined;
+  createdBefore?: string | undefined;
+  view?: string | undefined;
+  actionType?: string | undefined;
+  entryKind?: string | undefined;
+};
+
+/** @internal */
+export const GetPlaybookStatsRequest$outboundSchema: z.ZodType<
+  GetPlaybookStatsRequest$Outbound,
+  z.ZodTypeDef,
+  GetPlaybookStatsRequest
+> = z.object({
+  published: z.boolean().optional(),
+  createdAfter: z.date().transform(v => v.toISOString()).optional(),
+  createdBefore: z.date().transform(v => v.toISOString()).optional(),
+  view: models.ProposalView$outboundSchema.optional(),
+  actionType: models.ProposalActionType$outboundSchema.optional(),
+  entryKind: models.EntryType$outboundSchema.optional(),
+});
+
+export function getPlaybookStatsRequestToJSON(
+  getPlaybookStatsRequest: GetPlaybookStatsRequest,
+): string {
+  return JSON.stringify(
+    GetPlaybookStatsRequest$outboundSchema.parse(getPlaybookStatsRequest),
+  );
+}

package/src/models/operations/index.ts

@@ -18,6 +18,7 @@ export * from "./dismiss-proposal.js";
 export * from "./get-faq-version.js";
 export * from "./get-faq.js";
 export * from "./get-playbook-health.js";
+export * from "./get-playbook-stats.js";
 export * from "./get-proposal.js";
 export * from "./get-skill-resource.js";
 export * from "./get-skill-version.js";

package/src/models/operations/list-faq-versions.ts

@@ -23,6 +23,9 @@ export type ListFaqVersionsRequest = {
    */
   createdBefore?: Date | undefined;
   limit?: number | undefined;
+  /**
+   * Opaque position in a list, returned as `nextCursor` and passed back as `cursor`.
+   */
   cursor?: string | undefined;
 };
 

package/src/models/operations/list-faqs.ts

@@ -16,7 +16,7 @@ export type ListFaqsRequest = {
    */
   sortBy?: models.EntrySort | undefined;
   /**
-   * Defaults to desc. ID ties are always asc.
+   * Defaults to DESC. ID ties are always ASC.
    */
   sortOrder?: models.SortOrder | undefined;
   /**
@@ -32,6 +32,9 @@ export type ListFaqsRequest = {
    */
   published?: boolean | undefined;
   limit?: number | undefined;
+  /**
+   * Opaque position in a list, returned as `nextCursor` and passed back as `cursor`.
+   */
   cursor?: string | undefined;
 };
 

package/src/models/operations/list-proposals.ts

@@ -17,13 +17,16 @@ export type ListProposalsRequest = {
    */
   sortBy?: models.ProposalSort | undefined;
   /**
-   * Defaults to asc for deadlines, desc otherwise. ID ties are always asc.
+   * Defaults to ASC for deadlines, DESC otherwise. ID ties are always ASC.
    */
   sortOrder?: models.SortOrder | undefined;
   limit?: number | undefined;
+  /**
+   * Opaque position in a list, returned as `nextCursor` and passed back as `cursor`.
+   */
   cursor?: string | undefined;
   actionType?: models.ProposalActionType | undefined;
-  entryType?: models.EntryType | undefined;
+  entryKind?: models.EntryType | undefined;
 };
 
 /** @internal */
@@ -34,7 +37,7 @@ export type ListProposalsRequest$Outbound = {
   limit: number;
   cursor?: string | undefined;
   actionType?: string | undefined;
-  entryType?: string | undefined;
+  entryKind?: string | undefined;
 };
 
 /** @internal */
@@ -49,7 +52,7 @@ export const ListProposalsRequest$outboundSchema: z.ZodType<
   limit: z.number().int().default(50),
   cursor: z.string().optional(),
   actionType: models.ProposalActionType$outboundSchema.optional(),
-  entryType: models.EntryType$outboundSchema.optional(),
+  entryKind: models.EntryType$outboundSchema.optional(),
 });
 
 export function listProposalsRequestToJSON(

package/src/models/operations/list-skill-versions.ts

@@ -23,6 +23,9 @@ export type ListSkillVersionsRequest = {
    */
   createdBefore?: Date | undefined;
   limit?: number | undefined;
+  /**
+   * Opaque position in a list, returned as `nextCursor` and passed back as `cursor`.
+   */
   cursor?: string | undefined;
 };
 

package/src/models/operations/list-skills.ts

@@ -16,7 +16,7 @@ export type ListSkillsRequest = {
    */
   sortBy?: models.EntrySort | undefined;
   /**
-   * Defaults to desc. ID ties are always asc.
+   * Defaults to DESC. ID ties are always ASC.
    */
   sortOrder?: models.SortOrder | undefined;
   /**
@@ -32,6 +32,9 @@ export type ListSkillsRequest = {
    */
   published?: boolean | undefined;
   limit?: number | undefined;
+  /**
+   * Opaque position in a list, returned as `nextCursor` and passed back as `cursor`.
+   */
   cursor?: string | undefined;
 };