@orq-ai/node 4.10.0-rc.7 → 4.10.0-rc.73

package/src/models/components/createidentityrequest.ts

@@ -0,0 +1,76 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+export type CreateIdentityRequestMetadata = {};
+
+export type CreateIdentityRequest = {
+  externalId?: string | undefined;
+  displayName?: string | undefined;
+  email?: string | undefined;
+  avatarUrl?: string | undefined;
+  tags?: Array<string> | undefined;
+  metadata?: CreateIdentityRequestMetadata | undefined;
+};
+
+/** @internal */
+export type CreateIdentityRequestMetadata$Outbound = {};
+
+/** @internal */
+export const CreateIdentityRequestMetadata$outboundSchema: z.ZodType<
+  CreateIdentityRequestMetadata$Outbound,
+  z.ZodTypeDef,
+  CreateIdentityRequestMetadata
+> = z.object({});
+
+export function createIdentityRequestMetadataToJSON(
+  createIdentityRequestMetadata: CreateIdentityRequestMetadata,
+): string {
+  return JSON.stringify(
+    CreateIdentityRequestMetadata$outboundSchema.parse(
+      createIdentityRequestMetadata,
+    ),
+  );
+}
+
+/** @internal */
+export type CreateIdentityRequest$Outbound = {
+  external_id?: string | undefined;
+  display_name?: string | undefined;
+  email?: string | undefined;
+  avatar_url?: string | undefined;
+  tags?: Array<string> | undefined;
+  metadata?: CreateIdentityRequestMetadata$Outbound | undefined;
+};
+
+/** @internal */
+export const CreateIdentityRequest$outboundSchema: z.ZodType<
+  CreateIdentityRequest$Outbound,
+  z.ZodTypeDef,
+  CreateIdentityRequest
+> = z.object({
+  externalId: z.string().optional(),
+  displayName: z.string().optional(),
+  email: z.string().optional(),
+  avatarUrl: z.string().optional(),
+  tags: z.array(z.string()).optional(),
+  metadata: z.lazy(() => CreateIdentityRequestMetadata$outboundSchema)
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    externalId: "external_id",
+    displayName: "display_name",
+    avatarUrl: "avatar_url",
+  });
+});
+
+export function createIdentityRequestToJSON(
+  createIdentityRequest: CreateIdentityRequest,
+): string {
+  return JSON.stringify(
+    CreateIdentityRequest$outboundSchema.parse(createIdentityRequest),
+  );
+}

package/src/models/components/createidentityresponse.ts

@@ -0,0 +1,32 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { Identity, Identity$inboundSchema } from "./identity.js";
+
+export type CreateIdentityResponse = {
+  identity?: Identity | undefined;
+};
+
+/** @internal */
+export const CreateIdentityResponse$inboundSchema: z.ZodType<
+  CreateIdentityResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  identity: Identity$inboundSchema.optional(),
+});
+
+export function createIdentityResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateIdentityResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateIdentityResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateIdentityResponse' from JSON`,
+  );
+}

package/src/models/components/createmodelparameter.ts

@@ -0,0 +1,54 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+export type CreateModelParameter = {
+  config: { [k: string]: any };
+  description?: string | undefined;
+  hints?: string | undefined;
+  name: string;
+  parameter: string;
+  parameterType: string;
+  position?: number | undefined;
+};
+
+/** @internal */
+export type CreateModelParameter$Outbound = {
+  config: { [k: string]: any };
+  description?: string | undefined;
+  hints?: string | undefined;
+  name: string;
+  parameter: string;
+  parameter_type: string;
+  position?: number | undefined;
+};
+
+/** @internal */
+export const CreateModelParameter$outboundSchema: z.ZodType<
+  CreateModelParameter$Outbound,
+  z.ZodTypeDef,
+  CreateModelParameter
+> = z.object({
+  config: z.record(z.any()),
+  description: z.string().optional(),
+  hints: z.string().optional(),
+  name: z.string(),
+  parameter: z.string(),
+  parameterType: z.string(),
+  position: z.number().int().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    parameterType: "parameter_type",
+  });
+});
+
+export function createModelParameterToJSON(
+  createModelParameter: CreateModelParameter,
+): string {
+  return JSON.stringify(
+    CreateModelParameter$outboundSchema.parse(createModelParameter),
+  );
+}

