@orq-ai/node 4.10.0-rc.4 → 4.10.0-rc.45

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,7 +5,13 @@
 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;
 };
 

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/domain.ts

@@ -0,0 +1,82 @@
+/*
+ * 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 { DomainGroup, DomainGroup$inboundSchema } from "./domaingroup.js";
+import { ScopeMode, ScopeMode$inboundSchema } from "./scopemode.js";
+
+/**
+ * Domain describes a permission domain that can be granted to an API
+ *
+ * @remarks
+ *  key. The capability catalog is the registry consulted by
+ *  ResolvePermissions() at authorize() time. Verbs are derived by
+ *  convention from `id` + `group` + `readable` / `writable` flags.
+ */
+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 UI.
+   */
+  displayName?: string | undefined;
+  group?: DomainGroup | undefined;
+  /**
+   * Project scopes this domain may be granted under. A workspace-admin
+   *
+   * @remarks
+   *  domain like `member` is typically SCOPE_MODE_ALL only.
+   */
+  allowedScopes?: Array<ScopeMode> | undefined;
+  /**
+   * Whether this domain can be granted read access. When false the UI
+   *
+   * @remarks
+   *  disables the Read segment (e.g. write-only gateway endpoints).
+   */
+  readable?: boolean | undefined;
+  /**
+   * Whether this domain can be granted write access. When false the UI
+   *
+   * @remarks
+   *  disables the Write segment (e.g. read-only `model` listing).
+   */
+  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: DomainGroup$inboundSchema.optional(),
+    allowed_scopes: z.array(ScopeMode$inboundSchema).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/domaingroup.ts

@@ -0,0 +1,18 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const DomainGroup = {
+  DomainGroupUnspecified: "DOMAIN_GROUP_UNSPECIFIED",
+  DomainGroupWorkspaceAdmin: "DOMAIN_GROUP_WORKSPACE_ADMIN",
+  DomainGroupPlatform: "DOMAIN_GROUP_PLATFORM",
+  DomainGroupGateway: "DOMAIN_GROUP_GATEWAY",
+} as const;
+export type DomainGroup = ClosedEnum<typeof DomainGroup>;
+
+/** @internal */
+export const DomainGroup$inboundSchema: z.ZodNativeEnum<typeof DomainGroup> = z
+  .nativeEnum(DomainGroup);

package/src/models/components/file.ts

@@ -7,33 +7,37 @@ 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 { FilePurpose, FilePurpose$inboundSchema } from "./filepurpose.js";
 
 export type FileT = {
   fileId?: string | undefined;
-  purpose?: number | undefined;
+  purpose?: FilePurpose | undefined;
   fileName?: string | undefined;
-  workspaceId?: string | undefined;
   bytes?: string | undefined;
   createdAt?: Date | undefined;
+  /**
+   * Identifier of the project the file belongs to. Files are project-scoped; an API key may only access files in projects it is authorized for.
+   */
+  projectId?: string | undefined;
 };
 
 /** @internal */
 export const FileT$inboundSchema: z.ZodType<FileT, z.ZodTypeDef, unknown> = z
   .object({
     file_id: z.string().optional(),
-    purpose: z.number().int().optional(),
+    purpose: FilePurpose$inboundSchema.optional(),
     file_name: z.string().optional(),
-    workspace_id: z.string().optional(),
     bytes: z.string().optional(),
     created_at: z.string().datetime({ offset: true }).transform(v =>
       new Date(v)
     ).optional(),
+    project_id: z.string().optional(),
   }).transform((v) => {
     return remap$(v, {
       "file_id": "fileId",
       "file_name": "fileName",
-      "workspace_id": "workspaceId",
       "created_at": "createdAt",
+      "project_id": "projectId",
     });
   });
 

package/src/models/components/filepurpose.ts

@@ -0,0 +1,21 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const FilePurpose = {
+  FilePurposeUnspecified: "FILE_PURPOSE_UNSPECIFIED",
+  FilePurposeRetrieval: "FILE_PURPOSE_RETRIEVAL",
+  FilePurposeKnowledgeDatasource: "FILE_PURPOSE_KNOWLEDGE_DATASOURCE",
+  FilePurposeBatch: "FILE_PURPOSE_BATCH",
+} as const;
+export type FilePurpose = ClosedEnum<typeof FilePurpose>;
+
+/** @internal */
+export const FilePurpose$inboundSchema: z.ZodNativeEnum<typeof FilePurpose> = z
+  .nativeEnum(FilePurpose);
+/** @internal */
+export const FilePurpose$outboundSchema: z.ZodNativeEnum<typeof FilePurpose> =
+  FilePurpose$inboundSchema;

