@orq-ai/node 4.6.0-rc.8 → 4.6.3

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

@@ -0,0 +1,189 @@
+/*
+ * 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";
+
+/**
+ * Identity fields to update
+ */
+export type UpdateIdentityRequestBody = {
+  /**
+   * 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;
+};
+
+export type UpdateIdentityRequest = {
+  /**
+   * Unique identity id or external id
+   */
+  id: string;
+  /**
+   * Identity fields to update
+   */
+  requestBody?: UpdateIdentityRequestBody | undefined;
+};
+
+/**
+ * Updated identity
+ */
+export type UpdateIdentityResponseBody = {
+  /**
+   * 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;
+};
+
+/** @internal */
+export type UpdateIdentityRequestBody$Outbound = {
+  display_name?: string | null | undefined;
+  email?: string | null | undefined;
+  avatar_url?: string | null | undefined;
+  tags?: Array<string> | undefined;
+  metadata?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const UpdateIdentityRequestBody$outboundSchema: z.ZodType<
+  UpdateIdentityRequestBody$Outbound,
+  z.ZodTypeDef,
+  UpdateIdentityRequestBody
+> = z.object({
+  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(),
+}).transform((v) => {
+  return remap$(v, {
+    displayName: "display_name",
+    avatarUrl: "avatar_url",
+  });
+});
+
+export function updateIdentityRequestBodyToJSON(
+  updateIdentityRequestBody: UpdateIdentityRequestBody,
+): string {
+  return JSON.stringify(
+    UpdateIdentityRequestBody$outboundSchema.parse(updateIdentityRequestBody),
+  );
+}
+
+/** @internal */
+export type UpdateIdentityRequest$Outbound = {
+  id: string;
+  RequestBody?: UpdateIdentityRequestBody$Outbound | undefined;
+};
+
+/** @internal */
+export const UpdateIdentityRequest$outboundSchema: z.ZodType<
+  UpdateIdentityRequest$Outbound,
+  z.ZodTypeDef,
+  UpdateIdentityRequest
+> = z.object({
+  id: z.string(),
+  requestBody: z.lazy(() => UpdateIdentityRequestBody$outboundSchema)
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    requestBody: "RequestBody",
+  });
+});
+
+export function updateIdentityRequestToJSON(
+  updateIdentityRequest: UpdateIdentityRequest,
+): string {
+  return JSON.stringify(
+    UpdateIdentityRequest$outboundSchema.parse(updateIdentityRequest),
+  );
+}
+
+/** @internal */
+export const UpdateIdentityResponseBody$inboundSchema: z.ZodType<
+  UpdateIdentityResponseBody,
+  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-03-25T09:16:36.980Z",
+  ).transform(v => new Date(v)),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+    "external_id": "externalId",
+    "display_name": "displayName",
+    "avatar_url": "avatarUrl",
+  });
+});
+
+export function updateIdentityResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdateIdentityResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdateIdentityResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdateIdentityResponseBody' from JSON`,
+  );
+}