package/src/models/components/createprojectrequest.ts

@@ -5,14 +5,25 @@
 import * as z from "zod/v3";
 
 export type CreateProjectRequest = {
+  /**
+   * Project name. Names must be non-empty and at most 128 characters.
+   */
   name?: string | undefined;
+  /**
+   * Team identifiers to associate with the project.
+   */
   teams?: Array<string> | undefined;
+  /**
+   * Optional human-readable description, at most 500 characters.
+   */
+  description?: string | undefined;
 };
 
 /** @internal */
 export type CreateProjectRequest$Outbound = {
   name?: string | undefined;
   teams?: Array<string> | undefined;
+  description?: string | undefined;
 };
 
 /** @internal */
@@ -23,6 +34,7 @@ export const CreateProjectRequest$outboundSchema: z.ZodType<
 > = z.object({
   name: z.string().optional(),
   teams: z.array(z.string()).optional(),
+  description: z.string().optional(),
 });
 
 export function createProjectRequestToJSON(

package/src/models/components/createprojectresponse.ts

@@ -9,6 +9,9 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import { Project, Project$inboundSchema } from "./project.js";
 
 export type CreateProjectResponse = {
+  /**
+   * Newly created project.
+   */
   project?: Project | undefined;
 };
 

package/src/models/components/createskillrequest.ts

@@ -6,11 +6,29 @@ import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
 
 export type CreateSkillRequest = {
+  /**
+   * Workspace-unique display name. Must start with a letter and may contain letters, numbers, and underscores. Dashes and dots are not allowed.
+   */
   displayName?: string | undefined;
+  /**
+   * Short human-readable summary of what the skill is for.
+   */
   description?: string | undefined;
+  /**
+   * Free-form labels for organizing the skill.
+   */
   tags?: Array<string> | undefined;
+  /**
+   * Project path where the skill should be stored.
+   */
   path?: string | undefined;
+  /**
+   * Project that should contain the skill.
+   */
   projectId?: string | undefined;
+  /**
+   * Instruction body for the skill. Omit to create metadata first and fill instructions later.
+   */
   instructions?: string | undefined;
 };
 

package/src/models/components/createskillresponse.ts

@@ -9,6 +9,9 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import { Skill, Skill$inboundSchema } from "./skill.js";
 
 export type CreateSkillResponse = {
+  /**
+   * Newly created skill.
+   */
   skill?: Skill | undefined;
 };
 

package/src/models/components/datapoint.ts

@@ -0,0 +1,60 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type DataPoint = {
+  /**
+   * Bucket start in UTC, RFC 3339. Clients that need epoch ms can call
+   *
+   * @remarks
+   *  `Date.parse(timestamp)` or `new Date(timestamp).getTime()` —
+   *  returning the int64 in JSON would force a string (protojson rule)
+   *  and force callers to coerce anyway, so we ship ISO only.
+   */
+  timestamp?: Date | undefined;
+  /**
+   * Public breakdown labels for this bucket, keyed by group-by column.
+   *
+   * @remarks
+   *  Empty when no group-by was requested. Empty values are omitted so
+   *  the caller never has to special-case `""`.
+   */
+  dimensions?: { [k: string]: string } | undefined;
+  /**
+   * Metric values for this bucket. Single-metric requests carry one
+   *
+   * @remarks
+   *  entry keyed by the requested metric name (e.g. `"genai.cost"` →
+   *  `0.000495`). Bundle metrics carry one entry per field. Numbers are
+   *  pre-rounded to 10 significant digits to avoid IEEE-754 display
+   *  noise like `0.00009900000000000001`.
+   */
+  metrics?: { [k: string]: number } | undefined;
+};
+
+/** @internal */
+export const DataPoint$inboundSchema: z.ZodType<
+  DataPoint,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  timestamp: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  dimensions: z.record(z.string()).optional(),
+  metrics: z.record(z.number()).optional(),
+});
+
+export function dataPointFromJSON(
+  jsonString: string,
+): SafeParseResult<DataPoint, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DataPoint$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DataPoint' from JSON`,
+  );
+}

