@orq-ai/node 3.1.2 → 3.1.4

package/src/funcs/{promptsCreateVersion.ts → deploymentsStream.ts}

@@ -2,8 +2,10 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import * as z from "zod";
 import { OrqCore } from "../core.js";
 import { encodeJSON, encodeSimple } from "../lib/encodings.js";
+import { EventStream } from "../lib/event-streams.js";
 import * as M from "../lib/matchers.js";
 import { compactMap } from "../lib/primitives.js";
 import { safeParse } from "../lib/schemas.js";
@@ -23,15 +25,18 @@ import * as operations from "../models/operations/index.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Create a new prompt version
+ * Stream
+ *
+ * @remarks
+ * Stream deployment generation. Only supported for completions and chat completions.
  */
-export async function promptsCreateVersion(
+export async function deploymentsStream(
   client: OrqCore,
-  request: operations.CreatePromptVersionRequest,
+  request: operations.DeploymentStreamRequestBody,
   options?: RequestOptions,
 ): Promise<
   Result<
-    operations.CreatePromptVersionResponseBody,
+    EventStream<operations.DeploymentStreamResponseBody>,
     | APIError
     | SDKValidationError
     | UnexpectedClientError
@@ -44,27 +49,28 @@ export async function promptsCreateVersion(
   const parsed = safeParse(
     request,
     (value) =>
-      operations.CreatePromptVersionRequest$outboundSchema.parse(value),
+      operations.DeploymentStreamRequestBody$outboundSchema.parse(value),
     "Input validation failed",
   );
   if (!parsed.ok) {
     return parsed;
   }
   const payload = parsed.value;
-  const body = encodeJSON("body", payload.RequestBody, { explode: true });
+  const body = encodeJSON("body", payload, { explode: true });
 
-  const pathParams = {
-    id: encodeSimple("id", payload.id, {
-      explode: false,
-      charEncoding: "percent",
-    }),
-  };
-
-  const path = pathToFunc("/v2/resources/prompts/{id}/versions")(pathParams);
+  const path = pathToFunc("/v2/deployments/stream")();
 
   const headers = new Headers(compactMap({
     "Content-Type": "application/json",
-    Accept: "application/json",
+    Accept: "text/event-stream",
+    "contactId": encodeSimple("contactId", client._options.contactId, {
+      explode: false,
+      charEncoding: "none",
+    }),
+    "environment": encodeSimple("environment", client._options.environment, {
+      explode: false,
+      charEncoding: "none",
+    }),
   }));
 
   const secConfig = await extractSecurity(client._options.apiKey);
@@ -72,7 +78,7 @@ export async function promptsCreateVersion(
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
-    operationID: "CreatePromptVersion",
+    operationID: "DeploymentStream",
     oAuth2Scopes: [],
 
     resolvedSecurity: requestSecurity,
@@ -110,7 +116,7 @@ export async function promptsCreateVersion(
   const response = doResult.value;
 
   const [result] = await M.match<
-    operations.CreatePromptVersionResponseBody,
+    EventStream<operations.DeploymentStreamResponseBody>,
     | APIError
     | SDKValidationError
     | UnexpectedClientError
@@ -119,7 +125,20 @@ export async function promptsCreateVersion(
     | RequestTimeoutError
     | ConnectionError
   >(
-    M.json(200, operations.CreatePromptVersionResponseBody$inboundSchema),
+    M.sse(
+      200,
+      z.instanceof(ReadableStream<Uint8Array>).transform(stream => {
+        return new EventStream({
+          stream,
+          decoder(rawEvent) {
+            const schema =
+              operations.DeploymentStreamResponseBody$inboundSchema;
+            return schema.parse(rawEvent);
+          },
+        });
+      }),
+      { sseSentinel: "[DONE]" },
+    ),
     M.fail("4XX"),
     M.fail("5XX"),
   )(response);

package/src/funcs/{filesUpload.ts → filesCreate.ts}

@@ -26,12 +26,12 @@ import { Result } from "../types/fp.js";
 import { isReadableStream } from "../types/streams.js";
 
 /**
- * Upload file
+ * Create 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).
  */
-export async function filesUpload(
+export async function filesCreate(
   client: OrqCore,
   request?: operations.FileUploadRequestBody | undefined,
   options?: RequestOptions,

package/src/funcs/filesGet.ts

@@ -23,7 +23,10 @@ import * as operations from "../models/operations/index.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Get file by ID
+ * Retrieve a file
+ *
+ * @remarks
+ * Retrieves the details of an existing file object. After you supply a unique file ID, orq.ai returns the corresponding file object
  */
 export async function filesGet(
   client: OrqCore,

package/src/funcs/filesList.ts

@@ -24,6 +24,9 @@ import { Result } from "../types/fp.js";
 
 /**
  * List all files
+ *
+ * @remarks
+ * Returns a list of the files that your account has access to. orq.ai sorts and returns the files by their creation dates, placing the most recently created files at the top.
  */
 export async function filesList(
   client: OrqCore,
@@ -56,10 +59,9 @@ export async function filesList(
   const path = pathToFunc("/v2/files")();
 
   const query = encodeFormQuery({
-    "firstId": payload?.firstId,
-    "lastId": payload?.lastId,
+    "ending_before": payload?.ending_before,
     "limit": payload?.limit,
-    "page": payload?.page,
+    "starting_after": payload?.starting_after,
   });
 
   const headers = new Headers(compactMap({

package/src/funcs/promptsCreate.ts

@@ -23,7 +23,7 @@ import * as operations from "../models/operations/index.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Create a new prompt
+ * Create a prompt
  */
 export async function promptsCreate(
   client: OrqCore,
@@ -55,7 +55,7 @@ export async function promptsCreate(
     ? null
     : encodeJSON("body", payload, { explode: true });
 
-  const path = pathToFunc("/v2/resources/prompts")();
+  const path = pathToFunc("/v2/prompts")();
 
   const headers = new Headers(compactMap({
     "Content-Type": "application/json",

package/src/funcs/promptsDelete.ts

@@ -60,7 +60,7 @@ export async function promptsDelete(
     }),
   };
 
-  const path = pathToFunc("/v2/resources/prompts/{id}")(pathParams);
+  const path = pathToFunc("/v2/prompts/{id}")(pathParams);
 
   const headers = new Headers(compactMap({
     Accept: "*/*",

package/src/funcs/{promptSnippetsFindOne.ts → promptsGetVersion.ts}

@@ -18,20 +18,25 @@ import {
   RequestTimeoutError,
   UnexpectedClientError,
 } from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
 import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
 import * as operations from "../models/operations/index.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Get one prompt snippet
+ * Retrieve a prompt version
+ *
+ * @remarks
+ * Retrieves a specific version of a prompt by its ID and version ID.
  */
-export async function promptSnippetsFindOne(
+export async function promptsGetVersion(
   client: OrqCore,
-  request: operations.FindOnePromptSnippetRequest,
+  request: operations.GetPromptVersionRequest,
   options?: RequestOptions,
 ): Promise<
   Result<
-    operations.FindOnePromptSnippetResponseBody,
+    operations.GetPromptVersionResponseBody,
+    | errors.GetPromptVersionResponseBody
     | APIError
     | SDKValidationError
     | UnexpectedClientError
@@ -43,8 +48,7 @@ export async function promptSnippetsFindOne(
 > {
   const parsed = safeParse(
     request,
-    (value) =>
-      operations.FindOnePromptSnippetRequest$outboundSchema.parse(value),
+    (value) => operations.GetPromptVersionRequest$outboundSchema.parse(value),
     "Input validation failed",
   );
   if (!parsed.ok) {
@@ -54,13 +58,19 @@ export async function promptSnippetsFindOne(
   const body = null;
 
   const pathParams = {
-    key: encodeSimple("key", payload.key, {
+    prompt_id: encodeSimple("prompt_id", payload.prompt_id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+    version_id: encodeSimple("version_id", payload.version_id, {
       explode: false,
       charEncoding: "percent",
     }),
   };
 
-  const path = pathToFunc("/v2/resources/prompts/snippets/{key}")(pathParams);
+  const path = pathToFunc("/v2/prompts/{prompt_id}/versions/{version_id}")(
+    pathParams,
+  );
 
   const headers = new Headers(compactMap({
     Accept: "application/json",
@@ -71,7 +81,7 @@ export async function promptSnippetsFindOne(
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
-    operationID: "FindOnePromptSnippet",
+    operationID: "GetPromptVersion",
     oAuth2Scopes: [],
 
     resolvedSecurity: requestSecurity,
@@ -99,7 +109,7 @@ export async function promptSnippetsFindOne(
 
   const doResult = await client._do(req, {
     context,
-    errorCodes: ["400", "404", "4XX", "5XX"],
+    errorCodes: ["404", "4XX", "5XX"],
     retryConfig: context.retryConfig,
     retryCodes: context.retryCodes,
   });
@@ -108,8 +118,13 @@ export async function promptSnippetsFindOne(
   }
   const response = doResult.value;
 
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
   const [result] = await M.match<
-    operations.FindOnePromptSnippetResponseBody,
+    operations.GetPromptVersionResponseBody,
+    | errors.GetPromptVersionResponseBody
     | APIError
     | SDKValidationError
     | UnexpectedClientError
@@ -118,10 +133,11 @@ export async function promptSnippetsFindOne(
     | RequestTimeoutError
     | ConnectionError
   >(
-    M.json(200, operations.FindOnePromptSnippetResponseBody$inboundSchema),
-    M.fail([400, 404, "4XX"]),
+    M.json(200, operations.GetPromptVersionResponseBody$inboundSchema),
+    M.jsonErr(404, errors.GetPromptVersionResponseBody$inboundSchema),
+    M.fail("4XX"),
     M.fail("5XX"),
-  )(response);
+  )(response, { extraFields: responseFields });
   if (!result.ok) {
     return result;
   }

package/src/funcs/{promptsGetAll.ts → promptsList.ts}

@@ -3,7 +3,7 @@
  */
 
 import { OrqCore } from "../core.js";
-import { encodeJSON } from "../lib/encodings.js";
+import { encodeFormQuery } from "../lib/encodings.js";
 import * as M from "../lib/matchers.js";
 import { compactMap } from "../lib/primitives.js";
 import { safeParse } from "../lib/schemas.js";
@@ -23,11 +23,14 @@ import * as operations from "../models/operations/index.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Get all prompts
+ * 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
  */
-export async function promptsGetAll(
+export async function promptsList(
   client: OrqCore,
-  request?: operations.GetAllPromptsRequestBody | undefined,
+  request?: operations.GetAllPromptsRequest | undefined,
   options?: RequestOptions,
 ): Promise<
   Result<
@@ -44,23 +47,24 @@ export async function promptsGetAll(
   const parsed = safeParse(
     request,
     (value) =>
-      operations.GetAllPromptsRequestBody$outboundSchema.optional().parse(
-        value,
-      ),
+      operations.GetAllPromptsRequest$outboundSchema.optional().parse(value),
     "Input validation failed",
   );
   if (!parsed.ok) {
     return parsed;
   }
   const payload = parsed.value;
-  const body = payload === undefined
-    ? null
-    : encodeJSON("body", payload, { explode: true });
+  const body = null;
 
-  const path = pathToFunc("/v2/resources/prompts/query")();
+  const path = pathToFunc("/v2/prompts")();
+
+  const query = encodeFormQuery({
+    "ending_before": payload?.ending_before,
+    "limit": payload?.limit,
+    "starting_after": payload?.starting_after,
+  });
 
   const headers = new Headers(compactMap({
-    "Content-Type": "application/json",
     Accept: "application/json",
   }));
 
@@ -83,10 +87,11 @@ export async function promptsGetAll(
 
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
-    method: "POST",
+    method: "GET",
     baseURL: options?.serverURL,
     path: path,
     headers: headers,
+    query: query,
     body: body,
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || 600000,
   }, options);

package/src/funcs/{promptsDuplicate.ts → promptsListVersions.ts}

@@ -2,9 +2,8 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
 import { OrqCore } from "../core.js";
-import { encodeSimple } from "../lib/encodings.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";
@@ -24,15 +23,18 @@ import * as operations from "../models/operations/index.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Duplicate a prompt
+ * 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 promptsDuplicate(
+export async function promptsListVersions(
   client: OrqCore,
-  request: operations.DuplicatePromptRequest,
+  request: operations.ListPromptVersionsRequest,
   options?: RequestOptions,
 ): Promise<
   Result<
-    void,
+    operations.ListPromptVersionsResponseBody,
     | APIError
     | SDKValidationError
     | UnexpectedClientError
@@ -44,7 +46,7 @@ export async function promptsDuplicate(
 > {
   const parsed = safeParse(
     request,
-    (value) => operations.DuplicatePromptRequest$outboundSchema.parse(value),
+    (value) => operations.ListPromptVersionsRequest$outboundSchema.parse(value),
     "Input validation failed",
   );
   if (!parsed.ok) {
@@ -54,16 +56,22 @@ export async function promptsDuplicate(
   const body = null;
 
   const pathParams = {
-    id: encodeSimple("id", payload.id, {
+    prompt_id: encodeSimple("prompt_id", payload.prompt_id, {
       explode: false,
       charEncoding: "percent",
     }),
   };
 
-  const path = pathToFunc("/v2/resources/prompts/{id}/duplicate")(pathParams);
+  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: "*/*",
+    Accept: "application/json",
   }));
 
   const secConfig = await extractSecurity(client._options.apiKey);
@@ -71,7 +79,7 @@ export async function promptsDuplicate(
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
-    operationID: "DuplicatePrompt",
+    operationID: "ListPromptVersions",
     oAuth2Scopes: [],
 
     resolvedSecurity: requestSecurity,
@@ -89,6 +97,7 @@ export async function promptsDuplicate(
     baseURL: options?.serverURL,
     path: path,
     headers: headers,
+    query: query,
     body: body,
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || 600000,
   }, options);
@@ -109,7 +118,7 @@ export async function promptsDuplicate(
   const response = doResult.value;
 
   const [result] = await M.match<
-    void,
+    operations.ListPromptVersionsResponseBody,
     | APIError
     | SDKValidationError
     | UnexpectedClientError
@@ -118,7 +127,7 @@ export async function promptsDuplicate(
     | RequestTimeoutError
     | ConnectionError
   >(
-    M.nil(200, z.void()),
+    M.json(200, operations.ListPromptVersionsResponseBody$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),
   )(response);

package/src/funcs/{promptsGetOne.ts → promptsRetrieve.ts}

@@ -2,7 +2,6 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
 import { OrqCore } from "../core.js";
 import { encodeSimple } from "../lib/encodings.js";
 import * as M from "../lib/matchers.js";
@@ -24,15 +23,18 @@ import * as operations from "../models/operations/index.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Get one prompt
+ * Retrieve a prompt
+ *
+ * @remarks
+ * Retrieves a prompt object
  */
-export async function promptsGetOne(
+export async function promptsRetrieve(
   client: OrqCore,
   request: operations.GetOnePromptRequest,
   options?: RequestOptions,
 ): Promise<
   Result<
-    void,
+    operations.GetOnePromptResponseBody,
     | APIError
     | SDKValidationError
     | UnexpectedClientError
@@ -60,10 +62,10 @@ export async function promptsGetOne(
     }),
   };
 
-  const path = pathToFunc("/v2/resources/prompts/{id}")(pathParams);
+  const path = pathToFunc("/v2/prompts/{id}")(pathParams);
 
   const headers = new Headers(compactMap({
-    Accept: "*/*",
+    Accept: "application/json",
   }));
 
   const secConfig = await extractSecurity(client._options.apiKey);
@@ -109,7 +111,7 @@ export async function promptsGetOne(
   const response = doResult.value;
 
   const [result] = await M.match<
-    void,
+    operations.GetOnePromptResponseBody,
     | APIError
     | SDKValidationError
     | UnexpectedClientError
@@ -118,7 +120,7 @@ export async function promptsGetOne(
     | RequestTimeoutError
     | ConnectionError
   >(
-    M.nil(200, z.void()),
+    M.json(200, operations.GetOnePromptResponseBody$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),
   )(response);

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/funcs/{remoteconfigGetConfig.ts → remoteconfigsRetrieve.ts}

@@ -23,9 +23,9 @@ import * as operations from "../models/operations/index.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Get Configurations
+ * Retrieve a remote config
  */
-export async function remoteconfigGetConfig(
+export async function remoteconfigsRetrieve(
   client: OrqCore,
   request?: operations.RemoteConfigsGetConfigRequestBody | undefined,
   options?: RequestOptions,

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.2",
+  sdkVersion: "3.1.4",
   genVersion: "2.506.0",
-  userAgent: "speakeasy-sdk/typescript 3.1.2 2.506.0 2.0 @orq-ai/node",
+  userAgent: "speakeasy-sdk/typescript 3.1.4 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/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) {