@orq-ai/node 4.9.24 → 4.9.29

package/packages/orq-rc/src/funcs/piiRedact.ts

@@ -0,0 +1,162 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { OrqCore } from "../core.js";
+import { encodeJSON } 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 * as components from "../models/components/index.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import { OrqError } from "../models/errors/orqerror.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Redact PII
+ *
+ * @remarks
+ * Replaces detected PII with placeholders and returns the reverse mapping needed to restore the original text.
+ */
+export function piiRedact(
+  client: OrqCore,
+  request: components.RedactRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.RedactResponse,
+    | OrqError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: OrqCore,
+  request: components.RedactRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.RedactResponse,
+      | OrqError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => components.RedactRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload, { explode: true });
+
+  const path = pathToFunc("/v2/pii/redact")();
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKey);
+  const securityInput = secConfig == null ? {} : { apiKey: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "PIIRedact",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKey,
+    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 || 600000,
+  }, 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 [result] = await M.match<
+    components.RedactResponse,
+    | OrqError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.RedactResponse$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req);
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/packages/orq-rc/src/funcs/piiRestore.ts

@@ -0,0 +1,162 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { OrqCore } from "../core.js";
+import { encodeJSON } 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 * as components from "../models/components/index.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import { OrqError } from "../models/errors/orqerror.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Restore redacted text
+ *
+ * @remarks
+ * Reverses a redaction, substituting placeholders back to their original values using the mapping returned by Redact.
+ */
+export function piiRestore(
+  client: OrqCore,
+  request: components.RestoreRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.RestoreResponse,
+    | OrqError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: OrqCore,
+  request: components.RestoreRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.RestoreResponse,
+      | OrqError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => components.RestoreRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload, { explode: true });
+
+  const path = pathToFunc("/v2/pii/restore")();
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKey);
+  const securityInput = secConfig == null ? {} : { apiKey: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "PIIRestore",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKey,
+    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 || 600000,
+  }, 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 [result] = await M.match<
+    components.RestoreResponse,
+    | OrqError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.RestoreResponse$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req);
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/packages/orq-rc/src/lib/config.ts