package/src/models/components/deleteapikeyresponse.ts

@@ -0,0 +1,27 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type DeleteApiKeyResponse = {};
+
+/** @internal */
+export const DeleteApiKeyResponse$inboundSchema: z.ZodType<
+  DeleteApiKeyResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+export function deleteApiKeyResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<DeleteApiKeyResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DeleteApiKeyResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DeleteApiKeyResponse' from JSON`,
+  );
+}

package/src/models/components/deleteidentityresponse.ts

@@ -0,0 +1,27 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type DeleteIdentityResponse = {};
+
+/** @internal */
+export const DeleteIdentityResponse$inboundSchema: z.ZodType<
+  DeleteIdentityResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+export function deleteIdentityResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<DeleteIdentityResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DeleteIdentityResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DeleteIdentityResponse' from JSON`,
+  );
+}

package/src/models/components/detectrequest.ts

@@ -0,0 +1,56 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+/**
+ * The workspace is resolved from the API key, never sent in the body.
+ */
+export type DetectRequest = {
+  /**
+   * Text to analyse.
+   */
+  text?: string | undefined;
+  /**
+   * BCP-47 language code. Unset means auto-detect.
+   */
+  language?: string | undefined;
+  /**
+   * Global minimum recognizer score (0.0-1.0). Unset uses the provider default.
+   */
+  threshold?: number | undefined;
+  /**
+   * When true, the response includes a per-type entity breakdown.
+   */
+  includeEntities?: boolean | undefined;
+};
+
+/** @internal */
+export type DetectRequest$Outbound = {
+  text?: string | undefined;
+  language?: string | undefined;
+  threshold?: number | undefined;
+  include_entities?: boolean | undefined;
+};
+
+/** @internal */
+export const DetectRequest$outboundSchema: z.ZodType<
+  DetectRequest$Outbound,
+  z.ZodTypeDef,
+  DetectRequest
+> = z.object({
+  text: z.string().optional(),
+  language: z.string().optional(),
+  threshold: z.number().optional(),
+  includeEntities: z.boolean().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    includeEntities: "include_entities",
+  });
+});
+
+export function detectRequestToJSON(detectRequest: DetectRequest): string {
+  return JSON.stringify(DetectRequest$outboundSchema.parse(detectRequest));
+}

package/src/models/components/detectresponse.ts

@@ -0,0 +1,41 @@
+/*
+ * 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";
+
+export type DetectResponse = {
+  hasPii?: boolean | undefined;
+  /**
+   * Per-entity-type counts. Populated only when include_entities was set.
+   */
+  entities?: { [k: string]: number } | undefined;
+};
+
+/** @internal */
+export const DetectResponse$inboundSchema: z.ZodType<
+  DetectResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  has_pii: z.boolean().optional(),
+  entities: z.record(z.number().int()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_pii": "hasPii",
+  });
+});
+
+export function detectResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<DetectResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DetectResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DetectResponse' from JSON`,
+  );
+}

package/src/models/components/domain.ts

