@orq-ai/node 3.1.0-rc.64 → 3.1.0

package/packages/orq-rc/src/sdk/contacts.ts

@@ -0,0 +1,27 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { contactsCreate } from "../funcs/contactsCreate.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Contacts extends ClientSDK {
+  /**
+   * Update user information
+   *
+   * @remarks
+   * Update or add user information to workspace
+   */
+  async create(
+    request: operations.CreateContactRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.CreateContactResponseBody> {
+    return unwrapAsync(contactsCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/packages/orq-rc/src/sdk/deployments.ts

@@ -0,0 +1,89 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { deploymentsGetConfig } from "../funcs/deploymentsGetConfig.js";
+import { deploymentsInvoke } from "../funcs/deploymentsInvoke.js";
+import { deploymentsList } from "../funcs/deploymentsList.js";
+import { deploymentsStream } from "../funcs/deploymentsStream.js";
+import { EventStream } from "../lib/event-streams.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+import { Metrics } from "./metrics.js";
+
+export class Deployments extends ClientSDK {
+  private _metrics?: Metrics;
+  get metrics(): Metrics {
+    return (this._metrics ??= new Metrics(this._options));
+  }
+
+  /**
+   * List all deployments
+   *
+   * @remarks
+   * Returns a list of your deployments. The deployments are returned sorted by creation date, with the most recent deployments appearing first.
+   */
+  async list(
+    request?: operations.DeploymentsRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.DeploymentsResponseBody> {
+    return unwrapAsync(deploymentsList(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get config
+   *
+   * @remarks
+   * Retrieve the deployment configuration
+   */
+  async getConfig(
+    request: operations.DeploymentGetConfigRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.DeploymentGetConfigResponseBody | undefined> {
+    return unwrapAsync(deploymentsGetConfig(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Invoke
+   *
+   * @remarks
+   * Invoke a deployment with a given payload
+   */
+  async invoke(
+    request: components.Deployments,
+    options?: RequestOptions,
+  ): Promise<operations.DeploymentInvokeResponseBody | undefined> {
+    return unwrapAsync(deploymentsInvoke(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Stream
+   *
+   * @remarks
+   * Stream deployment generation. Only supported for completions and chat completions.
+   */
+  async stream(
+    request: operations.DeploymentStreamRequestBody,
+    options?: RequestOptions,
+  ): Promise<EventStream<operations.DeploymentStreamResponseBody>> {
+    return unwrapAsync(deploymentsStream(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/packages/orq-rc/src/sdk/feedback.ts

@@ -0,0 +1,27 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { feedbackCreate } from "../funcs/feedbackCreate.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Feedback extends ClientSDK {
+  /**
+   * Submit feedback
+   *
+   * @remarks
+   * Submit feedback for the LLM transaction via the API
+   */
+  async create(
+    request: operations.CreateFeedbackRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.CreateFeedbackResponseBody> {
+    return unwrapAsync(feedbackCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/packages/orq-rc/src/sdk/files.ts

@@ -0,0 +1,72 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { filesDelete } from "../funcs/filesDelete.js";
+import { filesGet } from "../funcs/filesGet.js";
+import { filesList } from "../funcs/filesList.js";
+import { filesUpload } from "../funcs/filesUpload.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Files extends ClientSDK {
+  /**
+   * Upload file
+   *
+   * @remarks
+   * Files are used to upload documents that can be used with features like [Deployments](https://docs.orq.ai/reference/post_v2-deployments-get-config).
+   */
+  async upload(
+    request?: operations.FileUploadRequestBody | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.FileUploadResponseBody> {
+    return unwrapAsync(filesUpload(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List all files
+   */
+  async list(
+    request?: operations.FileListRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.FileListResponseBody> {
+    return unwrapAsync(filesList(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get file by ID
+   */
+  async get(
+    request: operations.FileGetRequest,
+    options?: RequestOptions,
+  ): Promise<operations.FileGetResponseBody> {
+    return unwrapAsync(filesGet(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete file
+   */
+  async delete(
+    request: operations.FileDeleteRequest,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(filesDelete(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/packages/orq-rc/src/sdk/index.ts

@@ -0,0 +1,5 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export * from "./sdk.js";

package/packages/orq-rc/src/sdk/metrics.ts

@@ -0,0 +1,27 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { deploymentsMetricsCreate } from "../funcs/deploymentsMetricsCreate.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Metrics extends ClientSDK {
+  /**
+   * Add metrics
+   *
+   * @remarks
+   * Add metrics to a deployment
+   */
+  async create(
+    request: operations.DeploymentCreateMetricRequest,
+    options?: RequestOptions,
+  ): Promise<operations.DeploymentCreateMetricResponseBody> {
+    return unwrapAsync(deploymentsMetricsCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/packages/orq-rc/src/sdk/prompts.ts

@@ -0,0 +1,126 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { promptsCreate } from "../funcs/promptsCreate.js";
+import { promptsDelete } from "../funcs/promptsDelete.js";
+import { promptsGetVersion } from "../funcs/promptsGetVersion.js";
+import { promptsList } from "../funcs/promptsList.js";
+import { promptsListVersions } from "../funcs/promptsListVersions.js";
+import { promptsRetrieve } from "../funcs/promptsRetrieve.js";
+import { promptsUpdate } from "../funcs/promptsUpdate.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Prompts extends ClientSDK {
+  /**
+   * List all prompts
+   *
+   * @remarks
+   * Returns a list of your prompts. The prompts are returned sorted by creation date, with the most recent prompts appearing first
+   */
+  async list(
+    request?: operations.GetAllPromptsRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.GetAllPromptsResponseBody> {
+    return unwrapAsync(promptsList(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create a prompt
+   */
+  async create(
+    request?: operations.CreatePromptRequestBody | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.CreatePromptResponseBody> {
+    return unwrapAsync(promptsCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve a prompt
+   *
+   * @remarks
+   * Retrieves a prompt object
+   */
+  async retrieve(
+    request: operations.GetOnePromptRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetOnePromptResponseBody> {
+    return unwrapAsync(promptsRetrieve(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update a prompt
+   */
+  async update(
+    request: operations.UpdatePromptRequest,
+    options?: RequestOptions,
+  ): Promise<operations.UpdatePromptResponseBody> {
+    return unwrapAsync(promptsUpdate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete a prompt
+   */
+  async delete(
+    request: operations.DeletePromptRequest,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(promptsDelete(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List all prompt versions
+   *
+   * @remarks
+   * Returns a list of your prompt versions. The prompt versions are returned sorted by creation date, with the most recent prompt versions appearing first
+   */
+  async listVersions(
+    request: operations.ListPromptVersionsRequest,
+    options?: RequestOptions,
+  ): Promise<operations.ListPromptVersionsResponseBody> {
+    return unwrapAsync(promptsListVersions(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve a prompt version
+   *
+   * @remarks
+   * Retrieves a specific version of a prompt by its ID and version ID.
+   */
+  async getVersion(
+    request: operations.GetPromptVersionRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetPromptVersionResponseBody> {
+    return unwrapAsync(promptsGetVersion(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/packages/orq-rc/src/sdk/promptsnippets.ts

@@ -0,0 +1,99 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { promptSnippetsCreate } from "../funcs/promptSnippetsCreate.js";
+import { promptSnippetsDelete } from "../funcs/promptSnippetsDelete.js";
+import { promptSnippetsGet } from "../funcs/promptSnippetsGet.js";
+import { promptSnippetsGetByKey } from "../funcs/promptSnippetsGetByKey.js";
+import { promptSnippetsList } from "../funcs/promptSnippetsList.js";
+import { promptSnippetsUpdate } from "../funcs/promptSnippetsUpdate.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class PromptSnippets extends ClientSDK {
+  /**
+   * List all prompts snippets
+   */
+  async list(
+    request?: operations.GetAllPromptSnippetsRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.GetAllPromptSnippetsResponseBody> {
+    return unwrapAsync(promptSnippetsList(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create a prompt snippet
+   */
+  async create(
+    request?: operations.CreatePromptSnippetRequestBody | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.CreatePromptSnippetResponseBody> {
+    return unwrapAsync(promptSnippetsCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update a prompt snippet
+   */
+  async update(
+    request: operations.UpdatePromptSnippetRequest,
+    options?: RequestOptions,
+  ): Promise<operations.UpdatePromptSnippetResponseBody> {
+    return unwrapAsync(promptSnippetsUpdate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete a prompt snippet
+   */
+  async delete(
+    request: operations.DeletePromptSnippetRequest,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(promptSnippetsDelete(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve a prompt snippet
+   */
+  async get(
+    request: operations.FindOnePromptSnippetRequest,
+    options?: RequestOptions,
+  ): Promise<operations.FindOnePromptSnippetResponseBody> {
+    return unwrapAsync(promptSnippetsGet(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve a prompt snippet by key
+   */
+  async getByKey(
+    request: operations.FindOneByKeyPromptSnippetRequest,
+    options?: RequestOptions,
+  ): Promise<operations.FindOneByKeyPromptSnippetResponseBody> {
+    return unwrapAsync(promptSnippetsGetByKey(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/packages/orq-rc/src/sdk/remoteconfig.ts

@@ -0,0 +1,24 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { remoteconfigGetConfig } from "../funcs/remoteconfigGetConfig.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Remoteconfig extends ClientSDK {
+  /**
+   * Get Configurations
+   */
+  async getConfig(
+    request?: operations.RemoteConfigsGetConfigRequestBody | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.RemoteConfigsGetConfigResponseBody> {
+    return unwrapAsync(remoteconfigGetConfig(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/packages/orq-rc/src/sdk/sdk.ts

@@ -0,0 +1,49 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { ClientSDK } from "../lib/sdks.js";
+import { Contacts } from "./contacts.js";
+import { Deployments } from "./deployments.js";
+import { Feedback } from "./feedback.js";
+import { Files } from "./files.js";
+import { Prompts } from "./prompts.js";
+import { PromptSnippets } from "./promptsnippets.js";
+import { Remoteconfig } from "./remoteconfig.js";
+
+export class Orq extends ClientSDK {
+  private _contacts?: Contacts;
+  get contacts(): Contacts {
+    return (this._contacts ??= new Contacts(this._options));
+  }
+
+  private _feedback?: Feedback;
+  get feedback(): Feedback {
+    return (this._feedback ??= new Feedback(this._options));
+  }
+
+  private _deployments?: Deployments;
+  get deployments(): Deployments {
+    return (this._deployments ??= new Deployments(this._options));
+  }
+
+  private _files?: Files;
+  get files(): Files {
+    return (this._files ??= new Files(this._options));
+  }
+
+  private _promptSnippets?: PromptSnippets;
+  get promptSnippets(): PromptSnippets {
+    return (this._promptSnippets ??= new PromptSnippets(this._options));
+  }
+
+  private _prompts?: Prompts;
+  get prompts(): Prompts {
+    return (this._prompts ??= new Prompts(this._options));
+  }
+
+  private _remoteconfig?: Remoteconfig;
+  get remoteconfig(): Remoteconfig {
+    return (this._remoteconfig ??= new Remoteconfig(this._options));
+  }
+}

package/packages/orq-rc/src/types/blobs.ts

@@ -0,0 +1,31 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export const blobLikeSchema: z.ZodType<Blob, z.ZodTypeDef, Blob> =
+  z.custom<Blob>(isBlobLike, {
+    message: "expected a Blob, File or Blob-like object",
+    fatal: true,
+  });
+
+export function isBlobLike(val: unknown): val is Blob {
+  if (val instanceof Blob) {
+    return true;
+  }
+
+  if (typeof val !== "object" || val == null || !(Symbol.toStringTag in val)) {
+    return false;
+  }
+
+  const name = val[Symbol.toStringTag];
+  if (typeof name !== "string") {
+    return false;
+  }
+  if (name !== "Blob" && name !== "File") {
+    return false;
+  }
+
+  return "stream" in val && typeof val.stream === "function";
+}

package/packages/orq-rc/src/types/constdatetime.ts

@@ -0,0 +1,15 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export function constDateTime(
+  val: string,
+): z.ZodType<string, z.ZodTypeDef, unknown> {
+  return z.custom<string>((v) => {
+    return (
+      typeof v === "string" && new Date(v).getTime() === new Date(val).getTime()
+    );
+  }, `Value must be equivelant to ${val}`);
+}

package/packages/orq-rc/src/types/enums.ts

@@ -0,0 +1,16 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+declare const __brand: unique symbol;
+export type Unrecognized<T> = T & { [__brand]: "unrecognized" };
+
+export function catchUnrecognizedEnum<T>(value: T): Unrecognized<T> {
+  return value as Unrecognized<T>;
+}
+
+type Prettify<T> = { [K in keyof T]: T[K] } & {};
+export type ClosedEnum<T> = T[keyof T];
+export type OpenEnum<T> =
+  | Prettify<T[keyof T]>
+  | Unrecognized<T[keyof T] extends number ? number : string>;

package/packages/orq-rc/src/types/fp.ts

@@ -0,0 +1,50 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+/**
+ * A monad that captures the result of a function call or an error if it was not
+ * successful. Railway programming, enabled by this type, can be a nicer
+ * alternative to traditional exception throwing because it allows functions to
+ * declare all _known_ errors with static types and then check for them
+ * exhaustively in application code. Thrown exception have a type of `unknown`
+ * and break out of regular control flow of programs making them harder to
+ * inspect and more verbose work with due to try-catch blocks.
+ */
+export type Result<T, E = unknown> =
+  | { ok: true; value: T; error?: never }
+  | { ok: false; value?: never; error: E };
+
+export function OK<V>(value: V): Result<V, never> {
+  return { ok: true, value };
+}
+
+export function ERR<E>(error: E): Result<never, E> {
+  return { ok: false, error };
+}
+
+/**
+ * unwrap is a convenience function for extracting a value from a result or
+ * throwing if there was an error.
+ */
+export function unwrap<T>(r: Result<T, unknown>): T {
+  if (!r.ok) {
+    throw r.error;
+  }
+  return r.value;
+}
+
+/**
+ * unwrapAsync is a convenience function for resolving a value from a Promise
+ * of a result or rejecting if an error occurred.
+ */
+export async function unwrapAsync<T>(
+  pr: Promise<Result<T, unknown>>,
+): Promise<T> {
+  const r = await pr;
+  if (!r.ok) {
+    throw r.error;
+  }
+
+  return r.value;
+}

package/packages/orq-rc/src/types/index.ts

@@ -0,0 +1,11 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export { blobLikeSchema, isBlobLike } from "./blobs.js";
+export { catchUnrecognizedEnum } from "./enums.js";
+export type { ClosedEnum, OpenEnum, Unrecognized } from "./enums.js";
+export type { Result } from "./fp.js";
+export type { PageIterator, Paginator } from "./operations.js";
+export { createPageIterator } from "./operations.js";
+export { RFCDate } from "./rfcdate.js";