@orq-ai/node 4.9.18 → 4.9.19

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`,
+  );
+}

package/src/models/components/getapikeyresponse.ts

@@ -0,0 +1,40 @@
+/*
+ * 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 { ApiKey, ApiKey$inboundSchema } from "./apikey.js";
+
+export type GetApiKeyResponse = {
+  /**
+   * Requested api-key. Raw token never included.
+   */
+  apiKey?: ApiKey | undefined;
+};
+
+/** @internal */
+export const GetApiKeyResponse$inboundSchema: z.ZodType<
+  GetApiKeyResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  api_key: ApiKey$inboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "api_key": "apiKey",
+  });
+});
+
+export function getApiKeyResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<GetApiKeyResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetApiKeyResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetApiKeyResponse' from JSON`,
+  );
+}

package/src/models/components/getprojectresponse.ts

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

package/src/models/components/getskillresponse.ts

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

package/src/models/components/identity.ts

@@ -0,0 +1,83 @@
+/*
+ * 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 {
+  IdentityMetrics,
+  IdentityMetrics$inboundSchema,
+} from "./identitymetrics.js";
+
+export type Metadata = {};
+
+export type Identity = {
+  id?: string | undefined;
+  externalId?: string | undefined;
+  workspaceId?: string | undefined;
+  displayName?: string | undefined;
+  email?: string | undefined;
+  avatarUrl?: string | undefined;
+  tags?: Array<string> | undefined;
+  metadata?: Metadata | undefined;
+  created?: string | undefined;
+  updated?: string | undefined;
+  metrics?: IdentityMetrics | undefined;
+};
+
+/** @internal */
+export const Metadata$inboundSchema: z.ZodType<
+  Metadata,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+export function metadataFromJSON(
+  jsonString: string,
+): SafeParseResult<Metadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Metadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Metadata' from JSON`,
+  );
+}
+
+/** @internal */
+export const Identity$inboundSchema: z.ZodType<
+  Identity,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string().optional(),
+  external_id: z.string().optional(),
+  workspace_id: z.string().optional(),
+  display_name: z.string().optional(),
+  email: z.string().optional(),
+  avatar_url: z.string().optional(),
+  tags: z.array(z.string()).optional(),
+  metadata: z.lazy(() => Metadata$inboundSchema).optional(),
+  created: z.string().optional(),
+  updated: z.string().optional(),
+  metrics: IdentityMetrics$inboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+    "external_id": "externalId",
+    "workspace_id": "workspaceId",
+    "display_name": "displayName",
+    "avatar_url": "avatarUrl",
+  });
+});
+
+export function identityFromJSON(
+  jsonString: string,
+): SafeParseResult<Identity, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Identity$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Identity' from JSON`,
+  );
+}

package/src/models/components/identitymetrics.ts

@@ -0,0 +1,45 @@
+/*
+ * 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 IdentityMetrics = {
+  totalTokens?: number | undefined;
+  totalCost?: number | undefined;
+  totalRequests?: number | undefined;
+  errorRate?: number | undefined;
+};
+
+/** @internal */
+export const IdentityMetrics$inboundSchema: z.ZodType<
+  IdentityMetrics,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  total_tokens: z.number().optional(),
+  total_cost: z.number().optional(),
+  total_requests: z.number().optional(),
+  error_rate: z.number().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "total_tokens": "totalTokens",
+    "total_cost": "totalCost",
+    "total_requests": "totalRequests",
+    "error_rate": "errorRate",
+  });
+});
+
+export function identityMetricsFromJSON(
+  jsonString: string,
+): SafeParseResult<IdentityMetrics, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => IdentityMetrics$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'IdentityMetrics' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -12,20 +12,33 @@ export * from "./agentmessagecreatedstreamingevent.js";
 export * from "./agentresponsemessage.js";
 export * from "./agentstartedstreamingevent.js";
 export * from "./agentthoughtstreamingevent.js";
+export * from "./allprojects.js";
+export * from "./apikey.js";
+export * from "./apikeyowner.js";
+export * from "./apikeystatus.js";
 export * from "./audiocontentpartschema.js";
 export * from "./budgetlimit.js";
 export * from "./conversationparam.js";
 export * from "./createagentresponse.js";
+export * from "./createapikeyrequest.js";
+export * from "./createapikeyresponse.js";
 export * from "./createfilerequest.js";
 export * from "./createfileresponse.js";
