@orq-ai/node 4.8.0-rc.9 → 4.8.3

package/packages/orq-rc/src/models/operations/listdatasets.ts

@@ -0,0 +1,205 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type ListDatasetsRequest = {
+  /**
+   * A limit on the number of objects to be returned. Limit can range between 1 and 50, and the default is 10
+   */
+  limit?: number | undefined;
+  /**
+   * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with `01JJ1HDHN79XAS7A01WB3HYSDB`, your subsequent call can include `after=01JJ1HDHN79XAS7A01WB3HYSDB` in order to fetch the next page of the list.
+   */
+  startingAfter?: string | undefined;
+  /**
+   * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, starting with `01JJ1HDHN79XAS7A01WB3HYSDB`, your subsequent call can include `before=01JJ1HDHN79XAS7A01WB3HYSDB` in order to fetch the previous page of the list.
+   */
+  endingBefore?: string | undefined;
+};
+
+export const ListDatasetsObject = {
+  List: "list",
+} as const;
+export type ListDatasetsObject = ClosedEnum<typeof ListDatasetsObject>;
+
+export type ListDatasetsMetadata = {
+  totalVersions: number;
+  datapointsCount: number;
+};
+
+export type ListDatasetsData = {
+  /**
+   * The unique identifier of the dataset
+   */
+  id: string;
+  /**
+   * The display name of the dataset
+   */
+  displayName: string;
+  /**
+   * The unique identifier of the project it belongs to
+   */
+  projectId: string;
+  /**
+   * The unique identifier of the workspace it belongs to
+   */
+  workspaceId: string;
+  metadata: ListDatasetsMetadata;
+  /**
+   * The unique identifier of the user who created the dataset
+   */
+  createdById?: string | undefined;
+  /**
+   * The unique identifier of the user who last updated the dataset
+   */
+  updatedById?: string | undefined;
+  /**
+   * The date and time the resource was created
+   */
+  created?: Date | undefined;
+  /**
+   * The date and time the resource was last updated
+   */
+  updated: Date;
+};
+
+/**
+ * Datasets Retrieved Successfully
+ */
+export type ListDatasetsResponseBody = {
+  object: ListDatasetsObject;
+  data: Array<ListDatasetsData>;
+  hasMore: boolean;
+};
+
+/** @internal */
+export type ListDatasetsRequest$Outbound = {
+  limit: number;
+  starting_after?: string | undefined;
+  ending_before?: string | undefined;
+};
+
+/** @internal */
+export const ListDatasetsRequest$outboundSchema: z.ZodType<
+  ListDatasetsRequest$Outbound,
+  z.ZodTypeDef,
+  ListDatasetsRequest
+> = z.object({
+  limit: z.number().int().default(10),
+  startingAfter: z.string().optional(),
+  endingBefore: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    startingAfter: "starting_after",
+    endingBefore: "ending_before",
+  });
+});
+
+export function listDatasetsRequestToJSON(
+  listDatasetsRequest: ListDatasetsRequest,
+): string {
+  return JSON.stringify(
+    ListDatasetsRequest$outboundSchema.parse(listDatasetsRequest),
+  );
+}
+
+/** @internal */
+export const ListDatasetsObject$inboundSchema: z.ZodNativeEnum<
+  typeof ListDatasetsObject
+> = z.nativeEnum(ListDatasetsObject);
+
+/** @internal */
+export const ListDatasetsMetadata$inboundSchema: z.ZodType<
+  ListDatasetsMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  total_versions: z.number(),
+  datapoints_count: z.number(),
+}).transform((v) => {
+  return remap$(v, {
+    "total_versions": "totalVersions",
+    "datapoints_count": "datapointsCount",
+  });
+});
+
+export function listDatasetsMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<ListDatasetsMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListDatasetsMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListDatasetsMetadata' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListDatasetsData$inboundSchema: z.ZodType<
+  ListDatasetsData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string(),
+  display_name: z.string(),
+  project_id: z.string(),
+  workspace_id: z.string(),
+  metadata: z.lazy(() => ListDatasetsMetadata$inboundSchema),
+  created_by_id: z.string().optional(),
+  updated_by_id: z.string().optional(),
+  created: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  updated: z.string().datetime({ offset: true }).default(
+    "2026-04-30T15:24:06.216Z",
+  ).transform(v => new Date(v)),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+    "display_name": "displayName",
+    "project_id": "projectId",
+    "workspace_id": "workspaceId",
+    "created_by_id": "createdById",
+    "updated_by_id": "updatedById",
+  });
+});
+
+export function listDatasetsDataFromJSON(
+  jsonString: string,
+): SafeParseResult<ListDatasetsData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListDatasetsData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListDatasetsData' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListDatasetsResponseBody$inboundSchema: z.ZodType<
+  ListDatasetsResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: ListDatasetsObject$inboundSchema,
+  data: z.array(z.lazy(() => ListDatasetsData$inboundSchema)),
+  has_more: z.boolean(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+  });
+});
+
+export function listDatasetsResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<ListDatasetsResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListDatasetsResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListDatasetsResponseBody' from JSON`,
+  );
+}