package/src/models/components/filter.ts

@@ -0,0 +1,137 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Public reporting dimension to filter on. Valid fields depend on the selected metric.
+ */
+export const Field = {
+  Project: "project",
+  Identity: "identity",
+  Provider: "provider",
+  Model: "model",
+  Product: "product",
+  ApiKey: "api_key",
+  StatusCode: "status_code",
+  HttpStatusCode: "http_status_code",
+  CredentialType: "credential_type",
+  BillingBillable: "billing_billable",
+  Dimension: "dimension",
+  DimensionType: "dimension_type",
+  Tag: "tag",
+  Agent: "agent",
+  Tool: "tool",
+  Deployment: "deployment",
+  Evaluator: "evaluator",
+  Dataset: "dataset",
+  Prompt: "prompt",
+  Policy: "policy",
+  Conversation: "conversation",
+  Thread: "thread",
+  MemoryStore: "memory_store",
+  Knowledge: "knowledge",
+  Sheet: "sheet",
+  GuardrailOrigin: "guardrail_origin",
+  EvaluatorName: "evaluator_name",
+  EvaluatorType: "evaluator_type",
+  EvaluatorVersion: "evaluator_version",
+  ResultType: "result_type",
+  EvaluationStage: "evaluation_stage",
+  GuardrailStage: "guardrail_stage",
+  EvaluatorStage: "evaluator_stage",
+  GuardrailAction: "guardrail_action",
+  ResultLabel: "result_label",
+} as const;
+/**
+ * Public reporting dimension to filter on. Valid fields depend on the selected metric.
+ */
+export type Field = ClosedEnum<typeof Field>;
+
+/**
+ * Predicate operator. `eq` and `neq` accept exactly one value; `in` and `not_in` accept 1-100 values.
+ */
+export const Op = {
+  Eq: "eq",
+  Neq: "neq",
+  In: "in",
+  NotIn: "not_in",
+} as const;
+/**
+ * Predicate operator. `eq` and `neq` accept exactly one value; `in` and `not_in` accept 1-100 values.
+ */
+export type Op = ClosedEnum<typeof Op>;
+
+export type Filter = {
+  /**
+   * Public reporting dimension to filter on. Valid fields depend on the selected metric.
+   */
+  field?: Field | undefined;
+  /**
+   * Predicate operator. `eq` and `neq` accept exactly one value; `in` and `not_in` accept 1-100 values.
+   */
+  op?: Op | undefined;
+  /**
+   * Values compared against the selected field. Values are interpreted
+   *
+   * @remarks
+   *  as public API strings, not SQL fragments.
+   */
+  values?: Array<string> | undefined;
+};
+
+/** @internal */
+export const Field$inboundSchema: z.ZodNativeEnum<typeof Field> = z.nativeEnum(
+  Field,
+);
+/** @internal */
+export const Field$outboundSchema: z.ZodNativeEnum<typeof Field> =
+  Field$inboundSchema;
+
+/** @internal */
+export const Op$inboundSchema: z.ZodNativeEnum<typeof Op> = z.nativeEnum(Op);
+/** @internal */
+export const Op$outboundSchema: z.ZodNativeEnum<typeof Op> = Op$inboundSchema;
+
+/** @internal */
+export const Filter$inboundSchema: z.ZodType<Filter, z.ZodTypeDef, unknown> = z
+  .object({
+    field: Field$inboundSchema.optional(),
+    op: Op$inboundSchema.optional(),
+    values: z.array(z.string()).optional(),
+  });
+/** @internal */
+export type Filter$Outbound = {
+  field?: string | undefined;
+  op?: string | undefined;
+  values?: Array<string> | undefined;
+};
+
+/** @internal */
+export const Filter$outboundSchema: z.ZodType<
+  Filter$Outbound,
+  z.ZodTypeDef,
+  Filter
+> = z.object({
+  field: Field$outboundSchema.optional(),
+  op: Op$outboundSchema.optional(),
+  values: z.array(z.string()).optional(),
+});
+
+export function filterToJSON(filter: Filter): string {
+  return JSON.stringify(Filter$outboundSchema.parse(filter));
+}
+export function filterFromJSON(
+  jsonString: string,
+): SafeParseResult<Filter, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Filter$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Filter' from JSON`,
+  );
+}