+export * from "./createidentityrequest.js";
+export * from "./createidentityresponse.js";
 export * from "./createprojectrequest.js";
 export * from "./createprojectresponse.js";
 export * from "./createskillrequest.js";
 export * from "./createskillresponse.js";
 export * from "./datapart.js";
+export * from "./datapoint.js";
+export * from "./deleteapikeyresponse.js";
 export * from "./deletefileresponse.js";
+export * from "./deleteidentityresponse.js";
 export * from "./deleteprojectresponse.js";
 export * from "./deleteskillresponse.js";
+export * from "./domain.js";
+export * from "./domaingroup.js";
 export * from "./errorpart.js";
 export * from "./errorstreamingevent.js";
 export * from "./evaluatorref.js";
@@ -39,37 +52,52 @@ export * from "./fallbackconfig.js";
 export * from "./file.js";
 export * from "./filecontentpartschema.js";
 export * from "./filepart.js";
+export * from "./filepurpose.js";
+export * from "./filter.js";
 export * from "./getagentresponse.js";
+export * from "./getapikeyresponse.js";
 export * from "./getfilecontentresponse.js";
 export * from "./getfileresponse.js";
 export * from "./getprojectresponse.js";
 export * from "./getskillresponse.js";
 export * from "./guardrailref.js";
 export * from "./guardrailrule.js";
+export * from "./identity.js";
+export * from "./identitymetrics.js";
 export * from "./imagecontentpartschema.js";
 export * from "./incompletedetails.js";
 export * from "./inputtokensdetails.js";
 export * from "./invokedeploymentrequest.js";
+export * from "./legacytokenfamily.js";
 export * from "./limits.js";
+export * from "./listapikeysresponse.js";
+export * from "./listcapabilitiesresponse.js";
 export * from "./listfilesresponse.js";
+export * from "./listidentitiesresponse.js";
 export * from "./listprojectsresponse.js";
 export * from "./listskillsresponse.js";
 export * from "./memoryparam.js";
 export * from "./modelref.js";
 export * from "./modelsconfig.js";
 export * from "./outputtokensdetails.js";
+export * from "./ownertype.js";
 export * from "./partdelta.js";
 export * from "./partdeltaevent.js";
 export * from "./partdoneevent.js";
+export * from "./permissionmode.js";
 export * from "./policy.js";
 export * from "./policyretryconfig.js";
 export * from "./project.js";
+export * from "./projectscope.js";
 export * from "./publiccontact.js";
 export * from "./publicidentity.js";
+export * from "./publicmodelentry.js";
 export * from "./publicschedule.js";
 export * from "./publicscheduleerrordetail.js";
 export * from "./publicschedulepayload.js";
 export * from "./publicusage.js";
+export * from "./queryreportrequest.js";
+export * from "./queryreportresponse.js";
 export * from "./reasoning.js";
 export * from "./reasoningparam.js";
 export * from "./reasoningpart.js";
@@ -82,13 +110,18 @@ export * from "./responseerror.js";
 export * from "./responseexecutionlimits.js";
 export * from "./responsefailedevent.js";
 export * from "./responseidentity.js";
+export * from "./responsemeta.js";
 export * from "./responseretryconfig.js";
 export * from "./responsestartedevent.js";
 export * from "./responsestreamingevent.js";
 export * from "./responsethread.js";
+export * from "./retrieveidentityresponse.js";
 export * from "./reviewoutcome.js";
 export * from "./routingrule.js";
+export * from "./scopemode.js";
 export * from "./security.js";
+export * from "./serviceaccountowner.js";
+export * from "./singleproject.js";
 export * from "./skill.js";
 export * from "./streamoptions.js";
 export * from "./telemetry.js";
@@ -109,9 +142,15 @@ export * from "./toolresultpart.js";
 export * from "./toolreviewdoneevent.js";
 export * from "./toolreviewrequestedevent.js";
 export * from "./toolstartedevent.js";
+export * from "./totals.js";
+export * from "./updateapikeyrequest.js";
+export * from "./updateapikeyresponse.js";
 export * from "./updatefilerequest.js";
 export * from "./updatefileresponse.js";
+export * from "./updateidentityrequest.js";
+export * from "./updateidentityresponse.js";
 export * from "./updateprojectrequest.js";
 export * from "./updateprojectresponse.js";
 export * from "./updateskillrequest.js";
 export * from "./updateskillresponse.js";
+export * from "./userowner.js";

package/src/models/components/inputtokensdetails.ts

