@orq-ai/node 4.9.6 → 4.9.7

package/src/funcs/projectsDelete.ts

@@ -28,6 +28,9 @@ import { Result } from "../types/fp.js";
 
 /**
  * Delete a project
+ *
+ * @remarks
+ * Deletes a project from the workspace. The response body is empty when the delete succeeds.
  */
 export function projectsDelete(
   client: OrqCore,

package/src/funcs/projectsList.ts

@@ -30,7 +30,7 @@ import { Result } from "../types/fp.js";
  * List all projects
  *
  * @remarks
- * Returns a list of projects. Projects are sorted by creation date, with the most recently created projects appearing first.
+ * Returns projects visible to the current workspace, ordered by creation time with the newest project first. Use `starting_after` or `ending_before` to page through large collections.
  */
 export function projectsList(
   client: OrqCore,

package/src/funcs/{contactsCreate.ts → reportingQuery.ts}

@@ -11,6 +11,7 @@ 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,
@@ -21,23 +22,22 @@ import {
 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 user information
+ * Query reporting metrics
  *
  * @remarks
- * Update or add user information to workspace
+ * Returns time-series analytics for AI usage, cost, latency, evaluator results, and guardrail outcomes. Select a metric and time range, break results down by supported dimensions, apply filters, and optionally include totals for the full range.
  */
-export function contactsCreate(
+export function reportingQuery(
   client: OrqCore,
-  request: operations.CreateContactRequestBody,
+  request: components.QueryReportRequest,
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.CreateContactResponseBody,
+    components.QueryReportResponse,
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -57,12 +57,12 @@ export function contactsCreate(
 
 async function $do(
   client: OrqCore,
-  request: operations.CreateContactRequestBody,
+  request: components.QueryReportRequest,
   options?: RequestOptions,
 ): Promise<
   [
     Result<
-      operations.CreateContactResponseBody,
+      components.QueryReportResponse,
       | OrqError
       | ResponseValidationError
       | ConnectionError
@@ -77,7 +77,7 @@ async function $do(
 > {
   const parsed = safeParse(
     request,
-    (value) => operations.CreateContactRequestBody$outboundSchema.parse(value),
+    (value) => components.QueryReportRequest$outboundSchema.parse(value),
     "Input validation failed",
   );
   if (!parsed.ok) {
@@ -86,7 +86,7 @@ async function $do(
   const payload = parsed.value;
   const body = encodeJSON("body", payload, { explode: true });
 
-  const path = pathToFunc("/v2/contacts")();
+  const path = pathToFunc("/v2/reporting")();
 
   const headers = new Headers(compactMap({
     "Content-Type": "application/json",
@@ -100,7 +100,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "CreateContact",
+    operationID: "ReportingQuery",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
@@ -140,7 +140,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    operations.CreateContactResponseBody,
+    components.QueryReportResponse,
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -150,7 +150,7 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, operations.CreateContactResponseBody$inboundSchema),
+    M.json(200, components.QueryReportResponse$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),
   )(response, req);

package/src/funcs/skillsCreate.ts

@@ -29,7 +29,7 @@ import { Result } from "../types/fp.js";
  * Create a new skill
  *
  * @remarks
- * Skills are modular instructions you can use to codify processes and conventions
+ * Creates a reusable skill in the workspace. Skills store instructions, metadata, and an optional project location so teams can standardize repeatable AI workflows.
  */
 export function skillsCreate(
   client: OrqCore,

package/src/funcs/skillsDelete.ts

@@ -28,6 +28,9 @@ import { Result } from "../types/fp.js";
 
 /**
  * Delete a skill
+ *
+ * @remarks
+ * Deletes a skill from the workspace. The response body is empty when the delete succeeds.
  */
 export function skillsDelete(
   client: OrqCore,

package/src/funcs/skillsGet.ts

@@ -30,7 +30,7 @@ import { Result } from "../types/fp.js";
  * Retrieve a skill
  *
  * @remarks
- * Retrieves an existing skill by its unique skill ID or its display name (display names are unique within a workspace).
+ * Retrieves an existing skill by skill ID. Display names are also accepted for compatibility because they are unique within a workspace.
  */
 export function skillsGet(
   client: OrqCore,

package/src/funcs/skillsList.ts

@@ -30,7 +30,7 @@ import { Result } from "../types/fp.js";
  * List all skills
  *
  * @remarks
- * Returns a list of skills. Skills are sorted by creation date, with the most recently created skills appearing first.
+ * Returns the skills visible to the current workspace, ordered by creation time with the newest skill first. Use `starting_after` or `ending_before` to page through large collections.
  */
 export function skillsList(
   client: OrqCore,

package/src/funcs/skillsUpdate.ts

@@ -30,7 +30,7 @@ import { Result } from "../types/fp.js";
  * Update a skill
  *
  * @remarks
- * Updates the specified skill by setting the values of the parameters passed.
+ * Updates mutable skill fields. Omitted optional fields keep their current values. Repeated fields such as `tags` replace the existing collection when provided.
  */
 export function skillsUpdate(
   client: OrqCore,

package/src/lib/config.ts

@@ -68,7 +68,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "2.0",
-  sdkVersion: "4.9.6",
+  sdkVersion: "4.9.7",
   genVersion: "2.884.4",
-  userAgent: "speakeasy-sdk/typescript 4.9.6 2.884.4 2.0 @orq-ai/node",
+  userAgent: "speakeasy-sdk/typescript 4.9.7 2.884.4 2.0 @orq-ai/node",
 } as const;

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/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, underscores, and hyphens.
+   */
   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/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/file.ts

@@ -12,7 +12,6 @@ export type FileT = {
   fileId?: string | undefined;
   purpose?: number | undefined;
   fileName?: string | undefined;
-  workspaceId?: string | undefined;
   bytes?: string | undefined;
   createdAt?: Date | undefined;
 };
@@ -23,7 +22,6 @@ export const FileT$inboundSchema: z.ZodType<FileT, z.ZodTypeDef, unknown> = z
     file_id: z.string().optional(),
     purpose: z.number().int().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)
@@ -32,7 +30,6 @@ export const FileT$inboundSchema: z.ZodType<FileT, z.ZodTypeDef, unknown> = z
     return remap$(v, {
       "file_id": "fileId",
       "file_name": "fileName",
-      "workspace_id": "workspaceId",
       "created_at": "createdAt",
     });
   });

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/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;
 };