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

package/package.json

@@ -1,15 +1,15 @@
 {
   "name": "@redis-iris/agent-playbook",
-  "version": "0.1.0-alpha.3",
+  "version": "0.1.0-beta.1",
   "author": "Redis",
-  "description": "TypeScript SDK for Redis Playbook Service",
+  "description": "TypeScript SDK for Redis AgentPlaybooks",
   "engines": {
     "node": ">=20"
   },
   "homepage": "https://redis.io/docs/latest/develop/ai/",
   "license": "MIT",
   "publishConfig": {
-    "tag": "alpha",
+    "tag": "beta",
     "access": "public"
   },
   "type": "module",
@@ -26,7 +26,12 @@
       "./models": "./src/models/index.ts",
       "./models/operations": "./src/models/operations/index.ts",
       "./*.js": "./src/*.ts",
-      "./*": "./src/*.ts"
+      "./*": "./src/*.ts",
+      "./controlplane": "./src/controlplane/index.ts",
+      "./controlplane/models": "./src/controlplane/models/index.ts",
+      "./controlplane/models/errors": "./src/controlplane/models/errors/index.ts",
+      "./controlplane/models/operations": "./src/controlplane/models/operations/index.ts",
+      "./controlplane/types": "./src/controlplane/types/index.ts"
     }
   },
   "sideEffects": false,
@@ -133,6 +138,61 @@
         "types": "./dist/commonjs/*.d.ts",
         "default": "./dist/commonjs/*.js"
       }
+    },
+    "./controlplane": {
+      "import": {
+        "@redis-iris/agent-playbook/source": "./src/controlplane/index.ts",
+        "types": "./dist/esm/controlplane/index.d.ts",
+        "default": "./dist/esm/controlplane/index.js"
+      },
+      "require": {
+        "types": "./dist/commonjs/controlplane/index.d.ts",
+        "default": "./dist/commonjs/controlplane/index.js"
+      }
+    },
+    "./controlplane/models": {
+      "import": {
+        "@redis-iris/agent-playbook/source": "./src/controlplane/models/index.ts",
+        "types": "./dist/esm/controlplane/models/index.d.ts",
+        "default": "./dist/esm/controlplane/models/index.js"
+      },
+      "require": {
+        "types": "./dist/commonjs/controlplane/models/index.d.ts",
+        "default": "./dist/commonjs/controlplane/models/index.js"
+      }
+    },
+    "./controlplane/models/errors": {
+      "import": {
+        "@redis-iris/agent-playbook/source": "./src/controlplane/models/errors/index.ts",
+        "types": "./dist/esm/controlplane/models/errors/index.d.ts",
+        "default": "./dist/esm/controlplane/models/errors/index.js"
+      },
+      "require": {
+        "types": "./dist/commonjs/controlplane/models/errors/index.d.ts",
+        "default": "./dist/commonjs/controlplane/models/errors/index.js"
+      }
+    },
+    "./controlplane/models/operations": {
+      "import": {
+        "@redis-iris/agent-playbook/source": "./src/controlplane/models/operations/index.ts",
+        "types": "./dist/esm/controlplane/models/operations/index.d.ts",
+        "default": "./dist/esm/controlplane/models/operations/index.js"
+      },
+      "require": {
+        "types": "./dist/commonjs/controlplane/models/operations/index.d.ts",
+        "default": "./dist/commonjs/controlplane/models/operations/index.js"
+      }
+    },
+    "./controlplane/types": {
+      "import": {
+        "@redis-iris/agent-playbook/source": "./src/controlplane/types/index.ts",
+        "types": "./dist/esm/controlplane/types/index.d.ts",
+        "default": "./dist/esm/controlplane/types/index.js"
+      },
+      "require": {
+        "types": "./dist/commonjs/controlplane/types/index.d.ts",
+        "default": "./dist/commonjs/controlplane/types/index.js"
+      }
     }
   },
   "main": "./dist/commonjs/index.js",

package/src/controlplane/core.ts

@@ -0,0 +1,13 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { ClientSDK } from "./lib/sdks.js";
+
+/**
+ * A minimal client to use when calling standalone SDK functions. Typically, an
+ * instance of this class would be instantiated once at the start of an
+ * application and passed around through some dependency injection mechanism  to
+ * parts of an application that need to make SDK calls.
+ */
+export class AgentPlaybooksServiceCore extends ClientSDK {}

package/src/controlplane/funcs/clear-playbook.ts

