@orq-ai/node 4.15.0-rc.5 → 4.15.0-rc.51

package/src/funcs/workspacesUpdate.ts

@@ -0,0 +1,171 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { OrqCore } 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 * 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 * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Update a workspace
+ *
+ * @remarks
+ * Partially updates a workspace. Omit a field to leave it unchanged. Set `archived` to true to archive, false to restore. The workspace key cannot be changed.
+ */
+export function workspacesUpdate(
+  client: OrqCore,
+  request: operations.WorkspaceUpdateRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.UpdateWorkspaceResponse,
+    | OrqError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: OrqCore,
+  request: operations.WorkspaceUpdateRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.UpdateWorkspaceResponse,
+      | OrqError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.WorkspaceUpdateRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload.UpdateWorkspaceRequest, {
+    explode: true,
+  });
+
+  const pathParams = {
+    key: encodeSimple("key", payload.key, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/v2/workspaces/{key}")(pathParams);
+
+  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: "WorkspaceUpdate",
+    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: "PATCH",
+    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.UpdateWorkspaceResponse,
+    | OrqError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.UpdateWorkspaceResponse$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/src/lib/config.ts

@@ -58,7 +58,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "2.0",
-  sdkVersion: "4.15.0-rc.5",
-  genVersion: "2.932.15",
-  userAgent: "speakeasy-sdk/typescript 4.15.0-rc.5 2.932.15 2.0 @orq-ai/node",
+  sdkVersion: "4.15.0-rc.51",
+  genVersion: "2.937.18",
+  userAgent: "speakeasy-sdk/typescript 4.15.0-rc.51 2.937.18 2.0 @orq-ai/node",
 } as const;

package/src/models/components/agentresponserequest.ts

@@ -145,7 +145,7 @@ export type Contact = {
 /**
  * Thread information to group related requests
  */
-export type Thread = {
+export type AgentResponseRequestThread = {
   /**
    * Unique thread identifier to group related invocations.
    */
@@ -228,7 +228,7 @@ export type AgentResponseRequest = {
   /**
    * Thread information to group related requests
    */
-  thread?: Thread | undefined;
+  thread?: AgentResponseRequestThread | undefined;
   /**
    * Memory configuration for the agent execution. Used to associate memory stores with specific entities like users or sessions.
    */
@@ -419,23 +419,27 @@ export function contactToJSON(contact: Contact): string {
 }
 
 /** @internal */
-export type Thread$Outbound = {
+export type AgentResponseRequestThread$Outbound = {
   id: string;
   tags?: Array<string> | undefined;
 };
 
 /** @internal */
-export const Thread$outboundSchema: z.ZodType<
-  Thread$Outbound,
+export const AgentResponseRequestThread$outboundSchema: z.ZodType<
+  AgentResponseRequestThread$Outbound,
   z.ZodTypeDef,
-  Thread
+  AgentResponseRequestThread
 > = z.object({
   id: z.string(),
   tags: z.array(z.string()).optional(),
 });
 
-export function threadToJSON(thread: Thread): string {
-  return JSON.stringify(Thread$outboundSchema.parse(thread));
+export function agentResponseRequestThreadToJSON(
+  agentResponseRequestThread: AgentResponseRequestThread,
+): string {
+  return JSON.stringify(
+    AgentResponseRequestThread$outboundSchema.parse(agentResponseRequestThread),
+  );
 }
 
 /** @internal */
@@ -521,7 +525,7 @@ export type AgentResponseRequest$Outbound = {
   variables?: { [k: string]: any } | undefined;
   identity?: AgentResponseRequestIdentity$Outbound | undefined;
   contact?: Contact$Outbound | undefined;
-  thread?: Thread$Outbound | undefined;
+  thread?: AgentResponseRequestThread$Outbound | undefined;
   memory?: AgentResponseRequestMemory$Outbound | undefined;
   metadata?: { [k: string]: any } | undefined;
   engine?: string | undefined;
@@ -543,7 +547,7 @@ export const AgentResponseRequest$outboundSchema: z.ZodType<
   identity: z.lazy(() => AgentResponseRequestIdentity$outboundSchema)
     .optional(),
   contact: z.lazy(() => Contact$outboundSchema).optional(),
-  thread: z.lazy(() => Thread$outboundSchema).optional(),
+  thread: z.lazy(() => AgentResponseRequestThread$outboundSchema).optional(),
   memory: z.lazy(() => AgentResponseRequestMemory$outboundSchema).optional(),
   metadata: z.record(z.any()).optional(),
   engine: Engine$outboundSchema.optional(),

package/src/models/components/agentstartedstreamingevent.ts

@@ -140,6 +140,10 @@ export type Evaluators = {
    * Determines whether the evaluator runs on the agent input (user message) or output (agent response).
    */
   executeOn: AgentStartedStreamingEventDataExecuteOn;
+  /**
+   * Evaluator-specific configuration, passed through to the evaluator at run time. For orq_pii_detection this carries regions, entities, entity_thresholds, language and threshold, and is validated against PIIDetectionGuardrailOptions: regions and entities are two mutually exclusive coverage modes, and every entity_thresholds key must also appear in entities. on_failure is rejected: an evaluator acting as a guardrail always fails closed.
+   */
+  options?: { [k: string]: any } | undefined;
 };
 
 /**
@@ -169,6 +173,10 @@ export type Guardrails = {
    * Determines whether the evaluator runs on the agent input (user message) or output (agent response).
    */
   executeOn: AgentStartedStreamingEventExecuteOn;
+  /**
+   * Evaluator-specific configuration, passed through to the evaluator at run time. For orq_pii_detection this carries regions, entities, entity_thresholds, language and threshold, and is validated against PIIDetectionGuardrailOptions: regions and entities are two mutually exclusive coverage modes, and every entity_thresholds key must also appear in entities. on_failure is rejected: an evaluator acting as a guardrail always fails closed.
+   */
+  options?: { [k: string]: any } | undefined;
 };
 
 export type Settings = {
@@ -198,7 +206,7 @@ export type Settings = {
    */
   evaluators?: Array<Evaluators> | undefined;
   /**
-   * Configuration for a guardrail applied to the agent
+   * Configuration for a guardrail applied to the agent. sample_rate has no effect here: a guardrail is a gate rather than a measurement, so it runs on every request.
    */
   guardrails?: Array<Guardrails> | undefined;
 };
@@ -376,6 +384,7 @@ export const Evaluators$inboundSchema: z.ZodType<
   id: z.string(),
   sample_rate: z.number().default(50),
   execute_on: AgentStartedStreamingEventDataExecuteOn$inboundSchema,
+  options: z.record(z.any()).optional(),
 }).transform((v) => {
   return remap$(v, {
     "sample_rate": "sampleRate",
@@ -407,6 +416,7 @@ export const Guardrails$inboundSchema: z.ZodType<
   id: z.string(),
   sample_rate: z.number().default(50),
   execute_on: AgentStartedStreamingEventExecuteOn$inboundSchema,
+  options: z.record(z.any()).optional(),
 }).transform((v) => {
   return remap$(v, {
     "sample_rate": "sampleRate",

package/src/models/components/aggregatelogsrequest.ts

@@ -13,11 +13,11 @@ export type AggregateLogsRequest = {
   from?: Date | undefined;
   to?: Date | undefined;
   /**
-   * Time bucket grain: "auto" | "minute" | "hour" | "day", matching the shared
+   * Time bucket grain: "auto" | "minute" | "hour" | "day". "auto" picks the
    *
    * @remarks
-   *  libs/go/reporting Grain vocabulary used by the traces reporting API. Empty
-   *  defaults to "auto" (grain picked from the time range).
+   *  grain from the requested time range. Empty returns rows without time
+   *  buckets.
    */
   grain?: string | undefined;
   filters?: Array<TraceFilter> | undefined;

package/src/models/components/auditlog.ts

@@ -0,0 +1,122 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { Value, Value$inboundSchema } from "./value.js";
+
+/**
+ * Additional event metadata. The exact shape depends on entity_type and action.
+ */
+export type AuditLogMetadata = {};
+
+/**
+ * An audit log entry for an entity event in the authenticated workspace.
+ */
+export type AuditLog = {
+  /**
+   * Unique identifier for the audit log entry.
+   */
+  auditLogId: string;
+  /**
+   * Project associated with the event, when the audited entity belongs to a project.
+   */
+  projectId?: string | undefined;
+  /**
+   * Identifier of the entity that changed.
+   */
+  entityId: string;
+  entityType: Value;
+  action: Value;
+  /**
+   * User or system actor that caused the event, when available.
+   */
+  actorId?: string | undefined;
+  /**
+   * IP address observed for the actor, when available.
+   */
+  actorIp?: string | undefined;
+  actorType?: Value | undefined;
+  /**
+   * Human readable actor name captured when the action happened.
+   */
+  actorDisplay?: string | undefined;
+  origin?: Value | undefined;
+  /**
+   * Correlates the entry with the originating request.
+   */
+  requestId?: string | undefined;
+  /**
+   * Time when the audit log entry was created.
+   */
+  createdAt: Date;
+  /**
+   * Additional event metadata. The exact shape depends on entity_type and action.
+   */
+  metadata?: AuditLogMetadata | undefined;
+};
+
+/** @internal */
+export const AuditLogMetadata$inboundSchema: z.ZodType<
+  AuditLogMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+export function auditLogMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<AuditLogMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AuditLogMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AuditLogMetadata' from JSON`,
+  );
+}
+
+/** @internal */
+export const AuditLog$inboundSchema: z.ZodType<
+  AuditLog,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  audit_log_id: z.string(),
+  project_id: z.string().optional(),
+  entity_id: z.string(),
+  entity_type: Value$inboundSchema,
+  action: Value$inboundSchema,
+  actor_id: z.string().optional(),
+  actor_ip: z.string().optional(),
+  actor_type: Value$inboundSchema.optional(),
+  actor_display: z.string().optional(),
+  origin: Value$inboundSchema.optional(),
+  request_id: z.string().optional(),
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  metadata: z.lazy(() => AuditLogMetadata$inboundSchema).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "audit_log_id": "auditLogId",
+    "project_id": "projectId",
+    "entity_id": "entityId",
+    "entity_type": "entityType",
+    "actor_id": "actorId",
+    "actor_ip": "actorIp",
+    "actor_type": "actorType",
+    "actor_display": "actorDisplay",
+    "request_id": "requestId",
+    "created_at": "createdAt",
+  });
+});
+
+export function auditLogFromJSON(
+  jsonString: string,
+): SafeParseResult<AuditLog, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AuditLog$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AuditLog' from JSON`,
+  );
+}

package/src/models/components/auditlogfilter.ts

@@ -0,0 +1,51 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+/**
+ * A single advanced filter applied to audit logs.
+ */
+export type AuditLogFilter = {
+  /**
+   * Filter value type, such as string, date, number, boolean, or array.
+   */
+  type: string;
+  /**
+   * Audit log field path to filter on. Supported paths include created_at, entity_id, entity_type, action, actor_id, origin, and metadata.display_name.
+   */
+  path: string;
+  /**
+   * Filter operator supported by the selected field type.
+   */
+  operator: string;
+  /**
+   * Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values.
+   */
+  value?: any | undefined;
+};
+
+/** @internal */
+export type AuditLogFilter$Outbound = {
+  type: string;
+  path: string;
+  operator: string;
+  value?: any | undefined;
+};
+
+/** @internal */
+export const AuditLogFilter$outboundSchema: z.ZodType<
+  AuditLogFilter$Outbound,
+  z.ZodTypeDef,
+  AuditLogFilter
+> = z.object({
+  type: z.string(),
+  path: z.string(),
+  operator: z.string(),
+  value: z.any().optional(),
+});
+
+export function auditLogFilterToJSON(auditLogFilter: AuditLogFilter): string {
+  return JSON.stringify(AuditLogFilter$outboundSchema.parse(auditLogFilter));
+}

package/src/models/components/auditlogfilterquery.ts

@@ -0,0 +1,54 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  AuditLogFilter,
+  AuditLogFilter$Outbound,
+  AuditLogFilter$outboundSchema,
+} from "./auditlogfilter.js";
+
+/**
+ * Search and advanced filters for querying audit logs.
+ */
+export type AuditLogFilterQuery = {
+  /**
+   * Optional text search applied to supported display fields.
+   */
+  search?: string | undefined;
+  /**
+   * Logical operator used to combine filters.
+   */
+  operator: string;
+  /**
+   * Advanced filters applied to the query.
+   */
+  filters: Array<AuditLogFilter>;
+};
+
+/** @internal */
+export type AuditLogFilterQuery$Outbound = {
+  search?: string | undefined;
+  operator: string;
+  filters: Array<AuditLogFilter$Outbound>;
+};
+
+/** @internal */
+export const AuditLogFilterQuery$outboundSchema: z.ZodType<
+  AuditLogFilterQuery$Outbound,
+  z.ZodTypeDef,
+  AuditLogFilterQuery
+> = z.object({
+  search: z.string().optional(),
+  operator: z.string(),
+  filters: z.array(AuditLogFilter$outboundSchema),
+});
+
+export function auditLogFilterQueryToJSON(
+  auditLogFilterQuery: AuditLogFilterQuery,
+): string {
+  return JSON.stringify(
+    AuditLogFilterQuery$outboundSchema.parse(auditLogFilterQuery),
+  );
+}

package/src/models/components/auditlogpagination.ts

@@ -0,0 +1,55 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+/**
+ * Cursor pagination settings for audit log queries.
+ */
+export type AuditLogPagination = {
+  /**
+   * Maximum number of audit logs to return. Defaults to 50 when omitted.
+   */
+  limit?: number | undefined;
+  /**
+   * Cursor for the next page. Use the last audit_log_id from the previous page.
+   */
+  startingAfter?: string | undefined;
+  /**
+   * Cursor for the previous page. Use the first audit_log_id from the current page.
+   */
+  endingBefore?: string | undefined;
+};
+
+/** @internal */
+export type AuditLogPagination$Outbound = {
+  limit?: number | undefined;
+  starting_after?: string | undefined;
+  ending_before?: string | undefined;
+};
+
+/** @internal */
+export const AuditLogPagination$outboundSchema: z.ZodType<
+  AuditLogPagination$Outbound,
+  z.ZodTypeDef,
+  AuditLogPagination
+> = z.object({
+  limit: z.number().int().optional(),
+  startingAfter: z.string().optional(),
+  endingBefore: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    startingAfter: "starting_after",
+    endingBefore: "ending_before",
+  });
+});
+
+export function auditLogPaginationToJSON(
+  auditLogPagination: AuditLogPagination,
+): string {
+  return JSON.stringify(
+    AuditLogPagination$outboundSchema.parse(auditLogPagination),
+  );
+}

package/src/models/components/auditlogsort.ts

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+/**
+ * A sort expression for audit log queries.
+ */
+export type AuditLogSort = {
+  /**
+   * Audit log field to sort by. Supported keys include _id, created_at, entity_type, entity_id, action, and actor_id.
+   */
+  key: string;
+  /**
+   * Sort direction. Defaults to desc when omitted or invalid.
+   */
+  direction?: string | undefined;
+};
+
+/** @internal */
+export type AuditLogSort$Outbound = {
+  key: string;
+  direction?: string | undefined;
+};
+
+/** @internal */
+export const AuditLogSort$outboundSchema: z.ZodType<
+  AuditLogSort$Outbound,
+  z.ZodTypeDef,
+  AuditLogSort
+> = z.object({
+  key: z.string(),
+  direction: z.string().optional(),
+});
+
+export function auditLogSortToJSON(auditLogSort: AuditLogSort): string {
+  return JSON.stringify(AuditLogSort$outboundSchema.parse(auditLogSort));
+}

package/src/models/components/budgetlimit.ts

@@ -8,10 +8,10 @@ import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
-export const Currency = {
+export const BudgetLimitCurrency = {
   Usd: "usd",
 } as const;
-export type Currency = ClosedEnum<typeof Currency>;
+export type BudgetLimitCurrency = ClosedEnum<typeof BudgetLimitCurrency>;
 
 export const Period = {
   Hour: "hour",
@@ -23,16 +23,18 @@ export type Period = ClosedEnum<typeof Period>;
 
 export type BudgetLimit = {
   amount: number;
-  currency: Currency;
+  currency: BudgetLimitCurrency;
   period: Period;
 };
 
 /** @internal */
-export const Currency$inboundSchema: z.ZodNativeEnum<typeof Currency> = z
-  .nativeEnum(Currency);
+export const BudgetLimitCurrency$inboundSchema: z.ZodNativeEnum<
+  typeof BudgetLimitCurrency
+> = z.nativeEnum(BudgetLimitCurrency);
 /** @internal */
-export const Currency$outboundSchema: z.ZodNativeEnum<typeof Currency> =
-  Currency$inboundSchema;
+export const BudgetLimitCurrency$outboundSchema: z.ZodNativeEnum<
+  typeof BudgetLimitCurrency
+> = BudgetLimitCurrency$inboundSchema;
 
 /** @internal */
 export const Period$inboundSchema: z.ZodNativeEnum<typeof Period> = z
@@ -48,7 +50,7 @@ export const BudgetLimit$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   amount: z.number(),
-  currency: Currency$inboundSchema,
+  currency: BudgetLimitCurrency$inboundSchema,
   period: Period$inboundSchema,
 });
 /** @internal */
@@ -65,7 +67,7 @@ export const BudgetLimit$outboundSchema: z.ZodType<
   BudgetLimit
 > = z.object({
   amount: z.number(),
-  currency: Currency$outboundSchema,
+  currency: BudgetLimitCurrency$outboundSchema,
   period: Period$outboundSchema,
 });