@orq-ai/node 4.2.0-rc.5 → 4.2.0-rc.51

package/src/models/operations/listidentities.ts

@@ -0,0 +1,432 @@
+/*
+ * 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 | undefined;
+  metrics: ListIdentitiesMetrics;
+};
+
+/**
+ * List of identities
+ */
+export type ListIdentitiesResponseBody = {
+  object: ListIdentitiesObject;
+  data: Array<ListIdentitiesData>;
+  hasMore: boolean;
+};
+
+/** @internal */
+export const QueryParamFilterBy$inboundSchema: z.ZodType<
+  QueryParamFilterBy,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  tags: z.array(z.string()).optional(),
+});
+/** @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),
+  );
+}
+export function queryParamFilterByFromJSON(
+  jsonString: string,
+): SafeParseResult<QueryParamFilterBy, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => QueryParamFilterBy$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'QueryParamFilterBy' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListIdentitiesRequest$inboundSchema: z.ZodType<
+  ListIdentitiesRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  limit: z.number().default(10),
+  starting_after: z.string().optional(),
+  ending_before: z.string().optional(),
+  search: z.string().optional(),
+  filter_by: z.lazy(() => QueryParamFilterBy$inboundSchema).optional(),
+  include_metrics: z.nullable(z.boolean().default(false)),
+}).transform((v) => {
+  return remap$(v, {
+    "starting_after": "startingAfter",
+    "ending_before": "endingBefore",
+    "filter_by": "filterBy",
+    "include_metrics": "includeMetrics",
+  });
+});
+/** @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().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),
+  );
+}
+export function listIdentitiesRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<ListIdentitiesRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListIdentitiesRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListIdentitiesRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListIdentitiesObject$inboundSchema: z.ZodNativeEnum<
+  typeof ListIdentitiesObject
+> = z.nativeEnum(ListIdentitiesObject);
+/** @internal */
+export const ListIdentitiesObject$outboundSchema: z.ZodNativeEnum<
+  typeof ListIdentitiesObject
+> = ListIdentitiesObject$inboundSchema;
+
+/** @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",
+  });
+});
+/** @internal */
+export type ListIdentitiesMetrics$Outbound = {
+  total_cost: number;
+  total_tokens: number;
+  total_requests: number;
+  error_rate: number;
+};
+
+/** @internal */
+export const ListIdentitiesMetrics$outboundSchema: z.ZodType<
+  ListIdentitiesMetrics$Outbound,
+  z.ZodTypeDef,
+  ListIdentitiesMetrics
+> = z.object({
+  totalCost: z.number(),
+  totalTokens: z.number(),
+  totalRequests: z.number(),
+  errorRate: z.number(),
+}).transform((v) => {
+  return remap$(v, {
+    totalCost: "total_cost",
+    totalTokens: "total_tokens",
+    totalRequests: "total_requests",
+    errorRate: "error_rate",
+  });
+});
+
+export function listIdentitiesMetricsToJSON(
+  listIdentitiesMetrics: ListIdentitiesMetrics,
+): string {
+  return JSON.stringify(
+    ListIdentitiesMetrics$outboundSchema.parse(listIdentitiesMetrics),
+  );
+}
+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-01-20T14:50:36.860Z",
+  ).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",
+  });
+});
+/** @internal */
+export type ListIdentitiesData$Outbound = {
+  _id: string;
+  external_id: string;
+  display_name?: string | null | undefined;
+  email?: string | null | undefined;
+  avatar_url?: string | null | undefined;
+  tags?: Array<string> | undefined;
+  metadata?: { [k: string]: any } | undefined;
+  created?: string | undefined;
+  updated: string;
+  metrics: ListIdentitiesMetrics$Outbound;
+};
+
+/** @internal */
+export const ListIdentitiesData$outboundSchema: z.ZodType<
+  ListIdentitiesData$Outbound,
+  z.ZodTypeDef,
+  ListIdentitiesData
+> = z.object({
+  id: z.string(),
+  externalId: z.string(),
+  displayName: z.nullable(z.string()).optional(),
+  email: z.nullable(z.string()).optional(),
+  avatarUrl: z.nullable(z.string()).optional(),
+  tags: z.array(z.string()).optional(),
+  metadata: z.record(z.any()).optional(),
+  created: z.date().transform(v => v.toISOString()).optional(),
+  updated: z.date().default(() => new Date("2026-01-20T14:50:36.860Z"))
+    .transform(v => v.toISOString()),
+  metrics: z.lazy(() => ListIdentitiesMetrics$outboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    id: "_id",
+    externalId: "external_id",
+    displayName: "display_name",
+    avatarUrl: "avatar_url",
+  });
+});
+
+export function listIdentitiesDataToJSON(
+  listIdentitiesData: ListIdentitiesData,
+): string {
+  return JSON.stringify(
+    ListIdentitiesData$outboundSchema.parse(listIdentitiesData),
+  );
+}
+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",
+  });
+});
+/** @internal */
+export type ListIdentitiesResponseBody$Outbound = {
+  object: string;
+  data: Array<ListIdentitiesData$Outbound>;
+  has_more: boolean;
+};
+
+/** @internal */
+export const ListIdentitiesResponseBody$outboundSchema: z.ZodType<
+  ListIdentitiesResponseBody$Outbound,
+  z.ZodTypeDef,
+  ListIdentitiesResponseBody
+> = z.object({
+  object: ListIdentitiesObject$outboundSchema,
+  data: z.array(z.lazy(() => ListIdentitiesData$outboundSchema)),
+  hasMore: z.boolean(),
+}).transform((v) => {
+  return remap$(v, {
+    hasMore: "has_more",
+  });
+});
+
+export function listIdentitiesResponseBodyToJSON(
+  listIdentitiesResponseBody: ListIdentitiesResponseBody,
+): string {
+  return JSON.stringify(
+    ListIdentitiesResponseBody$outboundSchema.parse(listIdentitiesResponseBody),
+  );
+}
+export function listIdentitiesResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<ListIdentitiesResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListIdentitiesResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListIdentitiesResponseBody' from JSON`,
+  );
+}