@@ -0,0 +1,225 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { AgentPlaybooksServiceCore } from "../core.js";
+import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import { AgentPlaybooksServiceError } from "../models/errors/agent-playbooks-service-error.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/http-client-errors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/response-validation-error.js";
+import { SDKValidationError } from "../models/errors/sdk-validation-error.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Administratively clears all (default), entries, or proposals from a ready Playbook, preserving configuration and index readiness. Requires product_admin or suite_admin. Cleanup is not atomic across content: failures can leave partial progress; retry the same scope after resolving the failure. Without new writes, repeating a successful clear removes no additional entry families.
+ */
+export function clearPlaybook(
+  client: AgentPlaybooksServiceCore,
+  playbookId: string,
+  scope?: models.ClearScope | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    models.ClearPlaybookResponseContent,
+    | errors.BadRequestErrorResponseContent
+    | errors.AuthenticationErrorResponseContent
+    | errors.ExtractionForbiddenErrorResponseContent
+    | errors.NotFoundErrorResponseContent
+    | errors.TimeoutErrorResponseContent
+    | errors.ResourceSuspendedErrorResponseContent
+    | errors.FailedDependencyErrorResponseContent
+    | errors.UnexpectedErrorResponseContent
+    | errors.PlaybookServiceUnavailableErrorResponseContent
+    | AgentPlaybooksServiceError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    playbookId,
+    scope,
+    options,
+  ));
+}
+
+async function $do(
+  client: AgentPlaybooksServiceCore,
+  playbookId: string,
+  scope?: models.ClearScope | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      models.ClearPlaybookResponseContent,
+      | errors.BadRequestErrorResponseContent
+      | errors.AuthenticationErrorResponseContent
+      | errors.ExtractionForbiddenErrorResponseContent
+      | errors.NotFoundErrorResponseContent
+      | errors.TimeoutErrorResponseContent
+      | errors.ResourceSuspendedErrorResponseContent
+      | errors.FailedDependencyErrorResponseContent
+      | errors.UnexpectedErrorResponseContent
+      | errors.PlaybookServiceUnavailableErrorResponseContent
+      | AgentPlaybooksServiceError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const input: operations.ClearPlaybookRequest = {
+    playbookId: playbookId,
+    scope: scope,
+  };
+
+  const parsed = safeParse(
+    input,
+    (value) => operations.ClearPlaybookRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    playbookId: encodeSimple("playbookId", payload.playbookId, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/v1/playbooks/{playbookId}/clear")(pathParams);
+
+  const query = encodeFormQuery({
+    "scope": payload.scope,
+  });
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.token);
+  const securityInput = secConfig == null ? {} : { token: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "ClearPlaybook",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.token,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    models.ClearPlaybookResponseContent,
+    | errors.BadRequestErrorResponseContent
+    | errors.AuthenticationErrorResponseContent
+    | errors.ExtractionForbiddenErrorResponseContent
+    | errors.NotFoundErrorResponseContent
+    | errors.TimeoutErrorResponseContent
+    | errors.ResourceSuspendedErrorResponseContent
+    | errors.FailedDependencyErrorResponseContent
+    | errors.UnexpectedErrorResponseContent
+    | errors.PlaybookServiceUnavailableErrorResponseContent
+    | AgentPlaybooksServiceError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, models.ClearPlaybookResponseContent$inboundSchema),
+    M.jsonErr(400, errors.BadRequestErrorResponseContent$inboundSchema),
+    M.jsonErr(401, errors.AuthenticationErrorResponseContent$inboundSchema),
+    M.jsonErr(
+      403,
+      errors.ExtractionForbiddenErrorResponseContent$inboundSchema,
+    ),
+    M.jsonErr(404, errors.NotFoundErrorResponseContent$inboundSchema),
+    M.jsonErr(408, errors.TimeoutErrorResponseContent$inboundSchema),
+    M.jsonErr(423, errors.ResourceSuspendedErrorResponseContent$inboundSchema),
+    M.jsonErr(424, errors.FailedDependencyErrorResponseContent$inboundSchema),
+    M.jsonErr(500, errors.UnexpectedErrorResponseContent$inboundSchema),
+    M.jsonErr(
+      503,
+      errors.PlaybookServiceUnavailableErrorResponseContent$inboundSchema,
+    ),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/controlplane/funcs/create-extraction-binding.ts

@@ -0,0 +1,224 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { AgentPlaybooksServiceCore } from "../core.js";
+import { encodeJSON, encodeSimple } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import { AgentPlaybooksServiceError } from "../models/errors/agent-playbooks-service-error.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/http-client-errors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/response-validation-error.js";
+import { SDKValidationError } from "../models/errors/sdk-validation-error.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Registers a client-supplied RAM store reference and FAQ policy. The admin token can bind each store. An OIDC caller can bind a store in the configured store list. With a RAM connection, it can also bind a store on which it has read access in the Identity Service. In other cases, the request fails with 403, and the response does not show whether the store exists. Returns preparing and enabled=false. The control plane asynchronously provisions extraction-worker RAM source read and Playbook destination read/propose grants; both accepted grants make the binding ready, refused grants make it blocked, and dependency outages remain pending for retry. The worker validates live RAM access when extraction runs. Poll GET until ready, then PATCH to enable.
+ */
+export function createExtractionBinding(
+  client: AgentPlaybooksServiceCore,
+  playbookId: string,
+  body: models.CreateExtractionBindingRequestContent,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    models.CreateExtractionBindingResponseContent,
+    | errors.BadRequestErrorResponseContent
+    | errors.AuthenticationErrorResponseContent
+    | errors.ExtractionForbiddenErrorResponseContent
+    | errors.NotFoundErrorResponseContent
+    | errors.TimeoutErrorResponseContent
+    | errors.ExtractionConflictErrorResponseContent
+    | errors.FailedDependencyErrorResponseContent
+    | errors.UnexpectedErrorResponseContent
+    | errors.PlaybookServiceUnavailableErrorResponseContent
+    | AgentPlaybooksServiceError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    playbookId,
+    body,
+    options,
+  ));
+}
+
+async function $do(
+  client: AgentPlaybooksServiceCore,
+  playbookId: string,
+  body: models.CreateExtractionBindingRequestContent,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      models.CreateExtractionBindingResponseContent,
+      | errors.BadRequestErrorResponseContent
+      | errors.AuthenticationErrorResponseContent
+      | errors.ExtractionForbiddenErrorResponseContent
+      | errors.NotFoundErrorResponseContent
+      | errors.TimeoutErrorResponseContent
+      | errors.ExtractionConflictErrorResponseContent
+      | errors.FailedDependencyErrorResponseContent
+      | errors.UnexpectedErrorResponseContent
+      | errors.PlaybookServiceUnavailableErrorResponseContent
+      | AgentPlaybooksServiceError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const input: operations.CreateExtractionBindingRequest = {
+    playbookId: playbookId,
+    body: body,
+  };
+
+  const parsed = safeParse(
+    input,
+    (value) =>
+      operations.CreateExtractionBindingRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body$ = encodeJSON("body", payload.body, { explode: true });
+
+  const pathParams = {
+    playbookId: encodeSimple("playbookId", payload.playbookId, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/v1/playbooks/{playbookId}/extraction/bindings")(
+    pathParams,
+  );
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.token);
+  const securityInput = secConfig == null ? {} : { token: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "CreateExtractionBinding",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.token,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body$,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    models.CreateExtractionBindingResponseContent,
+    | errors.BadRequestErrorResponseContent
+    | errors.AuthenticationErrorResponseContent
+    | errors.ExtractionForbiddenErrorResponseContent
+    | errors.NotFoundErrorResponseContent
+    | errors.TimeoutErrorResponseContent
+    | errors.ExtractionConflictErrorResponseContent
+    | errors.FailedDependencyErrorResponseContent
+    | errors.UnexpectedErrorResponseContent
+    | errors.PlaybookServiceUnavailableErrorResponseContent
+    | AgentPlaybooksServiceError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(202, models.CreateExtractionBindingResponseContent$inboundSchema),
+    M.jsonErr(400, errors.BadRequestErrorResponseContent$inboundSchema),
+    M.jsonErr(401, errors.AuthenticationErrorResponseContent$inboundSchema),
+    M.jsonErr(
+      403,
+      errors.ExtractionForbiddenErrorResponseContent$inboundSchema,
+    ),
+    M.jsonErr(404, errors.NotFoundErrorResponseContent$inboundSchema),
+    M.jsonErr(408, errors.TimeoutErrorResponseContent$inboundSchema),
+    M.jsonErr(409, errors.ExtractionConflictErrorResponseContent$inboundSchema),
+    M.jsonErr(424, errors.FailedDependencyErrorResponseContent$inboundSchema),
+    M.jsonErr(500, errors.UnexpectedErrorResponseContent$inboundSchema),
+    M.jsonErr(
+      503,
+      errors.PlaybookServiceUnavailableErrorResponseContent$inboundSchema,
+    ),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}