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

package/src/funcs/promptsListVersions.ts

@@ -0,0 +1,139 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { OrqCore } from "../core.js";
+import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import { APIError } from "../models/errors/apierror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * 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
+ */
+export async function promptsListVersions(
+  client: OrqCore,
+  request: operations.ListPromptVersionsRequest,
+  options?: RequestOptions,
+): Promise<
+  Result<
+    operations.ListPromptVersionsResponseBody,
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.ListPromptVersionsRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return parsed;
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    prompt_id: encodeSimple("prompt_id", payload.prompt_id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc("/v2/prompts/{prompt_id}/versions")(pathParams);
+
+  const query = encodeFormQuery({
+    "ending_before": payload.ending_before,
+    "limit": payload.limit,
+    "starting_after": payload.starting_after,
+  });
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKey);
+  const securityInput = secConfig == null ? {} : { apiKey: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    operationID: "ListPromptVersions",
+    oAuth2Scopes: [],
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKey,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || 600000,
+  }, options);
+  if (!requestRes.ok) {
+    return requestRes;
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return doResult;
+  }
+  const response = doResult.value;
+
+  const [result] = await M.match<
+    operations.ListPromptVersionsResponseBody,
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(200, operations.ListPromptVersionsResponseBody$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response);
+  if (!result.ok) {
+    return result;
+  }
+
+  return result;
+}

package/src/funcs/promptsRetrieve.ts

@@ -0,0 +1,132 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { OrqCore } from "../core.js";
+import { encodeSimple } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import { APIError } from "../models/errors/apierror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Retrieve a prompt
+ *
+ * @remarks
+ * Retrieves a prompt object
+ */
+export async function promptsRetrieve(
+  client: OrqCore,
+  request: operations.GetOnePromptRequest,
+  options?: RequestOptions,
+): Promise<
+  Result<
+    operations.GetOnePromptResponseBody,
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.GetOnePromptRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return parsed;
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    id: encodeSimple("id", payload.id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc("/v2/prompts/{id}")(pathParams);
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKey);
+  const securityInput = secConfig == null ? {} : { apiKey: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    operationID: "GetOnePrompt",
+    oAuth2Scopes: [],
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKey,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || 600000,
+  }, options);
+  if (!requestRes.ok) {
+    return requestRes;
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return doResult;
+  }
+  const response = doResult.value;
+
+  const [result] = await M.match<
+    operations.GetOnePromptResponseBody,
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(200, operations.GetOnePromptResponseBody$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response);
+  if (!result.ok) {
+    return result;
+  }
+
+  return result;
+}

package/src/funcs/promptsUpdate.ts

@@ -61,7 +61,7 @@ export async function promptsUpdate(
     }),
   };
 