package/packages/orq-rc/src/models/operations/listdatasources.ts

@@ -0,0 +1,235 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Filter datasources by status.
+ */
+export type Status = Array<string> | string;
+
+export type ListDatasourcesRequest = {
+  /**
+   * Unique identifier of the knowledge base
+   */
+  knowledgeId: string;
+  /**
+   * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with `01JJ1HDHN79XAS7A01WB3HYSDB`, your subsequent call can include `after=01JJ1HDHN79XAS7A01WB3HYSDB` in order to fetch the next page of the list.
+   */
+  startingAfter?: string | undefined;
+  /**
+   * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, starting with `01JJ1HDHN79XAS7A01WB3HYSDB`, your subsequent call can include `before=01JJ1HDHN79XAS7A01WB3HYSDB` in order to fetch the previous page of the list.
+   */
+  endingBefore?: string | undefined;
+  /**
+   * Search query to find datasources by name.
+   */
+  q?: string | undefined;
+  /**
+   * A limit on the number of objects to be returned. Limit can range between 1 and 50, and the default is 10
+   */
+  limit?: number | undefined;
+  /**
+   * Filter datasources by status.
+   */
+  status?: Array<string> | string | undefined;
+};
+
+export const ListDatasourcesObject = {
+  List: "list",
+} as const;
+export type ListDatasourcesObject = ClosedEnum<typeof ListDatasourcesObject>;
+
+export const ListDatasourcesStatus = {
+  Pending: "pending",
+  Processing: "processing",
+  Completed: "completed",
+  Failed: "failed",
+  Queued: "queued",
+} as const;
+export type ListDatasourcesStatus = ClosedEnum<typeof ListDatasourcesStatus>;
+
+export type ListDatasourcesData = {
+  /**
+   * The unique identifier of the data source
+   */
+  id: string;
+  /**
+   * The display name of the datasource. Normally the name of the uploaded file
+   */
+  displayName: string;
+  /**
+   * The description of the knowledge base
+   */
+  description?: string | undefined;
+  status: ListDatasourcesStatus;
+  /**
+   * The unique identifier of the file used to create the datasource.
+   */
+  fileId?: string | null | undefined;
+  /**
+   * The date and time the datasource was created
+   */
+  created: string;
+  /**
+   * The date and time the datasource was updated
+   */
+  updated: string;
+  /**
+   * The user ID of the creator of the knowledge base
+   */
+  createdById?: string | null | undefined;
+  /**
+   * The user ID of the last user who updated the knowledge base
+   */
+  updateById?: string | null | undefined;
+  /**
+   * The unique identifier of the knowledge base
+   */
+  knowledgeId: string;
+  /**
+   * The number of chunks in the datasource
+   */
+  chunksCount: number;
+};
+
+/**
+ * Datasources successfully retrieved
+ */
+export type ListDatasourcesResponseBody = {
+  object: ListDatasourcesObject;
+  data: Array<ListDatasourcesData>;
+  hasMore: boolean;
+};
+
+/** @internal */
+export type Status$Outbound = Array<string> | string;
+
+/** @internal */
+export const Status$outboundSchema: z.ZodType<
+  Status$Outbound,
+  z.ZodTypeDef,
+  Status
+> = z.union([z.array(z.string()), z.string()]);
+
+export function statusToJSON(status: Status): string {
+  return JSON.stringify(Status$outboundSchema.parse(status));
+}
+
+/** @internal */
+export type ListDatasourcesRequest$Outbound = {
+  knowledge_id: string;
+  starting_after?: string | undefined;
+  ending_before?: string | undefined;
+  q?: string | undefined;
+  limit: number;
+  status?: Array<string> | string | undefined;
+};
+
+/** @internal */
+export const ListDatasourcesRequest$outboundSchema: z.ZodType<
+  ListDatasourcesRequest$Outbound,
+  z.ZodTypeDef,
+  ListDatasourcesRequest
+> = z.object({
+  knowledgeId: z.string(),
+  startingAfter: z.string().optional(),
+  endingBefore: z.string().optional(),
+  q: z.string().optional(),
+  limit: z.number().default(50),
+  status: z.union([z.array(z.string()), z.string()]).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    knowledgeId: "knowledge_id",
+    startingAfter: "starting_after",
+    endingBefore: "ending_before",
+  });
+});
+
+export function listDatasourcesRequestToJSON(
+  listDatasourcesRequest: ListDatasourcesRequest,
+): string {
+  return JSON.stringify(
+    ListDatasourcesRequest$outboundSchema.parse(listDatasourcesRequest),
+  );
+}
+
+/** @internal */
+export const ListDatasourcesObject$inboundSchema: z.ZodNativeEnum<
+  typeof ListDatasourcesObject
+> = z.nativeEnum(ListDatasourcesObject);
+
+/** @internal */
+export const ListDatasourcesStatus$inboundSchema: z.ZodNativeEnum<
+  typeof ListDatasourcesStatus
+> = z.nativeEnum(ListDatasourcesStatus);
+
+/** @internal */
+export const ListDatasourcesData$inboundSchema: z.ZodType<
+  ListDatasourcesData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string().default("01KQFFVBT1SW1ZKMXJNVGF67GY"),
+  display_name: z.string(),
+  description: z.string().optional(),
+  status: ListDatasourcesStatus$inboundSchema,
+  file_id: z.nullable(z.string()).optional(),
+  created: z.string(),
+  updated: z.string(),
+  created_by_id: z.nullable(z.string()).optional(),
+  update_by_id: z.nullable(z.string()).optional(),
+  knowledge_id: z.string(),
+  chunks_count: z.number(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+    "display_name": "displayName",
+    "file_id": "fileId",
+    "created_by_id": "createdById",
+    "update_by_id": "updateById",
+    "knowledge_id": "knowledgeId",
+    "chunks_count": "chunksCount",
+  });
+});
+
+export function listDatasourcesDataFromJSON(
+  jsonString: string,
+): SafeParseResult<ListDatasourcesData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListDatasourcesData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListDatasourcesData' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListDatasourcesResponseBody$inboundSchema: z.ZodType<
+  ListDatasourcesResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: ListDatasourcesObject$inboundSchema,
+  data: z.array(z.lazy(() => ListDatasourcesData$inboundSchema)),
+  has_more: z.boolean(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+  });
+});
+
+export function listDatasourcesResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<ListDatasourcesResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListDatasourcesResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListDatasourcesResponseBody' from JSON`,
+  );
+}