@@ -0,0 +1,75 @@
+/*
+ * 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";
+
+/**
+ * Domain describes a permission domain that can be granted to an
+ *
+ * @remarks
+ *  API key. Verbs are derived from id + group + readable/writable.
+ */
+export type Domain = {
+  /**
+   * Stable domain identifier (e.g. "agent", "chat_completions"). Used
+   *
+   * @remarks
+   *  as the key in ApiKey.access and as the verb prefix in resolved
+   *  permissions (e.g. agent.list, agent.view, agent.create).
+   */
+  id?: string | undefined;
+  /**
+   * Human-readable label for the dashboard.
+   */
+  displayName?: string | undefined;
+  /**
+   * Logical group used by the UI to render this entry.
+   */
+  group?: number | undefined;
+  /**
+   * Project scopes this domain may be granted under. A workspace-
+   *
+   * @remarks
+   *  admin domain like `member` is typically SCOPE_MODE_ALL only.
+   */
+  allowedScopes?: Array<number> | undefined;
+  /**
+   * Whether this domain can be granted read access.
+   */
+  readable?: boolean | undefined;
+  /**
+   * Whether this domain can be granted write access.
+   */
+  writable?: boolean | undefined;
+};
+
+/** @internal */
+export const Domain$inboundSchema: z.ZodType<Domain, z.ZodTypeDef, unknown> = z
+  .object({
+    id: z.string().optional(),
+    display_name: z.string().optional(),
+    group: z.number().int().optional(),
+    allowed_scopes: z.array(z.number().int()).optional(),
+    readable: z.boolean().optional(),
+    writable: z.boolean().optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      "display_name": "displayName",
+      "allowed_scopes": "allowedScopes",
+    });
+  });
+
+export function domainFromJSON(
+  jsonString: string,
+): SafeParseResult<Domain, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Domain$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Domain' from JSON`,
+  );
+}

package/src/models/components/embeddingcacheconfig.ts

@@ -0,0 +1,59 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Cache type.
+ */
+export const EmbeddingCacheConfigType = {
+  ExactMatch: "exact_match",
+} as const;
+/**
+ * Cache type.
+ */
+export type EmbeddingCacheConfigType = ClosedEnum<
+  typeof EmbeddingCacheConfigType
+>;
+
+export type EmbeddingCacheConfig = {
+  /**
+   * Time to live for cached responses in seconds. Maximum 259200 seconds (3 days).
+   */
+  ttl?: number | undefined;
+  /**
+   * Cache type.
+   */
+  type: EmbeddingCacheConfigType;
+};
+
+/** @internal */
+export const EmbeddingCacheConfigType$outboundSchema: z.ZodNativeEnum<
+  typeof EmbeddingCacheConfigType
+> = z.nativeEnum(EmbeddingCacheConfigType);
+
+/** @internal */
+export type EmbeddingCacheConfig$Outbound = {
+  ttl?: number | undefined;
+  type: string;
+};
+
+/** @internal */
+export const EmbeddingCacheConfig$outboundSchema: z.ZodType<
+  EmbeddingCacheConfig$Outbound,
+  z.ZodTypeDef,
+  EmbeddingCacheConfig
+> = z.object({
+  ttl: z.number().int().optional(),
+  type: EmbeddingCacheConfigType$outboundSchema,
+});
+
+export function embeddingCacheConfigToJSON(
+  embeddingCacheConfig: EmbeddingCacheConfig,
+): string {
+  return JSON.stringify(
+    EmbeddingCacheConfig$outboundSchema.parse(embeddingCacheConfig),
+  );
+}

package/src/models/components/embeddingcontactparams.ts

@@ -0,0 +1,48 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+export type EmbeddingContactParams = {
+  displayName?: string | undefined;
+  email?: string | undefined;
+  id: string;
+  metadata?: Array<{ [k: string]: any }> | null | undefined;
+  tags?: Array<string> | null | undefined;
+};
+
+/** @internal */
+export type EmbeddingContactParams$Outbound = {
+  display_name?: string | undefined;
+  email?: string | undefined;
+  id: string;
+  metadata?: Array<{ [k: string]: any }> | null | undefined;
+  tags?: Array<string> | null | undefined;
+};
+
+/** @internal */
+export const EmbeddingContactParams$outboundSchema: z.ZodType<
+  EmbeddingContactParams$Outbound,
+  z.ZodTypeDef,
+  EmbeddingContactParams
+> = z.object({
+  displayName: z.string().optional(),
+  email: z.string().optional(),
+  id: z.string(),
+  metadata: z.nullable(z.array(z.record(z.any()))).optional(),
+  tags: z.nullable(z.array(z.string())).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    displayName: "display_name",
+  });
+});
+
+export function embeddingContactParamsToJSON(
+  embeddingContactParams: EmbeddingContactParams,
+): string {
+  return JSON.stringify(
+    EmbeddingContactParams$outboundSchema.parse(embeddingContactParams),
+  );
+}