-  const path = pathToFunc("/v2/resources/prompts/{id}")(pathParams);
+  const path = pathToFunc("/v2/prompts/{id}")(pathParams);
 
   const headers = new Headers(compactMap({
     "Content-Type": "application/json",

package/src/hooks/global.ts

@@ -0,0 +1,44 @@
+import {
+    BeforeRequestHook,
+    BeforeRequestContext
+  } from "./types";
+  
+  export class GlobalHook implements BeforeRequestHook {
+    async beforeRequest(hookCtx: BeforeRequestContext, request: Request): Promise<Request> {
+      const contactId = request.headers.get('contactId')
+      if (contactId) {
+        request.headers.set('x-orq-contact-id', contactId);
+        request.headers.delete('contactId')
+      }
+  
+      const environment = request.headers.get('environment')
+      
+      // if the operation is related to deployment invoke & invoke stream
+      if (["DeploymentInvoke", "DeploymentStream"].includes(hookCtx.operationID) && environment) {
+        request.headers.delete('environment')
+        const payload = await request.json()
+
+        if (hookCtx.operationID === 'DeploymentStream') {
+          payload.stream = true;
+        } else {
+          payload.stream = false;
+        }
+  
+        if ('context' in payload && typeof payload.context === 'object') {
+          payload.context.environments = environment;
+        } else {
+          payload.context = {
+            environments: environment
+          }
+        }
+        return new Request(request.url, {
+          method: request.method,
+          headers: request.headers,
+          body: JSON.stringify(payload),
+          signal: request.signal
+        });
+      }
+  
+      return request;
+    }
+  }

package/src/hooks/registration.ts

@@ -1,3 +1,4 @@
+import { GlobalHook } from "./global.js";
 import { Hooks } from "./types.js";
 
 /*
@@ -6,9 +7,9 @@ import { Hooks } from "./types.js";
  * in this file or in separate files in the hooks folder.
  */
 
-// @ts-expect-error remove this line when you add your first hook and hooks is used
 export function initHooks(hooks: Hooks) {
   // Add hooks by calling hooks.register{ClientInit/BeforeCreateRequest/BeforeRequest/AfterSuccess/AfterError}Hook
   // with an instance of a hook that implements that specific Hook interface
   // Hooks are registered per SDK instance, and are valid for the lifetime of the SDK instance
+  hooks.registerBeforeRequestHook(new GlobalHook());
 }

package/src/lib/config.ts

@@ -17,6 +17,16 @@ export const ServerList = [
 export type SDKOptions = {
   apiKey?: string | (() => Promise<string>);
 
+  /**
+   * Allows setting the contactId parameter for all supported operations
+   */
+  contactId?: string | undefined;
+
+  /**
+   * Allows setting the environment parameter for all supported operations
+   */
+  environment?: string | undefined;
+
   httpClient?: HTTPClient;
   /**
    * Allows overriding the default server used by the SDK
@@ -54,7 +64,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "2.0",
-  sdkVersion: "3.1.0-rc.7",
-  genVersion: "2.493.32",
-  userAgent: "speakeasy-sdk/typescript 3.1.0-rc.7 2.493.32 2.0 @orq-ai/node",
+  sdkVersion: "3.1.0",
+  genVersion: "2.506.0",
+  userAgent: "speakeasy-sdk/typescript 3.1.0 2.506.0 2.0 @orq-ai/node",
 } as const;

package/src/lib/env.ts

@@ -5,16 +5,30 @@
 import { dlv } from "./dlv.js";
 
 import * as z from "zod";
+import { SDKOptions } from "./config.js";
 
 export interface Env {
   ORQ_API_KEY?: string | undefined;
 
+  /**
+   * Sets the contactId parameter for all supported operations
+   */
+  ORQ_CONTACT_ID?: string | undefined;
+
+  /**
+   * Sets the environment parameter for all supported operations
+   */
+  ORQ_ENVIRONMENT?: string | undefined;
+
   ORQ_DEBUG?: boolean | undefined;
 }
 
 export const envSchema: z.ZodType<Env, z.ZodTypeDef, unknown> = z.object({
   ORQ_API_KEY: z.string().optional(),
 
+  ORQ_CONTACT_ID: z.string().optional(),
+  ORQ_ENVIRONMENT: z.string().optional(),
+
   ORQ_DEBUG: z.coerce.boolean().optional(),
 });
 
@@ -39,3 +53,21 @@ export function env(): Env {
 export function resetEnv() {
   envMemo = undefined;
 }
+
+/**
+ * Populates global parameters with environment variables.
+ */
+export function fillGlobals(options: SDKOptions): SDKOptions {
+  const clone = { ...options };
+
+  const envVars = env();
+
+  if (typeof envVars.ORQ_CONTACT_ID !== "undefined") {
+    clone.contactId ??= envVars.ORQ_CONTACT_ID;
+  }
+  if (typeof envVars.ORQ_ENVIRONMENT !== "undefined") {
+    clone.environment ??= envVars.ORQ_ENVIRONMENT;
+  }
+
+  return clone;
+}

package/src/lib/retries.ts

@@ -158,7 +158,6 @@ async function retryBackoff(
   const start = Date.now();
   let x = 0;
 
-  // eslint-disable-next-line no-constant-condition
   while (true) {
     try {
       const res = await fn();

package/src/lib/sdks.ts

@@ -15,7 +15,7 @@ import { ERR, OK, Result } from "../types/fp.js";
 import { stringToBase64 } from "./base64.js";
 import { SDK_METADATA, SDKOptions, serverURLFromOptions } from "./config.js";
 import { encodeForm } from "./encodings.js";
-import { env } from "./env.js";
+import { env, fillGlobals } from "./env.js";
 import {
   HTTPClient,
   isAbortError,
@@ -94,7 +94,7 @@ export class ClientSDK {
     } else {
       this.#hooks = new SDKHooks();
     }
-    this._options = { ...options, hooks: this.#hooks };
+    this._options = { ...fillGlobals(options), hooks: this.#hooks };
 
     const url = serverURLFromOptions(options);
     if (url) {

package/src/models/components/deployments.ts

@@ -247,10 +247,6 @@ export type Deployments = {
    * The deployment key to invoke
    */
   key: string;
-  /**
-   * If set, partial message content will be sent. Tokens will be sent as data-only `server-sent events` as they become available, with the stream terminated by a `data: [DONE]` message.
-   */
-  stream?: boolean | undefined;
   /**
    * Key-value pairs variables to replace in your prompts. If a variable is not provided that is defined in the prompt, the default variables are used.
    */
@@ -1583,7 +1579,6 @@ export const Deployments$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   key: z.string(),
-  stream: z.boolean().default(false),
   inputs: z.record(z.union([z.string(), z.number(), z.boolean()])).optional(),
   context: z.record(z.any()).optional(),
   prefix_messages: z.array(z.lazy(() => PrefixMessages$inboundSchema))
@@ -1606,7 +1601,6 @@ export const Deployments$inboundSchema: z.ZodType<
 /** @internal */
 export type Deployments$Outbound = {
   key: string;
-  stream: boolean;
   inputs?: { [k: string]: string | number | boolean } | undefined;
   context?: { [k: string]: any } | undefined;
   prefix_messages?: Array<PrefixMessages$Outbound> | undefined;
@@ -1625,7 +1619,6 @@ export const Deployments$outboundSchema: z.ZodType<
   Deployments
 > = z.object({
   key: z.string(),
-  stream: z.boolean().default(false),
   inputs: z.record(z.union([z.string(), z.number(), z.boolean()])).optional(),
   context: z.record(z.any()).optional(),
   prefixMessages: z.array(z.lazy(() => PrefixMessages$outboundSchema))

package/src/models/errors/getpromptversion.ts

@@ -0,0 +1,71 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+/**
+ * Not Found - The prompt or prompt version does not exist.
+ */
+export type GetPromptVersionResponseBodyData = {
+  message: string;
+};
+
+/**
+ * Not Found - The prompt or prompt version does not exist.
+ */
+export class GetPromptVersionResponseBody extends Error {
+  /** The original data that was passed to this error instance. */
+  data$: GetPromptVersionResponseBodyData;
+
+  constructor(err: GetPromptVersionResponseBodyData) {
+    const message = "message" in err && typeof err.message === "string"
+      ? err.message
+      : `API error occurred: ${JSON.stringify(err)}`;
+    super(message);
+    this.data$ = err;
+
+    this.name = "GetPromptVersionResponseBody";
+  }
+}
+
+/** @internal */
+export const GetPromptVersionResponseBody$inboundSchema: z.ZodType<
+  GetPromptVersionResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  message: z.string(),
+})
+  .transform((v) => {
+    return new GetPromptVersionResponseBody(v);
+  });
+
+/** @internal */
+export type GetPromptVersionResponseBody$Outbound = {
+  message: string;
+};
+
+/** @internal */
+export const GetPromptVersionResponseBody$outboundSchema: z.ZodType<
+  GetPromptVersionResponseBody$Outbound,
+  z.ZodTypeDef,
+  GetPromptVersionResponseBody
+> = z.instanceof(GetPromptVersionResponseBody)
+  .transform(v => v.data$)
+  .pipe(z.object({
+    message: z.string(),
+  }));
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetPromptVersionResponseBody$ {
+  /** @deprecated use `GetPromptVersionResponseBody$inboundSchema` instead. */
+  export const inboundSchema = GetPromptVersionResponseBody$inboundSchema;
+  /** @deprecated use `GetPromptVersionResponseBody$outboundSchema` instead. */
+  export const outboundSchema = GetPromptVersionResponseBody$outboundSchema;
+  /** @deprecated use `GetPromptVersionResponseBody$Outbound` instead. */
+  export type Outbound = GetPromptVersionResponseBody$Outbound;
+}

package/src/models/errors/index.ts

@@ -3,7 +3,9 @@
  */
 
 export * from "./apierror.js";
+export * from "./getpromptversion.js";
 export * from "./honoapierror.js";
 export * from "./httpclienterrors.js";
 export * from "./sdkvalidationerror.js";
 export * from "./updateprompt.js";
+export * from "./updatepromptsnippet.js";

package/src/models/errors/updatepromptsnippet.ts

@@ -0,0 +1,71 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+/**
+ * Prompt snippet not found.
+ */
+export type UpdatePromptSnippetResponseBodyData = {
+  message: string;
+};
+
+/**
+ * Prompt snippet not found.
+ */
+export class UpdatePromptSnippetResponseBody extends Error {
+  /** The original data that was passed to this error instance. */
+  data$: UpdatePromptSnippetResponseBodyData;
+
+  constructor(err: UpdatePromptSnippetResponseBodyData) {
+    const message = "message" in err && typeof err.message === "string"
+      ? err.message
+      : `API error occurred: ${JSON.stringify(err)}`;
+    super(message);
+    this.data$ = err;
+
+    this.name = "UpdatePromptSnippetResponseBody";
+  }
+}
+
+/** @internal */
+export const UpdatePromptSnippetResponseBody$inboundSchema: z.ZodType<
+  UpdatePromptSnippetResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  message: z.string(),
+})
+  .transform((v) => {
+    return new UpdatePromptSnippetResponseBody(v);
+  });
+
+/** @internal */
+export type UpdatePromptSnippetResponseBody$Outbound = {
+  message: string;
+};
+
+/** @internal */
+export const UpdatePromptSnippetResponseBody$outboundSchema: z.ZodType<
+  UpdatePromptSnippetResponseBody$Outbound,
+  z.ZodTypeDef,
+  UpdatePromptSnippetResponseBody
+> = z.instanceof(UpdatePromptSnippetResponseBody)
+  .transform(v => v.data$)
+  .pipe(z.object({
+    message: z.string(),
+  }));
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace UpdatePromptSnippetResponseBody$ {
+  /** @deprecated use `UpdatePromptSnippetResponseBody$inboundSchema` instead. */
+  export const inboundSchema = UpdatePromptSnippetResponseBody$inboundSchema;
+  /** @deprecated use `UpdatePromptSnippetResponseBody$outboundSchema` instead. */
+  export const outboundSchema = UpdatePromptSnippetResponseBody$outboundSchema;
+  /** @deprecated use `UpdatePromptSnippetResponseBody$Outbound` instead. */
+  export type Outbound = UpdatePromptSnippetResponseBody$Outbound;
+}

package/src/models/operations/createcontact.ts

@@ -177,7 +177,7 @@ export const CreateContactResponseBody$inboundSchema: z.ZodType<
   created: z.string().datetime({ offset: true }).transform(v => new Date(v))
     .optional(),
   updated: z.string().datetime({ offset: true }).default(
-    "2025-01-21T09:55:10.979Z",
+    "2025-02-11T16:43:21.610Z",
   ).transform(v => new Date(v)),
 }).transform((v) => {
   return remap$(v, {
@@ -214,7 +214,7 @@ export const CreateContactResponseBody$outboundSchema: z.ZodType<
   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-21T09:55:10.979Z"))
+  updated: z.date().default(() => new Date("2025-02-11T16:43:21.610Z"))
     .transform(v => v.toISOString()),
 }).transform((v) => {
   return remap$(v, {