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

package/src/controlplane/funcs/list-playbooks.ts

@@ -0,0 +1,184 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { AgentPlaybooksServiceCore } from "../core.js";
+import { matchStatusCode } from "../lib/http.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.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 { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Lists the account's Playbooks. Cloud requests require JSESSIONID and X-CSRF-Token in addition to the operator JWT. If a selected database is unavailable, its Playbook remains listed without endpoint, database name or accessCidrs enrichment.
+ */
+export function listPlaybooks(
+  client: AgentPlaybooksServiceCore,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    models.ListPlaybooksResponseContent,
+    | errors.BadRequestErrorResponseContent
+    | errors.AuthenticationErrorResponseContent
+    | errors.ExtractionForbiddenErrorResponseContent
+    | errors.NotFoundErrorResponseContent
+    | errors.TimeoutErrorResponseContent
+    | errors.FailedDependencyErrorResponseContent
+    | errors.UnexpectedErrorResponseContent
+    | errors.PlaybookServiceUnavailableErrorResponseContent
+    | AgentPlaybooksServiceError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    options,
+  ));
+}
+
+async function $do(
+  client: AgentPlaybooksServiceCore,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      models.ListPlaybooksResponseContent,
+      | errors.BadRequestErrorResponseContent
+      | errors.AuthenticationErrorResponseContent
+      | errors.ExtractionForbiddenErrorResponseContent
+      | errors.NotFoundErrorResponseContent
+      | errors.TimeoutErrorResponseContent
+      | errors.FailedDependencyErrorResponseContent
+      | errors.UnexpectedErrorResponseContent
+      | errors.PlaybookServiceUnavailableErrorResponseContent
+      | AgentPlaybooksServiceError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const path = pathToFunc("/v1/playbooks")();
+
+  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: "ListPlaybooks",
+    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: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    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.ListPlaybooksResponseContent,
+    | errors.BadRequestErrorResponseContent
+    | errors.AuthenticationErrorResponseContent
+    | errors.ExtractionForbiddenErrorResponseContent
+    | errors.NotFoundErrorResponseContent
+    | errors.TimeoutErrorResponseContent
+    | errors.FailedDependencyErrorResponseContent
+    | errors.UnexpectedErrorResponseContent
+    | errors.PlaybookServiceUnavailableErrorResponseContent
+    | AgentPlaybooksServiceError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, models.ListPlaybooksResponseContent$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(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/put-model-credential.ts

@@ -0,0 +1,231 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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";
+
+/**
+ * Cloud only: set or rotate a model credential
+ *
+ * @remarks
+ * Creates or rotates the selected customer-funded provider's credential after account/resource authorization. No secret is returned. Each new attempt reloads credentials; in-flight attempts retain their resolved credential until completion or their configured timeout.
+ */
+export function putModelCredential(
+  client: AgentPlaybooksServiceCore,
+  playbookId: string,
+  purpose: models.ModelPurpose,
+  body: models.PutModelCredentialRequestContent,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    void,
+    | errors.BadRequestErrorResponseContent
+    | errors.AuthenticationErrorResponseContent
+    | errors.ExtractionForbiddenErrorResponseContent
+    | errors.NotFoundErrorResponseContent
+    | errors.TimeoutErrorResponseContent
+    | errors.FailedDependencyErrorResponseContent
+    | errors.UnexpectedErrorResponseContent
+    | errors.PlaybookServiceUnavailableErrorResponseContent
+    | AgentPlaybooksServiceError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    playbookId,
+    purpose,
+    body,
+    options,
+  ));
+}
+
+async function $do(
+  client: AgentPlaybooksServiceCore,
+  playbookId: string,
+  purpose: models.ModelPurpose,
+  body: models.PutModelCredentialRequestContent,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      void,
+      | errors.BadRequestErrorResponseContent
+      | errors.AuthenticationErrorResponseContent
+      | errors.ExtractionForbiddenErrorResponseContent
+      | errors.NotFoundErrorResponseContent
+      | errors.TimeoutErrorResponseContent
+      | errors.FailedDependencyErrorResponseContent
+      | errors.UnexpectedErrorResponseContent
+      | errors.PlaybookServiceUnavailableErrorResponseContent
+      | AgentPlaybooksServiceError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const input: operations.PutModelCredentialRequest = {
+    playbookId: playbookId,
+    purpose: purpose,
+    body: body,
+  };
+
+  const parsed = safeParse(
+    input,
+    (value) => operations.PutModelCredentialRequest$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",
+    }),
+    purpose: encodeSimple("purpose", payload.purpose, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc(
+    "/v1/playbooks/{playbookId}/model-credentials/{purpose}",
+  )(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: "PutModelCredential",
+    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: "PUT",
+    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<
+    void,
+    | errors.BadRequestErrorResponseContent
+    | errors.AuthenticationErrorResponseContent
+    | errors.ExtractionForbiddenErrorResponseContent
+    | errors.NotFoundErrorResponseContent
+    | errors.TimeoutErrorResponseContent
+    | errors.FailedDependencyErrorResponseContent
+    | errors.UnexpectedErrorResponseContent
+    | errors.PlaybookServiceUnavailableErrorResponseContent
+    | AgentPlaybooksServiceError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.nil(204, z.void()),
+    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(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/update-extraction-binding.ts

@@ -0,0 +1,232 @@
+/*
+ * 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";
+
+/**
+ * Updates FAQ policy or activation using expectedVersion. Supply job or enabled. Enabling requires ready status; pause is allowed while extraction is disabled. The deployment gate blocks policy updates and activation. Source identity is immutable; create a replacement binding to change stores. Stale revisions return conflict.
+ */
+export function updateExtractionBinding(
+  client: AgentPlaybooksServiceCore,
+  playbookId: string,
+  bindingId: string,
+  body: models.UpdateExtractionBindingRequestContent,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    models.UpdateExtractionBindingResponseContent,
+    | 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,
+    bindingId,
+    body,
+    options,
+  ));
+}
+
+async function $do(
+  client: AgentPlaybooksServiceCore,
+  playbookId: string,
+  bindingId: string,
+  body: models.UpdateExtractionBindingRequestContent,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      models.UpdateExtractionBindingResponseContent,
+      | 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.UpdateExtractionBindingRequest = {
+    playbookId: playbookId,
+    bindingId: bindingId,
+    body: body,
+  };
+
+  const parsed = safeParse(
+    input,
+    (value) =>
+      operations.UpdateExtractionBindingRequest$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 = {
+    bindingId: encodeSimple("bindingId", payload.bindingId, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+    playbookId: encodeSimple("playbookId", payload.playbookId, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc(
+    "/v1/playbooks/{playbookId}/extraction/bindings/{bindingId}",
+  )(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: "UpdateExtractionBinding",
+    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: "PATCH",
+    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.UpdateExtractionBindingResponseContent,
+    | 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(200, models.UpdateExtractionBindingResponseContent$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 }];
+}