package/packages/orq-rc/src/models/operations/listidentities.ts

@@ -0,0 +1,275 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Filter identities by tags. Can be provided as JSON object {"tags": ["premium", "beta-user"]} or as query format "tags=premium,beta-user"
+ */
+export type QueryParamFilterBy = {
+  tags?: Array<string> | undefined;
+};
+
+export type ListIdentitiesRequest = {
+  /**
+   * A limit on the number of objects to be returned. Limit can range between 1 and 50, and the default is 10
+   */
+  limit?: number | undefined;
+  /**
+   * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with `01JJ1HDHN79XAS7A01WB3HYSDB`, your subsequent call can include `after=01JJ1HDHN79XAS7A01WB3HYSDB` in order to fetch the next page of the list.
+   */
+  startingAfter?: string | undefined;
+  /**
+   * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, starting with `01JJ1HDHN79XAS7A01WB3HYSDB`, your subsequent call can include `before=01JJ1HDHN79XAS7A01WB3HYSDB` in order to fetch the previous page of the list.
+   */
+  endingBefore?: string | undefined;
+  /**
+   * Search identities by display name or email address. Minimum 2 characters required.
+   */
+  search?: string | undefined;
+  /**
+   * Filter identities by tags. Can be provided as JSON object {"tags": ["premium", "beta-user"]} or as query format "tags=premium,beta-user"
+   */
+  filterBy?: QueryParamFilterBy | undefined;
+  /**
+   * Include usage metrics of the last 30 days for each identity.
+   */
+  includeMetrics?: boolean | null | undefined;
+};
+
+export const ListIdentitiesObject = {
+  List: "list",
+} as const;
+export type ListIdentitiesObject = ClosedEnum<typeof ListIdentitiesObject>;
+
+export type ListIdentitiesMetrics = {
+  /**
+   * Total cost in dollars of the last 30 days
+   */
+  totalCost: number;
+  /**
+   * Total tokens of the last 30 days
+   */
+  totalTokens: number;
+  /**
+   * Total requests of the last 30 days
+   */
+  totalRequests: number;
+  /**
+   * P50 error rate of the last 30 days
+   */
+  errorRate: number;
+};
+
+export type ListIdentitiesData = {
+  /**
+   * Unique ULID (Universally Unique Lexicographically Sortable Identifier) for the contact
+   */
+  id: string;
+  /**
+   * Unique string value to identify the contact user in the customer's system. This should be the same ID you use in your system to reference this user.
+   */
+  externalId: string;
+  /**
+   * Display name or nickname of the contact user. This is typically shown in user interfaces.
+   */
+  displayName?: string | null | undefined;
+  /**
+   * Email address of the contact user
+   */
+  email?: string | null | undefined;
+  /**
+   * URL linking to the contact user's avatar image
+   */
+  avatarUrl?: string | null | undefined;
+  /**
+   * Array of tags associated with the contact. Useful for organizing and filtering contacts by categories, departments, or custom classifications.
+   */
+  tags?: Array<string> | undefined;
+  /**
+   * Additional custom metadata associated with the contact as key-value pairs. Use this to store any extra information specific to your application.
+   */
+  metadata?: { [k: string]: any } | undefined;
+  /**
+   * The date and time the resource was created
+   */
+  created?: Date | undefined;
+  /**
+   * The date and time the resource was last updated
+   */
+  updated: Date;
+  metrics: ListIdentitiesMetrics;
+};
+
+/**
+ * List of identities
+ */
+export type ListIdentitiesResponseBody = {
+  object: ListIdentitiesObject;
+  data: Array<ListIdentitiesData>;
+  hasMore: boolean;
+};
+
+/** @internal */
+export type QueryParamFilterBy$Outbound = {
+  tags?: Array<string> | undefined;
+};
+
+/** @internal */
+export const QueryParamFilterBy$outboundSchema: z.ZodType<
+  QueryParamFilterBy$Outbound,
+  z.ZodTypeDef,
+  QueryParamFilterBy
+> = z.object({
+  tags: z.array(z.string()).optional(),
+});
+
+export function queryParamFilterByToJSON(
+  queryParamFilterBy: QueryParamFilterBy,
+): string {
+  return JSON.stringify(
+    QueryParamFilterBy$outboundSchema.parse(queryParamFilterBy),
+  );
+}
+
+/** @internal */
+export type ListIdentitiesRequest$Outbound = {
+  limit: number;
+  starting_after?: string | undefined;
+  ending_before?: string | undefined;
+  search?: string | undefined;
+  filter_by?: QueryParamFilterBy$Outbound | undefined;
+  include_metrics: boolean | null;
+};
+
+/** @internal */
+export const ListIdentitiesRequest$outboundSchema: z.ZodType<
+  ListIdentitiesRequest$Outbound,
+  z.ZodTypeDef,
+  ListIdentitiesRequest
+> = z.object({
+  limit: z.number().int().default(10),
+  startingAfter: z.string().optional(),
+  endingBefore: z.string().optional(),
+  search: z.string().optional(),
+  filterBy: z.lazy(() => QueryParamFilterBy$outboundSchema).optional(),
+  includeMetrics: z.nullable(z.boolean().default(false)),
+}).transform((v) => {
+  return remap$(v, {
+    startingAfter: "starting_after",
+    endingBefore: "ending_before",
+    filterBy: "filter_by",
+    includeMetrics: "include_metrics",
+  });
+});
+
+export function listIdentitiesRequestToJSON(
+  listIdentitiesRequest: ListIdentitiesRequest,
+): string {
+  return JSON.stringify(
+    ListIdentitiesRequest$outboundSchema.parse(listIdentitiesRequest),
+  );
+}
+
+/** @internal */
+export const ListIdentitiesObject$inboundSchema: z.ZodNativeEnum<
+  typeof ListIdentitiesObject
+> = z.nativeEnum(ListIdentitiesObject);
+
+/** @internal */
+export const ListIdentitiesMetrics$inboundSchema: z.ZodType<
+  ListIdentitiesMetrics,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  total_cost: z.number(),
+  total_tokens: z.number(),
+  total_requests: z.number(),
+  error_rate: z.number(),
+}).transform((v) => {
+  return remap$(v, {
+    "total_cost": "totalCost",
+    "total_tokens": "totalTokens",
+    "total_requests": "totalRequests",
+    "error_rate": "errorRate",
+  });
+});
+
+export function listIdentitiesMetricsFromJSON(
+  jsonString: string,
+): SafeParseResult<ListIdentitiesMetrics, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListIdentitiesMetrics$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListIdentitiesMetrics' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListIdentitiesData$inboundSchema: z.ZodType<
+  ListIdentitiesData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string(),
+  external_id: z.string(),
+  display_name: z.nullable(z.string()).optional(),
+  email: z.nullable(z.string()).optional(),
+  avatar_url: z.nullable(z.string()).optional(),
+  tags: z.array(z.string()).optional(),
+  metadata: z.record(z.any()).optional(),
+  created: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  updated: z.string().datetime({ offset: true }).default(
+    "2026-04-30T15:24:06.216Z",
+  ).transform(v => new Date(v)),
+  metrics: z.lazy(() => ListIdentitiesMetrics$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+    "external_id": "externalId",
+    "display_name": "displayName",
+    "avatar_url": "avatarUrl",
+  });
+});
+
+export function listIdentitiesDataFromJSON(
+  jsonString: string,
+): SafeParseResult<ListIdentitiesData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListIdentitiesData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListIdentitiesData' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListIdentitiesResponseBody$inboundSchema: z.ZodType<
+  ListIdentitiesResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: ListIdentitiesObject$inboundSchema,
+  data: z.array(z.lazy(() => ListIdentitiesData$inboundSchema)),
+  has_more: z.boolean(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+  });
+});
+
+export function listIdentitiesResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<ListIdentitiesResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListIdentitiesResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListIdentitiesResponseBody' from JSON`,
+  );
+}