@@ -17,16 +17,6 @@ export const ServerList = [
 export type SDKOptions = {
   apiKey?: string | (() => Promise<string>) | undefined;
 
-  /**
-   * Allows setting the contactId parameter for all supported operations
-   */
-  contactId?: string | undefined;
-
-  /**
-   * Allows setting the environment parameter for all supported operations
-   */
-  environment?: string | undefined;
-
   httpClient?: HTTPClient;
   /**
    * Allows overriding the default server used by the SDK
@@ -68,7 +58,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "2.0",
-  sdkVersion: "4.10.0-rc.33",
-  genVersion: "2.886.0",
-  userAgent: "speakeasy-sdk/typescript 4.10.0-rc.33 2.886.0 2.0 @orq-ai/node",
+  sdkVersion: "4.10.0-rc.67",
+  genVersion: "2.892.5",
+  userAgent: "speakeasy-sdk/typescript 4.10.0-rc.67 2.892.5 2.0 @orq-ai/node",
 } as const;

package/packages/orq-rc/src/lib/env.ts

@@ -3,31 +3,17 @@
  */
 
 import * as z from "zod/v3";
-import { SDKOptions } from "./config.js";
 import { dlv } from "./dlv.js";
 
 export interface Env {
   ORQ_API_KEY?: string | undefined;
 
-  /**
-   * Sets the contactId parameter for all supported operations
-   */
-  ORQ_CONTACT_ID?: string | undefined;
-
-  /**
-   * Sets the environment parameter for all supported operations
-   */
-  ORQ_ENVIRONMENT?: string | undefined;
-
   ORQ_DEBUG?: boolean | undefined;
 }
 
 export const envSchema: z.ZodType<Env, z.ZodTypeDef, unknown> = z.object({
   ORQ_API_KEY: z.string().optional(),
 
-  ORQ_CONTACT_ID: z.string().optional(),
-  ORQ_ENVIRONMENT: z.string().optional(),
-
   ORQ_DEBUG: z.coerce.boolean().optional(),
 });
 
@@ -69,21 +55,3 @@ export function env(): Env {
 export function resetEnv() {
   envMemo = undefined;
 }
-
-/**
- * Populates global parameters with environment variables.
- */
-export function fillGlobals(options: SDKOptions): SDKOptions {
-  const clone = { ...options };
-
-  const envVars = env();
-
-  if (typeof envVars.ORQ_CONTACT_ID !== "undefined") {
-    clone.contactId ??= envVars.ORQ_CONTACT_ID;
-  }
-  if (typeof envVars.ORQ_ENVIRONMENT !== "undefined") {
-    clone.environment ??= envVars.ORQ_ENVIRONMENT;
-  }
-
-  return clone;
-}

package/packages/orq-rc/src/lib/sdks.ts

@@ -15,7 +15,7 @@ import { ERR, OK, Result } from "../types/fp.js";
 import { stringToBase64 } from "./base64.js";
 import { SDK_METADATA, SDKOptions, serverURLFromOptions } from "./config.js";
 import { encodeForm } from "./encodings.js";
-import { env, fillGlobals } from "./env.js";
+import { env } from "./env.js";
 import {
   HTTPClient,
   isAbortError,
@@ -108,7 +108,7 @@ export class ClientSDK {
     this._baseURL = baseURL;
     this.#httpClient = client;
 
-    this._options = { ...fillGlobals(options), hooks: this.#hooks };
+    this._options = { ...options, hooks: this.#hooks };
 
     this.#logger = this._options.debugLogger;
     if (!this.#logger && env().ORQ_DEBUG) {

package/packages/orq-rc/src/models/components/agentthoughtstreamingevent.ts

@@ -83,7 +83,7 @@ export type AgentThoughtStreamingEventFunction = {
   arguments?: string | undefined;
 };
 
-export type AgentThoughtStreamingEventToolCalls = {
+export type ToolCalls = {
   index?: number | undefined;
   id?: string | undefined;
   type?: AgentThoughtStreamingEventDataType | undefined;
@@ -104,7 +104,7 @@ export type AgentThoughtStreamingEventDataRole = ClosedEnum<
 /**
  * If the audio output modality is requested, this object contains data about the audio response from the model.
  */
-export type AgentThoughtStreamingEventAudio = {
+export type Audio = {
   id: string;
   expiresAt: number;
   data: string;
@@ -117,7 +117,7 @@ export type AgentThoughtStreamingEventAudio = {
 export type AgentThoughtStreamingEventMessage = {
   content?: string | null | undefined;
   refusal?: string | null | undefined;
-  toolCalls?: Array<AgentThoughtStreamingEventToolCalls> | undefined;
+  toolCalls?: Array<ToolCalls> | undefined;
   role?: AgentThoughtStreamingEventDataRole | undefined;
   /**
    * Internal thought process of the model
@@ -134,7 +134,7 @@ export type AgentThoughtStreamingEventMessage = {
   /**
    * If the audio output modality is requested, this object contains data about the audio response from the model.
    */
-  audio?: AgentThoughtStreamingEventAudio | null | undefined;
+  audio?: Audio | null | undefined;
 };
 
 export type TopLogprobs = {
@@ -152,7 +152,7 @@ export type TopLogprobs = {
   bytes: Array<number> | null;
 };
 
-export type AgentThoughtStreamingEventContent = {
+export type Content = {
   /**
    * The token.
    */
@@ -212,7 +212,7 @@ export type Logprobs = {
   /**
    * A list of message content tokens with log probability information.
    */
-  content: Array<AgentThoughtStreamingEventContent> | null;
+  content: Array<Content> | null;
   /**
    * A list of message refusal tokens with log probability information.
    */
@@ -411,8 +411,8 @@ export function agentThoughtStreamingEventFunctionFromJSON(
 }
 
 /** @internal */
-export const AgentThoughtStreamingEventToolCalls$inboundSchema: z.ZodType<
-  AgentThoughtStreamingEventToolCalls,
+export const ToolCalls$inboundSchema: z.ZodType<
+  ToolCalls,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -428,14 +428,13 @@ export const AgentThoughtStreamingEventToolCalls$inboundSchema: z.ZodType<
   });
 });
 
-export function agentThoughtStreamingEventToolCallsFromJSON(
+export function toolCallsFromJSON(
   jsonString: string,
-): SafeParseResult<AgentThoughtStreamingEventToolCalls, SDKValidationError> {
+): SafeParseResult<ToolCalls, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) =>
-      AgentThoughtStreamingEventToolCalls$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'AgentThoughtStreamingEventToolCalls' from JSON`,
+    (x) => ToolCalls$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ToolCalls' from JSON`,
   );
 }
 
@@ -445,28 +444,25 @@ export const AgentThoughtStreamingEventDataRole$inboundSchema: z.ZodNativeEnum<
 > = z.nativeEnum(AgentThoughtStreamingEventDataRole);
 
 /** @internal */
-export const AgentThoughtStreamingEventAudio$inboundSchema: z.ZodType<
-  AgentThoughtStreamingEventAudio,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  id: z.string(),
-  expires_at: z.number().int(),
-  data: z.string(),
-  transcript: z.string(),
-}).transform((v) => {
-  return remap$(v, {
-    "expires_at": "expiresAt",
+export const Audio$inboundSchema: z.ZodType<Audio, z.ZodTypeDef, unknown> = z
+  .object({
+    id: z.string(),
+    expires_at: z.number().int(),
+    data: z.string(),
+    transcript: z.string(),
+  }).transform((v) => {
+    return remap$(v, {
+      "expires_at": "expiresAt",
+    });
   });
-});
 
-export function agentThoughtStreamingEventAudioFromJSON(
+export function audioFromJSON(
   jsonString: string,
-): SafeParseResult<AgentThoughtStreamingEventAudio, SDKValidationError> {
+): SafeParseResult<Audio, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => AgentThoughtStreamingEventAudio$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'AgentThoughtStreamingEventAudio' from JSON`,
+    (x) => Audio$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Audio' from JSON`,
   );
 }
 
@@ -478,15 +474,12 @@ export const AgentThoughtStreamingEventMessage$inboundSchema: z.ZodType<
 > = z.object({
   content: z.nullable(z.string()).optional(),
   refusal: z.nullable(z.string()).optional(),
-  tool_calls: z.array(
-    z.lazy(() => AgentThoughtStreamingEventToolCalls$inboundSchema),
-  ).optional(),
+  tool_calls: z.array(z.lazy(() => ToolCalls$inboundSchema)).optional(),
   role: AgentThoughtStreamingEventDataRole$inboundSchema.optional(),
   reasoning: z.nullable(z.string()).optional(),
   reasoning_signature: z.nullable(z.string()).optional(),
   redacted_reasoning: z.string().optional(),
-  audio: z.nullable(z.lazy(() => AgentThoughtStreamingEventAudio$inboundSchema))
-    .optional(),
+  audio: z.nullable(z.lazy(() => Audio$inboundSchema)).optional(),
 }).transform((v) => {
   return remap$(v, {
     "tool_calls": "toolCalls",
@@ -527,28 +520,25 @@ export function topLogprobsFromJSON(
 }
 
 /** @internal */
-export const AgentThoughtStreamingEventContent$inboundSchema: z.ZodType<
-  AgentThoughtStreamingEventContent,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  token: z.string(),
-  logprob: z.number(),
-  bytes: z.nullable(z.array(z.number())),
-  top_logprobs: z.array(z.lazy(() => TopLogprobs$inboundSchema)),
-}).transform((v) => {
-  return remap$(v, {
-    "top_logprobs": "topLogprobs",
+export const Content$inboundSchema: z.ZodType<Content, z.ZodTypeDef, unknown> =
+  z.object({
+    token: z.string(),
+    logprob: z.number(),
+    bytes: z.nullable(z.array(z.number())),
+    top_logprobs: z.array(z.lazy(() => TopLogprobs$inboundSchema)),
+  }).transform((v) => {
+    return remap$(v, {
+      "top_logprobs": "topLogprobs",
+    });
   });
-});
 
-export function agentThoughtStreamingEventContentFromJSON(
+export function contentFromJSON(
   jsonString: string,
-): SafeParseResult<AgentThoughtStreamingEventContent, SDKValidationError> {
+): SafeParseResult<Content, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => AgentThoughtStreamingEventContent$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'AgentThoughtStreamingEventContent' from JSON`,
+    (x) => Content$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Content' from JSON`,
   );
 }
 
@@ -605,9 +595,7 @@ export const Logprobs$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  content: z.nullable(
-    z.array(z.lazy(() => AgentThoughtStreamingEventContent$inboundSchema)),
-  ),
+  content: z.nullable(z.array(z.lazy(() => Content$inboundSchema))),
   refusal: z.nullable(z.array(z.lazy(() => Refusal$inboundSchema))),
 });
 

package/packages/orq-rc/src/models/components/apikey.ts

@@ -55,18 +55,9 @@ export type ApiKey = {
    *  keys and the per-domain read / write semantics are exposed at
    *  runtime via the `ListCapabilities` RPC.
    *
-   *  Valid keys (Domain.id) currently in the catalog:
-   *    Workspace-admin: "api-key", "member", "billing", "sso", "group",
-   *                     "audit-log", "workspace"
-   *    Platform:        "agent", "agent-schedule", "annotation",
-   *                     "chunking", "dataset", "deployment", "eval",
-   *                     "file", "guardrail-rule", "identity",
-   *                     "knowledge", "memory-store", "policy",
-   *                     "project", "prompt", "routing-rule", "skill",
-   *                     "tool"
-   *    Gateway:         "chat_completions", "embeddings", "responses",
-   *                     "moderations", "images", "audio_speech",
-   *                     "audio_transcription", "realtime", "model"
+   *  Valid keys are the Domain.id values in the capability catalog —
+   *  see libs/catalog/orq/apikeys/v1/catalog.textpb for the canonical
+   *  list. The ids are intentionally not duplicated here to avoid drift.
    *
    *  Values are AccessLevel enum names on the JSON wire:
    *    "ACCESS_LEVEL_NONE"  — capability not granted