@@ -9,6 +9,8 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type InputTokensDetails = {
+  cacheCreation1hTokens?: number | undefined;
+  cacheCreation5mTokens?: number | undefined;
   cacheCreationTokens: number;
   cachedTokens: number;
 };
@@ -19,10 +21,14 @@ export const InputTokensDetails$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  cache_creation_1h_tokens: z.number().int().optional(),
+  cache_creation_5m_tokens: z.number().int().optional(),
   cache_creation_tokens: z.number().int(),
   cached_tokens: z.number().int(),
 }).transform((v) => {
   return remap$(v, {
+    "cache_creation_1h_tokens": "cacheCreation1hTokens",
+    "cache_creation_5m_tokens": "cacheCreation5mTokens",
     "cache_creation_tokens": "cacheCreationTokens",
     "cached_tokens": "cachedTokens",
   });

package/src/models/components/invokedeploymentrequest.ts

@@ -739,7 +739,7 @@ export type Messages =
 /**
  * Metadata about the document
  */
-export type Metadata = {
+export type InvokeDeploymentRequestMetadata = {
   /**
    * Name of the file the text is from.
    */
@@ -762,7 +762,7 @@ export type Documents = {
   /**
    * Metadata about the document
    */
-  metadata?: Metadata | undefined;
+  metadata?: InvokeDeploymentRequestMetadata | undefined;
 };
 
 export type InvokeOptions = {
@@ -2342,17 +2342,17 @@ export function messagesToJSON(messages: Messages): string {
 }
 
 /** @internal */
-export type Metadata$Outbound = {
+export type InvokeDeploymentRequestMetadata$Outbound = {
   file_name?: string | undefined;
   file_type?: string | undefined;
   page_number?: number | undefined;
 };
 
 /** @internal */
-export const Metadata$outboundSchema: z.ZodType<
-  Metadata$Outbound,
+export const InvokeDeploymentRequestMetadata$outboundSchema: z.ZodType<
+  InvokeDeploymentRequestMetadata$Outbound,
   z.ZodTypeDef,
-  Metadata
+  InvokeDeploymentRequestMetadata
 > = z.object({
   fileName: z.string().optional(),
   fileType: z.string().optional(),
@@ -2365,14 +2365,20 @@ export const Metadata$outboundSchema: z.ZodType<
   });
 });
 
-export function metadataToJSON(metadata: Metadata): string {
-  return JSON.stringify(Metadata$outboundSchema.parse(metadata));
+export function invokeDeploymentRequestMetadataToJSON(
+  invokeDeploymentRequestMetadata: InvokeDeploymentRequestMetadata,
+): string {
+  return JSON.stringify(
+    InvokeDeploymentRequestMetadata$outboundSchema.parse(
+      invokeDeploymentRequestMetadata,
+    ),
+  );
 }
 
 /** @internal */
 export type Documents$Outbound = {
   text: string;
-  metadata?: Metadata$Outbound | undefined;
+  metadata?: InvokeDeploymentRequestMetadata$Outbound | undefined;
 };
 
 /** @internal */
@@ -2382,7 +2388,8 @@ export const Documents$outboundSchema: z.ZodType<
   Documents
 > = z.object({
   text: z.string(),
-  metadata: z.lazy(() => Metadata$outboundSchema).optional(),
+  metadata: z.lazy(() => InvokeDeploymentRequestMetadata$outboundSchema)
+    .optional(),
 });
 
 export function documentsToJSON(documents: Documents): string {

package/src/models/components/legacytokenfamily.ts

@@ -0,0 +1,19 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const LegacyTokenFamily = {
+  LegacyTokenFamilyUnspecified: "LEGACY_TOKEN_FAMILY_UNSPECIFIED",
+  LegacyTokenFamilyRouterJwt: "LEGACY_TOKEN_FAMILY_ROUTER_JWT",
+  LegacyTokenFamilyProjectJwt: "LEGACY_TOKEN_FAMILY_PROJECT_JWT",
+  LegacyTokenFamilyWorkspaceJwt: "LEGACY_TOKEN_FAMILY_WORKSPACE_JWT",
+} as const;
+export type LegacyTokenFamily = ClosedEnum<typeof LegacyTokenFamily>;
+
+/** @internal */
+export const LegacyTokenFamily$inboundSchema: z.ZodNativeEnum<
+  typeof LegacyTokenFamily
+> = z.nativeEnum(LegacyTokenFamily);