@orq-ai/node 2.14.6 → 3.0.0-rc.19

package/src/models/operations/bulkfileupload.ts

@@ -0,0 +1,315 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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 Files = {
+  fileName: string;
+  content: ReadableStream<Uint8Array> | Blob | ArrayBuffer | Uint8Array;
+};
+
+/**
+ * The intended purpose of the uploaded file.
+ */
+export const BulkFileUploadPurpose = {
+  Retrieval: "retrieval",
+  KnowledgeDatasource: "knowledge_datasource",
+} as const;
+/**
+ * The intended purpose of the uploaded file.
+ */
+export type BulkFileUploadPurpose = ClosedEnum<typeof BulkFileUploadPurpose>;
+
+export type BulkFileUploadRequestBody = {
+  files: Array<Files>;
+  /**
+   * The intended purpose of the uploaded file.
+   */
+  purpose: BulkFileUploadPurpose;
+};
+
+/**
+ * The intended purpose of the uploaded file.
+ */
+export const BulkFileUploadFilesPurpose = {
+  Retrieval: "retrieval",
+  KnowledgeDatasource: "knowledge_datasource",
+} as const;
+/**
+ * The intended purpose of the uploaded file.
+ */
+export type BulkFileUploadFilesPurpose = ClosedEnum<
+  typeof BulkFileUploadFilesPurpose
+>;
+
+export type ResponseBody = {
+  id: string;
+  /**
+   * path to the file in the storage
+   */
+  objectName: string;
+  /**
+   * The intended purpose of the uploaded file.
+   */
+  purpose: BulkFileUploadFilesPurpose;
+  bytes: number;
+  fileName: string;
+  /**
+   * The id of the resource
+   */
+  workspaceId: string;
+  /**
+   * The date and time the resource was created
+   */
+  created?: Date | undefined;
+};
+
+/** @internal */
+export const Files$inboundSchema: z.ZodType<Files, z.ZodTypeDef, unknown> = z
+  .object({
+    fileName: z.string(),
+    content: z.union([
+      z.instanceof(ReadableStream<Uint8Array>),
+      z.instanceof(Blob),
+      z.instanceof(ArrayBuffer),
+      z.instanceof(Uint8Array),
+    ]),
+  });
+
+/** @internal */
+export type Files$Outbound = {
+  fileName: string;
+  content: ReadableStream<Uint8Array> | Blob | ArrayBuffer | Uint8Array;
+};
+
+/** @internal */
+export const Files$outboundSchema: z.ZodType<
+  Files$Outbound,
+  z.ZodTypeDef,
+  Files
+> = z.object({
+  fileName: z.string(),
+  content: z.union([
+    z.instanceof(ReadableStream<Uint8Array>),
+    z.instanceof(Blob),
+    z.instanceof(ArrayBuffer),
+    z.instanceof(Uint8Array),
+  ]),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Files$ {
+  /** @deprecated use `Files$inboundSchema` instead. */
+  export const inboundSchema = Files$inboundSchema;
+  /** @deprecated use `Files$outboundSchema` instead. */
+  export const outboundSchema = Files$outboundSchema;
+  /** @deprecated use `Files$Outbound` instead. */
+  export type Outbound = Files$Outbound;
+}
+
+export function filesToJSON(files: Files): string {
+  return JSON.stringify(Files$outboundSchema.parse(files));
+}
+
+export function filesFromJSON(
+  jsonString: string,
+): SafeParseResult<Files, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Files$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Files' from JSON`,
+  );
+}
+
+/** @internal */
+export const BulkFileUploadPurpose$inboundSchema: z.ZodNativeEnum<
+  typeof BulkFileUploadPurpose
+> = z.nativeEnum(BulkFileUploadPurpose);
+
+/** @internal */
+export const BulkFileUploadPurpose$outboundSchema: z.ZodNativeEnum<
+  typeof BulkFileUploadPurpose
+> = BulkFileUploadPurpose$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace BulkFileUploadPurpose$ {
+  /** @deprecated use `BulkFileUploadPurpose$inboundSchema` instead. */
+  export const inboundSchema = BulkFileUploadPurpose$inboundSchema;
+  /** @deprecated use `BulkFileUploadPurpose$outboundSchema` instead. */
+  export const outboundSchema = BulkFileUploadPurpose$outboundSchema;
+}
+
+/** @internal */
+export const BulkFileUploadRequestBody$inboundSchema: z.ZodType<
+  BulkFileUploadRequestBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  files: z.array(z.lazy(() => Files$inboundSchema)),
+  purpose: BulkFileUploadPurpose$inboundSchema,
+});
+
+/** @internal */
+export type BulkFileUploadRequestBody$Outbound = {
+  files: Array<Files$Outbound>;
+  purpose: string;
+};
+
+/** @internal */
+export const BulkFileUploadRequestBody$outboundSchema: z.ZodType<
+  BulkFileUploadRequestBody$Outbound,
+  z.ZodTypeDef,
+  BulkFileUploadRequestBody
+> = z.object({
+  files: z.array(z.lazy(() => Files$outboundSchema)),
+  purpose: BulkFileUploadPurpose$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace BulkFileUploadRequestBody$ {
+  /** @deprecated use `BulkFileUploadRequestBody$inboundSchema` instead. */
+  export const inboundSchema = BulkFileUploadRequestBody$inboundSchema;
+  /** @deprecated use `BulkFileUploadRequestBody$outboundSchema` instead. */
+  export const outboundSchema = BulkFileUploadRequestBody$outboundSchema;
+  /** @deprecated use `BulkFileUploadRequestBody$Outbound` instead. */
+  export type Outbound = BulkFileUploadRequestBody$Outbound;
+}
+
+export function bulkFileUploadRequestBodyToJSON(
+  bulkFileUploadRequestBody: BulkFileUploadRequestBody,
+): string {
+  return JSON.stringify(
+    BulkFileUploadRequestBody$outboundSchema.parse(bulkFileUploadRequestBody),
+  );
+}
+
+export function bulkFileUploadRequestBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<BulkFileUploadRequestBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BulkFileUploadRequestBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BulkFileUploadRequestBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const BulkFileUploadFilesPurpose$inboundSchema: z.ZodNativeEnum<
+  typeof BulkFileUploadFilesPurpose
+> = z.nativeEnum(BulkFileUploadFilesPurpose);
+
+/** @internal */
+export const BulkFileUploadFilesPurpose$outboundSchema: z.ZodNativeEnum<
+  typeof BulkFileUploadFilesPurpose
+> = BulkFileUploadFilesPurpose$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace BulkFileUploadFilesPurpose$ {
+  /** @deprecated use `BulkFileUploadFilesPurpose$inboundSchema` instead. */
+  export const inboundSchema = BulkFileUploadFilesPurpose$inboundSchema;
+  /** @deprecated use `BulkFileUploadFilesPurpose$outboundSchema` instead. */
+  export const outboundSchema = BulkFileUploadFilesPurpose$outboundSchema;
+}
+
+/** @internal */
+export const ResponseBody$inboundSchema: z.ZodType<
+  ResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string(),
+  object_name: z.string(),
+  purpose: BulkFileUploadFilesPurpose$inboundSchema,
+  bytes: z.number(),
+  file_name: z.string(),
+  workspace_id: z.string(),
+  created: z.string().datetime({ offset: true }).default(
+    "2025-01-02T13:55:01.176Z",
+  ).transform(v => new Date(v)),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+    "object_name": "objectName",
+    "file_name": "fileName",
+    "workspace_id": "workspaceId",
+  });
+});
+
+/** @internal */
+export type ResponseBody$Outbound = {
+  _id: string;
+  object_name: string;
+  purpose: string;
+  bytes: number;
+  file_name: string;
+  workspace_id: string;
+  created: string;
+};
+
+/** @internal */
+export const ResponseBody$outboundSchema: z.ZodType<
+  ResponseBody$Outbound,
+  z.ZodTypeDef,
+  ResponseBody
+> = z.object({
+  id: z.string(),
+  objectName: z.string(),
+  purpose: BulkFileUploadFilesPurpose$outboundSchema,
+  bytes: z.number(),
+  fileName: z.string(),
+  workspaceId: z.string(),
+  created: z.date().default(() => new Date("2025-01-02T13:55:01.176Z"))
+    .transform(v => v.toISOString()),
+}).transform((v) => {
+  return remap$(v, {
+    id: "_id",
+    objectName: "object_name",
+    fileName: "file_name",
+    workspaceId: "workspace_id",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ResponseBody$ {
+  /** @deprecated use `ResponseBody$inboundSchema` instead. */
+  export const inboundSchema = ResponseBody$inboundSchema;
+  /** @deprecated use `ResponseBody$outboundSchema` instead. */
+  export const outboundSchema = ResponseBody$outboundSchema;
+  /** @deprecated use `ResponseBody$Outbound` instead. */
+  export type Outbound = ResponseBody$Outbound;
+}
+
+export function responseBodyToJSON(responseBody: ResponseBody): string {
+  return JSON.stringify(ResponseBody$outboundSchema.parse(responseBody));
+}
+
+export function responseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<ResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ResponseBody' from JSON`,
+  );
+}

package/src/models/operations/createcontact.ts

@@ -0,0 +1,256 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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";
+
+/**
+ * Update user information payload
+ */
+export type CreateContactRequestBody = {
+  /**
+   * Unique string value to identify the contact user in the customer's system
+   */
+  externalId: string;
+  /**
+   * Display name or nickname of the user
+   */
+  displayName?: string | null | undefined;
+  /**
+   * Email address of the user
+   */
+  email?: string | null | undefined;
+  /**
+   * URL linking to the user's avatar image
+   */
+  avatarUrl?: string | null | undefined;
+  /**
+   * Array of UUIDs representing tags associated with the user
+   */
+  tags?: Array<string> | undefined;
+  /**
+   * Additional custom metadata associated with the user as key-value pairs
+   */
+  metadata?: { [k: string]: any } | undefined;
+};
+
+/**
+ * Successful operation
+ */
+export type CreateContactResponseBody = {
+  /**
+   * Unique ULID (Universally Unique Lexicographically Sortable Identifier) for the user
+   */
+  id: string;
+  /**
+   * Unique string value to identify the contact user in the customer's system
+   */
+  externalId: string;
+  /**
+   * Display name or nickname of the user
+   */
+  displayName?: string | null | undefined;
+  /**
+   * Email address of the user
+   */
+  email?: string | null | undefined;
+  /**
+   * URL linking to the user's avatar image
+   */
+  avatarUrl?: string | null | undefined;
+  /**
+   * Array of UUIDs representing tags associated with the user
+   */
+  tags?: Array<string> | undefined;
+  /**
+   * Additional custom metadata associated with the user as key-value pairs
+   */
+  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;
+};
+
+/** @internal */
+export const CreateContactRequestBody$inboundSchema: z.ZodType<
+  CreateContactRequestBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  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(),
+}).transform((v) => {
+  return remap$(v, {
+    "external_id": "externalId",
+    "display_name": "displayName",
+    "avatar_url": "avatarUrl",
+  });
+});
+
+/** @internal */
+export type CreateContactRequestBody$Outbound = {
+  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;
+};
+
+/** @internal */
+export const CreateContactRequestBody$outboundSchema: z.ZodType<
+  CreateContactRequestBody$Outbound,
+  z.ZodTypeDef,
+  CreateContactRequestBody
+> = z.object({
+  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(),
+}).transform((v) => {
+  return remap$(v, {
+    externalId: "external_id",
+    displayName: "display_name",
+    avatarUrl: "avatar_url",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CreateContactRequestBody$ {
+  /** @deprecated use `CreateContactRequestBody$inboundSchema` instead. */
+  export const inboundSchema = CreateContactRequestBody$inboundSchema;
+  /** @deprecated use `CreateContactRequestBody$outboundSchema` instead. */
+  export const outboundSchema = CreateContactRequestBody$outboundSchema;
+  /** @deprecated use `CreateContactRequestBody$Outbound` instead. */
+  export type Outbound = CreateContactRequestBody$Outbound;
+}
+
+export function createContactRequestBodyToJSON(
+  createContactRequestBody: CreateContactRequestBody,
+): string {
+  return JSON.stringify(
+    CreateContactRequestBody$outboundSchema.parse(createContactRequestBody),
+  );
+}
+
+export function createContactRequestBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateContactRequestBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateContactRequestBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateContactRequestBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const CreateContactResponseBody$inboundSchema: z.ZodType<
+  CreateContactResponseBody,
+  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(
+    "2025-01-02T13:55:01.056Z",
+  ).transform(v => new Date(v)),
+}).transform((v) => {
+  return remap$(v, {
+    "external_id": "externalId",
+    "display_name": "displayName",
+    "avatar_url": "avatarUrl",
+  });
+});
+
+/** @internal */
+export type CreateContactResponseBody$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;
+};
+
+/** @internal */
+export const CreateContactResponseBody$outboundSchema: z.ZodType<
+  CreateContactResponseBody$Outbound,
+  z.ZodTypeDef,
+  CreateContactResponseBody
+> = 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("2025-01-02T13:55:01.056Z"))
+    .transform(v => v.toISOString()),
+}).transform((v) => {
+  return remap$(v, {
+    externalId: "external_id",
+    displayName: "display_name",
+    avatarUrl: "avatar_url",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CreateContactResponseBody$ {
+  /** @deprecated use `CreateContactResponseBody$inboundSchema` instead. */
+  export const inboundSchema = CreateContactResponseBody$inboundSchema;
+  /** @deprecated use `CreateContactResponseBody$outboundSchema` instead. */
+  export const outboundSchema = CreateContactResponseBody$outboundSchema;
+  /** @deprecated use `CreateContactResponseBody$Outbound` instead. */
+  export type Outbound = CreateContactResponseBody$Outbound;
+}
+
+export function createContactResponseBodyToJSON(
+  createContactResponseBody: CreateContactResponseBody,
+): string {
+  return JSON.stringify(
+    CreateContactResponseBody$outboundSchema.parse(createContactResponseBody),
+  );
+}
+
+export function createContactResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateContactResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateContactResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateContactResponseBody' from JSON`,
+  );
+}